types

Documentation

Overview

Package types contains the config file structs

Index

• type ACL
  • func (a *ACL) Validate() []error
• type ConfigFile
  • func (c *ConfigFile) Validate() []error
• type Credential
  • func (c *Credential) Key() string
• type Files
• type InMemory
• type SVIDSources
• type SpiffeConfig
• type WorkloadAPI

Types

type ACL

type ACL struct {
	MatchPrincipal string       `yaml:"match_principal"`
	Credentials    []Credential `yaml:"credentials"`
}

ACL is a mapping between a given principal and the credentials for services it will gain access to.

func (*ACL) Validate

func (a *ACL) Validate() []error

type ConfigFile

type ConfigFile struct {
	SPIFFE *SpiffeConfig `yaml:"spiffe"`
	ACLs   []ACL         `yaml:"acls"`
}

ConfigFile represents the config file that will be loaded from disk, or some other mechanism.

func (*ConfigFile) Validate

func (c *ConfigFile) Validate() []error

type Credential

type Credential struct {
	Provider        string `yaml:"provider"`
	ObjectReference string `yaml:"object_reference"`
}

Credential represents any remote credential that the connector can give out.

func (*Credential) Key

func (c *Credential) Key() string

type Files

type Files struct {
	TrustDomainCA string `yaml:"trust_domain_ca"`
	SVIDCert      string `yaml:"svid_cert"`
	SVIDKey       string `yaml:"svid_key"`
}

type InMemory

type InMemory struct {
	TrustDomainCA []byte
	SVIDCert      []byte
	SVIDKey       []byte
}

InMemory is only used in testing

type SVIDSources

type SVIDSources struct {
	WorkloadAPI *WorkloadAPI `yaml:"workload_api,omitempty"`
	Files       *Files       `yaml:"files,omitempty"`

	// InMemory is only used in testing
	InMemory *InMemory
}

SVIDSources determines where spiffe-connector will obtain its own SVID and trust domain information. The SPIFFE Workload API and Static files are supported.

type SpiffeConfig

type SpiffeConfig struct {
	SVIDSources SVIDSources `yaml:"svid_sources"`
}

SpiffeConfig represents the SPIFFE configuration section of spiffe-connector's config file

type WorkloadAPI

type WorkloadAPI struct {
	SocketPath string `yaml:"socket_path"`
}