Package com.sshtools.client

Class PublicKeyAuthenticator

java.lang.Object

com.sshtools.common.ssh.AbstractRequestFuture

com.sshtools.client.SimpleClientAuthenticator

com.sshtools.client.PublicKeyAuthenticator

All Implemented Interfaces:

ClientAuthenticator, RequestFuture

Direct Known Subclasses:

ExternalKeyAuthenticator, IdentityFileAuthenticator, KeyPairAuthenticator, PrivateKeyFileAuthenticator

public abstract class PublicKeyAuthenticator
extends SimpleClientAuthenticator
implements ClientAuthenticator

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SSH_MSG_USERAUTH_PK_OK

Constructor Summary

Constructors

Constructor	Description
PublicKeyAuthenticator()

Method Summary

Modifier and Type	Method	Description
void	authenticate(TransportProtocolClient transport, String username)	Start the authentication
protected abstract SshKeyPair	getAuthenticatingKey()
String	getName()	The authentication mechanism name/.
protected abstract SshPublicKey	getNextKey()
protected SignatureGenerator	getSignatureGenerator()
protected abstract boolean	hasCredentialsRemaining()
protected void	onStartAuthentication(Connection<SshClientContext> con)
boolean	processMessage(com.sshtools.common.util.ByteArrayReader msg)	Process an authentication message.
byte[]	sign(SshPrivateKey prv, 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, isDoneAndSuccess, isSuccess, waitFor, waitForever

Field Details

SSH_MSG_USERAUTH_PK_OK

public static final int SSH_MSG_USERAUTH_PK_OK

See Also:

• Constant Field Values

Constructor Details

PublicKeyAuthenticator

public PublicKeyAuthenticator()

Method Details

authenticate

public void authenticate(TransportProtocolClient transport,
 String username)
                  throws IOException,
SshException

Description copied from interface: ClientAuthenticator

Start the authentication

Specified by:

authenticate in interface ClientAuthenticator

Throws:

IOException

SshException

onStartAuthentication

protected void onStartAuthentication(Connection<SshClientContext> con)

getNextKey

protected abstract SshPublicKey getNextKey()
                                    throws IOException

Throws:

IOException

getAuthenticatingKey

protected abstract SshKeyPair getAuthenticatingKey()
                                            throws IOException,
InvalidPassphraseException

Throws:

IOException

InvalidPassphraseException

hasCredentialsRemaining

protected abstract boolean hasCredentialsRemaining()

getSignatureGenerator

protected SignatureGenerator getSignatureGenerator()
                                            throws IOException,
InvalidPassphraseException

Throws:

IOException

InvalidPassphraseException

processMessage

public boolean processMessage(com.sshtools.common.util.ByteArrayReader msg)
                       throws IOException,
SshException

Description copied from interface: ClientAuthenticator

Process an authentication message.

Specified by:

processMessage in interface ClientAuthenticator

Overrides:

processMessage in class SimpleClientAuthenticator

Returns:

Throws:

IOException

SshException

sign

public byte[] sign(SshPrivateKey prv,
 String signingAlgorithm,
 byte[] data)
            throws SshException

Throws:

SshException

getName

public String getName()

Description copied from interface: ClientAuthenticator

The authentication mechanism name/.

Specified by:

getName in interface ClientAuthenticator

Returns: