net.sf.sshapi.impl.maverick16

Class MaverickAgent

java.lang.Object

net.sf.sshapi.impl.maverick16.MaverickAgent

All Implemented Interfaces:

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

public class MaverickAgent
extends java.lang.Object
implements SshAgent

Field Summary

Fields inherited from interface net.sf.sshapi.agent.SshAgent

AUTO_AGENT_SOCKET_TYPE, AUTO_PROTOCOL, NAMED_PIPED_AGENT_SOCKET_TYPE, OPENSSH_PROTOCOL, RFC_PROTOCOL, TCPIP_AGENT_SOCKET_TYPE, UNIX_DOMAIN_AGENT_SOCKET_TYPE

Constructor Summary

Constructors

Constructor and Description
MaverickAgent(java.lang.String application, java.lang.String location, int socketType, int protocol)

Method Summary

Modifier and Type	Method and Description
void	addKey(SshKeyPair keyPair, java.lang.String description) Add a key to the agent.
void	channelCreated(SshChannel channel) Called when a new channel with a supported name has been created.
void	close()
SshChannel.ChannelData	createChannel(java.lang.String channelName, byte[] requestData) Called when a new channel with a supported name has been created.
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
com.maverick.agent.client.SshAgentClient	getAgent()
byte[]	getRandomData(int count) Request some random data from the remote side
java.lang.String[]	getSupportChannelNames() Get the names of the channels this factory supports.
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 class java.lang.Object

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

Constructor Detail

MaverickAgent

public MaverickAgent(java.lang.String application,
                     java.lang.String location,
                     int socketType,
                     int protocol)
              throws SshException

Throws:

SshException

Method Detail

getAgent

public com.maverick.agent.client.SshAgentClient getAgent()

getSupportChannelNames

public java.lang.String[] getSupportChannelNames()

Description copied from interface: SshChannelHandler

Get the names of the channels this factory supports.

Specified by:

getSupportChannelNames in interface SshChannelHandler

Returns:

channel names

createChannel

public SshChannel.ChannelData createChannel(java.lang.String channelName,
                                            byte[] requestData)

Description copied from interface: SshChannelHandler

Called when a new channel with a supported name has been created.

Specified by:

createChannel in interface SshChannelHandler

Parameters:

channelName - channel name

requestData - request data

Returns:

data to send or null for none

channelCreated

public void channelCreated(SshChannel channel)
                    throws java.io.IOException

Description copied from interface: SshChannelHandler

Called when a new channel with a supported name has been created. The client code can hook in here to add listeners.

Specified by:

channelCreated in interface SshChannelHandler

Parameters:

channel - channel

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

addKey

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

Description copied from interface: SshAgent

Add a key to the agent.

Specified by:

addKey in interface SshAgent

description - description

Throws:

SshException

listKeys

public java.util.Map listKeys()
                       throws SshException

Description copied from interface: SshAgent

List all the keys on the agent.

Specified by:

listKeys in interface SshAgent

Returns:

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

Throws:

SshException - if an error occurs

lockAgent

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

Description copied from interface: SshAgent

Lock the agent

Specified by:

lockAgent in interface SshAgent

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

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

Description copied from interface: SshAgent

Unlock the agent

Specified by:

unlockAgent in interface SshAgent

Parameters:

password - the password to unlock

Returns:

true if the agent was unlocked, otherwise false

Throws:

SshException - if an error occurs

getRandomData

public byte[] getRandomData(int count)
                     throws SshException

Description copied from interface: SshAgent

Request some random data from the remote side

Specified by:

getRandomData in interface SshAgent

Parameters:

count - the number of bytes needed

Returns:

the random data received

Throws:

SshException - if an error occurs

deleteKey

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

Description copied from interface: SshAgent

Delete a key held by the agent

Specified by:

deleteKey in interface SshAgent

Parameters:

key - the public key of the private key to delete

description - the description of the key

Throws:

SshException - if an error occurs

hashAndSign

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

Description copied from interface: SshAgent

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

Specified by:

hashAndSign in interface SshAgent

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

public void deleteAllKeys()
                   throws SshException

Description copied from interface: SshAgent

Delete all the keys held by the agent.

Specified by:

deleteAllKeys in interface SshAgent

Throws:

SshException - if an error occurs

ping

public void ping(byte[] padding)
          throws SshException

Description copied from interface: SshAgent

Ping the remote side with some random padding data

Specified by:

ping in interface SshAgent

Parameters:

padding - the padding data

Throws:

SshException