t.c.s.f.SSHFactory(protocol.Factory) : class documentation

Part of twisted.conch.ssh.factory View Source View In Hierarchy

Known subclasses: twisted.conch.manhole_ssh.ConchFactory, twisted.conch.openssh_compat.factory.OpenSSHFactory

No class docstring
Method startFactory This will be called before I begin listening on a Port or Connector.
Method buildProtocol Create an instance of a subclass of Protocol.
Method getPublicKeys Called when the factory is started to get the public portions of the servers host keys. Returns a dictionary mapping SSH key types to public key strings.
Method getPrivateKeys Called when the factory is started to get the private portions of the servers host keys. Returns a dictionary mapping SSH key types to Crypto.PublicKey.pubkey.pubkey objects.
Method getPrimes Called when the factory is started to get Diffie-Hellman generators and primes to use. Returns a dictionary mapping number of bits to lists of tuple of (generator, prime).
Method getDHPrime Return a tuple of (g, p) for a Diffe-Hellman process, with p being as close to bits bits as possible.
Method getService Return a class to use as a service for the given transport.

Inherited from Factory:

Method doStart Make sure startFactory is called.
Method doStop Make sure stopFactory is called.
Method stopFactory This will be called before I stop listening on all Ports/Connectors.
def startFactory(self): (source)

This will be called before I begin listening on a Port or Connector.

It will only be called once, even if the factory is connected to multiple ports.

This can be used to perform 'unserialization' tasks that are best put off until things are actually running, such as connecting to a database, opening files, etcetera.
def buildProtocol(self, addr): (source)

Create an instance of a subclass of Protocol.

The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory.

Override this method to alter how Protocol instances get created.
Parametersaddran object implementing twisted.internet.interfaces.IAddress
def getPublicKeys(self): (source)
Called when the factory is started to get the public portions of the servers host keys. Returns a dictionary mapping SSH key types to public key strings.
Returns (type: dict )
def getPrivateKeys(self): (source)
Called when the factory is started to get the private portions of the servers host keys. Returns a dictionary mapping SSH key types to Crypto.PublicKey.pubkey.pubkey objects.
Returns (type: dict )
def getPrimes(self): (source)
Called when the factory is started to get Diffie-Hellman generators and primes to use. Returns a dictionary mapping number of bits to lists of tuple of (generator, prime).
Returns (type: dict )
def getDHPrime(self, bits): (source)
Return a tuple of (g, p) for a Diffe-Hellman process, with p being as close to bits bits as possible.
Parametersbits (type: int )
Returns (type: tuple )
def getService(self, transport, service): (source)
Return a class to use as a service for the given transport.
Parameterstransport (type: transport.SSHServerTransport )
service (type: str )
Returns (type: subclass of service.SSHService )
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.