spiffeutil

Documentation

Index

• Constants
• type KubernetesWorkload
  • func ParseKubernetesWorkloadID(workloadID string) (*KubernetesWorkload, error)
• type ParsedURI
  • func Parse(uri string) (*ParsedURI, error)

Constants

const (

	// ErrInvalidURI is the class of error returned when parsing SPIFFE URI fails
	ErrInvalidURI = ex.Class("Invalid SPIFFE URI")
	// ErrNonKubernetesWorkload is class of error returned when parsing a SPIFFE
	// Kubernetes workload identifier fails.
	ErrNonKubernetesWorkload = ex.Class("Workload ID not in Kubernetes format")
)

Types

type KubernetesWorkload

type KubernetesWorkload struct {
	Namespace      string
	ServiceAccount string
}

KubernetesWorkload describes a Kubernetes workload identifier.

func ParseKubernetesWorkloadID

func ParseKubernetesWorkloadID(workloadID string) (*KubernetesWorkload, error)

ParseKubernetesWorkloadID parses a SPIFFE workload identifier that identifies Kubernetes service account, of the form `ns/{namespace}/sa/{serviceAccount}`.

type ParsedURI

type ParsedURI struct {
	TrustDomain string
	WorkloadID  string
}

ParsedURI represents a SPIFFE URI that has been parsed via `Parse()`.

func Parse

func Parse(uri string) (*ParsedURI, error)

Parse consumes a SPIFFE URI and splits out the trust domain and workload identifier. For example in `spiffe://cluster.local/ns/blend/sa/quasar` the trust domain is `cluster.local` and the workload identifier is `ns/blend/sa/quasar`.