gcp

Documentation

Index

• type Config
  • func (c *Config) Clone() *Config
• type Credentials
  • func (c Credentials) MarshalJSON() ([]byte, error)
• type SecretManager
  • func Connect(ctx context.Context, c *Config) (*SecretManager, error)
  • func (s *SecretManager) Create(ctx context.Context, name string, key key.Key) error
  • func (s *SecretManager) Delete(ctx context.Context, name string) error
  • func (s *SecretManager) Get(ctx context.Context, name string) (key.Key, error)
  • func (s *SecretManager) List(ctx context.Context) (key.Iterator, error)
  • func (s *SecretManager) Status(ctx context.Context) (key.StoreState, error)

Types

type Config

type Config struct {
	// Endpoint is the GCP SecretManager endpoint.
	Endpoint string

	// ProjectID is the ID of the GCP project.
	ProjectID string

	// Credentials are the GCP credentials to
	// access the SecretManager.
	Credentials Credentials

	// ErrorLog is an optional logger for errors
	// that may occur when interacting with GCP
	// SecretManager.
	ErrorLog *log.Logger
	// contains filtered or unexported fields
}

A Config structure is used to configure a GCP SecretManager client.

func (*Config) Clone

func (c *Config) Clone() *Config

Clone returns a shallow clone of c or nil if c is nil. It is safe to clone a Config that is being used concurrently.

type Credentials

type Credentials struct {

	// ClientID is the client ID of the GCP service account.
	ClientID string

	// Client is the client email of the GCP service account.
	Client string

	// Key is the private key ID of the GCP service account.
	KeyID string

	// Key is the encoded private key of the GCP service account.
	Key string
	// contains filtered or unexported fields
}

Credentials represent GCP service account credentials.

func (Credentials) MarshalJSON

func (c Credentials) MarshalJSON() ([]byte, error)

MarshalJSON returns a JSON representation of the GCP credentials.

The returned JSON contains extra fields to match the JSON credentials returned by GCP. Those additional fields are set to default values.

type SecretManager

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

SecretManager is a GCP SecretManager client.

func Connect

func Connect(ctx context.Context, c *Config) (*SecretManager, error)

Connect connects and authenticates to a GCP SecretManager server.

func (*SecretManager) Create

func (s *SecretManager) Create(ctx context.Context, name string, key key.Key) error

Create stores the given key-value pair at GCP secret manager if and only if it doesn't exists. If such an entry already exists it returns kes.ErrKeyExists.

Creating a secret at the GCP SecretManager requires first creating secret itself and then adding a secret version with some payload data. The payload data contains the actual value.

func (*SecretManager) Delete

func (s *SecretManager) Delete(ctx context.Context, name string) error

Delete remove the key-value pair from GCP SecretManager.

Delete will remove all versions of the GCP secret. Even though CreateKey will create only one version and fails if the secret already exists a user may create more secrets versions through e.g. the GCP CLI. However, KES does not support multiple secret versions and expects a different mechanism for "key-rotation".

func (*SecretManager) Get

func (s *SecretManager) Get(ctx context.Context, name string) (key.Key, error)

Get returns the value associated with the given key.

func (*SecretManager) List

func (s *SecretManager) List(ctx context.Context) (key.Iterator, error)

List returns a new Iterator over the names of all stored keys.

func (*SecretManager) Status

func (s *SecretManager) Status(ctx context.Context) (key.StoreState, error)

Status returns the current state of the GCP SecretManager instance. In particular, whether it is reachable and the network latency.