prompter

Documentation

Index

• func Choose(pr string, options []string) int
• func ChooseWithDefault(pr string, defaultValue string, options []string) (string, error)
• func Display(pr string)
• func ParseResults(pinEntryOutput io.Reader) (output string, err error)
• func Password(pr string) string
• func RequestSecurityCode(pattern string) string
• func SetOutputWriter(writer survey_terminal.FileWriter)
• func SetPrompter(prmpt Prompter)
• func String(pr string, defaultValue string) string
• func StringRequired(pr string) string
• func ValidateAndSetPrompter(prmptCfg string) error
• type CliPrompter
  • func NewCli() *CliPrompter
  • func (cli *CliPrompter) Choose(pr string, options []string) int
  • func (cli *CliPrompter) ChooseWithDefault(pr string, defaultValue string, options []string) (string, error)
  • func (cli *CliPrompter) Display(pr string)
  • func (cli *CliPrompter) Password(pr string) string
  • func (cli *CliPrompter) RequestSecurityCode(pattern string) string
  • func (cli *CliPrompter) String(pr string, defaultValue string) string
  • func (cli *CliPrompter) StringRequired(pr string) string
• type PinentryPrompter
  • func NewPinentryPrompter(bin string) *PinentryPrompter
  • func (p *PinentryPrompter) Choose(pr string, options []string) int
  • func (p *PinentryPrompter) ChooseWithDefault(prompt string, def string, choices []string) (string, error)
  • func (p *PinentryPrompter) Display(pr string)
  • func (p *PinentryPrompter) Password(pr string) string
  • func (p *PinentryPrompter) RequestSecurityCode(pattern string) (output string)
  • func (p *PinentryPrompter) String(pr string, defaultValue string) string
  • func (p *PinentryPrompter) StringRequired(pr string) string
• type PinentryRunner
• type Prompter
• type RealPinentryRunner
  • func NewRealPinentryRunner(bin string) *RealPinentryRunner
  • func (r *RealPinentryRunner) Run(command string) (output string, err error)

Functions

func Choose

func Choose(pr string, options []string) int

Choose given the choice return the option selected

func ChooseWithDefault

func ChooseWithDefault(pr string, defaultValue string, options []string) (string, error)

ChooseWithDefault given the choice return the option selected with a default

func Display

func Display(pr string)

Display prompt, no user input required

func ParseResults

func ParseResults(pinEntryOutput io.Reader) (output string, err error)

ParseResults parses the standard output of the pinentry command and determine the user input, or wheter the program yielded any error

func Password

func Password(pr string) string

Password prompt for password which is required

func RequestSecurityCode

func RequestSecurityCode(pattern string) string

RequestSecurityCode request a security code to be entered by the user

func SetOutputWriter

func SetOutputWriter(writer survey_terminal.FileWriter)

SetOutputWriter sets the output writer to use for all survey operations

func SetPrompter

func SetPrompter(prmpt Prompter)

SetPrompter configure an aternate prompter to the default one

func String

func String(pr string, defaultValue string) string

String prompt for string which is required

func StringRequired

func StringRequired(pr string) string

StringRequired prompt for string which is required

func ValidateAndSetPrompter

func ValidateAndSetPrompter(prmptCfg string) error

ValidateAndSetPrompter validates the user configuration and will create a concrete prompter based on this configuration

Types

type CliPrompter

type CliPrompter struct {
}

CliPrompter used to prompt for cli input

func NewCli

func NewCli() *CliPrompter

NewCli builds a new cli prompter

func (*CliPrompter) Choose

func (cli *CliPrompter) Choose(pr string, options []string) int

Choose given the choice return the option selected

func (*CliPrompter) ChooseWithDefault

func (cli *CliPrompter) ChooseWithDefault(pr string, defaultValue string, options []string) (string, error)

ChooseWithDefault given the choice return the option selected with a default

func (*CliPrompter) Display

func (cli *CliPrompter) Display(pr string)

func (*CliPrompter) Password

func (cli *CliPrompter) Password(pr string) string

Password prompt for password which is required

func (*CliPrompter) RequestSecurityCode

func (cli *CliPrompter) RequestSecurityCode(pattern string) string

RequestSecurityCode request a security code to be entered by the user

func (*CliPrompter) String

func (cli *CliPrompter) String(pr string, defaultValue string) string

String prompt for string with a default

func (*CliPrompter) StringRequired

func (cli *CliPrompter) StringRequired(pr string) string

StringRequired prompt for string which is required

type PinentryPrompter

type PinentryPrompter struct {
	Runner          PinentryRunner
	DefaultPrompter Prompter
}

PinentryPrompter is a concrete implementation of the Prompter interface. It uses the default Cli under the hood, except for RequestSecurityCode, where it uses any _pinentry_ binary to capture the security code. Its purpose is mainly to capture the TOTP code outside of the TTY, and thus making it possible to use TOTP with the credential process. https://github.com/Versent/saml2aws#using-saml2aws-as-credential-process

func NewPinentryPrompter

func NewPinentryPrompter(bin string) *PinentryPrompter

NewPinentryPrompter is a factory for PinentryPrompter

func (*PinentryPrompter) Choose

func (p *PinentryPrompter) Choose(pr string, options []string) int

Choose is running the default CLI Choose

func (*PinentryPrompter) ChooseWithDefault

func (p *PinentryPrompter) ChooseWithDefault(prompt string, def string, choices []string) (string, error)

ChooseWithDefault is running the default CLI ChooseWithDefault

func (*PinentryPrompter) Display

func (p *PinentryPrompter) Display(pr string)

Display is runniner the default Cli Display

func (*PinentryPrompter) Password

func (p *PinentryPrompter) Password(pr string) string

Password is runniner the default Cli Password

func (*PinentryPrompter) RequestSecurityCode

func (p *PinentryPrompter) RequestSecurityCode(pattern string) (output string)

RequestSecurityCode for PinentryPrompter is creating a query for pinentry and sends it to the pinentry bin.

func (*PinentryPrompter) String

func (p *PinentryPrompter) String(pr string, defaultValue string) string

String is runniner the default Cli String

func (*PinentryPrompter) StringRequired

func (p *PinentryPrompter) StringRequired(pr string) string

StringRequired is runniner the default Cli StringRequired

type PinentryRunner

type PinentryRunner interface {
	Run(string) (string, error)
}

PinentryRunner is the interface for pinentry to run itself

type Prompter

type Prompter interface {
	RequestSecurityCode(string) string
	ChooseWithDefault(string, string, []string) (string, error)
	Choose(string, []string) int
	StringRequired(string) string
	String(string, string) string
	Password(string) string
	Display(string)
}

Prompter handles prompting user for input

var ActivePrompter Prompter = NewCli()

ActivePrompter is by default the survey cli prompter

type RealPinentryRunner

type RealPinentryRunner struct {
	PinentryBin string
}

RealPinentryRunner is the concrete implementation of PinentryRunner

func NewRealPinentryRunner

func NewRealPinentryRunner(bin string) *RealPinentryRunner

NewRealPinentryRunner is a factory for RealPinentryRunner

func (*RealPinentryRunner) Run

func (r *RealPinentryRunner) Run(command string) (output string, err error)

Run wraps a pinentry run. It sends the query to pinentry via stdin and reads its stdout to determine the user PIN. Pinentry uses an Assuan protocol