Package pyxmpp2 :: Package sasl :: Module plain :: Class PlainClientAuthenticator
[hide private]

Class PlainClientAuthenticator


Provides PLAIN SASL authentication for a client.

Authentication properties used:

Authentication properties returned:

Nested Classes [hide private]

Inherited from core.ClientAuthenticator: __metaclass__

Instance Methods [hide private]
 
__init__(self)
Initialize a ClientAuthenticator object.
 
start(self, properties)
Start the authentication process.
Response or Failure
challenge(self, challenge)
Process the server's challenge.
Success or Failure
finish(self, data)
Handle authentication succes information from the server.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]
 
are_properties_sufficient(cls, properties)
Check if the provided properties are sufficient for this authentication mechanism.
Class Variables [hide private]
  __abstractmethods__ = frozenset([])
  _abc_cache = <_weakrefset.WeakSet object at 0x9d2ca6c>
  _pyxmpp_sasl_preference = 50
  _pyxmpp_sasl_secure = 10
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

 
Initialize a ClientAuthenticator object.
Overrides: object.__init__
(inherited documentation)

are_properties_sufficient(cls, properties)
Class Method

 
Check if the provided properties are sufficient for
this authentication mechanism.

If `are_properties_sufficient` returns False for given `properties`
mapping, the `start` method of `cls` instance will also fail with
such argument.

:Parameters:
    - `properties`: the `authentication properties`_
:Types:
    - `properties`: mapping

:Return: if the mechanism can be used with those properties

Overrides: core.ClientAuthenticator.are_properties_sufficient
(inherited documentation)

start(self, properties)

 
Start the authentication process.

:Parameters:
    - `properties`: the `authentication properties`_
:Types:
    - `properties`: mapping

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

Overrides: core.ClientAuthenticator.start
(inherited documentation)

challenge(self, challenge)

 
Process the server's challenge.
Parameters:
  • challenge - the challenge.
Returns: Response or Failure
the response or a failure indicator.
Overrides: core.ClientAuthenticator.challenge
(inherited documentation)

finish(self, data)

 
Handle authentication succes information from the server.
Parameters:
  • data - the optional additional data returned with the success.
Returns: Success or Failure
success or failure indicator.
Overrides: core.ClientAuthenticator.finish
(inherited documentation)