openssh

Documentation

Index

• func GetSystemSSHVersion() (*semver.Version, error)
• type SSHConfig
  • func NewSSHConfig(getSSHVersion func() (*semver.Version, error), log logrus.FieldLogger) *SSHConfig
  • func (c *SSHConfig) GetSSHConfig(sb *strings.Builder, config *SSHConfigParameters) error
• type SSHConfigApps
• type SSHConfigParameters

Functions

func GetSystemSSHVersion

func GetSystemSSHVersion() (*semver.Version, error)

GetSystemSSHVersion attempts to query the system SSH for its current version.

Types

type SSHConfig

type SSHConfig struct {
	// contains filtered or unexported fields
}

func NewSSHConfig

func NewSSHConfig(getSSHVersion func() (*semver.Version, error), log logrus.FieldLogger) *SSHConfig

NewSSHConfig creates a SSHConfig initialized with provided values or defaults otherwise.

func (*SSHConfig) GetSSHConfig

func (c *SSHConfig) GetSSHConfig(sb *strings.Builder, config *SSHConfigParameters) error

type SSHConfigApps

type SSHConfigApps string

SSHConfigApps represent apps that support ssh config generation.

const (
	TshApp  SSHConfigApps = teleport.ComponentTSH
	TbotApp SSHConfigApps = teleport.ComponentTBot
)

type SSHConfigParameters

type SSHConfigParameters struct {
	AppName             SSHConfigApps
	ClusterNames        []string
	KnownHostsPath      string
	IdentityFilePath    string
	CertificateFilePath string
	ProxyHost           string
	ProxyPort           string
	ExecutablePath      string
	Username            string
	DestinationDir      string
	// Port is the node port to use, defaulting to 3022, if not specified by flag
	Port int
}

SSHConfigParameters is a set of SSH related parameters used to generate ~/.ssh/config file.