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

Public Types

enum  AuthType { Any , Basic }
enum  PasswordType { None , Clear , Hashed }

Public Member Functions

 CredentialHttp (QObject *parent=nullptr)
 Constructs a new CredentialHttp 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 setAuthorizationRequiredMessage (const QString &message)
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.
void setRequireSsl (bool require)
void setType (CredentialHttp::AuthType type)
void setUsernameField (const QString &fieldName)
 Sets the field to look for when authenticating the user.
QString usernameField () const
 Returns the field to look for when authenticating the user.
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

Additional Inherited Members

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)
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 credentialhttp.h.

Member Enumeration Documentation

◆ AuthType

enum Cutelyst::CredentialHttp::AuthType

Definition at line 28 of file credentialhttp.h.

◆ PasswordType

enum Cutelyst::CredentialHttp::PasswordType

Definition at line 21 of file credentialhttp.h.

Constructor & Destructor Documentation

◆ CredentialHttp()

◆ ~CredentialHttp()

CredentialHttp::~CredentialHttp ( )
virtual

Definition at line 25 of file credentialhttp.cpp.

Member Function Documentation

◆ authenticate()

AuthenticationUser CredentialHttp::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 108 of file credentialhttp.cpp.

References CredentialHttp(), and Cutelyst::AuthenticationUser::isNull().

◆ passwordField()

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

Definition at line 42 of file credentialhttp.cpp.

References CredentialHttp().

◆ passwordPostSalt()

QString CredentialHttp::passwordPostSalt ( ) const

Definition at line 78 of file credentialhttp.cpp.

References CredentialHttp().

Referenced by setPasswordPostSalt().

◆ passwordPreSalt()

QString CredentialHttp::passwordPreSalt ( ) const

Definition at line 66 of file credentialhttp.cpp.

References CredentialHttp().

Referenced by setPasswordPreSalt().

◆ passwordType()

CredentialHttp::PasswordType CredentialHttp::passwordType ( ) const

Definition at line 54 of file credentialhttp.cpp.

References CredentialHttp().

◆ setAuthorizationRequiredMessage()

void CredentialHttp::setAuthorizationRequiredMessage ( const QString & message)

Set this to a string to override the default body content "Authorization required.", or set to undef to suppress body content being generated.

Definition at line 36 of file credentialhttp.cpp.

References CredentialHttp().

◆ setPasswordField()

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

Definition at line 48 of file credentialhttp.cpp.

References CredentialHttp().

◆ setPasswordPostSalt()

void CredentialHttp::setPasswordPostSalt ( const QString & passwordPostSalt)

Definition at line 84 of file credentialhttp.cpp.

References CredentialHttp(), and passwordPostSalt().

◆ setPasswordPreSalt()

void CredentialHttp::setPasswordPreSalt ( const QString & passwordPreSalt)

Definition at line 72 of file credentialhttp.cpp.

References CredentialHttp(), and passwordPreSalt().

◆ setPasswordType()

void CredentialHttp::setPasswordType ( CredentialHttp::PasswordType type)

Definition at line 60 of file credentialhttp.cpp.

References CredentialHttp().

◆ setRequireSsl()

void CredentialHttp::setRequireSsl ( bool require)

If this configuration is true then authentication will be denied (and a 401 issued in normal circumstances) unless the request is via https.

Definition at line 102 of file credentialhttp.cpp.

References CredentialHttp().

◆ setType()

void CredentialHttp::setType ( CredentialHttp::AuthType type)

Can be either any (the default), basic.

This controls authorization_required_response and authenticate, but not the "manual" methods.

Definition at line 30 of file credentialhttp.cpp.

References CredentialHttp().

◆ setUsernameField()

void CredentialHttp::setUsernameField ( const QString & fieldName)
See also
authenticate().

Definition at line 96 of file credentialhttp.cpp.

References CredentialHttp().

◆ usernameField()

QString CredentialHttp::usernameField ( ) const
See also
authenticate().

Definition at line 90 of file credentialhttp.cpp.

References CredentialHttp().