Cutelyst  2.14.2
Public Types | Public Member Functions | List of all members
Cutelyst::CredentialHttp Class Reference
Inheritance diagram for Cutelyst::CredentialHttp:
Inheritance graph
[legend]

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. More...
 
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 setAuthorizationRequiredMessage (const QString &message)
 
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.
 
void setRequireSsl (bool require)
 
void setType (CredentialHttp::AuthType type)
 
void setUsernameField (const QString &fieldName)
 Sets the field to look for when authenticating the user. More...
 
QString usernameField () const
 Returns the field to look for when authenticating the user. More...
 
- 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 QObjectList & children () const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const
 
bool disconnect (const QObject *receiver, const char *method) const
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const
 
bool inherits (const char *className) const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const
 
bool isWindowType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval, Qt::TimerType timerType)
 
QThreadthread () 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- 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
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Definition at line 29 of file credentialhttp.h.

Member Function Documentation

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 121 of file credentialhttp.cpp.

References Cutelyst::AuthenticationUser::isNull().

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

Definition at line 55 of file credentialhttp.cpp.

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 49 of file credentialhttp.cpp.

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

Definition at line 61 of file credentialhttp.cpp.

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 115 of file credentialhttp.cpp.

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 43 of file credentialhttp.cpp.

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

Definition at line 109 of file credentialhttp.cpp.

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

Definition at line 103 of file credentialhttp.cpp.