kmsClient

Documentation

Index

• type AWSKMS
  • func (a *AWSKMS) Decrypt(ctx context.Context, keyID string, version string, input []byte) (result []byte, _ error)
  • func (a *AWSKMS) Encrypt(ctx context.Context, input []byte) (keyID string, version string, result []byte, _ error)
• type AWSKMSConfig
  • func (c *AWSKMSConfig) Validate() error
• type KeyManagement
  • func NewAWSKMS(config AWSKMSConfig) (KeyManagement, error)
  • func NewMockAwsKms() (KeyManagement, error)
• type MockKeyManagement
  • func (*MockKeyManagement) Decrypt(ctx context.Context, keyID string, version string, input []byte) (result []byte, _ error)
  • func (*MockKeyManagement) Encrypt(ctx context.Context, input []byte) (keyID string, version string, result []byte, _ error)

Types

type AWSKMS

type AWSKMS struct {
	// contains filtered or unexported fields
}

AWSKMS is the implementation of the KeyManagement interface for AWS KMS

func (*AWSKMS) Decrypt

func (a *AWSKMS) Decrypt(ctx context.Context, keyID string, version string, input []byte) (result []byte, _ error)

Decrypt decrypts the input using the AWS KMS client

func (*AWSKMS) Encrypt

func (a *AWSKMS) Encrypt(ctx context.Context, input []byte) (keyID string, version string, result []byte, _ error)

Encrypt encrypts the input using the AWS KMS client

type AWSKMSConfig

type AWSKMSConfig struct {
	// Log is the logger to use for this implementation
	Log *zap.Logger
	// KeyID is the ID of the key to use for encryption and decryption
	AccessKey string
	// Region is the AWS region to use for the KMS client
	Region string
	// SecretKey is the secret key to use for the KMS client
	SecretKey string
	// Endpoint is the endpoint to use for the KMS client
	Endpoint *string
	// KmsKeyID is the ID of the key to use for encryption and decryption
	KmsKeyID string
}

AWSKMSConfig is the configuration for the AWS KMS implementation of the KeyManagement interface

func (*AWSKMSConfig) Validate

func (c *AWSKMSConfig) Validate() error

`func (c *AWSKMSConfig) Validate() error` is a method defined on the `AWSKMSConfig` struct. It validates that all the required fields in the `AWSKMSConfig` struct are present and returns an error if any of them are missing. This method is called when creating a new instance of the `AWSKMS` struct to ensure that the configuration is valid.

type KeyManagement

type KeyManagement interface {
	Encrypt(ctx context.Context, input []byte) (keyID, version string, result []byte, _ error)
	Decrypt(ctx context.Context, keyID, version string, input []byte) (result []byte, _ error)
}

KeyManagement is the interface that defines the methods for encrypting and decrypting data

func NewAWSKMS

func NewAWSKMS(config AWSKMSConfig) (KeyManagement, error)

NewAWSKMS creates a new AWS KMS implementation of the KeyManagement interface

func NewMockAwsKms

func NewMockAwsKms() (KeyManagement, error)

type MockKeyManagement

type MockKeyManagement struct{}

func (*MockKeyManagement) Decrypt

func (*MockKeyManagement) Decrypt(ctx context.Context, keyID string, version string, input []byte) (result []byte, _ error)

Decrypt implements KeyManagement

func (*MockKeyManagement) Encrypt

func (*MockKeyManagement) Encrypt(ctx context.Context, input []byte) (keyID string, version string, result []byte, _ error)

Encrypt implements KeyManagement