store

Documentation

Overview

Package store defines a key storage interface.

Index

• type KeyFactory
  • func (kf KeyFactory[T, M]) FromTurnkeyPrivateKey(data string) (T, error)
• type Store

Types

type KeyFactory

type KeyFactory[T common.IKey[M], M common.IMetadata] struct{}

KeyFactory generic struct to select the correct FromTurnkeyPrivateKey function.

func (KeyFactory[T, M]) FromTurnkeyPrivateKey

func (kf KeyFactory[T, M]) FromTurnkeyPrivateKey(data string) (T, error)

FromTurnkeyPrivateKey converts a Turnkey-encoded private key string to a key.

type Store

type Store[T common.IKey[M], M common.IMetadata] interface {
	// Load pulls a key from the store.
	Load(name string) (T, error)

	// Store saves the key to the store.
	Store(name string, key common.IKey[M]) error
}

Store provides an interface in which API or Encryption keys may be stored and retrieved.