Package com.jcraft.jsch

Class IdentityFile

java.lang.Object

com.jcraft.jsch.IdentityFile

All Implemented Interfaces:

Identity

class IdentityFile
extends Object
implements Identity

Field Summary

Fields

Modifier and Type	Field	Description
private String	identity
private JSch	jsch
private KeyPair	kpair

Constructor Summary

Constructors

Modifier	Constructor	Description
private	IdentityFile(JSch jsch, String name, KeyPair kpair)

Method Summary

Modifier and Type	Method	Description
void	clear()	Disposes internally allocated data, like byte array for the private key.
boolean	decrypt()	Deprecated. This method should not be invoked.
String	getAlgName()	Returns the name of the key algorithm.
KeyPair	getKeyPair()	Returns an instance of KeyPair used in this Identity.
String	getName()	Returns the name of this identity.
byte[]	getPublicKeyBlob()	Returns the public-key blob.
byte[]	getSignature(byte[] data)	Signs on data with this identity, and returns the result.
boolean	isEncrypted()	Returns true if this identity is cyphered.
(package private) static IdentityFile	newInstance(String name, byte[] prvkey, byte[] pubkey, JSch jsch)
(package private) static IdentityFile	newInstance(String prvfile, String pubfile, JSch jsch)
boolean	setPassphrase(byte[] passphrase)	Decrypts this identity with the specified pass-phrase.

Methods inherited from class java.lang.Object

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

Field Details

jsch

private JSch jsch

kpair

private KeyPair kpair

identity

private String identity

Constructor Details

IdentityFile

private IdentityFile(JSch jsch,
 String name,
 KeyPair kpair)
              throws JSchException

Throws:

JSchException

Method Details

newInstance

static IdentityFile newInstance(String prvfile,
 String pubfile,
 JSch jsch)
                         throws JSchException

Throws:

JSchException

newInstance

static IdentityFile newInstance(String name,
 byte[] prvkey,
 byte[] pubkey,
 JSch jsch)
                         throws JSchException

Throws:

JSchException

setPassphrase

public boolean setPassphrase(byte[] passphrase)
                      throws JSchException

Decrypts this identity with the specified pass-phrase.

Specified by:

setPassphrase in interface Identity

Parameters:

passphrase - the pass-phrase for this identity.

Returns:

true if the decryption is succeeded or this identity is not cyphered.

Throws:

JSchException

getPublicKeyBlob

public byte[] getPublicKeyBlob()

Returns the public-key blob.

Specified by:

getPublicKeyBlob in interface Identity

Returns:

the public-key blob

getSignature

public byte[] getSignature(byte[] data)

Signs on data with this identity, and returns the result.

Specified by:

getSignature in interface Identity

Parameters:

data - data to be signed

Returns:

the signature

decrypt

public boolean decrypt()

Deprecated.

This method should not be invoked.

Specified by:

decrypt in interface Identity

See Also:

• setPassphrase(byte[] passphrase)

getAlgName

public String getAlgName()

Returns the name of the key algorithm.

Specified by:

getAlgName in interface Identity

Returns:

"ssh-rsa" or "ssh-dss"

getName

public String getName()

Returns the name of this identity. It will be useful to identify this object in the IdentityRepository.

Specified by:

getName in interface Identity

isEncrypted

public boolean isEncrypted()

Returns true if this identity is cyphered.

Specified by:

isEncrypted in interface Identity

Returns:

true if this identity is cyphered.

clear

public void clear()

Disposes internally allocated data, like byte array for the private key.

Specified by:

clear in interface Identity

getKeyPair

public KeyPair getKeyPair()

Returns an instance of KeyPair used in this Identity.

Returns:

an instance of KeyPair used in this Identity.