kms

Documentation

Index

• type Config
• type EndpointResolver
  • func (e *EndpointResolver) ResolveEndpoint(_ context.Context, _ kms.EndpointParameters) (transport.Endpoint, error)
• type KeyManager
  • func GetAriesKeyManager(suite api.Suite, kmsType Type, metrics metricsProvider) *KeyManager
  • func NewAriesKeyManager(cfg *Config, metrics metricsProvider) (*KeyManager, error)
  • func (km *KeyManager) CreateCryptoKey(keyType kmsapi.KeyType) (string, interface{}, error)
  • func (km *KeyManager) CreateJWKKey(keyType kmsapi.KeyType) (string, *jwk.JWK, error)
  • func (km *KeyManager) NewVCSigner(creator string, signatureType vcsverifiable.SignatureType) (vc.SignerAlgorithm, error)
  • func (km *KeyManager) Suite() api.Suite
  • func (km *KeyManager) SupportedKeyTypes() []kmsapi.KeyType
• type Registry
  • func NewRegistry(defaultVCSKeyManager VCSKeyManager, defaultKmsConfig Config, ...) *Registry
  • func (r *Registry) GetKeyManager(config *Config) (VCSKeyManager, error)
• type Type
• type VCSKeyManager

Types

type Config

type Config struct {
	KMSType     Type `json:"kmsType"`
	Endpoint    string
	Region      string
	AliasPrefix string
	HTTPClient  *http.Client

	SecretLockKeyPath string
	DBType            string
	DBURL             string
	DBName            string
	MasterKey         string
}

Config configure kms that stores signing keys.

type EndpointResolver

type EndpointResolver struct {
	Endpoint string
}

EndpointResolver resolves the endpoint.

func (*EndpointResolver) ResolveEndpoint

func (e *EndpointResolver) ResolveEndpoint(
	_ context.Context,
	_ kms.EndpointParameters,
) (transport.Endpoint, error)

ResolveEndpoint resolves the endpoint.

type KeyManager

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

func GetAriesKeyManager

func GetAriesKeyManager(suite api.Suite, kmsType Type, metrics metricsProvider) *KeyManager

func NewAriesKeyManager

func NewAriesKeyManager(cfg *Config, metrics metricsProvider) (*KeyManager, error)

func (*KeyManager) CreateCryptoKey

func (km *KeyManager) CreateCryptoKey(keyType kmsapi.KeyType) (string, interface{}, error)

func (*KeyManager) CreateJWKKey

func (km *KeyManager) CreateJWKKey(keyType kmsapi.KeyType) (string, *jwk.JWK, error)

func (*KeyManager) NewVCSigner

func (km *KeyManager) NewVCSigner(
	creator string, signatureType vcsverifiable.SignatureType) (vc.SignerAlgorithm, error)

func (*KeyManager) Suite

func (km *KeyManager) Suite() api.Suite

func (*KeyManager) SupportedKeyTypes

func (km *KeyManager) SupportedKeyTypes() []kmsapi.KeyType

type Registry

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

func NewRegistry

func NewRegistry(
	defaultVCSKeyManager VCSKeyManager,
	defaultKmsConfig Config,
	defaultMetricProvider metricsProvider,
) *Registry

func (*Registry) GetKeyManager

func (r *Registry) GetKeyManager(config *Config) (VCSKeyManager, error)

type Type

type Type string

const (
	AWS   Type = "aws"
	Local Type = "local"
	Web   Type = "web"
)

type VCSKeyManager

type VCSKeyManager interface {
	SupportedKeyTypes() []kms.KeyType
	CreateJWKKey(keyType kms.KeyType) (string, *jwk.JWK, error)
	CreateCryptoKey(keyType kms.KeyType) (string, interface{}, error)
	NewVCSigner(creator string, signatureType vcsverifiable.SignatureType) (vc.SignerAlgorithm, error)
}