Package pyxmpp2 :: Package sasl :: Module core :: Class ServerAuthenticator

Class ServerAuthenticator

Base class for server authenticators.

A server authenticator class is a server-side implementation of a SASL mechanism. One ServerAuthenticator object may be used for one client authentication process.

Nested Classes

[hide private]

__metaclass__
Metaclass for defining Abstract Base Classes (ABCs).

Instance Methods

[hide private]

__init__(self, password_database)
Initialize a ServerAuthenticator object.

start(self, properties, initial_response)
Start the authentication process.

Challenge or Success or Failure

response(self, response)
Process a response from a client.

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(['response', 'start'])

_abc_cache = <_weakrefset.WeakSet object at 0x9d2c80c>

_abc_negative_cache = <_weakrefset.WeakSet object at 0x9d2c84c>

_abc_negative_cache_version = 10

_abc_registry = <_weakrefset.WeakSet object at 0x9d2c7ac>

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, password_database)
(Constructor)

Initialize a ServerAuthenticator object.

Parameters:

password_database (PasswordDataBase) - a password database

Overrides: object.__init__

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

start(self, properties, initial_response)

Start the authentication process.

:Parameters:
    - `properties`: the `authentication properties`_
    - `initial_response`: the initial response send by the client with
      the authentication request.

:Types:
    - `properties`: mapping
    - `initial_response`: `bytes`

:return: a challenge, a success or a failure indicator.
:returntype: `Challenge` or `Failure` or `Success`

Decorators:

@abstractmethod

response(self, response)

Process a response from a client.

Parameters:

response (bytes) - the response from the client to our challenge.

Returns: Challenge or Success or Failure

a challenge, a success or a failure indicator.

Decorators:

@abstractmethod

Class ServerAuthenticator

__init__(self, password_database) (Constructor)

are_properties_sufficient(cls, properties) Class Method

start(self, properties, initial_response)

response(self, response)

init(self, password_database)
(Constructor)

are_properties_sufficient(cls, properties)
Class Method