entities

Documentation

Index

• Constants
• type Annotation
• type Attributes
• type CryptoOperation
• type ETHAccount
• type Key
  • func (k *Key) IsETHAccount() bool
• type Metadata
• type Recovery
• type RecoveryPolicy
• type Secret
• type Store

Constants

const (
	Signing    = "signing"
	Encryption = "encryption"
)

const (
	EthereumStoreType = "ethereum"
	KeyStoreType      = "key"
	SecretStoreType   = "secret"
)

Types

type Annotation

type Annotation struct {
	AWSKeyID             string `json:"AWSKeyID,omitempty"`
	AWSCustomKeyStoreID  string `json:"AWSCustomKeyStoreID,omitempty"`
	AWSCloudHsmClusterID string `json:"AWSCloudHsmClusterID,omitempty"`
	AWSAccountID         string `json:"AWSAccountID,omitempty"`
	AWSArn               string `json:"AWSArn,omitempty"`
}

type Attributes

type Attributes struct {
	// Operations supported by a stored item (e.g. sign, encrypt...)
	Operations []CryptoOperation

	// Disabled whether item is disabled
	Disabled bool

	// TTL
	TTL time.Duration

	// Recovery policy about a key after being deleted before being destroyed
	Recovery *Recovery

	// Tags attached to a stored item
	Tags map[string]string
}

Attributes are user set configuration and information attached to stored item

type CryptoOperation

type CryptoOperation string

CryptoOperation type of crypto operation

type ETHAccount

type ETHAccount struct {
	Address             common.Address
	KeyID               string
	PublicKey           []byte
	CompressedPublicKey []byte
	Metadata            *Metadata
	Tags                map[string]string
}

type Key

type Key struct {
	ID          string
	PublicKey   []byte
	Algo        *entities.Algorithm
	Metadata    *Metadata
	Tags        map[string]string
	Annotations *Annotation
}

Key public part of a key

func (*Key) IsETHAccount

func (k *Key) IsETHAccount() bool

type Metadata

type Metadata struct {
	Version   string
	Disabled  bool
	ExpireAt  time.Time
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt time.Time
}

type Recovery

type Recovery struct {
	// Policy for recovery
	Policy RecoveryPolicy

	// Period for recovery
	Period time.Time
}

type RecoveryPolicy

type RecoveryPolicy string

RecoveryPolicy policies for recovering a deleted item

type Secret

type Secret struct {
	ID       string
	Value    string
	Metadata *Metadata
	Tags     map[string]string
}

type Store

type Store struct {
	Name           string
	AllowedTenants []string
	Store          interface{}
	StoreType      string
}