secret

Documentation

Index

• Variables
• func Update(p *Printer, opts ...Option)
• type Option
  • func CustomValueLength(length int) Option
  • func OnlyKeys(b bool) Option
  • func OnlyPaths(b bool) Option
  • func ShowMetadata(b bool) Option
  • func ShowValues(b bool) Option
  • func ShowVersion(b bool) Option
  • func ToFormat(format OutputFormat) Option
  • func WithEnginePath(path string) Option
  • func WithHyperLinks(b bool) Option
  • func WithTemplate(str, path string) Option
  • func WithVaultClient(v *vault.Vault) Option
  • func WithWriter(w io.Writer) Option
• type OutputFormat
• type Printer
  • func NewSecretPrinter(opts ...Option) *Printer
  • func (p *Printer) Out(secrets interface{}) error

Variables

var (

	// ErrInvalidFormat invalid output format.
	ErrInvalidFormat = errors.New("invalid format (valid options: base, yaml, json, export, markdown, template, policy)")
)

Functions

func Update

func Update(p *Printer, opts ...Option)

Update update printer applies the given options.

Types

type Option

type Option func(*Printer)

Option list of available options for modifying the output.

func CustomValueLength

func CustomValueLength(length int) Option

CustomValueLength option for trimming down the output of secrets.

func OnlyKeys

func OnlyKeys(b bool) Option

OnlyKeys flag for only showing secrets keys.

func OnlyPaths

func OnlyPaths(b bool) Option

OnlyPaths flag for only printing kv paths.

func ShowMetadata

func ShowMetadata(b bool) Option

ShowMetadata flag for unmasking secrets in output.

func ShowValues

func ShowValues(b bool) Option

ShowValues flag for displaying the secrets version.

func ShowVersion

func ShowVersion(b bool) Option

ShowVersion flag for unmasking secrets in output.

func ToFormat

func ToFormat(format OutputFormat) Option

ToFormat sets the output format of the printer.

func WithEnginePath

func WithEnginePath(path string) Option

func WithHyperLinks

func WithHyperLinks(b bool) Option

WithHyperLinks for enabling hyperlinks.

func WithTemplate

func WithTemplate(str, path string) Option

WithTemplate sets the template file.

func WithVaultClient

func WithVaultClient(v *vault.Vault) Option

WithVaultClient inject a vault client.

func WithWriter

func WithWriter(w io.Writer) Option

WithWriter option for passing a custom io.Writer.

type OutputFormat

type OutputFormat int

OutputFormat enum of valid output formats.

const (

	// MaxValueLength maximum length of passwords.
	MaxValueLength = 12

	// Base prints the secrets in the default format.
	Base OutputFormat = iota

	// YAML prints the secrets in yaml format.
	YAML

	// JSON prints the secrets in json format.
	JSON

	// Export prints the secrets in export (export "key=value") format.
	Export

	// Markdown prints the secrets in markdowntable format.
	Markdown

	// Template renders a given template string or file.
	Template

	// Policy displays the current token policy capabilities for each path in a matrix.
	Policy
)

type Printer

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

Printer struct that holds all options used for displaying the secrets.

func NewSecretPrinter

func NewSecretPrinter(opts ...Option) *Printer

NewPrinter return a new printer struct.

func (*Printer) Out

func (p *Printer) Out(secrets interface{}) error

Out prints out the secrets according all configured options. nolint: cyclop