security.secret_manager_if.SecretManagerIf Class Reference

Retrieve secrets without exposing their storage mechanism. More...

Inheritance diagram for security.secret_manager_if.SecretManagerIf:

Public Member Functions
str|None	get_secret (self, str name)
	Return a secret value, or None when it is unavailable.
str	require_secret (self, str name)
	Return a required secret or raise a descriptive error.

Detailed Description

Retrieve secrets without exposing their storage mechanism.

Member Function Documentation

get_secret()

str | None security.secret_manager_if.SecretManagerIf.get_secret	(		self,
		str	name
	)

Return a secret value, or None when it is unavailable.

Parameters

name	Stable secret name.

Returns

Secret value, or None when it is unavailable.

Reimplemented in security.environment_variable_secret_manager.EnvironmentVariableSecretManager.

require_secret()

str security.secret_manager_if.SecretManagerIf.require_secret	(		self,
		str	name
	)

Return a required secret or raise a descriptive error.

Parameters

name	Stable secret name.

Returns

Required secret value.

Exceptions

RuntimeError

if the secret is unavailable.

---

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

• security/secret_manager_if.py