ssh

type Config struct {
	log.LoggerInjectable `yaml:"-" json:"-"`
	Address              string           `` /* 147-byte string literal not displayed */
	User                 string           `` /* 136-byte string literal not displayed */
	Port                 int              `` /* 154-byte string literal not displayed */
	KeyPath              *string          `yaml:"keyPath,omitempty" json:"keyPath,omitempty" validate:"omitempty" jsonschema:"description=Path to SSH private key"`
	Bastion              *Config          `yaml:"bastion,omitempty" json:"bastion,omitempty" jsonschema:"description=Optional bastion host"`
	PasswordCallback     PasswordCallback `yaml:"-" json:"-"`

	// SSHConfigOptions provides supplementary ssh_config options that fill gaps not
	// covered by the native fields above. They take priority over ~/.ssh/config but
	// yield to any native field that is explicitly set. Keys are ssh_config directive
	// names (case-insensitive), e.g. {"Ciphers": "aes128-ctr", "StrictHostKeyChecking": false}.
	// Booleans are accepted for options that take yes/no values. Only options that rig
	// reads from the config are acted upon; others are stored but silently ignored at
	// connection time. An unknown key name is an error.
	// See docs/ssh-config-precedence.md for the full precedence rules.
	// YAML key: options.
	SSHConfigOptions sshconfig.OptionArguments `` /* 127-byte string literal not displayed */

	// IgnoreSSHConfig disables reading the OpenSSH client configuration files
	// (~/.ssh/config and the system-wide ssh_config) when setting up this
	// connection, mirroring "ssh -F none". OpenSSH's built-in defaults and any
	// SSHConfigOptions given above are still applied, so only file-derived
	// settings are dropped.
	//
	// Use this to opt out when a config file cannot be parsed or contains
	// directives that should not influence rig. The setting is inherited by the
	// bastion connection.
	// YAML key: ignoreSSHConfig.
	IgnoreSSHConfig bool `` /* 155-byte string literal not displayed */

	// AuthMethods can be used to pass in a list of crypto/ssh.AuthMethod objects
	// for example to use a private key from memory:
	//   ssh.PublicKeys(privateKey)
	// For convenience, you can use ParseSSHPrivateKey() to parse a private key:
	//   authMethods, err := ssh.ParseSSHPrivateKey(key, rig.DefaultPassphraseCallback)
	AuthMethods []ssh.AuthMethod `yaml:"-" json:"-"`
}

type Connection struct {
	log.LoggerInjectable `yaml:"-"`
	Config               `yaml:",inline"`
	// contains filtered or unexported fields
}

type Option func(*Options)

type Options struct {
	log.LoggerInjectable
	KeepAliveInterval *time.Duration
	IgnoreSSHConfig   bool
}

type PasswordCallback func() (secret string, err error)