gowebssh

README

说明

使用 github.com/gorilla/websocket 与 golang.org/x/crypto/ssh 实现的 webssh，支持颜色以及自动补全

参考：https://github.com/myml/webssh 实现，原项目只实现了 password 登陆，本项目新增 publickey 登陆，并新增 zmodem 支持

服务器端文档

快速开始

...
import (
    ...

    "github.com/gorilla/websocket"
    "github.com/leffss/gowebssh"
)
...
id := r.Header.Get("Sec-WebSocket-Key")
webssh := gowebssh.NewWebSSH()
webssh.SetTerm(gowebssh.TermLinux)
webssh.SetBuffSize(8192)
webssh.SetId(id)
webssh.SetConnTimeOut(15 * time.Second)
...
upGrader := websocket.Upgrader{
    CheckOrigin: func(r *http.Request) bool {
        return true
    },
    Subprotocols: []string{r.Header.Get("Sec-WebSocket-Protocol")},
    ReadBufferSize: 8192,
    WriteBufferSize: 8192,
}
ws, _ := upGrader.Upgrade(w, r, nil)
webssh.AddWebsocket(ws)

客户端文档

消息类型

type messageType string

const (
	messageTypeAddr		 = "addr"
	messageTypeTerm     = "term"
	messageTypeLogin     = "login"
	messageTypePassword  = "password"
	messageTypePublickey = "publickey"
	messageTypeStdin     = "stdin"
	messageTypeStdout    = "stdout"
	messageTypeStderr    = "stderr"
	messageTypeResize    = "resize"
    messageTypeIgnore    = "ignore"
)

type message struct {
	Type messageType `json:"type"`
	Data []byte      `json:"data"`
	Cols int         `json:"cols,omitempty"`
	Rows int         `json:"rows,omitempty"`
}

消息协议

1. 地址 {type:"addr",data:"$addr"}
   地址格式： ip:port，例如 192.168.223.111:22
2. 登录 {type:"login",data:"$username"}
3. 设置 term 终端类型 {type:"term",data:"$term"} # 可不设置，默认 xterm
4. 验证 {type:"password",data:"$password"} or {type:"publickey",data:"$publickey"}
5. 窗口大小调整 {type:"resize",cols:40,rows:80}
6. 忽略数据流 {type:"ignore",data:"$data"} # 客户端发送到服务端，服务器忽略，主要用于 zmodem 文件传输记录
7. 标准流数据
   {type:"stdin",data:"$data"} {type:"stdout",data:"$data"} {type:"stderr",data:"$data"}
   客户端发送 stdin, 接收 stdout, stderr

Data 数据

消息的 data 数据使用 base64 编码传输，JavaScript 的atob & btoa可用于 base64 编码，但对 utf8 有兼容性问题，要使用decodeURIComponent & encodeURIComponent做包裹, 以下是实现

function atou(encodeString) {
  return decodeURIComponent(escape(atob(encodeString)));
}

function utoa(rawString) {
  return btoa(encodeURIComponent(rawString));
}

实例

具体实例参考 example 文件夹

预览

Documentation

Index

• Constants
• Variables
• type WebSSH
  • func NewWebSSH() *WebSSH
  • func (ws *WebSSH) AddSSHConn(conn net.Conn)
  • func (ws *WebSSH) AddWebsocket(conn *websocket.Conn)
  • func (ws *WebSSH) SetBuffSize(buffSize uint32)
  • func (ws *WebSSH) SetConnTimeOut(connTimeout time.Duration)
  • func (ws *WebSSH) SetId(id string)
  • func (ws *WebSSH) SetLogOut(out io.Writer)
  • func (ws *WebSSH) SetLogger(logger *log.Logger)
  • func (ws *WebSSH) SetTerm(term string)

Constants

const (
	TermLinux         = "linux"
	TermAnsi          = "ansi"
	TermScoAnsi       = "scoansi"
	TermXterm         = "xterm"
	TermXterm256Color = "xterm-256color"
	TermVt100         = "vt100"
	TermVt102         = "vt102"
	TermVt220         = "vt220"
	TermVt320         = "vt320"
	TermWyse50        = "wyse50"
	TermWyse60        = "wyse60"
	TermDumb          = "dumb"
)

Variables

var (
	DefaultTerm        = TermXterm
	DefaultConnTimeout = 30 * time.Second
	DefaultLogger      = log.New(ioutil.Discard, "[webssh] ", log.Ltime|log.Ldate)
	DefaultBuffSize    = uint32(1024)
)

var (
	// sz 下载文件
	ZModemSzStart = fmt.Sprintf("%+q", "rz\r**\x18B00000000000000\r\x8a\x11")
	ZModemSzEnd   = fmt.Sprintf("%+q", "\r**\x18B0800000000022d\r\x8a")
	// 经过测试发现不一定会出现，就是两个大写的字母 OO
	//ZModemSzEnd2 = fmt.Sprintf("%+q", "OO")
	ZModemSzEndOO = []byte{79, 79}

	// rz 上传文件
	ZModemRzStart   = fmt.Sprintf("%+q", "rz waiting to receive.**\x18B0100000023be50\r\x8a\x11")
	ZModemRzEStart  = fmt.Sprintf("%+q", "rz waiting to receive.**\x18B0100000063f694\r\x8a\x11") // rz -e
	ZModemRzSStart  = fmt.Sprintf("%+q", "rz waiting to receive.**\x18B0100000223d832\r\x8a\x11") // rz -S
	ZModemRzQStart  = fmt.Sprintf("%+q", "**\x18B0100000023be50\r\x8a\x11")                       // rz -q
	ZModemRzQEStart = fmt.Sprintf("%+q", "**\x18B0100000063f694\r\x8a\x11")                       // rz -q -e
	ZModemRzQSStart = fmt.Sprintf("%+q", "**\x18B0100000223d832\r\x8a\x11")                       // rz -q -S
	ZModemRzEnd     = fmt.Sprintf("%+q", "**\x18B0800000000022d\r\x8a")

	// zmodem 取消 \x18\x18\x18\x18\x18\x08\x08\x08\x08\x08，使用 %+q 的形式无法正确使用 strings.Index 处理
	ZModemCancel = string([]byte{24, 24, 24, 24, 24, 8, 8, 8, 8, 8})
)

Types

type WebSSH

type WebSSH struct {
	ZModemOO, ZModem bool
	// contains filtered or unexported fields
}

WebSSH 管理 Websocket 和 ssh 连接

func NewWebSSH

func NewWebSSH() *WebSSH

WebSSH 构造函数

func (*WebSSH) AddSSHConn

func (ws *WebSSH) AddSSHConn(conn net.Conn)

添加 ssh 连接

func (*WebSSH) AddWebsocket

func (ws *WebSSH) AddWebsocket(conn *websocket.Conn)

添加 websocket 连接

func (*WebSSH) SetBuffSize

func (ws *WebSSH) SetBuffSize(buffSize uint32)

设置 buff 大小

func (*WebSSH) SetConnTimeOut

func (ws *WebSSH) SetConnTimeOut(connTimeout time.Duration)

设置连接超时时间

func (*WebSSH) SetId

func (ws *WebSSH) SetId(id string)

设置连接 id

func (*WebSSH) SetLogOut

func (ws *WebSSH) SetLogOut(out io.Writer)

设置日志输出

func (*WebSSH) SetLogger

func (ws *WebSSH) SetLogger(logger *log.Logger)

func (*WebSSH) SetTerm

func (ws *WebSSH) SetTerm(term string)

设置终端 term 类型