class documentation

class twisted.conch.ssh.factory.SSHFactory(protocol.Factory): (source)

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

View In Hierarchy

A Factory for SSH servers.

Class Variable services Undocumented
Method startFactory Check for public and private keys.
Instance Variable publicKeys Undocumented
Instance Variable privateKeys Undocumented
Instance Variable primes Undocumented
Method buildProtocol Create an instance of the server side of the SSH 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 twisted.conch.ssh.keys.Key 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.
Class Variable _log Undocumented

Inherited from Factory:

Class Variable protocol Undocumented
Instance Variable numPorts Undocumented
Class Variable noisy Undocumented
Class Method forProtocol Create a factory for the given protocol.
Method logPrefix Describe this factory for log messages.
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.
_log = (source)

Undocumented

services = (source)

Undocumented

def startFactory(self): (source)

Check for public and private keys.

publicKeys = (source)

Undocumented

privateKeys = (source)

Undocumented

primes = (source)

Undocumented

def buildProtocol(self, addr): (source)

Create an instance of the server side of the SSH protocol.

ParametersaddrThe address at which the server will listen. (type: twisted.internet.interfaces.IAddress provider)
ReturnsThe built transport. (type: twisted.conch.ssh.transport.SSHServerTransport)
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.

ReturnsUndocumented (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 twisted.conch.ssh.keys.Key objects.

ReturnsUndocumented (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).

ReturnsUndocumented (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.

ParametersbitsUndocumented (type: int)
ReturnsUndocumented (type: tuple)
def getService(self, transport, service): (source)

Return a class to use as a service for the given transport.

ParameterstransportUndocumented (type: transport.SSHServerTransport)
serviceUndocumented (type: bytes)
ReturnsUndocumented (type: subclass of service.SSHService)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.