Home       Trees       Index       Help   

PyXMPP

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.
  challenge(self, challenge)
Process the challenge and return the response.
  finish(self, data)
Handle authentication succes information from the server.
  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.
:Types:
    - `password_manager`: `PasswordManager`
Overrides:
pyxmpp.sasl.core.ClientAuthenticator.__init__

challenge(self, challenge) 

Process the challenge and return the response.

:Parameters:
    - `challenge`: the challenge.
:Types:
    - `challenge`: `str`

:return: the response or a failure indicator.
:returntype: `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.
:Types:
    - `data`: `str`

:return: a success indicator.
:returntype: `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).
    - `authzid`: authorization id.
:Types:
    - `username`: `unicode`
    - `authzid`: `unicode`

:return: the initial response or a failure indicator.
:returntype: `sasl.Response` or `sasl.Failure`
Overrides:
pyxmpp.sasl.core.ClientAuthenticator.start

   Home       Trees       Index       Help   

PyXMPP

Generated by Epydoc 2.1 on Wed May 31 22:36:59 2006 http://epydoc.sf.net