twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer(BaseFeatureInitiatingInitializer) class documentation

Part of twisted.words.protocols.jabber.xmlstream (View In Hierarchy)

TLS stream initializer for the initiating entity.

It is strongly required to include this initializer in the list of initializers for an XMPP stream. By default it will try to negotiate TLS. An XMPP server may indicate that TLS is required. If TLS is not desired, set the wanted attribute to False instead of removing it from the list of initializers, so a proper exception TLSRequired can be raised.

Instance Variable wanted indicates if TLS negotiation is wanted. (type: bool)
Method __init__ No summary
Method onProceed Proceed with TLS negotiation and reset the XML stream.
Method onFailure Undocumented
Method start Start TLS negotiation.

Inherited from BaseFeatureInitiatingInitializer:

Class Variable feature tuple of (uri, name) of the stream feature root element. (type: tuple of (str, str))
Instance Variable required whether the stream feature is required to be advertized by the receiving entity. (type: bool)
Method initialize Initiate the initialization.
wanted =
indicates if TLS negotiation is wanted. (type: bool)
def __init__(self, xs, required=True, configurationForTLS=None):
overrides twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.__init__
ParametersconfigurationForTLSAn object which creates appropriately configured TLS connections. This is passed to startTLS on the transport and is preferably created using twisted.internet.ssl.optionsForClientTLS. If None, the default is to verify the server certificate against the trust roots as provided by the platform. See twisted.internet._sslverify.platformTrust. (type: IOpenSSLClientConnectionCreator or None)
def onProceed(self, obj):

Proceed with TLS negotiation and reset the XML stream.

def onFailure(self, obj):
Undocumented
def start(self):
overrides twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.start

Start TLS negotiation.

This checks if the receiving entity requires TLS, the SSL library is available and uses the required and wanted instance variables to determine what to do in the various different cases.

For example, if the SSL library is not available, and wanted and required by the user, it raises an exception. However if it is not required by both parties, initialization silently succeeds, moving on to the next step.

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