com.sshtools.client

Class ExternalKeyAuthenticator

java.lang.Object

com.sshtools.common.ssh.AbstractRequestFuture

com.sshtools.client.SimpleClientAuthenticator

com.sshtools.client.ExternalKeyAuthenticator

All Implemented Interfaces:

ClientAuthenticator, SignatureGenerator, RequestFuture

public class ExternalKeyAuthenticator
extends SimpleClientAuthenticator
implements ClientAuthenticator, SignatureGenerator

Implements public key authentication taking a separately loaded SshKeyPair as the private key for authentication.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SSH_MSG_USERAUTH_PK_OK

Constructor Summary

Constructors

Constructor and Description
ExternalKeyAuthenticator()
ExternalKeyAuthenticator(SignatureGenerator signatureGenerator)

Method Summary

Modifier and Type	Method and Description
void	authenticate(TransportProtocolClient transport, java.lang.String username) Start the authentication
java.lang.String	getName() The authentication mechanism name/.
java.util.Collection<SshPublicKey>	getPublicKeys()
SignatureGenerator	getSignatureGenerator(Connection<SshClientContext> con)
protected void	onStartAuthentication(Connection<SshClientContext> con)
boolean	processMessage(com.sshtools.common.util.ByteArrayReader msg) Process an authentication message.
byte[]	sign(SshPublicKey key, java.lang.String signingAlgorithm, byte[] data)

Methods inherited from class com.sshtools.client.SimpleClientAuthenticator

cancel, failure, getAuthenticationMethods, isCancelled, isMoreAuthenticationRequired, success, success

Methods inherited from class com.sshtools.common.ssh.AbstractRequestFuture

addFutureListener, done, isDone, isSuccess, waitFor, waitForever

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sshtools.client.ClientAuthenticator

cancel, failure, getAuthenticationMethods, isCancelled, isMoreAuthenticationRequired, success, success

Methods inherited from interface com.sshtools.common.ssh.RequestFuture

addFutureListener, isDone, isSuccess, waitFor, waitForever

Field Detail

SSH_MSG_USERAUTH_PK_OK

public static final int SSH_MSG_USERAUTH_PK_OK

See Also:

Constant Field Values

Constructor Detail

ExternalKeyAuthenticator

public ExternalKeyAuthenticator(SignatureGenerator signatureGenerator)

ExternalKeyAuthenticator

public ExternalKeyAuthenticator()

Method Detail

authenticate

public void authenticate(TransportProtocolClient transport,
                         java.lang.String username)
                  throws SshException,
                         java.io.IOException

Description copied from interface: ClientAuthenticator

Start the authentication

Specified by:

authenticate in interface ClientAuthenticator

Throws:

SshException

java.io.IOException

onStartAuthentication

protected void onStartAuthentication(Connection<SshClientContext> con)

processMessage

public boolean processMessage(com.sshtools.common.util.ByteArrayReader msg)
                       throws java.io.IOException

Description copied from interface: ClientAuthenticator

Process an authentication message.

Specified by:

processMessage in interface ClientAuthenticator

Overrides:

processMessage in class SimpleClientAuthenticator

Returns:

Throws:

java.io.IOException

getSignatureGenerator

public SignatureGenerator getSignatureGenerator(Connection<SshClientContext> con)

sign

public byte[] sign(SshPublicKey key,
                   java.lang.String signingAlgorithm,
                   byte[] data)
            throws SshException

Specified by:

sign in interface SignatureGenerator

Throws:

SshException

getName

public java.lang.String getName()

Description copied from interface: ClientAuthenticator

The authentication mechanism name/.

Specified by:

getName in interface ClientAuthenticator

Returns:

getPublicKeys

public java.util.Collection<SshPublicKey> getPublicKeys()
                                                 throws java.io.IOException

Specified by:

getPublicKeys in interface SignatureGenerator

Throws:

java.io.IOException