secrets

Documentation

Overview

Package secrets provides primitives for resolving secrets from external sources, such as Hashicorp Vault or Azure Key Vault, into Credential Sets and injecting them into bundle runtimes.

Index

• Constants
• type Client
  • func (g *Client) Resolve(keyName string, keyValue string) (string, error)
• type Plugin
  • func (Plugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)
  • func (p *Plugin) Server(*plugin.MuxBroker) (interface{}, error)
• type Server
  • func (s *Server) Resolve(args map[string]interface{}, resp *string) error
• type Set
  • func (s Set) IsValid(key string) bool
  • func (s Set) Merge(s2 Set) error
  • func (s Set) ToCNAB() valuesource.Set
• type Source
  • func (s Source) MarshalJSON() ([]byte, error)
  • func (s Source) MarshalRaw() interface{}
  • func (s Source) MarshalYAML() (interface{}, error)
  • func (s *Source) UnmarshalJSON(data []byte) error
  • func (s *Source) UnmarshalRaw(raw map[string]interface{}) error
  • func (s *Source) UnmarshalYAML(value *yaml.Node) error
• type Store
• type Strategy

Constants

const PluginInterface = "secrets"

PluginInterface for the secrets. This first part of the three-part plugin key is only seen/used by the plugins when the host is communicating with the plugin and is not exposed to users.

const SourceSecret = "secret"

Types

type Client

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

func (*Client) Resolve

func (g *Client) Resolve(keyName string, keyValue string) (string, error)

type Plugin

type Plugin struct {
	Impl plugins.SecretsProtocol
}

Plugin is a generic type of plugin for working with any implementation of a secret store.

func (Plugin) Client

func (Plugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)

func (*Plugin) Server

func (p *Plugin) Server(*plugin.MuxBroker) (interface{}, error)

type Server

type Server struct {
	Impl plugins.SecretsProtocol
}

func (*Server) Resolve

func (s *Server) Resolve(args map[string]interface{}, resp *string) error

type Set

type Set map[string]string

Set is an actual set of resolved values. This is the output of resolving a parameter or credential set file.

func (Set) IsValid

func (s Set) IsValid(key string) bool

IsValid determines if the provided key (designating a name of a parameter or credential) is included in the provided set

func (Set) Merge

func (s Set) Merge(s2 Set) error

Merge merges a second Set into the base.

Duplicate names are not allow and will result in an error, this is the case even if the values are identical.

func (Set) ToCNAB

func (s Set) ToCNAB() valuesource.Set

ToCNAB converts this to a type accepted by the cnab-go runtime.

type Source

type Source struct {
	Key   string
	Value string
}

Source represents a strategy for loading a value from local host.

func (Source) MarshalJSON

func (s Source) MarshalJSON() ([]byte, error)

func (Source) MarshalRaw

func (s Source) MarshalRaw() interface{}

func (Source) MarshalYAML

func (s Source) MarshalYAML() (interface{}, error)

func (*Source) UnmarshalJSON

func (s *Source) UnmarshalJSON(data []byte) error

func (*Source) UnmarshalRaw

func (s *Source) UnmarshalRaw(raw map[string]interface{}) error

func (*Source) UnmarshalYAML

func (s *Source) UnmarshalYAML(value *yaml.Node) error

type Store

type Store interface {
	plugins.SecretsPlugin
}

Store is the interface that Porter uses to interact with secrets.

type Strategy

type Strategy struct {
	// Name is the name of the parameter or credential.
	Name string `json:"name" yaml:"name"`
	// Source is the location of the value.
	// During resolution, the source will be loaded, and the result temporarily placed
	// into Value.
	Source Source `json:"source,omitempty" yaml:"source,omitempty"`
	// Value holds the parameter or credential value.
	// When a parameter or credential is loaded, it is loaded into this field. In all
	// other cases, it is empty. This field is omitted during serialization.
	Value string `json:"-" yaml:"-"`
}

Strategy represents a strategy for determining the value of a parameter or credential