Public Member Functions | |
| defaultSASLAuthenticator () | |
| ~defaultSASLAuthenticator () | |
| const std::vector< shared_ptr < SASLMechanism > > | getAcceptableMechanisms (const std::vector< shared_ptr< SASLMechanism > > &available, shared_ptr< SASLMechanism > suggested) const |
| const string | getUsername () const |
| const string | getPassword () const |
| const string | getHostname () const |
| const string | getAnonymousToken () const |
| const string | getServiceName () const |
| void | setService (shared_ptr< net::service > serv) |
| weak_ptr< net::service > | getService () const |
| void | setSASLSession (shared_ptr< SASLSession > sess) |
| shared_ptr< SASLSession > | getSASLSession () const |
| void | setSASLMechanism (shared_ptr< SASLMechanism > mech) |
| shared_ptr< SASLMechanism > | getSASLMechanism () const |
Additional Inherited Members | |
 Protected Member Functions inherited from object | |
| object () | |
| object (const object &) | |
| object & | operator= (const object &) |
| virtual | ~object () |
Detailed Description
An authenticator that is capable of providing information for simple authentication mechanisms (username and password).
Constructor & Destructor Documentation
Member Function Documentation
|
virtual |
This method is called to allow the client to choose the authentication mechanisms that will be used.
By default, the most secure mechanisms are chosen.
- Parameters
-
available available mechanisms suggested suggested mechanism (or NULL if the system could not suggest a mechanism)
- Returns
- ordered list of mechanism to use among the available mechanisms (from the first to try to the last)
Implements SASLAuthenticator.
|
virtual |
Return the anonymous token (usually, this is the user's email address).
- Returns
- anonymous token
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
References defaultAuthenticator::getAnonymousToken().
|
virtual |
Return the local host name of the machine.
- Returns
- hostname
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
References defaultAuthenticator::getHostname().
|
virtual |
Return the password of the authentication identity.
- Returns
- password
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
References defaultAuthenticator::getPassword().
| shared_ptr< SASLMechanism > getSASLMechanism | ( | ) | const |
| shared_ptr< SASLSession > getSASLSession | ( | ) | const |
| weak_ptr< net::service > getService | ( | ) | const |
|
virtual |
Return the registered service name of the application service (eg: "imap").
This can be used by GSSAPI or DIGEST-MD5 mechanisms with SASL.
- Returns
- service name
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
|
virtual |
Return the authentication identity (usually, this is the username).
- Returns
- username
- Exceptions
-
exceptions::no_auth_information if the information could not be provided
Implements authenticator.
References defaultAuthenticator::getUsername().
|
virtual |
Set the SASL mechanism which has been selected for the SASL authentication process.
This may be called several times if the multiple mechanisms are tried by the service which use this authentication.
- Parameters
-
mech SASL mechanism
Implements SASLAuthenticator.
|
virtual |
Set the SASL session which is using this authenticator.
- Parameters
-
sess SASL session
Implements SASLAuthenticator.
|
virtual |
Called by the messaging service to allow this authenticator to know which service is currently using it.
This is called just before the service starts the authentication process.
- Parameters
-
serv messaging service instance
Implements authenticator.
References defaultAuthenticator::setService().
The documentation for this class was generated from the following files:
