utils

Documentation

Index

• Constants
• Variables
• func AppendNewLine(filename string, data []byte, perm os.FileMode) error
• func CompleteURL(rawurl string) (string, error)
• 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
• func WriteSnippet(filename string, data []byte, perm os.FileMode) error
• type File
  • func OpenFile(name string, flag int, perm os.FileMode) (*File, error)
  • func (f *File) Close() error
  • func (f *File) Read(b []byte) (n int, err error)
  • func (f *File) ReadAt(b []byte, off int64) (n int, err error)
  • func (f *File) Seek(offset int64, whence int) (ret int64, err error)
  • func (f *File) Write(b []byte) (n int, err error)
  • func (f *File) WriteAt(b []byte, off int64) (n int, err error)
  • func (f *File) WriteString(s string) (n int, err 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")

	// SnippetHeader is the header of a step generated snippet in a
	// configuration file.
	SnippetHeader = "# autogenerated by step"

	// SnippetFooter is the header of a step generated snippet in a
	// configuration file.
	SnippetFooter = "# end"
)

Functions

func AppendNewLine

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

AppendNewLine appends the given data at the end of the file. If the last character of the file does not contain an LF it prepends it to the data.

func CompleteURL

func CompleteURL(rawurl string) (string, error)

CompleteURL parses and validates the given URL. It supports general URLs like https://ca.smallstep.com[:port][/path], and incomplete URLs like ca.smallstep.com[:port][/path].

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 os.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.

func WriteSnippet

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

WriteSnippet writes the given data on the given filename. It surrounds the data with a header and footer, and it will replace the previous one.

Types

type File

type File struct {
	File *os.File
	// contains filtered or unexported fields
}

File represents a wrapper on os.File that supports read, write, seek and close methods, but they won't be called if an error occurred before.

func OpenFile

func OpenFile(name string, flag int, perm os.FileMode) (*File, error)

OpenFile calls os.OpenFile method and returns the os.File wrapped.

func (*File) Close

func (f *File) Close() error

Close wraps `func (*os.File) Close` it will always call Close but the error return will be the first error thrown if any.

func (*File) Read

func (f *File) Read(b []byte) (n int, err error)

Read wraps `func (*os.File) Read` but doesn't perform the operation if a previous error was thrown.

func (*File) ReadAt

func (f *File) ReadAt(b []byte, off int64) (n int, err error)

ReadAt wraps `func (*os.File) ReadAt` but doesn't perform the operation if a previous error was thrown.

func (*File) Seek

func (f *File) Seek(offset int64, whence int) (ret int64, err error)

Seek wraps `func (*os.File) Seek` but doesn't perform the operation if a previous error was thrown.

func (*File) Write

func (f *File) Write(b []byte) (n int, err error)

Write wraps `func (*os.File) Write` but doesn't perform the operation if a previous error was thrown.

func (*File) WriteAt

func (f *File) WriteAt(b []byte, off int64) (n int, err error)

WriteAt wraps `func (*os.File) WriteAt` but doesn't perform the operation if a previous error was thrown.

func (*File) WriteString

func (f *File) WriteString(s string) (n int, err error)

WriteString wraps `func (*os.File) WriteString` but doesn't perform the operation if a previous error was thrown.