kms

Documentation

Index

• Variables
• type Config
• type KeyInfo
• type KeyInfos
  • func (ki *KeyInfos) Set(s string) error
  • func (ki *KeyInfos) String() string
  • func (KeyInfos) Type() string
• type SecretsService
• type Service
  • func NewService(config Config) *Service
  • func (s *Service) DecryptPassphrase(ctx context.Context, keyID int, encryptedPassphrase []byte) ([]byte, error)
  • func (s *Service) EncryptPassphrase(ctx context.Context, passphrase []byte) (_ []byte, keyID int, err error)
  • func (s *Service) GenerateEncryptedPassphrase(ctx context.Context) (_ []byte, keyID int, err error)
  • func (s *Service) Initialize(ctx context.Context) (err error)

Variables

var (
	// MockChecksumMismatch can be used as a key info version to signal to mockGsmClient to return a checksum that does not match.
	MockChecksumMismatch = "mock-checksum-mismatch"

	// MockAccessSecretVersionError can be used as a key info version to signal to mockGsmClient to return an error from AccessSecretVersion method.
	MockAccessSecretVersionError = "mock-access-secret-version-error"

	// MockKeyNotFound can be used as a key info version to signal to mockGsmClient to return no payload data from AccessSecretVersion.
	MockKeyNotFound = "mock-key-not-found"
)

var (
	// Error is the default error class for the package.
	Error = errs.Class("kms")
)

Types

type Config

type Config struct {
	Provider         string   `help:"the provider of the passphrase encryption keys: 'gsm' for google, 'local' for a local file" default:"gsm"`
	KeyInfos         KeyInfos `` /* 204-byte string literal not displayed */
	DefaultMasterKey int      `help:"the key ID to use for passphrase encryption." default:"1"`
	TestMasterKey    string   `` /* 193-byte string literal not displayed */
	MockClient       bool     `` /* 132-byte string literal not displayed */
}

Config is a configuration struct for secret management Service.

type KeyInfo

type KeyInfo struct {
	SecretVersion  string
	SecretChecksum int64
}

KeyInfo contains the location and checksum of a key.

type KeyInfos

type KeyInfos struct {
	Values map[int]KeyInfo
}

KeyInfos is a map of key IDs to key infos.

func (*KeyInfos) Set

func (ki *KeyInfos) Set(s string) error

Set sets the list of keys to the parsed string.

func (*KeyInfos) String

func (ki *KeyInfos) String() string

func (KeyInfos) Type

func (KeyInfos) Type() string

Type returns the type of the pflag.Value.

type SecretsService

type SecretsService interface {
	// GetKeys gets key from the source.
	GetKeys(ctx context.Context) (map[int]*storj.Key, error)
	// Close closes the service.
	Close() error
}

SecretsService is a service for retrieving keys.

architecture: Service

type Service

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

Service is a service for encrypting/decrypting project passphrases.

architecture: Service

func NewService

func NewService(config Config) *Service

NewService creates a new Service.

func (*Service) DecryptPassphrase

func (s *Service) DecryptPassphrase(ctx context.Context, keyID int, encryptedPassphrase []byte) ([]byte, error)

DecryptPassphrase decrypts the provided encrypted passphrase using the masterKey.

func (*Service) EncryptPassphrase

func (s *Service) EncryptPassphrase(ctx context.Context, passphrase []byte) (_ []byte, keyID int, err error)

EncryptPassphrase encrypts the provided passphrase using the masterKey in an XSalsa20 and Poly1305 encryption.

func (*Service) GenerateEncryptedPassphrase

func (s *Service) GenerateEncryptedPassphrase(ctx context.Context) (_ []byte, keyID int, err error)

GenerateEncryptedPassphrase generates a cryptographically random passphrase, returning its encrypted form and the id of the encryption key.

func (*Service) Initialize

func (s *Service) Initialize(ctx context.Context) (err error)

Initialize initializes the service.