t.w.p.j.c.ListenComponentAuthenticator(xmlstream.ListenAuthenticator) : class documentation

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

Authenticator for accepting components.
Instance VariablessecretThe shared secret used to authorized incoming component connections. (type: unicode. )
Present Since8.2
Method __init__ Undocumented
Method associateWithStream Associate the authenticator with a stream.
Method streamStarted Called by the stream when it has started.
Method onElement Called on incoming XML Stanzas.
Method onHandshake Called upon receiving the handshake request.

Inherited from Authenticator (via ListenAuthenticator):

Method connectionMade Called by the XmlStream when the underlying socket connection is in place.
def __init__(self, secret): (source)
overrides twisted.words.protocols.jabber.xmlstream.Authenticator.__init__
Undocumented
def associateWithStream(self, xs): (source)
overrides twisted.words.protocols.jabber.xmlstream.ListenAuthenticator.associateWithStream

Associate the authenticator with a stream.

This sets the stream's version to 0.0, because the XEP-0114 component protocol was not designed for XMPP 1.0.
def streamStarted(self, rootElement): (source)
overrides twisted.words.protocols.jabber.xmlstream.ListenAuthenticator.streamStarted

Called by the stream when it has started.

This examines the default namespace of the incoming stream and whether there is a requested hostname for the component. Then it generates a stream identifier, sends a response header and adds an observer for the first incoming element, triggering onElement.
def onElement(self, element): (source)

Called on incoming XML Stanzas.

The very first element received should be a request for handshake. Otherwise, the stream is dropped with a 'not-authorized' error. If a handshake request was received, the hash is extracted and passed to onHandshake.
def onHandshake(self, handshake): (source)

Called upon receiving the handshake request.

This checks that the given hash in handshake is equal to a calculated hash, responding with a handshake reply or a stream error. If the handshake was ok, the stream is authorized, and XML Stanzas may be exchanged.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.