kms

Documentation

Index

• Constants
• type Creator
• type KeyManager
• type KeyType
• type Provider

Constants

const (
	// AES128GCM key type value
	AES128GCM = "AES128GCM"
	// AES256GCMNoPrefix key type value
	AES256GCMNoPrefix = "AES256GCMNoPrefix"
	// AES256GCM key type value
	AES256GCM = "AES256GCM"
	// ChaCha20Poly1305 key type value
	ChaCha20Poly1305 = "ChaCha20Poly1305"
	// XChaCha20Poly1305 key type value
	XChaCha20Poly1305 = "XChaCha20Poly1305"
	// ECDSAP256DER key type value
	ECDSAP256DER = "ECDSAP256DER"
	// ECDSAP384DER key type value
	ECDSAP384DER = "ECDSAP384DER"
	// ECDSAP521DER key type value
	ECDSAP521DER = "ECDSAP521DER"
	// ECDSAP256IEEEP1363 key type value
	ECDSAP256IEEEP1363 = "ECDSAP256IEEEP1363"
	// ECDSAP384IEEEP1363 key type value
	ECDSAP384IEEEP1363 = "ECDSAP384IEEEP1363"
	// ECDSAP521IEEEP1363 key type value
	ECDSAP521IEEEP1363 = "ECDSAP521IEEEP1363"
	// ED25519 key type value
	ED25519 = "ED25519"
	// RSA key type value
	RSA = "RSA"
	// HMACSHA256Tag256 key type value
	HMACSHA256Tag256 = "HMACSHA256Tag256"
	// ECDHES256AES256GCM key type value
	ECDHES256AES256GCM = "ECDHES256AES256GCM"
)

const (
	// AES128GCMType key type value
	AES128GCMType = KeyType(AES128GCM)
	// AES256GCMNoPrefixType key type value
	AES256GCMNoPrefixType = KeyType(AES256GCMNoPrefix)
	// AES256GCMType key type value
	AES256GCMType = KeyType(AES256GCM)
	// ChaCha20Poly1305Type key type value
	ChaCha20Poly1305Type = KeyType(ChaCha20Poly1305)
	// XChaCha20Poly1305Type key type value
	XChaCha20Poly1305Type = KeyType(XChaCha20Poly1305)
	// ECDSAP256TypeDER key type value
	ECDSAP256TypeDER = KeyType(ECDSAP256DER)
	// ECDSAP384TypeDER key type value
	ECDSAP384TypeDER = KeyType(ECDSAP384DER)
	// ECDSAP521TypeDER key type value
	ECDSAP521TypeDER = KeyType(ECDSAP521DER)
	// ECDSAP256TypeIEEEP1363 key type value
	ECDSAP256TypeIEEEP1363 = KeyType(ECDSAP256IEEEP1363)
	// ECDSAP384TypeIEEEP1363 key type value
	ECDSAP384TypeIEEEP1363 = KeyType(ECDSAP384IEEEP1363)
	// ECDSAP521TypeIEEEP1363 key type value
	ECDSAP521TypeIEEEP1363 = KeyType(ECDSAP521IEEEP1363)
	// ED25519Type key type value
	ED25519Type = KeyType(ED25519)
	// RSAType key type value
	RSAType = KeyType(RSA)
	// HMACSHA256Tag256Type key type value
	HMACSHA256Tag256Type = KeyType(HMACSHA256Tag256)
	// ECDHES256AES256GCMType key type value
	ECDHES256AES256GCMType = KeyType(ECDHES256AES256GCM)
)

Types

type Creator

type Creator func(provider Provider) (KeyManager, error)

Creator method to create new key management service

type KeyManager

type KeyManager interface {
	// Create a new key/keyset/key handle for the type kt
	Create(kt KeyType) (string, interface{}, error)
	// Get key handle for the given keyID
	Get(keyID string) (interface{}, error)
	// Rotate a key referenced by keyID and return a new handle of a keyset including old key and
	// new key with type kt. It also returns the updated keyID as the first return value
	Rotate(kt KeyType, keyID string) (string, interface{}, error)
}

KeyManager manages keys and their storage for the aries framework

type KeyType

type KeyType string

KeyType represents a key type supported by the KMS

type Provider

type Provider interface {
	StorageProvider() storage.Provider
	SecretLock() secretlock.Service
}

Provider for KeyManager builder/constructor