net.sf.sshapi.util

Class PEMFilePublicKeyAuthenticator

java.lang.Object

net.sf.sshapi.util.PEMFilePublicKeyAuthenticator

All Implemented Interfaces:

SshAuthenticator, SshPublicKeyAuthenticator

public class PEMFilePublicKeyAuthenticator
extends java.lang.Object
implements SshPublicKeyAuthenticator

A public key authenticator that reads the key from a file. The passphrase for the key is retrieved using the provided SshPasswordPrompt.

Constructor Summary

Constructors

Constructor and Description
PEMFilePublicKeyAuthenticator(SshPasswordPrompt passphrasePrompt, java.io.File pemFile) Constructor

Method Summary

Modifier and Type	Method and Description
byte[]	getPrivateKey() Get the private key data.
java.lang.String	getTypeName() Get the name of this authenticator (e.g "password", "publickey" etc).
char[]	promptForPassphrase(SshClient session, java.lang.String message) Invoked when the session requires a passphrase (for a key).

Methods inherited from class java.lang.Object

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

Constructor Detail

PEMFilePublicKeyAuthenticator

public PEMFilePublicKeyAuthenticator(SshPasswordPrompt passphrasePrompt,
                                     java.io.File pemFile)
                              throws java.io.IOException

Constructor

Parameters:

passphrasePrompt - invoked when passphrase is required

pemFile - A file containing a DSA or RSA private key of the user in OpenSSH key format.

Throws:

java.io.IOException - on any IO error

Method Detail

getPrivateKey

public byte[] getPrivateKey()

Description copied from interface: SshPublicKeyAuthenticator

Get the private key data.

Specified by:

getPrivateKey in interface SshPublicKeyAuthenticator

Returns:

private key

promptForPassphrase

public char[] promptForPassphrase(SshClient session,
                                  java.lang.String message)

Description copied from interface: SshPublicKeyAuthenticator

Invoked when the session requires a passphrase (for a key).

Specified by:

promptForPassphrase in interface SshPublicKeyAuthenticator

Parameters:

session - session

message - message

Returns:

passphrase or null if passphrase is not available (e.g. cancelled)

getTypeName

public java.lang.String getTypeName()

Description copied from interface: SshAuthenticator

Get the name of this authenticator (e.g "password", "publickey" etc).

Specified by:

getTypeName in interface SshAuthenticator

Returns:

name