entities

Documentation

Index

• Constants
• type AWSConfig
• type Algorithm
• type Alias
  • func NewAlias(registry, key, kind string, value interface{}) (*Alias, error)
  • func (a *Alias) Array() ([]string, error)
  • func (a *Alias) String() (string, error)
  • func (a *Alias) Validate() error
• type AliasRegistry
• type AzureConfig
• type Curve
• type HashicorpConfig
• type KeyType
• type Manifest
• type Vault

Constants

const (
	Ecdsa KeyType = "ecdsa"
	Eddsa KeyType = "eddsa"

	Babyjubjub Curve = "babyjubjub"
	Secp256k1  Curve = "secp256k1"
	Curve25519 Curve = "curve25519"
)

const (
	AliasKindString string = "string"
	AliasKindArray  string = "array"
)

const (
	RoleKind  string = "Role"
	NodeKind  string = "Node"
	StoreKind string = "Store"
	VaultKind string = "Vault"
)

const (
	HashicorpVaultType = "hashicorp"
	AzureVaultType     = "azure"
	AWSVaultType       = "aws"
)

Types

type AWSConfig

type AWSConfig struct {
	Region    string `json:"region" yaml:"region" validate:"required" example:"eu-west-3"`
	AccessID  string `json:"accessID" yaml:"access_id" validate:"required" example:"AKIAQX7AV2NLJTF5ZZOB"`
	SecretKey string `json:"secretKey" yaml:"secret_key" validate:"required" example:"my-secert"`
	Debug     bool   `json:"debug,omitempty" yaml:"debug" example:"true"`
}

type Algorithm

type Algorithm struct {
	Type          KeyType
	EllipticCurve Curve
}

type Alias

type Alias struct {
	Key          string
	RegistryName string
	Kind         string
	Value        interface{}
	CreatedAt    time.Time
	UpdatedAt    time.Time
}

func NewAlias

func NewAlias(registry, key, kind string, value interface{}) (*Alias, error)

func (*Alias) Array

func (a *Alias) Array() ([]string, error)

func (*Alias) String

func (a *Alias) String() (string, error)

func (*Alias) Validate

func (a *Alias) Validate() error

type AliasRegistry

type AliasRegistry struct {
	Name           string
	Aliases        []Alias
	AllowedTenants []string
	CreatedAt      time.Time
	UpdatedAt      time.Time
}

type AzureConfig

type AzureConfig struct {
	VaultName    string `json:"vaultName" yaml:"vault_name" validate:"required" example:"quorumkeymanager"`
	TenantID     string `json:"tenantID" yaml:"tenant_id" validate:"required" example:"17255fb0-373b-4a1a-bd47-d211ab86df81"`
	ClientID     string `json:"clientID" yaml:"client_id" validate:"required" example:"8c925036-dd6f-4a1e-a315-5e6fab4f2f09"`
	ClientSecret string `json:"clientSecret" yaml:"client_secret" validate:"required" example:"my-secret"`
}

type Curve

type Curve string

type HashicorpConfig

type HashicorpConfig struct {
	MountPoint    string        `json:"mountPoint" yaml:"mount_point" validate:"required" example:"secret"`
	Address       string        `json:"address"  yaml:"address" validate:"required" example:"https://hashicorp:8200"`
	Token         string        `json:"token,omitempty" yaml:"token" example:"s.W7IMlFuBGsTaR6uHLcGDw9Mq"`
	TokenPath     string        `json:"tokenPath,omitempty" yaml:"token_path,omitempty" example:"/vault/token/.my_token"`
	Namespace     string        `json:"namespace,omitempty" yaml:"namespace,omitempty" example:"namespace"`
	CACert        string        `json:"CACert,omitempty" yaml:"ca_cert,omitempty" example:"/vault/tls/ca.crt"`
	CAPath        string        `json:"CAPath,omitempty" yaml:"ca_path,omitempty" example:"/vault/tls/root-certs"`
	ClientCert    string        `json:"clientCert,omitempty" yaml:"client_cert,omitempty" example:"/vault/tls/client.crt"`
	ClientKey     string        `json:"clientKey,omitempty" yaml:"client_key,omitempty" example:"/vault/tls/client.key"`
	TLSServerName string        `json:"TLSServerName,omitempty" yaml:"tls_server_name,omitempty" example:"server-name"`
	ClientTimeout time.Duration `json:"clientTimeout,omitempty" yaml:"client_timeout,omitempty" example:"60s"`
	RateLimit     float64       `json:"rateLimit,omitempty" yaml:"rate_limit,omitempty" example:"0"`
	BurstLimit    int           `json:"burstLimit,omitempty" yaml:"burst_limit,omitempty" example:"0"`
	MaxRetries    int           `json:"maxRetries,omitempty" yaml:"max_retries,omitempty" example:"2"`
	SkipVerify    bool          `json:"skipVerify,omitempty" yaml:"skip_verify,omitempty" example:"false"`
}

type KeyType

type KeyType string

type Manifest

type Manifest struct {
	Kind           string      `yaml:"kind" validate:"required,isManifestKind" example:"store"`
	Name           string      `yaml:"name" validate:"required" example:"my-store"`
	ResourceType   string      `yaml:"type,omitempty" example:"ethereum"`
	Specs          interface{} `yaml:"specs" validate:"required"`
	AllowedTenants []string    `json:"allowedTenants,omitempty" yaml:"allowed_tenants,omitempty" example:"tenant1,tenant2"`
}

type Vault

type Vault struct {
	Client         interface{}
	VaultType      string
	Name           string
	AllowedTenants []string
}