ssh

Documentation

Index

• Constants
• Variables
• type AuthMethod
• type KeyboardInteractive
  • func (a *KeyboardInteractive) Name() string
  • func (a *KeyboardInteractive) String() string
• type Password
  • func (a *Password) Name() string
  • func (a *Password) String() string
• type PasswordCallback
  • func (a *PasswordCallback) Name() string
  • func (a *PasswordCallback) String() string
• type PublicKeys
  • func (a *PublicKeys) Name() string
  • func (a *PublicKeys) String() string
• type PublicKeysCallback
  • func NewSSHAgentAuth(user string) (*PublicKeysCallback, error)
  • func (a *PublicKeysCallback) Name() string
  • func (a *PublicKeysCallback) String() string

Constants

const (
	KeyboardInteractiveName = "ssh-keyboard-interactive"
	PasswordName            = "ssh-password"
	PasswordCallbackName    = "ssh-password-callback"
	PublicKeysName          = "ssh-public-keys"
	PublicKeysCallbackName  = "ssh-public-key-callback"
)

The names of the AuthMethod implementations. To be returned by the Name() method. Most git servers only allow PublicKeysName and PublicKeysCallbackName.

const DefaultSSHUsername = "git"

Variables

var DefaultClient = common.NewClient(&runner{})

DefaultClient is the default SSH client.

Types

type AuthMethod

type AuthMethod interface {
	// contains filtered or unexported methods
}

AuthMethod is the interface all auth methods for the ssh client must implement. The clientConfig method returns the ssh client configuration needed to establish an ssh connection.

type KeyboardInteractive

type KeyboardInteractive struct {
	User      string
	Challenge ssh.KeyboardInteractiveChallenge
}

KeyboardInteractive implements AuthMethod by using a prompt/response sequence controlled by the server.

func (*KeyboardInteractive) Name

func (a *KeyboardInteractive) Name() string

func (*KeyboardInteractive) String

func (a *KeyboardInteractive) String() string

type Password

type Password struct {
	User string
	Pass string
}

Password implements AuthMethod by using the given password.

func (*Password) Name

func (a *Password) Name() string

func (*Password) String

func (a *Password) String() string

type PasswordCallback

type PasswordCallback struct {
	User     string
	Callback func() (pass string, err error)
}

PasswordCallback implements AuthMethod by using a callback to fetch the password.

func (*PasswordCallback) Name

func (a *PasswordCallback) Name() string

func (*PasswordCallback) String

func (a *PasswordCallback) String() string

type PublicKeys

type PublicKeys struct {
	User   string
	Signer ssh.Signer
}

PublicKeys implements AuthMethod by using the given key pairs.

func (*PublicKeys) Name

func (a *PublicKeys) Name() string

func (*PublicKeys) String

func (a *PublicKeys) String() string

type PublicKeysCallback

type PublicKeysCallback struct {
	User     string
	Callback func() (signers []ssh.Signer, err error)
}

PublicKeysCallback implements AuthMethod by asking a ssh.agent.Agent to act as a signer.

func NewSSHAgentAuth

func NewSSHAgentAuth(user string) (*PublicKeysCallback, error)

Opens a pipe with the ssh agent and uses the pipe as the implementer of the public key callback function.

func (*PublicKeysCallback) Name

func (a *PublicKeysCallback) Name() string

func (*PublicKeysCallback) String

func (a *PublicKeysCallback) String() string