twisted.words.protocols.jabber.xmlstream.TLSInitiatingInitializer : API documentation

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.

Class Variable	wanted	indicates if TLS negotiation is wanted. (type: `bool`)
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	__init__	Undocumented
Method	initialize	Initiate the initialization.

def start(self): (source)

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.

t.w.p.j.x.TLSInitiatingInitializer(BaseFeatureInitiatingInitializer) : class documentation