Categorygithub.com/libopenstorage/secrets
modulepackage
0.0.0-20240416031220-a17cf7f72c6c
Repository: https://github.com/libopenstorage/secrets.git
Documentation: pkg.go.dev

# README

secrets

Openstorage support for Key Management Systems

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Package mock is a generated GoMock package.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

Instance returns the instance set via SetInstance.
KeyContextChecks performs a series of checks on the keys and values passed through the key context map.
New returns a new instance of Secrets backend KMS identified by the supplied name.
NewReader returns a new instance of SecretReader backend SM identified by the supplied name.
NewStore returns a new instance of SecretStore backend SM identified by the supplied name.
Register adds a new backend KMS.
RegisterReader adds a new backend KMS that implements SecretReader.
RegisterStore adds a new backend KMS that implements SecretStore and SecretReader.
SetInstance sets the singleton instance of the secrets backend.

# Constants

CustomSecretData is a constant used in the key context of the secrets APIs It indicates that the secret provider should not generate secret but use the provided secret in the API.
DestroySecret is a keyContext parameter for Vault secrets indicating whether the Secret should be destroyed This is only valid when Vault's KV Secret Engine is running on version 2 since by default keys are versioned and soft-deleted Activating this will PERMANENTLY delete all metadata and versions for a key.
KeyVaultNamespace is a keyContext parameter for vault secrets.
NoVersion indicates that the provider does not support versions for secrets.
OverwriteSecretDataInStore is a constant used in the key context of Secret APIs It indicates whether the secret data stored in the persistent store can be overwritten.
PublicSecretData is a constant used in the key context of Secret APIs It indicates that the API is dealing with the public part of a secret instead of the actual secret.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

ErrEmptySecretData returned when no secret data is provided to store the secret.
ErrEmptySecretId returned when no secret Name/ID is provided to retrive secret data.
ErrInvalidKvdbProvided is returned when an incorrect KVDB implementation is provided for persistence store.
ErrInvalidSecretData is returned when no secret data is found.
ErrInvalidSecretId returned when no secret data is found associated with the id.
ErrNotAuthenticated returned when not authenticated with secrets endpoint.
ErrNotSupported returned when implementation of specific function is not supported.
ErrSecretExists returned when a secret for the given secret id already exists.

# Structs

ErrInvalidKeyContext is returned when secret data is provided to the secret APIs with an invalid key context.
ErrProviderInternal is returned when an error is received from the secrets provider which is not known to this library.
A SecretKey identifies a secret.

# Interfaces

SecretReader interface implemented by Secrets Managers to read secrets.
Secrets interface implemented by backend Key Management Systems (KMS).
SecretStore interface implemented by Secrets Managers to set and delete secrets.

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
Version represents the unique identifier associated with the version of the new secret.