Interface EncryptionAlgorithm

internal/crypto/crypto.go:19–29

go:generate mockgen -typed -package crypto -destination ./crypto.mock.go . EncryptionAlgorithm

//go:generate mockgen -typed -package crypto -destination ./crypto.mock.go . EncryptionAlgorithm

type EncryptionAlgorithm interface {
	Algorithm() string
	EncryptionKeyID() string
	DecryptionKeyIDs() []string
	Encrypt(value []byte) ([]byte, error)
	Decrypt(hashed []byte, keyID string) ([]byte, error)

	// DecryptString decrypts the value using the key identified by keyID.
	// When the decrypted value contains non-UTF8 characters an error is returned.
	DecryptString(hashed []byte, keyID string) (string, error)
}

// CryptoValue is a struct that can be used to store encrypted values in a database.
// The struct is compatible with the [driver.Valuer] and database/sql.Scanner interfaces.