credentials

Documentation

Index

• Constants
• func Validate(given valuesource.Set, spec map[string]bundle.Credential, action string) error
• type CredentialSet
  • func Load(path string) (*CredentialSet, error)
  • func NewCredentialSet(name string, creds ...valuesource.Strategy) CredentialSet
  • func (c *CredentialSet) ResolveCredentials(s secrets.Store) (valuesource.Set, error)

Constants

const (
	// DefaultSchemaVersion is the default SchemaVersion value
	// set on new CredentialSet instances, and is the semver portion
	// of CNABSpecVersion.
	DefaultSchemaVersion = schema.Version("1.0.0-DRAFT+b6c701f")

	// CNABSpecVersion represents the CNAB Spec version of the Credentials
	// that this library implements
	// This value is prefixed with e.g. `cnab-credentials-` so isn't itself valid semver.
	CNABSpecVersion string = "cnab-credentialsets-" + string(DefaultSchemaVersion)
)

Functions

func Validate

func Validate(given valuesource.Set, spec map[string]bundle.Credential, action string) error

Validate compares the given credentials with the spec.

This will result in an error only when the following conditions are true: - a credential in the spec is not present in the given set - the credential is required - the credential applies to the specified action

It is allowed for spec to specify both an env var and a file. In such case, if the given set provides either, it will be considered valid.

Types

type CredentialSet

type CredentialSet struct {
	// SchemaVersion is the version of the credential-set schema.
	SchemaVersion schema.Version `json:"schemaVersion" yaml:"schemaVersion"`
	// Name is the name of the credentialset.
	Name string `json:"name" yaml:"name"`
	// Created timestamp of the credentialset.
	Created time.Time `json:"created" yaml:"created"`
	// Modified timestamp of the credentialset.
	Modified time.Time `json:"modified" yaml:"modified"`
	// Credentials is a list of credential specs.
	Credentials []valuesource.Strategy `json:"credentials" yaml:"credentials"`
}

CredentialSet represents a collection of credentials

func Load

func Load(path string) (*CredentialSet, error)

Load a CredentialSet from a file at a given path.

It does not load the individual credentials.

func NewCredentialSet

func NewCredentialSet(name string, creds ...valuesource.Strategy) CredentialSet

NewCredentialSet creates a new CredentialSet with the required fields initialized.

func (*CredentialSet) ResolveCredentials

func (c *CredentialSet) ResolveCredentials(s secrets.Store) (valuesource.Set, error)

ResolveCredentials looks up the credentials as described in Source, then copies the resulting value into the Value field of each credential strategy.

The typical workflow for working with a credential set is:

• Load the set
• Validate the credentials against a spec
• Resolve the credentials
• Expand them into bundle values