twisted.conch.ssh.agent.SSHAgentServer(protocol.Protocol)
class documentationtwisted.conch.ssh.agent
View Source
(View In Hierarchy)
The server side of the SSH agent protocol. This is equivalent to ssh-agent(1) and can be used with either ssh-add(1) or the SSHAgentClient protocol, also in this package.
Method | __init__ | Undocumented |
Method | dataReceived | Called whenever data is received. |
Method | sendResponse | Undocumented |
Method | agentc_REQUEST_IDENTITIES | Return all of the identities that have been added to the server |
Method | agentc_SIGN_REQUEST | Data is a structure with a reference to an already added key object and some data that the clients wants signed with that key. If the key object wasn't loaded, return AGENT_FAILURE, else return the signature. |
Method | agentc_ADD_IDENTITY | Adds a private key to the agent's collection of identities. On subsequent interactions, the private key can be accessed using only the corresponding public key. |
Method | agentc_REMOVE_IDENTITY | Remove a specific key from the agent's collection of identities. |
Method | agentc_REMOVE_ALL_IDENTITIES | Remove all keys from the agent's collection of identities. |
Method | agentc_REQUEST_RSA_IDENTITIES | v1 message for listing RSA1 keys; superseded by agentc_REQUEST_IDENTITIES, which handles different key types. |
Method | agentc_REMOVE_RSA_IDENTITY | v1 message for removing RSA1 keys; superseded by agentc_REMOVE_IDENTITY, which handles different key types. |
Method | agentc_REMOVE_ALL_RSA_IDENTITIES | v1 message for removing all RSA1 keys; superseded by agentc_REMOVE_ALL_IDENTITIES, which handles different key types. |
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. |
Return all of the identities that have been added to the server
Data is a structure with a reference to an already added key object and some data that the clients wants signed with that key. If the key object wasn't loaded, return AGENT_FAILURE, else return the signature.
Adds a private key to the agent's collection of identities. On subsequent interactions, the private key can be accessed using only the corresponding public key.
Remove a specific key from the agent's collection of identities.
Remove all keys from the agent's collection of identities.
v1 message for listing RSA1 keys; superseded by agentc_REQUEST_IDENTITIES, which handles different key types.
v1 message for removing RSA1 keys; superseded by agentc_REMOVE_IDENTITY, which handles different key types.
v1 message for removing all RSA1 keys; superseded by agentc_REMOVE_ALL_IDENTITIES, which handles different key types.