Documentation
¶
Index ¶
- type MasterKey
- func (key *MasterKey) Decrypt() ([]byte, error)
- func (key *MasterKey) Encrypt(dataKey []byte) error
- func (key *MasterKey) EncryptIfNeeded(dataKey []byte) error
- func (key *MasterKey) EncryptedDataKey() []byte
- func (key *MasterKey) NeedsRotation() bool
- func (key *MasterKey) SetEncryptedDataKey(enc []byte)
- func (key MasterKey) ToMap() map[string]interface{}
- func (key *MasterKey) ToString() string
- type Token
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MasterKey ¶
type MasterKey struct {
// VaultAddress is the address of the Vault server.
VaultAddress string
// EnginePath is the path to the Vault Transit Secret engine relative
// to the VaultAddress.
EnginePath string
// KeyName is the name of the key in the Vault Transit engine.
KeyName string
// EncryptedKey contains the SOPS data key encrypted with the Vault Transit
// key.
EncryptedKey string
// CreationDate of the MasterKey, used to determine if the EncryptedKey
// needs rotation.
CreationDate time.Time
// contains filtered or unexported fields
}
MasterKey is a Vault Transit backend path used to Encrypt and Decrypt SOPS' data key.
func NewMasterKey ¶
NewMasterKey creates a new MasterKey from a Vault address, Transit backend path and a key name.
func NewMasterKeyFromURI ¶
NewMasterKeyFromURI obtains the Vault address, Transit backend path and the key name from the full URI of the key.
func NewMasterKeysFromURIs ¶
NewMasterKeysFromURIs creates a list of MasterKeys from a list of Vault URIs.
func (*MasterKey) Decrypt ¶
Decrypt decrypts the EncryptedKey field with Vault Transit and returns the result.
func (*MasterKey) Encrypt ¶
Encrypt takes a SOPS data key, encrypts it with Vault Transit, and stores the result in the EncryptedKey field.
func (*MasterKey) EncryptIfNeeded ¶
EncryptIfNeeded encrypts the provided SOPS data key, if it has not been encrypted yet.
func (*MasterKey) EncryptedDataKey ¶
EncryptedDataKey returns the encrypted data key this master key holds.
func (*MasterKey) NeedsRotation ¶
NeedsRotation returns whether the data key needs to be rotated or not.
func (*MasterKey) SetEncryptedDataKey ¶
SetEncryptedDataKey sets the encrypted data key for this master key.
Source Files