Class t.w.p.j.s.SASLInitiatingInitializer(xmlstream.BaseFeatureInitiatingInitializer):

Part of twisted.words.protocols.jabber.sasl View Source View In Hierarchy

Stream initializer that performs SASL authentication.

The supported mechanisms by this initializer are DIGEST-MD5 and PLAIN which are attemped in that order.

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:

Method	__init__	Undocumented
Method	initialize	Initiate the initialization.

def start(self): (source)

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

Start SASL authentication exchange.

Used 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 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 )

API Documentation for twisted, generated by pydoctor.