utils

Documentation

Index

• Constants
• Variables
• func AskForConfirmation(s string) bool
• func AskForSelectItem(s string, ss map[string]string) string
• func ConvertFlags(cmd *cobra.Command, fs []types.Flag) *pflag.FlagSet
• func ConvertToFields(obj interface{}) (map[string]schemas.Field, error)
• func EnsureFileExist(path, file string) error
• func EnsureFolderExist(path string) error
• func GenerateSSHKey(path string) error
• func GetSSHConfig(username, sshPrivateKeyString, passphrase, sshCert string, password string, ...) (*ssh.ClientConfig, error)
• func MergeConfig(source, target reflect.Value)
• func RandomToken(size int) (string, error)
• func RemoveSSHKey(path string) error
• func SSHCertificatePath(sshCertPath string) (string, error)
• func SSHPrivateKeyPath(sshKey string) (string, error)
• func StringSupportBase64(value string) string
• func UniqueArray(origin []string) (unique []string)
• func UserHome() string
• func ValidateRequiredFlags(flags *pflag.FlagSet)
• func WaitFor(fn func() (bool, error)) error
• type KeyPair
  • func NewKeyPair() (keyPair *KeyPair, err error)
  • func (kp *KeyPair) Fingerprint() string
  • func (kp *KeyPair) WriteToFile(privateKeyPath string, publicKeyPath string) error

Constants

const BashCompEnvVarFlag = "cobra_annotation_bash_env_var_flag"

BashCompEnvVarFlag cobra flag's annotation used for bind env to flag.

Variables

var (
	ErrKeyGeneration     = errors.New("unable to generate key")
	ErrValidation        = errors.New("unable to validate key")
	ErrPublicKey         = errors.New("unable to convert public key")
	ErrUnableToWriteFile = errors.New("unable to write file")
)

This file Borrowed from https://github.com/docker/machine/blob/master/libmachine/ssh/keys.go.

Functions

func AskForConfirmation

func AskForConfirmation(s string) bool

AskForConfirmation ask for confirmation form os.Stdin.

func AskForSelectItem

func AskForSelectItem(s string, ss map[string]string) string

AskForSelectItem ask for select item from the given map key.

func ConvertFlags

func ConvertFlags(cmd *cobra.Command, fs []types.Flag) *pflag.FlagSet

ConvertFlags change autok3s flags to FlagSet, will mark required annotation if possible.

func ConvertToFields

func ConvertToFields(obj interface{}) (map[string]schemas.Field, error)

ConvertToFields convert interface to schemas' field.

func EnsureFileExist

func EnsureFileExist(path, file string) error

EnsureFileExist ensures file exist.

func EnsureFolderExist

func EnsureFolderExist(path string) error

EnsureFolderExist ensures folder exist.

func GenerateSSHKey

func GenerateSSHKey(path string) error

GenerateSSHKey generates SSH keypair based on path of the private key The public key would be generated to the same path with ".pub" added.

func GetSSHConfig

func GetSSHConfig(username, sshPrivateKeyString, passphrase, sshCert string, password string, timeout time.Duration, useAgentAuth bool) (*ssh.ClientConfig, error)

GetSSHConfig generate ssh config.

func MergeConfig

func MergeConfig(source, target reflect.Value)

MergeConfig merge config.

func RandomToken

func RandomToken(size int) (string, error)

RandomToken generate random token.

func RemoveSSHKey

func RemoveSSHKey(path string) error

RemoveSSHKey delete SSH keypair based on path.

func SSHCertificatePath

func SSHCertificatePath(sshCertPath string) (string, error)

SSHCertificatePath returns ssh certificate key content from given path

func SSHPrivateKeyPath

func SSHPrivateKeyPath(sshKey string) (string, error)

SSHPrivateKeyPath returns ssh private key content from given path.

func StringSupportBase64

func StringSupportBase64(value string) string

func UniqueArray

func UniqueArray(origin []string) (unique []string)

UniqueArray returns unique array.

func UserHome

func UserHome() string

UserHome returns user's home dir.

func ValidateRequiredFlags

func ValidateRequiredFlags(flags *pflag.FlagSet)

ValidateRequiredFlags set `flag.Change` if the required flag has default value but not changed by flags.Set to pass the required check https://github.com/spf13/cobra/blob/v1.1.1/command.go#L1001

func WaitFor

func WaitFor(fn func() (bool, error)) error

WaitFor holds parameters applied to a Backoff function.

Types

type KeyPair

type KeyPair struct {
	PrivateKey []byte
	PublicKey  []byte
}

KeyPair struct for private/public key.

func NewKeyPair

func NewKeyPair() (keyPair *KeyPair, err error)

NewKeyPair generates a new SSH keypair This will return a private & public key encoded as DER.

func (*KeyPair) Fingerprint

func (kp *KeyPair) Fingerprint() string

Fingerprint calculates the fingerprint of the public key.

func (*KeyPair) WriteToFile

func (kp *KeyPair) WriteToFile(privateKeyPath string, publicKeyPath string) error

WriteToFile writes keypair to files.