twisted.protocols.tls.TLSMemoryBIOFactory(WrappingFactory) class documentation

Part of twisted.protocols.tls (View In Hierarchy)

TLSMemoryBIOFactory adds TLS to connections.

Method __init__ Create a TLSMemoryBIOFactory.
Method logPrefix Annotate the wrapped factory's log prefix with some text indicating TLS is in use.
Instance Variable _creatorInterface the interface which _connectionCreator is expected to implement. (type: zope.interface.interfaces.IInterface)
Instance Variable _connectionCreator a callable which creates an OpenSSL Connection object. (type: 1-argument callable taking TLSMemoryBIOProtocol and returning OpenSSL.SSL.Connection.)
Method _applyProtocolNegotiation Applies ALPN/NPN protocol neogitation to the connection, if the factory supports it.
Method _createConnection Create an OpenSSL connection and set it up good.

Inherited from WrappingFactory:

Method doStart Make sure startFactory is called.
Method doStop Make sure stopFactory is called.
Method startedConnecting Called when a connection has been started.
Method clientConnectionFailed Called when a connection has failed to connect.
Method clientConnectionLost Called when an established connection is lost.
Method buildProtocol Create an instance of a subclass of Protocol.
Method registerProtocol Called by protocol to register itself.
Method unregisterProtocol Called by protocols when they go away.

Inherited from Factory (via WrappingFactory, ClientFactory):

Class Method forProtocol Create a factory for the given protocol.
Method startFactory This will be called before I begin listening on a Port or Connector.
Method stopFactory This will be called before I stop listening on all Ports/Connectors.
_creatorInterface =
the interface which _connectionCreator is expected to implement. (type: zope.interface.interfaces.IInterface)
_connectionCreator =
a callable which creates an OpenSSL Connection object. (type: 1-argument callable taking TLSMemoryBIOProtocol and returning OpenSSL.SSL.Connection.)
def __init__(self, contextFactory, isClient, wrappedFactory):
overrides twisted.protocols.policies.WrappingFactory.__init__

Create a TLSMemoryBIOFactory.

ParameterscontextFactoryConfiguration parameters used to create an OpenSSL connection. In order of preference, what you should pass here should be:
  1. twisted.internet.ssl.CertificateOptions (if you're writing a server) or the result of twisted.internet.ssl.optionsForClientTLS (if you're writing a client). If you want security you should really use one of these.
  2. If you really want to implement something yourself, supply a provider of IOpenSSLClientConnectionCreator or IOpenSSLServerConnectionCreator.
  3. If you really have to, supply a twisted.internet.ssl.ContextFactory. This will likely be deprecated at some point so please upgrade to the new interfaces.
(type: IOpenSSLClientConnectionCreator or IOpenSSLServerConnectionCreator, or, for compatibility with older code, anything implementing twisted.internet.interfaces.IOpenSSLContextFactory. See https://twistedmatrix.com/trac/ticket/7215 for information on the upcoming deprecation of passing a twisted.internet.ssl.ContextFactory here.)
isClientIs this a factory for TLS client connections; in other words, those that will send a ClientHello greeting? True if so, False otherwise. This flag determines what interface is expected of contextFactory. If True, contextFactory should provide IOpenSSLClientConnectionCreator; otherwise it should provide IOpenSSLServerConnectionCreator. (type: bool)
wrappedFactoryA factory which will create the application-level protocol. (type: twisted.internet.interfaces.IProtocolFactory)
def logPrefix(self):
from twisted.internet.interfaces.ILoggingContext
overrides twisted.protocols.policies.WrappingFactory.logPrefix

Annotate the wrapped factory's log prefix with some text indicating TLS is in use.

Returns (type: str)
def _applyProtocolNegotiation(self, connection):

Applies ALPN/NPN protocol neogitation to the connection, if the factory supports it.

ParametersconnectionThe OpenSSL connection object to have ALPN/NPN added to it. (type: OpenSSL.SSL.Connection)
ReturnsNothing (type: None)
def _createConnection(self, tlsProtocol):

Create an OpenSSL connection and set it up good.

ParameterstlsProtocolThe protocol which is establishing the connection. (type: TLSMemoryBIOProtocol)
Returnsan OpenSSL connection object for tlsProtocol to use (type: OpenSSL.SSL.Connection)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.