yera 0.11.1

yera.apps.builtin.credential_storage

Shared credential-storage disclosure for Yera's built-in applications.

Symbols

def credential_storage_notice — Describe how a secret-store backend will retain sensitive values.
def present_credential_storage_notice — Present capability-aware credential-storage information.

credential_storage_notice

credential_storage_notice(
    secret_store: SecretStore,
    value_label: str,
    alternative: str | None = None,
) → str

Describe how a secret-store backend will retain sensitive values.

The description reflects the backend's declared capabilities. Filesystem locations are included when the selected backend exposes one, without requiring every secret-store implementation to have a path.

Parameters

secret_store
type: SecretStore

Backend that would receive the sensitive values.

value_label
type: str

User-facing name for the values being stored.

alternative
type: str | None = None

Optional way to avoid storing the values locally.

Returns

type: str

Markdown explaining the storage location and at-rest protections.

present_credential_storage_notice

present_credential_storage_notice(
    secret_store: SecretStore,
    value_label: str,
    alternative: str | None = None,
) → None

Present capability-aware credential-storage information.

Parameters

secret_store
type: SecretStore

Backend that would receive the sensitive values.

value_label
type: str

User-facing name for the values being stored.

alternative
type: str | None = None

Optional way to avoid storing the values locally.