net.sf.sshapi.agent

Interface SshAgent

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, SshChannelHandler

All Known Implementing Classes:

MaverickAgent

public interface SshAgent
extends SshChannelHandler, java.io.Closeable

Client implementations are responsible for maintaining the connection with the server, authentication, and access to the sub-systems

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_AGENT_SOCKET_TYPE Try to automatically determine the socket type.
static int	AUTO_PROTOCOL Attempt to determine protocol automatically, falling back to OPENSSH_PROTOCOL if not possible.
static int	NAMED_PIPED_AGENT_SOCKET_TYPE Use a windows named pipe for communication with agent.
static int	OPENSSH_PROTOCOL OpenSSH and the de-facto standard
static int	RFC_PROTOCOL RFC agent protocol.
static int	TCPIP_AGENT_SOCKET_TYPE Use a TCP/IP socket for communication with agent.
static int	UNIX_DOMAIN_AGENT_SOCKET_TYPE Use a domain socket for communication with agent.

Method Summary

Modifier and Type	Method and Description
void	addKey(SshKeyPair keyPair, java.lang.String description) Add a key to the agent.
void	deleteAllKeys() Delete all the keys held by the agent.
void	deleteKey(SshPublicKey key, java.lang.String description) Delete a key held by the agent
byte[]	getRandomData(int count) Request some random data from the remote side
byte[]	hashAndSign(SshPublicKey key, byte[] data) Request a hash and sign operation be performed for a given public key.
java.util.Map	listKeys() List all the keys on the agent.
boolean	lockAgent(java.lang.String password) Lock the agent
void	ping(byte[] padding) Ping the remote side with some random padding data
boolean	unlockAgent(java.lang.String password) Unlock the agent

Methods inherited from interface net.sf.sshapi.SshChannelHandler

channelCreated, createChannel, getSupportChannelNames

Methods inherited from interface java.io.Closeable

close

Field Detail

OPENSSH_PROTOCOL

static final int OPENSSH_PROTOCOL

OpenSSH and the de-facto standard

See Also:

Constant Field Values

RFC_PROTOCOL

static final int RFC_PROTOCOL

RFC agent protocol.

See Also:

Constant Field Values

AUTO_PROTOCOL

static final int AUTO_PROTOCOL

Attempt to determine protocol automatically, falling back to OPENSSH_PROTOCOL if not possible. NOTE: No providers can currently implement auto-detection due to a code clash used by the two different protocols. Both use code 9, with the RFC version using it as the FIRST request to determine protocol version. However, OpenSSH uses the code for removing all keys! This makes detection of protocol in use hard.

See Also:

Constant Field Values

AUTO_AGENT_SOCKET_TYPE

static final int AUTO_AGENT_SOCKET_TYPE

Try to automatically determine the socket type.

See Also:

Constant Field Values

TCPIP_AGENT_SOCKET_TYPE

static final int TCPIP_AGENT_SOCKET_TYPE

Use a TCP/IP socket for communication with agent.

See Also:

Constant Field Values

UNIX_DOMAIN_AGENT_SOCKET_TYPE

static final int UNIX_DOMAIN_AGENT_SOCKET_TYPE

Use a domain socket for communication with agent.

See Also:

Constant Field Values

NAMED_PIPED_AGENT_SOCKET_TYPE

static final int NAMED_PIPED_AGENT_SOCKET_TYPE

Use a windows named pipe for communication with agent.

See Also:

Constant Field Values

Method Detail

addKey

void addKey(SshKeyPair keyPair,
            java.lang.String description)
     throws SshException,
            java.lang.UnsupportedOperationException

Add a key to the agent.

Parameters:

keypair - keypair

description - description

Throws:

java.lang.UnsupportedOperationException - if keys cannot be added using this API

SshException

listKeys

java.util.Map listKeys()
                throws SshException

List all the keys on the agent.

Returns:

a map of public keys and descriptions (key is SshPublicKey, value is String)

Throws:

SshException - if an error occurs

lockAgent

boolean lockAgent(java.lang.String password)
           throws SshException

Lock the agent

Parameters:

password - password that will be required to unlock

Returns:

true if the agent was locked, otherwise false

Throws:

SshException - if an error occurs

unlockAgent

boolean unlockAgent(java.lang.String password)
             throws SshException

Unlock the agent

Parameters:

password - the password to unlock

Returns:

true if the agent was unlocked, otherwise false

Throws:

SshException - if an error occurs

getRandomData

byte[] getRandomData(int count)
              throws SshException

Request some random data from the remote side

Parameters:

count - the number of bytes needed

Returns:

the random data received

Throws:

SshException - if an error occurs

deleteKey

void deleteKey(SshPublicKey key,
               java.lang.String description)
        throws SshException

Delete a key held by the agent

Parameters:

key - the public key of the private key to delete

description - the description of the key

Throws:

SshException - if an error occurs

hashAndSign

byte[] hashAndSign(SshPublicKey key,
                   byte[] data)
            throws SshException

Request a hash and sign operation be performed for a given public key.

Parameters:

key - the public key of the required private key

data - the data to has and sign

Returns:

the hashed and signed data

Throws:

SshException - if an error occurs

deleteAllKeys

void deleteAllKeys()
            throws SshException

Delete all the keys held by the agent.

Throws:

SshException - if an error occurs

ping

void ping(byte[] padding)
   throws SshException

Ping the remote side with some random padding data

Parameters:

padding - the padding data

Throws:

IOException - if an IO error occurs

SshException