com.sshtools.common.auth

Class PublicKeyAuthentication<C extends Context>

java.lang.Object

com.sshtools.common.auth.PublicKeyAuthentication<C>

All Implemented Interfaces:

AuthenticationMechanism

public class PublicKeyAuthentication<C extends Context>
extends java.lang.Object
implements AuthenticationMechanism

Provides an AuthenticationMechanism that enables the public key authentication. The current implementation will look for an authorized_keys file in the users home directory which is returned from the com.maverick.sshd.platform.NativeAuthenticationProvider#getHomeDirectory(String) method. The format of this file is identical to that required by OpenSSH.

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHENTICATION_METHOD
static int	SSH_MSG_USERAUTH_PK_OK

Constructor Summary

Constructors

Constructor and Description
PublicKeyAuthentication(AbstractServerTransport<C> transport, AbstractAuthenticationProtocol<C> authentication, SshConnection con, PublicKeyAuthenticationProvider[] providers)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMethod() Return the SSH method name for this authentication.
boolean	processMessage(byte[] msg) If the SSH protocol authentication method defines additional messages which are sent from the client, they will be passed into your implementation here when received.
boolean	startRequest(java.lang.String username, byte[] msg) Start an authentication transaction.

Methods inherited from class java.lang.Object

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

Field Detail

SSH_MSG_USERAUTH_PK_OK

public static final int SSH_MSG_USERAUTH_PK_OK

See Also:

Constant Field Values

AUTHENTICATION_METHOD

public static final java.lang.String AUTHENTICATION_METHOD

See Also:

Constant Field Values

Constructor Detail

PublicKeyAuthentication

public PublicKeyAuthentication(AbstractServerTransport<C> transport,
                               AbstractAuthenticationProtocol<C> authentication,
                               SshConnection con,
                               PublicKeyAuthenticationProvider[] providers)

Method Detail

getMethod

public java.lang.String getMethod()

Description copied from interface: AuthenticationMechanism

Return the SSH method name for this authentication. e.g "password"

Specified by:

getMethod in interface AuthenticationMechanism

Returns:

String

startRequest

public boolean startRequest(java.lang.String username,
                            byte[] msg)
                     throws java.io.IOException

Description copied from interface: AuthenticationMechanism

Start an authentication transaction. If the authentication mechanism is simple and you can determine the result from all information received in the SSH_MSG_USERAUTH_REQUEST message, you should call the approriate completion methods on the com.maverick.sshd.AuthenticationProtocol instance that was passed in the initialization process. The request data varies according to the authentication method.

 if (success)
        authentication.completedAuthentication(method, username, service);
 else
        authentication.failedAuthentication(method);
 

Specified by:

startRequest in interface AuthenticationMechanism

msg - the request data from the SSH_MSG_USERAUTH_REQUEST message

Returns:

true if the message was processed, otherwise false

Throws:

java.io.IOException

processMessage

public boolean processMessage(byte[] msg)
                       throws java.io.IOException

Description copied from interface: AuthenticationMechanism

If the SSH protocol authentication method defines additional messages which are sent from the client, they will be passed into your implementation here when received.

Specified by:

processMessage in interface AuthenticationMechanism

Returns:

boolean

Throws:

java.io.IOException