aws

Documentation

Index

• func Decrypt(ctx context.Context, data []byte, name string, dataKey []byte) (string, error)
• func Encrypt(ctx context.Context, data, name string, dataKey []byte) ([]byte, error)
• func NewConfig(ctx context.Context, o NewConfigOptions) (aws.Config, error)
• func NewS3Client(ctx context.Context, o NewS3ClientOptions) (*s3.Client, error)
• type AssumeRole
• type KMSClient
  • func NewKMSClient(ctx context.Context, o NewConfigOptions, keyAlias string) (*KMSClient, error)
  • func (c *KMSClient) CreateDataKey(ctx context.Context) ([]byte, []byte, error)
  • func (c *KMSClient) DecryptDataKey(ctx context.Context, encryptedKey []byte) ([]byte, error)
• type MockKMSClient
  • func NewMockKMSClient() *MockKMSClient
  • func (m *MockKMSClient) CreateDataKey(ctx context.Context) ([]byte, []byte, error)
  • func (m *MockKMSClient) DecryptDataKey(ctx context.Context, encryptedKey []byte) ([]byte, error)
• type NewConfigOptions
• type NewS3ClientOptions

Functions

func Decrypt

func Decrypt(ctx context.Context, data []byte, name string, dataKey []byte) (string, error)

Decrypt decrypts into a string data.

func Encrypt

func Encrypt(ctx context.Context, data, name string, dataKey []byte) ([]byte, error)

Encrypt encrypts a string data.

func NewConfig

func NewConfig(ctx context.Context, o NewConfigOptions) (aws.Config, error)

NewConfig returns a new configuration.

func NewS3Client

func NewS3Client(ctx context.Context, o NewS3ClientOptions) (*s3.Client, error)

NewS3Client returns a new S3 client.

Types

type AssumeRole

type AssumeRole struct {
	RoleARN    string
	ExternalID string
}

AssumeRole is the options for AssumeRole.

type KMSClient

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

KMSClient maintains the client to access AWS KMS related service.

func NewKMSClient

func NewKMSClient(ctx context.Context, o NewConfigOptions, keyAlias string) (*KMSClient, error)

NewKMSClient construct a KMS client.

func (*KMSClient) CreateDataKey

func (c *KMSClient) CreateDataKey(ctx context.Context) ([]byte, []byte, error)

CreateDataKey creates a data key with KMS master key.

func (*KMSClient) DecryptDataKey

func (c *KMSClient) DecryptDataKey(ctx context.Context, encryptedKey []byte) ([]byte, error)

DecryptDataKey decrypts the data key with KMS master key.

type MockKMSClient

type MockKMSClient struct {
	// DataKey is the data key used for testing. It is exposed,
	// in case the test needs to refer/overwrite it.
	DataKey []byte
}

MockKMSClient is a mock implementation of KMSClient.

func NewMockKMSClient

func NewMockKMSClient() *MockKMSClient

NewMockKMSClient creates a new MockClient with a default data key.

func (*MockKMSClient) CreateDataKey

func (m *MockKMSClient) CreateDataKey(ctx context.Context) ([]byte, []byte, error)

CreateDataKey implements a DataKeyManagementClient method.

func (*MockKMSClient) DecryptDataKey

func (m *MockKMSClient) DecryptDataKey(ctx context.Context, encryptedKey []byte) ([]byte, error)

DecryptDataKey implements a DataKeyManagementClient method.

type NewConfigOptions

type NewConfigOptions struct {
	Region string

	UseAnonymousCredentials bool

	AssumeRole *AssumeRole

	InsecureSkipVerify bool
}

NewConfigOptions is the configuration options.

type NewS3ClientOptions

type NewS3ClientOptions struct {
	EndpointURL string
	Region      string

	UseAnonymousCredentials bool

	AssumeRole *AssumeRole

	InsecureSkipVerify bool
}

NewS3ClientOptions is the options for NewS3Client.