com.sshtools.j2ssh.agent

Class SshAgentConnection

Implemented Interfaces:
Runnable

public class SshAgentConnection
extends java.lang.Object
implements Runnable

This class provides a connection using the SSH agent protocol.
Version:
$Revision: 1.14 $
Author:
$author$

Method Summary

protected void
onAddKey(com.sshtools.j2ssh.agent.SshAgentAddKey msg)
Called when the remote side adds a key the agent.
protected void
onDeleteAllKeys(com.sshtools.j2ssh.agent.SshAgentDeleteAllKeys msg)
Called when the remote side requests that all keys be removed from the agent.
protected void
onDeleteKey(com.sshtools.j2ssh.agent.SshAgentDeleteKey msg)
Called by the remote side to delete a key from the agent
protected void
onForwardingNotice(com.sshtools.j2ssh.agent.SshAgentForwardingNotice msg)
Called when a forwarding notice is recceived from the remote side.
protected void
onListKeys(com.sshtools.j2ssh.agent.SshAgentListKeys msg)
Called by the remote side when a list of the agents keys is required
protected void
onLock(com.sshtools.j2ssh.agent.SshAgentLock msg)
Called by the remote side when the agent is to be locked
protected void
onMessageReceived(byte[] msgdata)
Process a message and route to the handler method
protected void
onPing(com.sshtools.j2ssh.agent.SshAgentPing msg)
Called when a ping message is received
protected void
onPrivateKeyOp(com.sshtools.j2ssh.agent.SshAgentPrivateKeyOp msg)
Called by the remote side to initiate a private key operation.
protected void
onRandom(com.sshtools.j2ssh.agent.SshAgentRandom msg)
Called when the remote side sends a random message
protected void
onRequestVersion(com.sshtools.j2ssh.agent.SshAgentRequestVersion msg)
Called when the remote side requests the version number of this protocol.
protected void
onUnlock(com.sshtools.j2ssh.agent.SshAgentUnlock msg)
Called by the remote side when the agent is to be unlocked
void
run()
The connection thread
protected void
sendAgentAlive(byte[] padding)
Send the agent alive message.
protected void
sendAgentFailure(int errorcode)
Send a failure message
protected void
sendAgentKeyList()
Send the agents key list to the remote side.
protected void
sendAgentSuccess()
Send a success message.
protected void
sendMessage(SubsystemMessage msg)
Sends a subsystem message.
protected void
sendOperationComplete(byte[] data)
Send the completed signing operation data.
protected void
sendRandomData(byte[] data)
Send some random data to the remote side.
protected void
sendVersionResponse()
Send the version response; this class currently implements version 2

Method Details

onAddKey

protected void onAddKey(com.sshtools.j2ssh.agent.SshAgentAddKey msg)
            throws IOException
Called when the remote side adds a key the agent.
Parameters:
msg - the message containing the key

onDeleteAllKeys

protected void onDeleteAllKeys(com.sshtools.j2ssh.agent.SshAgentDeleteAllKeys msg)
            throws IOException
Called when the remote side requests that all keys be removed from the agent.
Parameters:
msg - the delete all keys message

onDeleteKey

protected void onDeleteKey(com.sshtools.j2ssh.agent.SshAgentDeleteKey msg)
            throws IOException
Called by the remote side to delete a key from the agent
Parameters:
msg - the message containin the key to delete

onForwardingNotice

protected void onForwardingNotice(com.sshtools.j2ssh.agent.SshAgentForwardingNotice msg)
Called when a forwarding notice is recceived from the remote side.
Parameters:
msg - the forwarding notice

onListKeys

protected void onListKeys(com.sshtools.j2ssh.agent.SshAgentListKeys msg)
            throws IOException
Called by the remote side when a list of the agents keys is required
Parameters:
msg - the list all keys message

onLock

protected void onLock(com.sshtools.j2ssh.agent.SshAgentLock msg)
            throws IOException
Called by the remote side when the agent is to be locked
Parameters:
msg - the message containing a password

onMessageReceived

protected void onMessageReceived(byte[] msgdata)
            throws IOException
Process a message and route to the handler method
Parameters:
msgdata - the raw message received

onPing

protected void onPing(com.sshtools.j2ssh.agent.SshAgentPing msg)
            throws IOException
Called when a ping message is received
Parameters:
msg - the ping message containing some padding

onPrivateKeyOp

protected void onPrivateKeyOp(com.sshtools.j2ssh.agent.SshAgentPrivateKeyOp msg)
            throws IOException
Called by the remote side to initiate a private key operation.
Parameters:
msg - the private key operation message

onRandom

protected void onRandom(com.sshtools.j2ssh.agent.SshAgentRandom msg)
            throws IOException
Called when the remote side sends a random message
Parameters:
msg - the random message

onRequestVersion

protected void onRequestVersion(com.sshtools.j2ssh.agent.SshAgentRequestVersion msg)
            throws IOException
Called when the remote side requests the version number of this protocol.
Parameters:
msg - the version request message

onUnlock

protected void onUnlock(com.sshtools.j2ssh.agent.SshAgentUnlock msg)
            throws IOException
Called by the remote side when the agent is to be unlocked
Parameters:
msg - the message containin the password

run

public void run()
The connection thread

sendAgentAlive

protected void sendAgentAlive(byte[] padding)
            throws IOException
Send the agent alive message. This is sent to test whether the agent is still active
Parameters:
padding - some random padding for the message

sendAgentFailure

protected void sendAgentFailure(int errorcode)
            throws IOException
Send a failure message
Parameters:
errorcode - the error code of the failure

sendAgentKeyList

protected void sendAgentKeyList()
            throws IOException
Send the agents key list to the remote side. This supplies all the public keys.

sendAgentSuccess

protected void sendAgentSuccess()
            throws IOException
Send a success message.

sendMessage

protected void sendMessage(SubsystemMessage msg)
            throws IOException
Sends a subsystem message.
Parameters:
msg - the subsystem message to send

sendOperationComplete

protected void sendOperationComplete(byte[] data)
            throws IOException
Send the completed signing operation data.
Parameters:
data - the data generating from the signing operation

sendRandomData

protected void sendRandomData(byte[] data)
            throws IOException
Send some random data to the remote side.
Parameters:
data - some random data

sendVersionResponse

protected void sendVersionResponse()
            throws IOException
Send the version response; this class currently implements version 2

Copyright © 2002-2003 Lee David Painter & Contributors. All Rights Reserved.