ssh

Documentation

Index

• Constants
• func DeleteKeyPairFiles(files *KeyPairFiles) error
• func GenerateSSHKey(basePath string, keyName string) (*KeyPair, *KeyPairFiles, error)
• func NewClient(host, port, user string, k *KeyPairFiles) (*ssh.Client, *ssh.Session, error)
• type KeyPair
  • func NewKeyPair() (*KeyPair, error)
  • func (kp *KeyPair) WriteToFile(privateKeyPath string, publicKeyPath string) error
• type KeyPairFiles

Constants

const (
	DefaultPort = 22
)

Functions

func DeleteKeyPairFiles

func DeleteKeyPairFiles(files *KeyPairFiles) error

DeleteKeyPairFiles deletes the keypair files.

func GenerateSSHKey

func GenerateSSHKey(basePath string, keyName string) (*KeyPair, *KeyPairFiles, error)

GenerateSSHKey generates SSH keypair based on a base path.

func NewClient

func NewClient(host, port, user string, k *KeyPairFiles) (*ssh.Client, *ssh.Session, error)

NewClient creates a new SSH client and session.

Types

type KeyPair

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

KeyPair represents a private & public keypair.

func NewKeyPair

func NewKeyPair() (*KeyPair, error)

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

func (*KeyPair) WriteToFile

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

WriteToFile writes keypair to files.

type KeyPairFiles

type KeyPairFiles struct {
	PrivateKeyPath string `json:"publicKeyPath"`
	PublicKeyPath  string `json:"privateKeyPath"`
}

KeyPairFiles holds the paths to a private & public key files.