com.sshtools.ssh2

Class Ssh2PasswordAuthentication

java.lang.Object

com.sshtools.ssh.PasswordAuthentication

com.sshtools.ssh2.Ssh2PasswordAuthentication

All Implemented Interfaces:

SshAuthentication, AuthenticationClient

public class Ssh2PasswordAuthentication
extends PasswordAuthentication
implements AuthenticationClient

Implements Password authentication as defined in the SSH Authenticaiton Protocol. To use password authentication first construct an instance and set the username and password fields.

 PasswordAuthentication pwd = new PasswordAuthentication();
 
 pwd.setUsername("username");
 pwd.setPassword("password");
 
 int result = ssh.authenticate(pwd);
 

When the authentication returns the result should be evaluated. If the authentication has completed no further processing is required, however if the result is failed you should check the password change flag to determine if the attempt failed because the user is required to change their password. If this is required set the new password on the instance using setNewPassword and call the authentication procedure again. If the authenticaiton fails again the password may not be acceptable.

 if (result == SshAuthentication.FAILED) {
        if (pwd.requiresPasswordChange()) {
                pwd.setNewPassword("foo");
 
                // Perform authentication again
                result = ssh.authenticate(pwd);
        }
 }
 
 

Author:

Lee David Painter

Field Summary

Fields inherited from interface com.sshtools.ssh.SshAuthentication

CANCELLED, COMPLETE, FAILED, FURTHER_AUTHENTICATION_REQUIRED, PUBLIC_KEY_ACCEPTABLE

Constructor Summary

Constructors

Constructor and Description
Ssh2PasswordAuthentication() Construct the method

Method Summary

Modifier and Type	Method and Description
void	authenticate(AuthenticationProtocol authentication, String servicename) Implementation of the authentication method.
boolean	requiresPasswordChange() Indicates whether the users password requires changing.
void	setNewPassword(String newpassword) After performing an initial authentication attempt a flag may be set to indicate that a password change is required.

Methods inherited from class com.sshtools.ssh.PasswordAuthentication

getMethod, getPassword, getUsername, setPassword, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sshtools.ssh.SshAuthentication

getMethod, getUsername, setUsername

Constructor Detail

Ssh2PasswordAuthentication

public Ssh2PasswordAuthentication()

Construct the method

Method Detail

setNewPassword

public void setNewPassword(String newpassword)

After performing an initial authentication attempt a flag may be set to indicate that a password change is required. Use this method to set the new password and retry the authentication attempt.

Parameters:

newpassword -

requiresPasswordChange

public boolean requiresPasswordChange()

Indicates whether the users password requires changing. This will always return false until after an initial authentication attempt. Then it MAY be true so should always be checked upon a failed attempt.

Returns:

true if the user must change their password otherwise false.

authenticate

public void authenticate(AuthenticationProtocol authentication,
                         String servicename)
                  throws SshException,
                         AuthenticationResult

Implementation of the authentication method.

Specified by:

authenticate in interface AuthenticationClient

Parameters:

authentication -

servicename -

Throws:

IOException

AuthenticationResult

SshException