Documentation ¶
Index ¶
- Constants
- Variables
- func Fail(err error)
- func GetKeyDetailsFromCLI(ctx *cli.Context, insecure bool, ktyKey, curveKey, sizeKey string) (string, string, int, error)
- func ReadAll(r io.Reader) ([]byte, error)
- func ReadFile(name string) (b []byte, err error)
- func ReadInput(prompt string) ([]byte, error)
- func ReadPassword(prompt string) ([]byte, error)
- func ReadPasswordGenerate(prompt string) ([]byte, error)
- func ReadString(r io.Reader) (string, error)
- func WriteFile(filename string, data []byte, perm os.FileMode) error
Constants ¶
const DefaultECCurve = "P-256"
DefaultECCurve sets the default curve for EC to P-256.
const DefaultRSASize = 2048
DefaultRSASize sets the default key size for RSA to 2048 bits.
Variables ¶
var ( // ErrFileExists is the error returned if a file exists. ErrFileExists = errors.New("file exists") // ErrIsDir is the error returned if the file is a directory. ErrIsDir = errors.New("file is a directory") )
Functions ¶
func Fail ¶
func Fail(err error)
Fail prints out the error struct if STEPDEBUG is true otherwise it just prints out the error message. Finally, it exits with an error code of 1.
func GetKeyDetailsFromCLI ¶
func GetKeyDetailsFromCLI(ctx *cli.Context, insecure bool, ktyKey, curveKey, sizeKey string) (string, string, int, error)
GetKeyDetailsFromCLI gets the key pair algorithm, curve, and size inputs from the CLI context.
func ReadFile ¶ added in v0.8.4
ReadFile returns the contents of the file identified by name. It reads from STDIN if name is a hyphen ("-").
func ReadInput ¶
ReadInput from stdin if something is detected or ask the user for an input using the given prompt.
func ReadPassword ¶
ReadPassword asks the user for a password using the given prompt. If the program is receiving data from STDIN using a pipe, we cannot use terminal.ReadPassword on STDIN and we need to open the tty and read from it.
This solution works on darwin and linux, but it might not work on other OSs.
func ReadPasswordGenerate ¶
ReadPasswordGenerate asks the user for a password using the given prompt. **Do Not** use this method from within another script. It may print a generated password to stdout. Instead use ReadPassword.
This solution works on darwin and linux, but it might not work on other OSs.
func ReadString ¶
ReadString reads one line from the given io.Reader.
Types ¶
This section is empty.