cli

Documentation

Overview

Package cli provides the template for adding new cfssl commands

Index

• func PopFirstArgument(args []string) (string, []string, error)
• func PrintCRL(certList []byte)
• func PrintCert(key, csrBytes, cert []byte)
• func PrintOCSPResponse(resp []byte)
• func ReadStdin(filename string) ([]byte, error)
• func RootFromConfig(c *Config) universal.Root
• func Start(cmds map[string]*Command) error
• type Command
• type Config

Functions

func PopFirstArgument

func PopFirstArgument(args []string) (string, []string, error)

PopFirstArgument returns the first element and the rest of a string slice and return error if failed to do so. It is a helper function to parse non-flag arguments previously used in cfssl commands.

func PrintCRL

func PrintCRL(certList []byte)

PrintCRL outputs the CRL to stdout

func PrintCert

func PrintCert(key, csrBytes, cert []byte)

PrintCert outputs a cert, key and csr to stdout

func PrintOCSPResponse

func PrintOCSPResponse(resp []byte)

PrintOCSPResponse outputs an OCSP response to stdout ocspResponse is base64 encoded

func ReadStdin

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

ReadStdin reads from stdin if the file is "-"

func RootFromConfig

func RootFromConfig(c *Config) universal.Root

RootFromConfig returns a universal signer Root structure that can be used to produce a signer.

func Start

func Start(cmds map[string]*Command) error

Start is the entrance point of cfssl command line tools.

Types

type Command

type Command struct {
	// The Usage Text
	UsageText string
	// Flags to look up in the global table
	Flags []string
	// Main runs the command, args are the arguments after flags
	Main func(args []string, c Config) error
}

Command holds the implementation details of a cfssl command.

type Config

type Config struct {
	Hostname          string
	CertFile          string
	CSRFile           string
	CAFile            string
	CAKeyFile         string
	TLSCertFile       string
	TLSKeyFile        string
	MutualTLSCAFile   string
	MutualTLSCNRegex  string
	TLSRemoteCAs      string
	MutualTLSCertFile string
	MutualTLSKeyFile  string
	KeyFile           string
	IntermediatesFile string
	CABundleFile      string
	IntBundleFile     string
	Address           string
	Port              int
	Password          string
	ConfigFile        string
	CFG               *config.Config
	Profile           string
	IsCA              bool
	RenewCA           bool
	IntDir            string
	Flavor            string
	Metadata          string
	Domain            string
	IP                string
	Remote            string
	Label             string
	AuthKey           string
	ResponderFile     string
	ResponderKeyFile  string
	Status            string
	Reason            string
	RevokedAt         string
	Interval          time.Duration
	List              bool
	Family            string
	Timeout           time.Duration
	Scanner           string
	CSVFile           string
	NumWorkers        int
	MaxHosts          int
	Responses         string
	Path              string
	CRL               string
	Usage             string
	PGPPrivate        string
	PGPName           string
	Serial            string
	CNOverride        string
	AKI               string
	DBConfigFile      string
	CRLExpiration     time.Duration
}

Config is a type to hold flag values used by cfssl commands.