com.jcraft.jsch.Identity Interface Reference

A user identity for public-key authentication. More...

Inheritance diagram for com.jcraft.jsch.Identity:
Inheritance graph
[legend]

List of all members.

Public Member Functions

String getName ()
 returns the name of this identity.
String getAlgName ()
 Returns the name of the algorithm.
byte[] getPublicKeyBlob ()
 Returns the public key data.

Detailed Description

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"

Definition at line 47 of file Identity.java.


Member Function Documentation

String com.jcraft.jsch.Identity.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.

Implemented in com.jcraft.jsch.IdentityFile.

Referenced by com.jcraft.jsch.UserAuthPublicKey.start().

String com.jcraft.jsch.Identity.getName (  ) 

returns the name of this identity.

This is only used by the library for bookkeeping purposes (and allows the application to JSch#removeIdentity remove an identity), is not sent to the server.

Implemented in com.jcraft.jsch.IdentityFile.

Referenced by com.jcraft.jsch.UserAuthPublicKey.start(), and com.jcraft.jsch.ChannelAgentForwarding.write().

byte [] com.jcraft.jsch.Identity.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).

Implemented in com.jcraft.jsch.IdentityFile.

Referenced by com.jcraft.jsch.UserAuthPublicKey.start(), and com.jcraft.jsch.ChannelAgentForwarding.write().


The documentation for this interface was generated from the following file:

Generated on 5 May 2015 for HPCVIEWER by  doxygen 1.6.1