ssh

Documentation

Index

• type Client
  • func NewSshClient() *Client
  • func NewSshClientKey(username string, rsaKeyPair RsaKeyPair, host string) *Client
  • func (p *Client) Execute(command string) (ExecutionResult, error)
  • func (p *Client) Executef(command string, a ...any) (ExecutionResult, error)
  • func (p *Client) SetConnectionData(username string, password string, host string)
• type CryptoBytes
  • func (c CryptoBytes) MarshalYAML() (interface{}, error)
  • func (c *CryptoBytes) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ExecutionError
  • func (e *ExecutionError) ToError() error
• type ExecutionResult
  • func (r *ExecutionResult) Code() int
  • func (r *ExecutionResult) Error() error
  • func (r ExecutionResult) IsError() bool
• type RsaKeyPair
  • func GenerateRsaKeyPair() (RsaKeyPair, error)
  • func (r *RsaKeyPair) Empty() bool

Types

type Client

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

func NewSshClient

func NewSshClient() *Client

func NewSshClientKey

func NewSshClientKey(username string, rsaKeyPair RsaKeyPair, host string) *Client

func (*Client) Execute

func (p *Client) Execute(command string) (ExecutionResult, error)

func (*Client) Executef

func (p *Client) Executef(command string, a ...any) (ExecutionResult, error)

func (*Client) SetConnectionData

func (p *Client) SetConnectionData(username string, password string, host string)

type CryptoBytes

type CryptoBytes []byte

func (CryptoBytes) MarshalYAML

func (c CryptoBytes) MarshalYAML() (interface{}, error)

func (*CryptoBytes) UnmarshalYAML

func (c *CryptoBytes) UnmarshalYAML(unmarshal func(interface{}) error) error

type ExecutionError

type ExecutionError struct {
	Output string
	Code   int
}

func (*ExecutionError) ToError

func (e *ExecutionError) ToError() error

type ExecutionResult

type ExecutionResult struct {
	Output string
	// contains filtered or unexported fields
}

func (*ExecutionResult) Code

func (r *ExecutionResult) Code() int

func (*ExecutionResult) Error

func (r *ExecutionResult) Error() error

func (ExecutionResult) IsError

func (r ExecutionResult) IsError() bool

type RsaKeyPair

type RsaKeyPair struct {
	PrivateKey CryptoBytes `json:"privateKey" yaml:"privateKey"`
	PublicKey  CryptoBytes `json:"publicKey" yaml:"publicKey"`
}

func GenerateRsaKeyPair

func GenerateRsaKeyPair() (RsaKeyPair, error)

func (*RsaKeyPair) Empty

func (r *RsaKeyPair) Empty() bool