secrets

Documentation

Overview

Package secrets defines the interface common to all secret managers.

Index

• func AreCompatible(a, b Manager) bool
• type Manager

Functions

func AreCompatible

func AreCompatible(a, b Manager) bool

AreCompatible returns true if the two Managers are of the same type and have the same state.

Types

type Manager

type Manager interface {
	// Type retruns a string that reflects the type of this provider. This is serialized along with the state of
	// the manager into the deployment such that we can re-construct the correct manager when deserializing a
	// deployment into a snapshot.
	Type() string
	// An opaque state, which can be JSON serialized and used later to reconstruct the provider when deserializing
	// the deployment into a snapshot.
	State() interface{}
	// Encrypter returns a `config.Encrypter` that can be used to encrypt values when serializing a snapshot into a
	// deployment, or an error if one can not be constructed.
	Encrypter() (config.Encrypter, error)
	// Decrypter returns a `config.Decrypter` that can be used to decrypt values when deserializing a snapshot from a
	// deployment, or an error if one can not be constructed.
	Decrypter() (config.Decrypter, error)
}

Manager provides the interface for providing stack encryption.