Cutelyst  2.3.0
Public Types | Public Member Functions | Static Public Member Functions | List of all members
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. More...
 
QByteArray hmac (QCryptographicHash::Algorithm method, QByteArray key, const QByteArray &message)
 Generates the Hash-based message authentication code.
 
QString passwordField () const
 Returns the field to look for when authenticating the user. More...
 
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. More...
 
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, QCryptographicHash::Algorithm method, int iterations, int saltByteSize, int hashByteSize)
 Creates a password hash string. More...
 
static QByteArray createPassword (const QByteArray &password)
 Creates a password hash string using sensible defaults. More...
 
static QByteArray createPassword (const QString &password)
 Creates a password hash string using sensible defaults. More...
 
static QByteArray pbkdf2 (QCryptographicHash::Algorithm method, const QByteArray &password, const QByteArray &salt, int rounds, int keyLength)
 Generates a pbkdf2 string for the given password. More...
 
static bool validatePassword (const QByteArray &password, const QByteArray &correctHash)
 Validates the given password against the correct hash.
 

Detailed Description

Definition at line 29 of file credentialpassword.h.

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 41 of file credentialpassword.cpp.

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

◆ createPassword() [1/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 146 of file credentialpassword.cpp.

References pbkdf2().

Referenced by createPassword().

◆ createPassword() [2/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 171 of file credentialpassword.cpp.

References createPassword().

◆ createPassword() [3/3]

QByteArray 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 144 of file credentialpassword.h.

◆ passwordField()

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

Definition at line 58 of file credentialpassword.cpp.

Referenced by hmac().

◆ 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 180 of file credentialpassword.cpp.

Referenced by createPassword(), and validatePassword().

◆ setPasswordField()

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

Definition at line 64 of file credentialpassword.cpp.