ionflux.org | Impressum

Ionflux::Tools::Auth Class Reference
[Authentication]

Auth. More...

#include <Auth.hpp>

Inheritance diagram for Ionflux::Tools::Auth:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 Auth ()
 Constructor.
virtual ~Auth ()
 Destructor.
virtual bool auth (const std::string &username, const std::string &password)=0
 Authenticate user.
virtual void getSecret (const std::string &username, std::string &secret)=0
 Get secret.
virtual ReportergetLog ()=0
 Get Console output/logging facility.

Detailed Description

Auth.

A simple user authentication interface.


Constructor & Destructor Documentation

Ionflux::Tools::Auth::Auth  )  [inline]
 

Constructor.

Construct new Auth object.

virtual Ionflux::Tools::Auth::~Auth  )  [inline, virtual]
 

Destructor.

Destruct Auth object.


Member Function Documentation

virtual bool Ionflux::Tools::Auth::auth const std::string &  username,
const std::string &  password
[pure virtual]
 

Authenticate user.

Authenticate a username/password pair.

Parameters:
username Username.
password Password.
Returns:
true if the username and password are valid, false otherwise.

Implemented in Ionflux::Tools::AuthFile.

virtual Reporter& Ionflux::Tools::Auth::getLog  )  [pure virtual]
 

Get Console output/logging facility.

Returns:
The console output/logging facility used by this object.

Implemented in Ionflux::Tools::AuthFile.

virtual void Ionflux::Tools::Auth::getSecret const std::string &  username,
std::string &  secret
[pure virtual]
 

Get secret.

Get the secret associated with a username. If the username is not valid, the secret will be set to an empty string.

Parameters:
username Username.
secret Where to store the secret.

Implemented in Ionflux::Tools::AuthFile.


The documentation for this class was generated from the following file:
Generated on Tue Mar 14 21:07:16 2006 for Ionflux Tools Class Library (iftools) by  doxygen 1.4.6