fortanix

Documentation

Index

• type APIKey
  • func (k APIKey) String() string
• type Config
• type Store
  • func Connect(ctx context.Context, config *Config) (*Store, error)
  • func (s *Store) Close() error
  • func (s *Store) Create(ctx context.Context, name string, value []byte) error
  • func (s *Store) Delete(ctx context.Context, name string) error
  • func (s *Store) Get(ctx context.Context, name string) ([]byte, error)
  • func (s *Store) List(ctx context.Context, prefix string, n int) ([]string, string, error)
  • func (s *Store) Set(ctx context.Context, name string, value []byte) error
  • func (s *Store) Status(ctx context.Context) (kes.KeyStoreState, error)
  • func (s *Store) String() string

Types

type APIKey

type APIKey string

APIKey is a Fortanix API key for authenticating to a Fortanix SDKMS instance.

func (APIKey) String

func (k APIKey) String() string

String returns a string representation of the API key that can be sent to a Fortanix SDKMS as part of the request headers.

type Config

type Config struct {
	// Endpoint is the Fortanix SDKMS instance endpoint.
	Endpoint string

	// GroupID is ID of the Fortanix SDKMS group newly created
	// keys will belong to.
	//
	// Fortanix SDKMS uses groups as collection of (security) objects.
	// Typically, applications can access some/all objects within groups
	// the application is assigned to.
	GroupID string

	// APIKey is the application's Fortanix SDKMS API key used to authenticate
	// operations. It is sent on each request as part of the request headers.
	APIKey APIKey

	// CAPath is an optional path to a CA certificate or directory
	// containing CA certificates.
	//
	// If not empty, the KeyStore will use the specified CAs to
	// verify the Fortanix SDKMS server certificate.
	CAPath string
}

Config is a structure containing configuration options for connecting to a Fortanix SDKMS server.

type Store

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

Store is a Fortanix SDKMS secret store.

func Connect

func Connect(ctx context.Context, config *Config) (*Store, error)

Connect establishes and returns a Store to a Fortanix SDKMS server using the given config.

func (*Store) Close

func (s *Store) Close() error

Close closes the Store.

func (*Store) Create

func (s *Store) Create(ctx context.Context, name string, value []byte) error

Create stores the given key at the Fortanix SDKMS if and only if no entry with the given name exists.

If no such entry exists, Create returns kes.ErrKeyExists.

func (*Store) Delete

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

Delete deletes the key associated with the given name from the Fortanix SDKMS. It may not return an error if no entry for the given name exists.

func (*Store) Get

func (s *Store) Get(ctx context.Context, name string) ([]byte, error)

Get returns the key associated with the given name.

If there is no such entry, Get returns kes.ErrKeyNotFound.

func (*Store) List

func (s *Store) List(ctx context.Context, prefix string, n int) ([]string, string, error)

List returns a new Iterator over the names of all stored keys. List returns the first n key names, that start with the given prefix, and the next prefix from which the listing should continue.

It returns all keys with the prefix if n < 0 and less than n names if n is greater than the number of keys with the prefix.

An empty prefix matches any key name. At the end of the listing or when there are no (more) keys starting with the prefix, the returned prefix is empty.

func (*Store) Set

func (s *Store) Set(ctx context.Context, name string, value []byte) error

Set stores the given key at the Fortanix SDKMS if and only if no entry with the given name exists.

If no such entry exists, Create returns kes.ErrKeyExists.

func (*Store) Status

func (s *Store) Status(ctx context.Context) (kes.KeyStoreState, error)

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

func (*Store) String

func (s *Store) String() string