com.jcraft.jsch

Interface Identity

public interface Identity

A user identity for public-key authentication. This object encapsulates a key pair and the signature algorithm. It is used by the Session objects on connecting to authenticate to the server.

The library contains a default implementation which is used by JSch.addIdentity() when used with non-Identity parameters.

See Also:

JSch.addIdentity(Identity, byte[]), RFC 4252, section 7. Public Key Authentication Method: "publickey"

Method Summary

Modifier and Type	Method and Description
void	clear() Disposes internally allocated data, like byte array for the private key.
boolean	decrypt() Deprecated. The decryption should be done automatically in #setPassphase(byte[] passphrase)
String	getAlgName() Returns the name of the algorithm.
String	getName() returns the name of this identity.
byte[]	getPublicKeyBlob() Returns the public key data.
byte[]	getSignature(byte[] data) Signs some data with our private key and signature algorithm.
boolean	isEncrypted() Checks whether the private key is encrypted.
boolean	setPassphrase(byte[] passphrase) Provides a passphrase to decrypt the private key.

Method Detail

setPassphrase

boolean setPassphrase(byte[] passphrase)
               throws JSchException

Provides a passphrase to decrypt the private key.

Returns:

true if the passphrase was right and getSignature(byte[]) can now be used, false if the passphrase was wrong.

Throws:

JSchException

getPublicKeyBlob

byte[] getPublicKeyBlob()

Returns the public key data. This will be sent to the server, which then will check the key is authorized for this user (and whether the signature is done with the corresponding private key).

getSignature

byte[] getSignature(byte[] data)

Signs some data with our private key and signature algorithm.

Parameters:

data - data to be signed

Returns:

a signature of data, or null if there was some problem.

decrypt

boolean decrypt()

Deprecated. The decryption should be done automatically in #setPassphase(byte[] passphrase)

See Also:

setPassphrase(byte[] passphrase)

getAlgName

String getAlgName()

Returns the name of the algorithm. This will be sent together with the public key to the server for authorization purposes. The server will use the signature checking algorithm to check the signature.

Returns:

"ssh-rsa" or "ssh-dss"

getName

String getName()

returns the name of this identity. This is only used by the library for bookkeeping purposes in the IdentityRepository (and by this allows the application to remove an identity), is not sent to the server.

isEncrypted

boolean isEncrypted()

Checks whether the private key is encrypted.

Returns:

true if the key is encrypted, i.e. a call of setPassphrase(byte[]) is needed, false if the key is ready to be used (e.g. getSignature(byte[]) can be called).

clear

void clear()

Disposes internally allocated data, like byte array for the private key. This will be called by the library when the identity is removed.