ssh

Documentation

Index

• Constants
• Variables
• func AuthKey(username string, auths []ssh.AuthMethod, keyCallBack ssh.HostKeyCallback) (ssh.ClientConfig, error)
• func PublicKey(file string) ssh.AuthMethod
• func PublicKeys(filenames []string) []ssh.AuthMethod
• func WithAgent(username string, keyCallBack ssh.HostKeyCallback) (ssh.ClientConfig, error)
• func WithKey(username string, path string, keyCallBack ssh.HostKeyCallback) (ssh.ClientConfig, error)
• func WithPassphrase(path string, passpharase []byte, username string, ...) (ssh.ClientConfig, error)
• func WithPassword(username string, password string, keyCallBack ssh.HostKeyCallback) (ssh.ClientConfig, error)
• type DirHeader
• type EndDirHeader
• type FileHeader
• type FileInfo
  • func (fi *FileInfo) CreateFile(opt *Option) (io.WriteCloser, error)
  • func (fi *FileInfo) Receive(opt *Option, src io.Reader) error
• type Header
• type Option
• type Path
• type Receiver
  • func (rf *Receiver) Do(reply io.Reader, ack io.Writer) (err error)
• type Reply
  • func ParseReply(reader io.Reader) (Reply, error)
  • func (r Reply) Error() string
  • func (r Reply) GetMessage() string
  • func (r Reply) IsError() bool
  • func (r Reply) IsFailure() bool
  • func (r Reply) IsOk() bool
  • func (r Reply) IsWarning() bool
  • func (r Reply) Parse() (interface{}, error)
• type ReplyType
  • func (rt ReplyType) String() string
• type Result
• type Scp
  • func NewScp(session *Session) *Scp
  • func (scp *Scp) Close()
  • func (scp *Scp) ReceiveFrom(opt *Option) error
  • func (scp *Scp) SendTo(id int, opt *Option) *Result
  • func (scp *Scp) SendToByReader(src io.Reader, size int64, opt *Option, remoteFilename string) error
  • func (scp *Scp) WithCmd(cmd string) *Scp
• type Sender
  • func (wf *Sender) Do(reply io.Reader, src io.Reader) (err error)
• type Session
  • func NewSession(host string, conf *ssh.ClientConfig) *Session
  • func (s *Session) Close()
  • func (s *Session) Connect() error
  • func (s *Session) Exec(id int, command string) *Result
• type Sftp
  • func NewSftp(session *Session) *Sftp
  • func (sf *Sftp) Exec(id int, localFilePath string, remoteFilePath string) *Result
• type TimeHeader

Constants

const KRemoteCmd = "scp"

Variables

var ErrAck = errors.New("failed to write ack buffer")

var ErrCopy = errors.New("failed to copy file")

Functions

func AuthKey

func AuthKey(username string, auths []ssh.AuthMethod, keyCallBack ssh.HostKeyCallback) (ssh.ClientConfig, error)

func PublicKey

func PublicKey(file string) ssh.AuthMethod

func PublicKeys

func PublicKeys(filenames []string) []ssh.AuthMethod

func WithAgent

func WithAgent(username string, keyCallBack ssh.HostKeyCallback) (ssh.ClientConfig, error)

func WithKey

func WithKey(username string, path string, keyCallBack ssh.HostKeyCallback) (ssh.ClientConfig, error)

func WithPassphrase

func WithPassphrase(path string, passpharase []byte, username string, keyCallBack ssh.HostKeyCallback) (ssh.ClientConfig, error)

func WithPassword

func WithPassword(username string, password string, keyCallBack ssh.HostKeyCallback) (ssh.ClientConfig, error)

Types

type DirHeader

type DirHeader struct {
	FileInfo
}

type EndDirHeader

type EndDirHeader struct {
}

type FileHeader

type FileHeader struct {
	FileInfo
}

type FileInfo

type FileInfo struct {
	Name string
	Size int64
	Mode os.FileMode
}

func (*FileInfo) CreateFile

func (fi *FileInfo) CreateFile(opt *Option) (io.WriteCloser, error)

func (*FileInfo) Receive

func (fi *FileInfo) Receive(opt *Option, src io.Reader) error

type Header

type Header struct {
	Type ReplyType
}

type Option

type Option struct {
	Cmd              string
	Local            Path
	Remote           Path
	UpdatePermission bool //-p 保留原文件的修改时间，访问时间和访问权限。
	Recursive        bool //-r
}

type Path

type Path struct {
	Mode  os.FileMode
	Name  string
	IsDir bool
}

type Receiver

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

func (*Receiver) Do

func (rf *Receiver) Do(reply io.Reader, ack io.Writer) (err error)

type Reply

type Reply struct {
	Type    ReplyType
	Message string
}

func ParseReply

func ParseReply(reader io.Reader) (Reply, error)

func (Reply) Error

func (r Reply) Error() string

func (Reply) GetMessage

func (r Reply) GetMessage() string

GetMessage returns the message the remote sent back.

func (Reply) IsError

func (r Reply) IsError() bool

IsError returns true when the remote responded with an error.

func (Reply) IsFailure

func (r Reply) IsFailure() bool

IsFailure returns true when the remote answered with a warning or an error.

func (Reply) IsOk

func (r Reply) IsOk() bool

func (Reply) IsWarning

func (r Reply) IsWarning() bool

func (Reply) Parse

func (r Reply) Parse() (interface{}, error)

type ReplyType

type ReplyType uint8

const (
	Ok      ReplyType = 0
	Warning ReplyType = 1
	Error   ReplyType = 2
)

func (ReplyType) String

func (rt ReplyType) String() string

type Result

type Result struct {
	Id         int
	Host       string
	Command    string
	LocalPath  string
	RemotePath string
	Result     string
	StartTime  time.Time
	EndTime    time.Time
	Error      error
}

type Scp

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

func NewScp

func NewScp(session *Session) *Scp

func (*Scp) Close

func (scp *Scp) Close()

func (*Scp) ReceiveFrom

func (scp *Scp) ReceiveFrom(opt *Option) error

func (*Scp) SendTo

func (scp *Scp) SendTo(id int, opt *Option) *Result

SendTo 上传

func (*Scp) SendToByReader

func (scp *Scp) SendToByReader(src io.Reader, size int64, opt *Option, remoteFilename string) error

func (*Scp) WithCmd

func (scp *Scp) WithCmd(cmd string) *Scp

type Sender

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

func (*Sender) Do

func (wf *Sender) Do(reply io.Reader, src io.Reader) (err error)

type Session

type Session struct {
	Host    string //ip:port
	Session *ssh.Session
	Client  *ssh.Client
	// contains filtered or unexported fields
}

func NewSession

func NewSession(host string, conf *ssh.ClientConfig) *Session

func (*Session) Close

func (s *Session) Close()

func (*Session) Connect

func (s *Session) Connect() error

func (*Session) Exec

func (s *Session) Exec(id int, command string) *Result

type Sftp

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

func NewSftp

func NewSftp(session *Session) *Sftp

func (*Sftp) Exec

func (sf *Sftp) Exec(id int, localFilePath string, remoteFilePath string) *Result

type TimeHeader

type TimeHeader struct {
	Mtime time.Time
	Atime time.Time
}