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:

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.
Public Member Functions inherited from QObject
 QObject (QObject *parent)
bool blockSignals (bool block)
const QObjectListchildren () const const
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool disconnect (const QObject *receiver, const char *method) const const
void dumpObjectInfo ()
void dumpObjectInfo () const const
void dumpObjectTree ()
void dumpObjectTree () const const
QList< QByteArraydynamicPropertyNames () const const
virtual bool event (QEvent *e)
virtual bool eventFilter (QObject *watched, QEvent *event)
findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
bool inherits (const char *className) const const
void installEventFilter (QObject *filterObj)
bool isWidgetType () const const
bool isWindowType () const const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName, QPrivateSignal)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_DISABLE_COPY (Class)
 Q_DISABLE_COPY_MOVE (Class)
 Q_DISABLE_MOVE (Class)
 Q_EMIT Q_EMIT
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
 Q_GADGET Q_GADGET
 Q_INTERFACES (...)
 Q_INVOKABLE Q_INVOKABLE
 Q_NAMESPACE Q_NAMESPACE
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 Q_OBJECT Q_OBJECT
 Q_PROPERTY (...)
 Q_REVISION Q_REVISION
 Q_SET_OBJECT_NAME (Object)
 Q_SIGNAL Q_SIGNAL
 Q_SIGNALS Q_SIGNALS
 Q_SLOT Q_SLOT
 Q_SLOTS Q_SLOTS
qFindChild (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T > qFindChildren (const QObject *obj, const QString &name)
qobject_cast (const QObject *object)
qobject_cast (QObject *object)
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool signalsBlocked () const const
int startTimer (int interval, Qt::TimerType timerType)
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThreadthread () const const

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.
Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool disconnect (const QMetaObject::Connection &connection)
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members

Public Attributes inherited from QObject
typedef QObjectList
Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const QMetaMethod &signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const QMetaMethod &signal)
bool isSignalConnected (const QMetaMethod &signal) const const
int receivers (const char *signal) const const
QObjectsender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)
Properties inherited from QObject
 objectName

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::~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

◆ 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(), and QCryptographicHash::Sha512.

◆ 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 QUuid::createUuid(), QByteArray::number(), QFile::open(), pbkdf2(), QIODevice::read(), QIODevice::ReadOnly, QByteArray::toBase64(), and QUuid::toRfc4122().

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(), QString::fromLatin1(), and QString::toUtf8().

◆ hmac()

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

Definition at line 221 of file credentialpassword.cpp.

References QMessageAuthenticationCode::hash().

◆ 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

◆ 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

◆ validatePassword() [2/2]

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

Definition at line 145 of file credentialpassword.h.

References QString::toLatin1(), QString::toUtf8(), and validatePassword().