Home       Trees       Index       Help   

PyXMPP

Package pyxmpp :: Package sasl :: Module core :: Class ClientAuthenticator
[show private | hide private]
[frames | no frames]

Class ClientAuthenticator

Known Subclasses:
DigestMD5ClientAuthenticator, PlainClientAuthenticator
Base class for client authenticators.

A client authenticator class is a client-side implementation of a SASL
mechanism. One `ClientAuthenticator` object may be used for one
client authentication process.
Method Summary
  __init__(self, password_manager)
Initialize a `ClientAuthenticator` object.
  challenge(self, challenge)
Process the server's challenge.
  finish(self, data)
Handle authentication succes information from the server.
  start(self, username, authzid)
Start the authentication process.

Method Details

__init__(self, password_manager)
(Constructor) 

Initialize a `ClientAuthenticator` object.

:Parameters:
    - `password_manager`: a password manager providing authentication
      credentials.
:Types:
    - `password_manager`: `PasswordManager`

challenge(self, challenge) 

Process the server's challenge.

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

:return: the response or a failure indicator.
:returntype: `Response` or `Failure`

finish(self, data) 

Handle authentication succes information from the server.

:Parameters:
    - `data`: the optional additional data returned with the success.
:Types:
    - `data`: `str`

:return: success or failure indicator.
:returntype: `Success` or `Failure`

start(self, username, authzid) 

Start the authentication process.

:Parameters:
    - `username`: the username (authentication id).
    - `authzid`: the authorization id requester.
:Types:
    - `username`: `unicode`
    - `authzid`: `unicode`

:return: the initial response to send to the server or a failuer
    indicator.
:returntype: `Response` or `Failure`

   Home       Trees       Index       Help   

PyXMPP

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