secret

Documentation

Overview

Package secret resolves a value from somewhere other than the environment.

`valueEnv` covers one person: the value is already exported in their shell. It does not cover a team, where the value lives in a password manager and nobody should be exporting it by hand in the first place.

Nothing in this package writes to stdout, and no resolved value is ever returned to anything that renders.

Index

• type OnePassword
  • func (o OnePassword) Resolve(ctx context.Context, ref string) (string, error)
  • func (OnePassword) Scheme() string
• type Resolver
• type Set
  • func Default() *Set
  • func NewSet(resolvers ...Resolver) *Set
  • func (s *Set) Resolve(ctx context.Context, ref string) (string, error)
  • func (s *Set) Schemes() []string

Types

type OnePassword

type OnePassword struct {
	// contains filtered or unexported fields
}

OnePassword reads through the `op` CLI, so upkeep never handles a vault credential itself: `op` is already signed in, or it is not and says so.

func (OnePassword) Resolve

func (o OnePassword) Resolve(ctx context.Context, ref string) (string, error)

func (OnePassword) Scheme

func (OnePassword) Scheme() string

type Resolver

type Resolver interface {
	// Scheme is the prefix that selects this resolver, without "://".
	Scheme() string
	// Resolve returns the value for a reference, or an error explaining what a
	// human should do about it.
	Resolve(ctx context.Context, ref string) (string, error)
}

Resolver fetches one value by reference.

type Set

type Set struct {
	// contains filtered or unexported fields
}

Set is the resolvers available to a run.

func Default

func Default() *Set

Default is what the CLI uses.

func NewSet

func NewSet(resolvers ...Resolver) *Set

func (*Set) Resolve

func (s *Set) Resolve(ctx context.Context, ref string) (string, error)

Resolve dispatches a reference to its resolver.

func (*Set) Schemes

func (s *Set) Schemes() []string

Schemes lists what this build can resolve, for an error that helps.