Use HTTP basic authentication to authenticate a user. More...

#include <Cutelyst/Plugins/Authentication/credentialhttp.h>

Inheritance diagram for Cutelyst::CredentialHttp:

[legend]

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

Public Member Functions
	CredentialHttp (QObject *parent=nullptr)
virtual	~CredentialHttp ()
AuthenticationUser	authenticate (Context c, AuthenticationRealm realm, const ParamsMultiMap &authinfo) final
QString	passwordField () const
QString	passwordPostSalt () const
QString	passwordPreSalt () const
PasswordType	passwordType () const
void	setAuthorizationRequiredMessage (const QString &message)
void	setPasswordField (const QString &fieldName)
void	setPasswordPostSalt (const QString &passwordPostSalt)
void	setPasswordPreSalt (const QString &passwordPreSalt)
void	setPasswordType (PasswordType type)
void	setRequireSsl (bool require)
void	setType (CredentialHttp::AuthType type)
void	setUsernameField (const QString &fieldName)
QString	usernameField () const
Public Member Functions inherited from Cutelyst::AuthenticationCredential
	AuthenticationCredential (QObject *parent=nullptr)
virtual	~AuthenticationCredential ()

Detailed Description

This credential provider authenticates a user using HTTP basic authentication as described in RFC 76147. It tries to read the user name and the password from the Authorization header send by the user agent. If the authorization fails or if no Authorization header is available, it will respond with a 401 Unauthorized status code and will set the WWW-Authenticate header requesting basic authentication with the used realm.

For an example implementation see Authentication overview.

Logging category: cutelyst.plugin.credentialhttp
Logging with Cutelyst

Definition at line 32 of file credentialhttp.h.

Member Enumeration Documentation

◆ AuthType

enum Cutelyst::CredentialHttp::AuthType

The authentication type.

Definition at line 51 of file credentialhttp.h.

◆ PasswordType

enum Cutelyst::CredentialHttp::PasswordType

The used password type.

Enumerator
None	Ignore password check.
Clear	Clear text password.
Hashed	Derived password hash using PBKDF2 method.

Definition at line 40 of file credentialhttp.h.

Constructor & Destructor Documentation

◆ CredentialHttp()

CredentialHttp::CredentialHttp ( QObject * parent = nullptr )

explicit

Constructs a new CredentialHttp object with the given parent.

Definition at line 20 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

Destroys the CredentialHttp object.

Definition at line 26 of file credentialhttp.cpp.

Member Function Documentation

◆ authenticate()

AuthenticationUser CredentialHttp::authenticate	(	Cutelyst::Context *	c,
		AuthenticationRealm *	realm,
		const ParamsMultiMap &	authinfo )

nodiscardfinalvirtual

Gets the user data from the Authorization HTTP header field and tries to find it in the realm. On success, this returns a not null AuthenticationUser object. If authentication fails, the HTTP response status code will be set to 401 Unauthorized and the WWW-Authenticate header will be set with the required authentication method and realm name while a null AuthenticationUser object is returned.

Implements Cutelyst::AuthenticationCredential.

Definition at line 109 of file credentialhttp.cpp.

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