twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer : API documentation

Stream initializer that performs SASL authentication.

The supported mechanisms by this initializer are DIGEST-MD5, PLAIN and ANONYMOUS. The ANONYMOUS SASL mechanism is used when the JID, set on the authenticator, does not have a localpart (username), requesting an anonymous session where the username is generated by the server. Otherwise, DIGEST-MD5 and PLAIN are attempted, in that order.

Method	setMechanism	Select and setup authentication mechanism.
Method	start	Start SASL authentication exchange.
Method	sendAuth	Initiate authentication protocol exchange.
Method	sendResponse	Send response to a challenge.
Method	onChallenge	Parse challenge and send response from the mechanism.
Method	onSuccess	Clean up observers, reset the XML stream and send a new header.
Method	onFailure	Clean up observers, parse the failure and errback the deferred.

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 setMechanism(self): (source)

Select and setup authentication mechanism.

Uses the authenticator's jid and password attribute for the authentication credentials. If no supported SASL mechanisms are advertized by the receiving party, a failing deferred is returned with a SASLNoAcceptableMechanism exception.

def start(self): (source)

overrides twisted.words.protocols.jabber.xmlstream.BaseFeatureInitiatingInitializer.start

Start SASL authentication exchange.

def sendAuth(self, data=None): (source)

Initiate authentication protocol exchange.

If an initial client response is given in data, it will be sent along.

Parameters data initial client response. (type: str or None.)

def sendResponse(self, data=''): (source)

Send response to a challenge.

Parameters data client response. (type: str.)

def onChallenge(self, element): (source)

Parse challenge and send response from the mechanism.

Parameters element the challenge protocol element. (type: domish.Element.)

def onSuccess(self, success): (source)

Clean up observers, reset the XML stream and send a new header.

Parameters success the success protocol element. For now unused, but could hold additional data. (type: domish.Element)

def onFailure(self, failure): (source)

Clean up observers, parse the failure and errback the deferred.

Parameters failure the failure protocol element. Holds details on the error condition. (type: domish.Element)

twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer(xmlstream.BaseFeatureInitiatingInitializer) class documentation

`twisted.words.protocols.jabber.sasl.SASLInitiatingInitializer(xmlstream.BaseFeatureInitiatingInitializer)` class documentation