twisted.conch.ssh.agent.SSHAgentClient(protocol.Protocol)
class documentationtwisted.conch.ssh.agent
View Source
(View In Hierarchy)
Known subclasses: twisted.conch.client.agent.SSHAgentClient
The client side of the SSH agent protocol. This is equivalent to ssh-add(1) and can be used with either ssh-agent(1) or the SSHAgentServer protocol, also in this package.
Method | __init__ | Undocumented |
Method | dataReceived | Called whenever data is received. |
Method | sendRequest | Undocumented |
Method | requestIdentities | |
Method | addIdentity | Add a private key blob to the agent's collection of keys. |
Method | signData | Request that the agent sign the given data with the private
key which corresponds to the public key given by blob . The
private key should have been added to the agent already. |
Method | removeIdentity | Remove the private key corresponding to the public key in blob from the running agent. |
Method | removeAllIdentities | Remove all keys from the running agent. |
Method | _cbRequestIdentities | Unpack a collection of identities into a list of tuples comprised of public key blobs and comments. |
Method | _cbSignData | Undocumented |
Inherited from Protocol:
Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Method | connectionLost | Called when the connection is shut down. |
Inherited from BaseProtocol (via Protocol):
Method | makeConnection | Make a connection to a transport and a server. |
Method | connectionMade | Called when a connection is made. |
Called whenever data is received.
Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.
Parameters | data | a string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time. |
Returns | A Deferred
which will fire with a list of all keys found in the SSH agent. The list of
keys is comprised of (public key blob, comment) tuples. |
Unpack a collection of identities into a list of tuples comprised of public key blobs and comments.
Add a private key blob to the agent's collection of keys.
Request that the agent sign the given data
with the private
key which corresponds to the public key given by blob
. The
private key should have been added to the agent already.
Returns | A Deferred
which fires with a signature for given data created with the given key. |
Remove the private key corresponding to the public key in blob from the running agent.