twisted.conch.ssh.agent.SSHAgentServer(protocol.Protocol) class documentation

Part of twisted.conch.ssh.agent (View In Hierarchy)

Known subclasses: twisted.conch.test.test_agent.CorruptServer

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.
def __init__(self):
Undocumented
def dataReceived(self, data):
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.dataReceived

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.

Parametersdataa 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.
def sendResponse(self, reqType, data):
Undocumented
def agentc_REQUEST_IDENTITIES(self, data):
overridden in twisted.conch.test.test_agent.CorruptServer

Return all of the identities that have been added to the server

def agentc_SIGN_REQUEST(self, data):
overridden in twisted.conch.test.test_agent.CorruptServer

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.

def agentc_ADD_IDENTITY(self, data):

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.

def agentc_REMOVE_IDENTITY(self, data):

Remove a specific key from the agent's collection of identities.

def agentc_REMOVE_ALL_IDENTITIES(self, data):

Remove all keys from the agent's collection of identities.

def agentc_REQUEST_RSA_IDENTITIES(self, data):

v1 message for listing RSA1 keys; superseded by agentc_REQUEST_IDENTITIES, which handles different key types.

def agentc_REMOVE_RSA_IDENTITY(self, data):

v1 message for removing RSA1 keys; superseded by agentc_REMOVE_IDENTITY, which handles different key types.

def agentc_REMOVE_ALL_RSA_IDENTITIES(self, data):

v1 message for removing all RSA1 keys; superseded by agentc_REMOVE_ALL_IDENTITIES, which handles different key types.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.