ssh

Documentation

Index

• Constants
• func Backend(conf *logical.BackendConfig) (*backend, error)
• func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)
• func SSHCommNew(address string, config *SSHCommConfig) (result *comm, err error)
• type SSHCommConfig

Constants

const (
	// KeyTypeOTP is an key of type OTP
	KeyTypeOTP = "otp"
	// KeyTypeDynamic is dynamic key type
	KeyTypeDynamic = "dynamic"
	// KeyTypeCA is an key of type CA
	KeyTypeCA = "ca"
)

const (
	// This is a constant representing a script to install and uninstall public
	// key in remote hosts.
	DefaultPublicKeyInstallScript = `` /* 2467-byte string literal not displayed */

)

const SecretDynamicKeyType = "secret_dynamic_key_type"

const SecretOTPType = "secret_otp_type"

Functions

func Backend

func Backend(conf *logical.BackendConfig) (*backend, error)

func Factory

func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error)

func SSHCommNew

func SSHCommNew(address string, config *SSHCommConfig) (result *comm, err error)

Creates a new communicator implementation over SSH. This takes an already existing TCP connection and SSH configuration.

Types

type SSHCommConfig

type SSHCommConfig struct {
	// The configuration of the Go SSH connection
	SSHConfig *ssh.ClientConfig

	// Connection returns a new connection. The current connection
	// in use will be closed as part of the Close method, or in the
	// case an error occurs.
	Connection func() (net.Conn, error)

	// Pty, if true, will request a pty from the remote end.
	Pty bool

	// DisableAgent, if true, will not forward the SSH agent.
	DisableAgent bool

	// Logger for output
	Logger log.Logger
}

SSHCommConfig is the structure used to configure the SSH communicator.