Documentation
¶
Index ¶
- Variables
- func Alpha(n int) string
- func AlphaNumeric(n int) string
- func CreateToken(length int) string
- func CryptoRandInt() uint64
- type SecretManager
- type SecretManagerContext
- func (smc *SecretManagerContext) AddSecretVersion(ctx context.Context, secret string, payload []byte) error
- func (smc *SecretManagerContext) CreateSecret(ctx context.Context, secret string) error
- func (smc *SecretManagerContext) DeleteSecret(ctx context.Context, secret string) error
- func (smc *SecretManagerContext) GetLatestVersion(ctx context.Context, secret string) ([]byte, error)
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func Alpha ¶ added in v1.7.0
Alpha generates a random string of n characters that only includes upper and lowercase letters (no symbols or digits).
func AlphaNumeric ¶ added in v1.7.0
AlphaNumeric generates a random string of n characters that includes upper and lowercase letters and the digits 0-9.
func CreateToken ¶
CreateToken creates a variable length random token that can be used for passwords or API keys.
func CryptoRandInt ¶ added in v1.7.0
func CryptoRandInt() uint64
Types ¶
type SecretManager ¶
type SecretManager struct {
// contains filtered or unexported fields
}
SecretManager holds a client to the Google secret manager, and the path to the `parent` project for the secret manager.
func New ¶
func New(conf config.SecretsConfig) (sm *SecretManager, err error)
New creates and returns a client to access the Google Secret Manager. This function requires the $GOOGLE_APPLICATION_CREDENTIALS environment variable to be set, which specifies the JSON path to the service account credentials.
func NewMock ¶
func NewMock(conf config.SecretsConfig) (*SecretManager, error)
NewMock creates and returns a client to access a mock Secret Manager for testing. Note that the SecretManager is identical and all external functionality is unchanged, however instead of making requests to Google Secret Manager, the mock object is simply storing things in memory. NOTE: this is ported from github.com/rotationalio/whisper
func NewSecretManager ¶
func NewSecretManager(config config.SecretsConfig) (sm *SecretManager, err error)
NewSecretManager creates and returns a new secret manager client and an error if one occurs. Note that the `secretmanager` package leverages the GOOGLE_APPLICATION_CREDENTIALS environment variable which specifies the json path to the service account credentials, meaning that this function is a lightweight method for testing that the application can successfully connect to the secret manager API. However, this function does not validate the parent path.
func (*SecretManager) With ¶
func (sm *SecretManager) With(certRequest string) *SecretManagerContext
With allows us to engage a single SecretManager across all required calls during the certificate request process
type SecretManagerContext ¶
type SecretManagerContext struct {
// contains filtered or unexported fields
}
SecretManagerContext maintains a single long-running secret manager that can be used for the duration of the certificate request process
func (*SecretManagerContext) AddSecretVersion ¶
func (smc *SecretManagerContext) AddSecretVersion(ctx context.Context, secret string, payload []byte) error
AddSecretVersion adds a new secret version to the given secret and the provided payload. Returns an error if one occurs. Note: to add a secret version, the secret must first be created using CreateSecret.
func (*SecretManagerContext) CreateSecret ¶
func (smc *SecretManagerContext) CreateSecret(ctx context.Context, secret string) error
CreateSecret creates a new secret in the Google Cloud Manager top-level directory using the `secret` name provided. This function returns an error if any occurs. Note: A secret is a logical wrapper around a collection of secret versions. To store a secret payload, you must first CreateSecret and then AddSecretVersion.
func (*SecretManagerContext) DeleteSecret ¶
func (smc *SecretManagerContext) DeleteSecret(ctx context.Context, secret string) error
DeleteSecret deletes the secret with the given the name, and all of its versions. Note: this is an irreversible operation. Any service or workload that attempts to access a deleted secret receives a Not Found error.
func (*SecretManagerContext) GetLatestVersion ¶
func (smc *SecretManagerContext) GetLatestVersion(ctx context.Context, secret string) ([]byte, error)
GetLatestVersion returns the payload for the latest version of the given secret, if one exists, else an error.
Source Files