components::Secdist Class Reference

#include <userver/storages/secdist/component.hpp>

Detailed Description

Component that stores security related data (keys, passwords, ...).

The component must be configured in service config.

Secdist requires a provider storages::secdist::SecdistProvider You can implement your own or use components::DefaultSecdistProvider

Static configuration example:

# yaml
        secdist:                                         # Component that stores configuration of hosts and passwords
            provider: default-secdist-provider
        default-secdist-provider:                        # Component that loads configuration of hosts and passwords
            config: /etc/redis_service/secure_data.json  # Values are supposed to be stored in this file
            missing-ok: true                             # ... but if the file is missing it is still ok
            environment-secrets-key: SECDIST_CONFIG      # ... values will be loaded from this environment value

Static options:

Name	Description	Default value
provider	optional secdist provider component name	'default-secdist-provider'
config	path to the config file with data	''
format	config format, either json or yaml	'json'
missing-ok	do not terminate components load if no file found by the config option	false
environment-secrets-key	name of environment variable from which to load additional data	-
update-period	period between data updates in utils::StringToDuration() suitable format ('0s' for no updates)	0s
blocking-task-processor	name of task processor for background blocking operations	–

Examples

samples/digest_auth_service/auth_digest.cpp, samples/production_service/production_service.cpp, and samples/redis_service/redis_service.cpp.

Definition at line 42 of file component.hpp.

Inheritance diagram for components::Secdist:

Public Member Functions
	Secdist (const ComponentConfig &, const ComponentContext &)
const storages::secdist::SecdistConfig &	Get () const
rcu::ReadablePtr< storages::secdist::SecdistConfig >	GetSnapshot () const
storages::secdist::Secdist &	GetStorage ()
ComponentHealth	GetComponentHealth () const override
void	OnLoadingCancelled () override
void	OnAllComponentsLoaded () override
void	OnAllComponentsAreStopping () override

Static Public Member Functions
static yaml_config::Schema	GetStaticConfigSchema ()

Static Public Attributes
static constexpr std::string_view	kName = "secdist"
	The default name of components::Secdist.

Protected Types
using	LoggableComponentBase = ComponentBase
	Legacy alias, use ComponentBase instead.

Member Typedef Documentation

LoggableComponentBase

using components::ComponentBase::LoggableComponentBase = ComponentBase

protectedinherited

Legacy alias, use ComponentBase instead.

Definition at line 69 of file component_base.hpp.

Member Function Documentation

GetComponentHealth()

ComponentHealth components::ComponentBase::GetComponentHealth ( ) const

inlineoverridevirtualinherited

Override this function to inform the world of the state of your component.

Warning

The function is called concurrently from multiple threads.

Reimplemented from components::RawComponentBase.

Definition at line 35 of file component_base.hpp.

OnAllComponentsAreStopping()

void components::ComponentBase::OnAllComponentsAreStopping ( )

inlineoverridevirtualinherited

Component may use this function to stop doing work before the stop of the components that depend on it.

Base components may override it and make final to do some work before the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, and components::Server.

Definition at line 60 of file component_base.hpp.

OnAllComponentsLoaded()

void components::ComponentBase::OnAllComponentsLoaded ( )

inlineoverridevirtualinherited

Component may use this function to finalize registration of other components that depend on it (for example, handler components register in server component, and the latter uses OnAllComponentsLoaded() to start processing requests).

Base components may override it and make final to do some work after the derived object constructor is called. Don't use it otherwise.

Reimplemented from components::RawComponentBase.

Reimplemented in urabbitmq::ConsumerComponentBase, components::Server, and server::handlers::Ping.

Definition at line 53 of file component_base.hpp.

OnLoadingCancelled()

void components::ComponentBase::OnLoadingCancelled ( )

inlineoverridevirtualinherited

Called once if the creation of any other component failed. If the current component expects some other component to take any action with the current component, this call is a signal that such action may never happen due to components loading was cancelled. Application components might not want to override it.

Reimplemented from components::RawComponentBase.

Definition at line 44 of file component_base.hpp.

---

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

• userver/storages/secdist/component.hpp