Home       Trees       Indices       Help   
PyXMPP2
Package pyxmpp2 :: Package sasl :: Module external :: Class ExternalClientAuthenticator
[hide private]

Class ExternalClientAuthenticator

Provides client-side External SASL (TLS-Identify) authentication.
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.
Success
finish(self, data)
Handle authentication success information from the server.

Inherited from core.ClientAuthenticator: challenge

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(['challenge'])
  _abc_cache = <_weakrefset.WeakSet object at 0x9d2ce8c>
  _abc_negative_cache = <_weakrefset.WeakSet object at 0x9d2cecc>
  _pyxmpp_sasl_preference = 20
  _pyxmpp_sasl_secure = False

Inherited from core.ClientAuthenticator (private): _abc_negative_cache_version, _abc_registry

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)

finish(self, data)

 
Handle authentication success information from the server.
Parameters:
  • data (bytes) - the optional additional data returned with the success.
Returns: Success
a success indicator.
Overrides: core.ClientAuthenticator.finish

   Home       Trees       Indices       Help   
PyXMPP2
Generated by Epydoc 3.0.1 on Sun Sep 22 12:47:31 2013 http://epydoc.sourceforge.net