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.

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 ( QObject * parent = nullptr )

explicit

Definition at line 19 of file credentialhttp.cpp.

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

Referenced by CredentialHttp(), authenticate(), passwordField(), passwordPostSalt(), passwordPreSalt(), passwordType(), setAuthorizationRequiredMessage(), setPasswordField(), setPasswordPostSalt(), setPasswordPreSalt(), setPasswordType(), setRequireSsl(), setType(), setUsernameField(), and usernameField().

~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().