managers

Documentation

Overview

********************************************************************************** The MIT License (MIT)

Copyright (c) 2022 Sean Beard

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. **********************************************************************************

********************************************************************************** The MIT License (MIT)

Copyright (c) 2022 Sean Beard

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. **********************************************************************************

Index

• Constants
• type AWSSecretsManager
  • func NewAWSSecretsManager(configuration secrets.ManagerConfiguration) (*AWSSecretsManager, error)
  • func (awssecrets *AWSSecretsManager) AddSecret(key string, value secrets.Secret) error
  • func (awssecrets *AWSSecretsManager) Close() error
  • func (awssecrets *AWSSecretsManager) DeleteSecret(key string) error
  • func (awssecrets *AWSSecretsManager) GetSecret(key string) (secrets.Secret, error)
  • func (awssecrets *AWSSecretsManager) UpdateSecret(key string, value secrets.Secret) error
• type LocalSecretsManager
  • func NewLocalSecretsManager(configuration secrets.ManagerConfiguration) (*LocalSecretsManager, error)
  • func (localSecrets *LocalSecretsManager) AddSecret(name string, value secrets.Secret) error
  • func (localSecrets *LocalSecretsManager) Close() error
  • func (localSecrets *LocalSecretsManager) DeleteSecret(key string) error
  • func (localSecrets *LocalSecretsManager) GetSecret(key string) (secrets.Secret, error)
  • func (localSecrets *LocalSecretsManager) UpdateSecret(key string, value secrets.Secret) error

Constants

const (
	// DefaultLocalSecretStore exports the value for the base file name used for the
	// local secrets store
	DefaultLocalSecretStore = "secrets.bdb"
)

Types

type AWSSecretsManager

type AWSSecretsManager struct{}

AWSSecretsManager holds all of the attributes necessaary to manage a connection to, retrieval of, and rotation of application specific secrets leveraging the AWS Secrets Manager service

func NewAWSSecretsManager

func NewAWSSecretsManager(configuration secrets.ManagerConfiguration) (*AWSSecretsManager, error)

NewAWSSecretsManager creates and returns a new references to an AWSSecretsManager instance

func (*AWSSecretsManager) AddSecret

func (awssecrets *AWSSecretsManager) AddSecret(key string, value secrets.Secret) error

AddSecret implements the Manager interface function for adding a new secret to the secrets manager

func (*AWSSecretsManager) Close

func (awssecrets *AWSSecretsManager) Close() error

Close implements the Manager interface function for shutting down the secrets manager

func (*AWSSecretsManager) DeleteSecret

func (awssecrets *AWSSecretsManager) DeleteSecret(key string) error

DeleteSecret implements the Manager interface function for deleting a specific secret managed by the secrets manager

func (*AWSSecretsManager) GetSecret

func (awssecrets *AWSSecretsManager) GetSecret(key string) (secrets.Secret, error)

GetSecret implements the Manager interface function for retrieving a specific secret managed by the secrets manager

func (*AWSSecretsManager) UpdateSecret

func (awssecrets *AWSSecretsManager) UpdateSecret(key string, value secrets.Secret) error

UpdateSecret implements the Manager interface function for updating the passed in secret to the secrets manager

type LocalSecretsManager

type LocalSecretsManager struct {
	// contains filtered or unexported fields
}

LocalSecretsManager holds all of the attributes necessaary to manage a persistent in memory secrets manager to retrieve, store and rotate specific secrets

func NewLocalSecretsManager

func NewLocalSecretsManager(configuration secrets.ManagerConfiguration) (*LocalSecretsManager, error)

NewLocalSecretsManager creates and returns a new references to a LocalSecretsManager instance

func (*LocalSecretsManager) AddSecret

func (localSecrets *LocalSecretsManager) AddSecret(name string, value secrets.Secret) error

AddSecret implements the Manager interface function for adding a new secret to the secrets manager

func (*LocalSecretsManager) Close

func (localSecrets *LocalSecretsManager) Close() error

Close implements the Manager interface function for shutting down the secrets manager

func (*LocalSecretsManager) DeleteSecret

func (localSecrets *LocalSecretsManager) DeleteSecret(key string) error

DeleteSecret implements the Manager interface function for deleting a specific secret managed by the secrets manager

func (*LocalSecretsManager) GetSecret

func (localSecrets *LocalSecretsManager) GetSecret(key string) (secrets.Secret, error)

GetSecret implements the Manager interface function for retrieving a specific secret managed by the secrets manager

func (*LocalSecretsManager) UpdateSecret

func (localSecrets *LocalSecretsManager) UpdateSecret(key string, value secrets.Secret) error

UpdateSecret implements the Manager interface function for updating the passed in secret to the secrets manager