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. 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.

Detailed Description

Definition at line 29 of file credentialhttp.h.

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

References Cutelyst::AuthenticationUser::isNull().

passwordField()

QString CredentialHttp::passwordField

(

)

const

See also

authenticate().

Definition at line 55 of file credentialhttp.cpp.

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

setPasswordField()

void CredentialHttp::setPasswordField

(

const QString &

fieldName

)

See also

authenticate().

Definition at line 61 of file credentialhttp.cpp.

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

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

setUsernameField()

void CredentialHttp::setUsernameField

(

const QString &

fieldName

)

See also

authenticate().

Definition at line 109 of file credentialhttp.cpp.

usernameField()

QString CredentialHttp::usernameField

(

)

const

See also

authenticate().

Definition at line 103 of file credentialhttp.cpp.