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 (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" // configuration file. SnippetFooter = "# end" )
Functions ¶
func AppendNewLine ¶ added in v0.14.0
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 ¶ added in v0.18.0
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 ¶ added in v0.9.0
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 ReadFile ¶ added in v0.8.1
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 ReadPasswordFromFile ¶ added in v0.8.1
ReadPasswordFromFile reads and returns the password from the given filename. The contents of the file will be trimmed at the right.
func ReadString ¶
ReadString reads one line from the given io.Reader.
func ReadStringPasswordFromFile ¶ added in v0.8.4
ReadStringPasswordFromFile reads and returns the password from the given filename. The contents of the file will be trimmed at the right.
Types ¶
type File ¶ added in v0.14.0
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 (*File) Close ¶ added in v0.14.0
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 ¶ added in v0.14.0
Read wraps `func (*os.File) Read` but doesn't perform the operation if a previous error was thrown.
func (*File) ReadAt ¶ added in v0.14.0
ReadAt wraps `func (*os.File) ReadAt` but doesn't perform the operation if a previous error was thrown.
func (*File) Seek ¶ added in v0.14.0
Seek wraps `func (*os.File) Seek` but doesn't perform the operation if a previous error was thrown.
func (*File) Write ¶ added in v0.14.0
Write wraps `func (*os.File) Write` but doesn't perform the operation if a previous error was thrown.
Source Files
Directories