Package pyxmpp :: Package sasl :: Module plain :: Class PlainClientAuthenticator
[show private | hide private]
[frames | no frames]

Class PlainClientAuthenticator

ClientAuthenticator --+
                      |
                     PlainClientAuthenticator


Provides PLAIN SASL authentication for a client.
Method Summary
  __init__(self, password_manager)
Initialize a PlainClientAuthenticator object.
sasl.Response or sasl.Failure challenge(self, challenge)
Process the challenge and return the response.
Success finish(self, data)
Handle authentication succes information from the server.
sasl.Response or sasl.Failure start(self, username, authzid)
Start the authentication process and return the initial response.

Method Details

__init__(self, password_manager)
(Constructor)

Initialize a PlainClientAuthenticator object.
Parameters:
password_manager - name of the password manager object providing authentication credentials.
           (type=PasswordManager)
Overrides:
pyxmpp.sasl.core.ClientAuthenticator.__init__

challenge(self, challenge)

Process the challenge and return the response.
Parameters:
challenge - the challenge.
           (type=str)
Returns:
the response or a failure indicator.
           (type=sasl.Response or sasl.Failure)
Overrides:
pyxmpp.sasl.core.ClientAuthenticator.challenge

finish(self, data)

Handle authentication succes information from the server.
Parameters:
data - the optional additional data returned with the success.
           (type=str)
Returns:
a success indicator.
           (type=Success)
Overrides:
pyxmpp.sasl.core.ClientAuthenticator.finish

start(self, username, authzid)

Start the authentication process and return the initial response.
Parameters:
username - username (authentication id).
           (type=unicode)
authzid - authorization id.
           (type=unicode)
Returns:
the initial response or a failure indicator.
           (type=sasl.Response or sasl.Failure)
Overrides:
pyxmpp.sasl.core.ClientAuthenticator.start