Package com.sshtools.client

Class PrivateKeyFileAuthenticator

java.lang.Object

com.sshtools.common.ssh.AbstractRequestFuture

com.sshtools.client.SimpleClientAuthenticator

com.sshtools.client.PublicKeyAuthenticator

com.sshtools.client.PrivateKeyFileAuthenticator

All Implemented Interfaces:

ClientAuthenticator, RequestFuture

public class PrivateKeyFileAuthenticator
extends PublicKeyAuthenticator

Implements public key authentication, taking a java.io.File object as the source private key.

Field Summary

Fields inherited from class com.sshtools.client.PublicKeyAuthenticator

SSH_MSG_USERAUTH_PK_OK

Constructor Summary

Constructors

Constructor	Description
PrivateKeyFileAuthenticator(File path)
PrivateKeyFileAuthenticator(File path, PassphrasePrompt passphrase)
PrivateKeyFileAuthenticator(File path, String passphrase)
PrivateKeyFileAuthenticator(Path path)
PrivateKeyFileAuthenticator(Path path, PassphrasePrompt passphrase)
PrivateKeyFileAuthenticator(Path path, String passphrase)

Method Summary

Modifier and Type	Method	Description
protected SshKeyPair	getAuthenticatingKey()
protected SshPublicKey	getNextKey()
String	getPassphrase()
protected boolean	hasCredentialsRemaining()

Methods inherited from class com.sshtools.client.PublicKeyAuthenticator

authenticate, getName, getSignatureGenerator, onStartAuthentication, processMessage, sign

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

Constructor Details

PrivateKeyFileAuthenticator

public PrivateKeyFileAuthenticator(File path,
 String passphrase)
                            throws IOException

Throws:

IOException

PrivateKeyFileAuthenticator

public PrivateKeyFileAuthenticator(File path,
 PassphrasePrompt passphrase)
                            throws IOException

Throws:

IOException

PrivateKeyFileAuthenticator

public PrivateKeyFileAuthenticator(Path path,
 String passphrase)
                            throws IOException

Throws:

IOException

PrivateKeyFileAuthenticator

public PrivateKeyFileAuthenticator(Path path,
 PassphrasePrompt passphrase)
                            throws IOException

Throws:

IOException

PrivateKeyFileAuthenticator

public PrivateKeyFileAuthenticator(File path)
                            throws IOException

Throws:

IOException

PrivateKeyFileAuthenticator

public PrivateKeyFileAuthenticator(Path path)
                            throws IOException

Throws:

IOException

Method Details

getPassphrase

public String getPassphrase()

getNextKey

protected SshPublicKey getNextKey()
                           throws IOException

Specified by:

getNextKey in class PublicKeyAuthenticator

Throws:

IOException

getAuthenticatingKey

protected SshKeyPair getAuthenticatingKey()
                                   throws IOException,
InvalidPassphraseException

Specified by:

getAuthenticatingKey in class PublicKeyAuthenticator

Throws:

IOException

InvalidPassphraseException

hasCredentialsRemaining

protected boolean hasCredentialsRemaining()

Specified by:

hasCredentialsRemaining in class PublicKeyAuthenticator