userver: server::handlers::auth::digest::AuthCheckerSettingsComponent Class Reference
⚠️ This is the documentation for an old userver version. Click here to switch to the latest version.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
server::handlers::auth::digest::AuthCheckerSettingsComponent Class Reference

Component that loads digest auth configuration settings from a static_config.yaml. More...

#include <userver/server/handlers/auth/digest/auth_checker_settings_component.hpp>

+ Inheritance diagram for server::handlers::auth::digest::AuthCheckerSettingsComponent:
+ Collaboration diagram for server::handlers::auth::digest::AuthCheckerSettingsComponent:

Public Member Functions

 AuthCheckerSettingsComponent (const components::ComponentConfig &config, const components::ComponentContext &context)
 
const AuthCheckerSettingsGetSettings () const
 
- Public Member Functions inherited from components::LoggableComponentBase
 LoggableComponentBase (const ComponentConfig &, const ComponentContext &)
 
 LoggableComponentBase (LoggableComponentBase &&)=delete
 
 LoggableComponentBase (const LoggableComponentBase &)=delete
 
 ~LoggableComponentBase () override=default
 
ComponentHealth GetComponentHealth () const override
 
void OnLoadingCancelled () override
 
void OnAllComponentsLoaded () override
 
void OnAllComponentsAreStopping () override
 

Static Public Member Functions

static yaml_config::Schema GetStaticConfigSchema ()
 
- Static Public Member Functions inherited from components::LoggableComponentBase
static yaml_config::Schema GetStaticConfigSchema ()
 

Static Public Attributes

static constexpr std::string_view kName = "auth-digest-checker-settings"
 The default name of server::handlers::auth::digest::AuthCheckerSettingsComponent.
 

Detailed Description

Component that loads digest auth configuration settings from a static_config.yaml.

Static options:

Name Description Default value
algorithm algorithm for hashing nonce   sha256
domains list of URIs, that define the protection space /
qops list of supported qop-options. Use auth for authentication and auth-in for authentication with integrity protection auth
is-proxy indicates that the server is a proxy server. If set, the Proxy prefix is inserted into the header false
is-session activate session algorithm (md5-sess, sha256-sess or sha512-sess) false
nonce-ttl ttl for nonce 10s
Examples
samples/digest_auth_service/auth_digest.cpp.

Definition at line 38 of file auth_checker_settings_component.hpp.


The documentation for this class was generated from the following file: