ssh

Documentation

Index

• Constants
• func ParseSSHVersion(version string) (int, int, error)
• func RequireSSHVersionAbove9_2(major, minor int) error
• type Client
  • func NewClient(cfg *Config, logger log.Logger, km *KeyManager) *Client
  • func (s *Client) Collect(ch chan<- prometheus.Metric)
  • func (s *Client) Describe(ch chan<- *prometheus.Desc)
  • func (s *Client) SSHFlagsFromConfig() ([]string, error)
• type Config
  • func DefaultConfig() *Config
  • func (cfg Config) KeyFileDir() string
  • func (cfg *Config) RegisterFlags(f *flag.FlagSet)
• type KeyManager
  • func NewKeyManager(cfg *Config, logger log.Logger, client pdc.Client) *KeyManager
  • func (km *KeyManager) CreateKeys(ctx context.Context, forceNewKeys bool) error
  • func (km *KeyManager) Start(ctx context.Context) error

Constants

const (
	// SSHKeySize is the size of the SSH key.
	SSHKeySize     = 4096
	KnownHostsFile = "grafana_pdc_known_hosts"
)

const (
	// The exit code sent by the pdc server when the connection limit is reached.
	ConnectionLimitReachedCode  = 254
	ConnectionAlreadyExistsCode = 253
)

Functions

func ParseSSHVersion

func ParseSSHVersion(version string) (int, int, error)

func RequireSSHVersionAbove9_2

func RequireSSHVersionAbove9_2(major, minor int) error

Types

type Client

type Client struct {
	*services.BasicService

	SSHCmd string // SSH command to run, defaults to "ssh". Require for testing.
	// contains filtered or unexported fields
}

Client is a client for ssh. It configures and runs ssh commands

func NewClient

func NewClient(cfg *Config, logger log.Logger, km *KeyManager) *Client

NewClient returns a new SSH client in an idle state

func (*Client) Collect

func (s *Client) Collect(ch chan<- prometheus.Metric)

func (*Client) Describe

func (s *Client) Describe(ch chan<- *prometheus.Desc)

func (*Client) SSHFlagsFromConfig

func (s *Client) SSHFlagsFromConfig() ([]string, error)

SSHFlagsFromConfig generates the array of flags to pass to the ssh command. It does not stop default flags from being overidden, but only the first instance of `-o` flags are used.

type Config

type Config struct {
	Args []string // deprecated

	KeyFile           string
	SSHFlags          []string // Additional flags to be passed to ssh(1). e.g. --ssh-flag="-vvv" --ssh-flag="-L 80:localhost:80"
	Port              int
	LogLevel          string
	PDC               pdc.Config
	LegacyMode        bool
	SkipSSHValidation bool
	// ForceKeyFileOverwrite forces a new ssh key pair to be generated.
	ForceKeyFileOverwrite bool
	// CertExpiryWindow is the time before the certificate expires to renew it.
	CertExpiryWindow time.Duration
	// CertCheckCertExpiryPeriod is how often to check that the current certificate
	// is valid and regenerate it if necessary.
	CertCheckCertExpiryPeriod time.Duration
	URL                       *url.URL

	// MetricsAddr is the port to expose metrics on
	MetricsAddr  string
	ParseMetrics bool

	// Used for local development.
	// DevPort is the port number for the PDC gateway
	DevPort int
}

Config represents all configurable properties of the ssh package.

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns a Config with some sensible defaults set

func (Config) KeyFileDir

func (cfg Config) KeyFileDir() string

func (*Config) RegisterFlags

func (cfg *Config) RegisterFlags(f *flag.FlagSet)

type KeyManager

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

TODO KeyManager implements KeyManager. If needed, it gets new certificates signed by the PDC API.

If the service starts successfully, then the key and cert files will exist. It will attempt to reuse existing keys and certs if they exist.

func NewKeyManager

func NewKeyManager(cfg *Config, logger log.Logger, client pdc.Client) *KeyManager

NewKeyManager returns a new KeyManager in an idle state

func (*KeyManager) CreateKeys

func (km *KeyManager) CreateKeys(ctx context.Context, forceNewKeys bool) error

CreateKeys checks that the SSH public key, private key, certificate and known_hosts files for existence and validity, and generates new ones if required.

func (*KeyManager) Start

func (km *KeyManager) Start(ctx context.Context) error

Start ensures valid keys and certs exist, and optionally starts a background certificate refresh goroutine.