cutelyst 3.9.1
A C++ Web Framework built on top of Qt, using the simple approach of Catalyst (Perl) framework.
Cutelyst::CredentialPassword Class Reference
Inheritance diagram for Cutelyst::CredentialPassword:
Inheritance graph
[legend]

Public Types

enum  PasswordType { None , Clear , Hashed }

Public Member Functions

 CredentialPassword (QObject *parent=nullptr)
 Constructs a new CredentialPassword object with the given parent.
AuthenticationUser authenticate (Context *c, AuthenticationRealm *realm, const ParamsMultiMap &authinfo) final
 Tries to authenticate the authinfo using the give realm.
QString passwordField () const
 Returns the field to look for when authenticating the user.
QString passwordPostSalt () const
 Returns the salt string to be appended to the password.
QString passwordPreSalt () const
 Returns the salt string to be prepended to the password.
PasswordType passwordType () const
 Returns the type of password this class will be dealing with.
void setPasswordField (const QString &fieldName)
 Sets the field to look for when authenticating the user.
void setPasswordPostSalt (const QString &passwordPostSalt)
 Sets the salt string to be appended to the password.
void setPasswordPreSalt (const QString &passwordPreSalt)
 Sets the salt string to be prepended to the password.
void setPasswordType (PasswordType type)
 Sets the type of password this class will be dealing with.
Public Member Functions inherited from Cutelyst::AuthenticationCredential
 AuthenticationCredential (QObject *parent=nullptr)
 Constructs a new AuthenticationCredential object with the given parent.

Static Public Member Functions

static QByteArray createPassword (const QByteArray &password)
 Creates a password hash string using sensible defaults.
static QByteArray createPassword (const QByteArray &password, QCryptographicHash::Algorithm method, int iterations, int saltByteSize, int hashByteSize)
 Creates a password hash string.
static QString createPassword (const QString &password)
 Creates a password hash string using sensible defaults.
static QByteArray hmac (QCryptographicHash::Algorithm method, const QByteArray &key, const QByteArray &message)
 Generates the Hash-based message authentication code.
static QByteArray pbkdf2 (QCryptographicHash::Algorithm method, const QByteArray &password, const QByteArray &salt, int rounds, int keyLength)
 Generates a pbkdf2 string for the given password.
static bool validatePassword (const QByteArray &password, const QByteArray &correctHash)
 Validates the given password against the correct hash.
static bool validatePassword (const QString &password, const QString &correctHash)
 Validates the given password string against the correct hash string.

Detailed Description

Definition at line 16 of file credentialpassword.h.

Member Enumeration Documentation

◆ PasswordType

enum Cutelyst::CredentialPassword::PasswordType

Definition at line 21 of file credentialpassword.h.

Constructor & Destructor Documentation

◆ CredentialPassword()

CredentialPassword::CredentialPassword ( QObject * parent = nullptr)
explicit

Definition at line 17 of file credentialpassword.cpp.

References Cutelyst::AuthenticationCredential::AuthenticationCredential(), and CredentialPassword().

Referenced by CredentialPassword(), authenticate(), passwordField(), passwordPostSalt(), passwordPreSalt(), passwordType(), setPasswordField(), setPasswordPostSalt(), setPasswordPreSalt(), and setPasswordType().

◆ ~CredentialPassword()

CredentialPassword::~CredentialPassword ( )
overridevirtual

Definition at line 23 of file credentialpassword.cpp.

Member Function Documentation

◆ authenticate()

AuthenticationUser CredentialPassword::authenticate ( Context * c,
AuthenticationRealm * realm,
const ParamsMultiMap & authinfo )
finalvirtual

Returns a not null AuthenticationUser object in case of success.

Implements Cutelyst::AuthenticationCredential.

Definition at line 28 of file credentialpassword.cpp.

References CredentialPassword(), Cutelyst::AuthenticationRealm::findUser(), and Cutelyst::AuthenticationUser::isNull().

◆ createPassword() [1/3]

QByteArray CredentialPassword::createPassword ( const QByteArray & password)
static
Note
That is you want pre and post salts you must manualy add them.
Parameters
password
Returns
the pbkdf2 representation of the password

Definition at line 155 of file credentialpassword.cpp.

References createPassword().

◆ createPassword() [2/3]

QByteArray CredentialPassword::createPassword ( const QByteArray & password,
QCryptographicHash::Algorithm method,
int iterations,
int saltByteSize,
int hashByteSize )
static
Note
That is you want pre and post salts you must manualy add them.
Parameters
password
method
iterations
saltByteSize
hashByteSize
Returns
the pbkdf2 representation of the password

Definition at line 132 of file credentialpassword.cpp.

References pbkdf2().

Referenced by createPassword(), and createPassword().

◆ createPassword() [3/3]

QString Cutelyst::CredentialPassword::createPassword ( const QString & password)
inlinestatic
Note
That is you want pre and post salts you must manualy add them.
Parameters
password
Returns
the pbkdf2 representation of the password

Definition at line 151 of file credentialpassword.h.

References createPassword().

◆ hmac()

QByteArray CredentialPassword::hmac ( QCryptographicHash::Algorithm method,
const QByteArray & key,
const QByteArray & message )
static

Definition at line 221 of file credentialpassword.cpp.

◆ passwordField()

QString CredentialPassword::passwordField ( ) const
See also
authenticate().

Definition at line 48 of file credentialpassword.cpp.

References CredentialPassword().

◆ passwordPostSalt()

QString CredentialPassword::passwordPostSalt ( ) const

Definition at line 84 of file credentialpassword.cpp.

References CredentialPassword().

Referenced by setPasswordPostSalt().

◆ passwordPreSalt()

QString CredentialPassword::passwordPreSalt ( ) const

Definition at line 72 of file credentialpassword.cpp.

References CredentialPassword().

Referenced by setPasswordPreSalt().

◆ passwordType()

CredentialPassword::PasswordType CredentialPassword::passwordType ( ) const

Definition at line 60 of file credentialpassword.cpp.

References CredentialPassword().

◆ pbkdf2()

QByteArray CredentialPassword::pbkdf2 ( QCryptographicHash::Algorithm method,
const QByteArray & password,
const QByteArray & salt,
int rounds,
int keyLength )
static
Parameters
method
password
salt
rounds
keyLength
Returns

Definition at line 164 of file credentialpassword.cpp.

Referenced by createPassword(), and validatePassword().

◆ setPasswordField()

void CredentialPassword::setPasswordField ( const QString & fieldName)
See also
authenticate().

Definition at line 54 of file credentialpassword.cpp.

References CredentialPassword().

◆ setPasswordPostSalt()

void CredentialPassword::setPasswordPostSalt ( const QString & passwordPostSalt)

Definition at line 90 of file credentialpassword.cpp.

References CredentialPassword(), and passwordPostSalt().

◆ setPasswordPreSalt()

void CredentialPassword::setPasswordPreSalt ( const QString & passwordPreSalt)

Definition at line 78 of file credentialpassword.cpp.

References CredentialPassword(), and passwordPreSalt().

◆ setPasswordType()

void CredentialPassword::setPasswordType ( PasswordType type)

Definition at line 66 of file credentialpassword.cpp.

References CredentialPassword().

◆ validatePassword() [1/2]

bool CredentialPassword::validatePassword ( const QByteArray & password,
const QByteArray & correctHash )
static

Definition at line 111 of file credentialpassword.cpp.

References pbkdf2().

Referenced by validatePassword().

◆ validatePassword() [2/2]

bool Cutelyst::CredentialPassword::validatePassword ( const QString & password,
const QString & correctHash )
inlinestatic

Definition at line 145 of file credentialpassword.h.

References validatePassword().