Digital Authentication Framework 6.0.1.33
Public Member Functions

DAAuthProtocol Class Reference

Co-ordinates calls required for enrollment, authentication and passphrase change. More...

#include <authglue.h>

List of all members.

Public Member Functions

virtual ~DAAuthProtocol ()
 Virtual destructor.
virtual DAErrorgetLastError ()=0
 Retrieve the current error information for this protocol.
virtual bool requiresExistingPassphrase () const =0
 Returns true if this protocol requires input of an existing user passphrase.
virtual bool inputExistingPassphrase (const std::string &string)=0
 Inputs an existing passphrase.
virtual bool requiresNewPassphrase () const =0
 Returns true if this protocol requires input of a fresh passphrase.
virtual bool inputNewPassphrase (const std::string &string)=0
 Inputs a fresh pasphrase.
virtual bool finished () const =0
 Returns true if this protocol instance completed successfully.
virtual bool getSecret (DAData &out)=0
 Extracts the resulting authentication secret.
virtual bool getNewSecret (DAData &out)=0
 Extracts the new authentication secret, as a result of a enrollment or passphrase change protocol.

Detailed Description

Co-ordinates calls required for enrollment, authentication and passphrase change.

The 'authglue' library provides a variety of implementations of this (abstract) class. See authglue.h documentation for an overview.

Implementations have their own error state, accessible via getLastError. Implementations with an error set are not recoverable, and finished() will never return true. To retry, make another instance using the original function.


Constructor & Destructor Documentation

virtual DAAuthProtocol::~DAAuthProtocol ( ) [inline, virtual]

Virtual destructor.


Member Function Documentation

virtual bool DAAuthProtocol::finished ( ) const [pure virtual]

Returns true if this protocol instance completed successfully.

virtual DAError& DAAuthProtocol::getLastError ( ) [pure virtual]

Retrieve the current error information for this protocol.

virtual bool DAAuthProtocol::getNewSecret ( DAData out) [pure virtual]

Extracts the new authentication secret, as a result of a enrollment or passphrase change protocol.

For other protocols, this returns false.

Valid to call only if finished() just returned true.

virtual bool DAAuthProtocol::getSecret ( DAData out) [pure virtual]

Extracts the resulting authentication secret.

This should is passed to the GD library and is used to protect the underlying container keys.

Valid to call only if finished() just returned true.

virtual bool DAAuthProtocol::inputExistingPassphrase ( const std::string &  string) [pure virtual]

Inputs an existing passphrase.

Valid to call only if requiresExistingPassphrase() just returned true.

virtual bool DAAuthProtocol::inputNewPassphrase ( const std::string &  string) [pure virtual]

Inputs a fresh pasphrase.

Valid to call only if requiresNewPassphrase() just returned true.

virtual bool DAAuthProtocol::requiresExistingPassphrase ( ) const [pure virtual]

Returns true if this protocol requires input of an existing user passphrase.

See DA_AUTH_PUBLIC in daf_auth_identify.h for more information.

virtual bool DAAuthProtocol::requiresNewPassphrase ( ) const [pure virtual]

Returns true if this protocol requires input of a fresh passphrase.

See DA_AUTH_PUBLIC in daf_auth_identify.h for more information.


The documentation for this class was generated from the following file: