secret

package

v0.0.0-...-59817e7 Latest Latest Go to latest Published: Mar 1, 2025 License: MIT Imports: 15 Imported by: 0

Details

Package secret provides utility functions for handling secrets.

View Source

const Secret = "Secret"

Secret is the type of a secret value.

This section is empty.

func PromptPassword(ctx context.Context, out io.Writer) (redact.Secret, error)

PromptPassword prompts a password input from stdin.

func PromptUsername(ctx context.Context, out io.Writer) (string, error)

PromptUsername prompts a username input from stdin.

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

Value implements ValueResolver.

func (v *Value) Get(ctx context.Context) (redact.Secret, error)

Get returns the value of the secret resolved from the secret source.

func (v *Value) Set(s string) error

Set parses a secret source into the source prefix and value.

func (v *Value) String() string

String returns the original secret source provided to Set().

func (v *Value) Type() string

Type returns the type of the pflag.Value, i.e. "Secret".

type ValueResolver interface {
	pflag.Value

	// Get returns the secret value.
	Get(context.Context) (redact.Secret, error)
}

ValueResolver extends pflag.Value with a secret value getter.