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

Public Types

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

Public Member Functions

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

Protected Attributes

CredentialHttpPrivate * d_ptr
 

Detailed Description

Definition at line 31 of file credentialhttp.h.

Member Function Documentation

void Cutelyst::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.

void Cutelyst::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.

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

Can be either any (the default), basic or digest.

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