utils

Documentation

Index

• Constants
• Variables
• func Fail(err error)
• func FileExists(path string) bool
• 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 ReadPasswordFromFile(filename string) ([]byte, error)
• func ReadString(r io.Reader) (string, error)
• func ReadStringPasswordFromFile(filename string) (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 FileExists

func FileExists(path string) bool

FileExists is a wrapper on os.Stat that returns false if os.Stat returns an error, it returns true otherwise. This method does not care if os.Stat returns any other kind of errors.

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 ReadAll

func ReadAll(r io.Reader) ([]byte, error)

ReadAll returns a slice of bytes with the content of the given reader.

func ReadFile

func ReadFile(name string) (b []byte, err error)

ReadFile returns the contents of the file identified by name. It reads from STDIN if name is a hyphen ("-").

func ReadInput

func ReadInput(prompt string) ([]byte, error)

ReadInput from stdin if something is detected or ask the user for an input using the given prompt.

func ReadPasswordFromFile

func ReadPasswordFromFile(filename string) ([]byte, error)

ReadPasswordFromFile reads and returns the password from the given filename. The contents of the file will be trimmed at the right.

func ReadString

func ReadString(r io.Reader) (string, error)

ReadString reads one line from the given io.Reader.

func ReadStringPasswordFromFile

func ReadStringPasswordFromFile(filename string) (string, error)

ReadStringPasswordFromFile reads and returns the password from the given filename. The contents of the file will be trimmed at the right.

func WriteFile

func WriteFile(filename string, data []byte, perm os.FileMode) error

WriteFile wraps ioutil.WriteFile with a prompt to overwrite a file if the file exists. It returns ErrFileExists if the user picks to not overwrite the file. If force is set to true, the prompt will not be presented and the file if exists will be overwritten.