Documentation
¶
Overview ¶
Package driver defines interfaces to be implemented for providers of the secrets package.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Keeper ¶
type Keeper interface {
// Decrypt decrypts the ciphertext and returns the plaintext or an error.
// Decrypt *may* decrypt ciphertexts that were encrypted using a different
// key than the one provided to Keeper; some providers encode the key used
// in the ciphertext.
Decrypt(ctx context.Context, ciphertext []byte) ([]byte, error)
// Encrypt encrypts the plaintext using the key, and returns the ciphertext.
Encrypt(ctx context.Context, plaintext []byte) ([]byte, error)
// Close releases any resources used for the Keeper.
Close() error
// ErrorAs allows providers to expose provider-specific types for returned
// errors.
//
// See https://gocloud.dev/concepts/as/ for background information.
ErrorAs(err error, i interface{}) bool
// ErrorCode should return a code that describes the error, which was returned
// by one of the other methods in this interface.
ErrorCode(error) gcerrors.ErrorCode
}
Keeper holds the key information to encrypt a plain text message into a cipher message, as well as decrypt a cipher message into a plain text message.
Click to show internal directories.
Click to hide internal directories.