webssh
v1.6.2
一个简单的 Web 应用程序,用作 ssh 客户端来连接到 ssh 服务器。它是用Python编写的,基于tornado、paramiko和xterm.js。
+---------+ http +--------+ ssh +-----------+
| browser | <==========> | webssh | <=======> | ssh server|
+---------+ websocket +--------+ ssh +-----------+
pip install webssh
wssh
127.0.0.1:8888
# start a http server with specified listen address and listen port
wssh --address= ' 2.2.2.2 ' --port=8000
# start a https server, certfile and keyfile must be passed
wssh --certfile= ' /path/to/cert.crt ' --keyfile= ' /path/to/cert.key '
# missing host key policy
wssh --policy=reject
# logging level
wssh --logging=debug
# log to file
wssh --log-file-prefix=main.log
# more options
wssh --help
// connect to your ssh server
wssh . connect ( hostname , port , username , password , privatekey , passphrase , totp ) ;
// pass an object to wssh.connect
var opts = {
hostname : 'hostname' ,
port : 'port' ,
username : 'username' ,
password : 'password' ,
privatekey : 'the private key text' ,
passphrase : 'passphrase' ,
totp : 'totp'
} ;
wssh . connect ( opts ) ;
// without an argument, wssh will use the form data to connect
wssh . connect ( ) ;
// set a new encoding for client to use
wssh . set_encoding ( encoding ) ;
// reset encoding to use the default one
wssh . reset_encoding ( ) ;
// send a command to the server
wssh . send ( 'ls -l' ) ;
要使用自定义字体,请将字体文件放在目录webssh/static/css/fonts/
中并重新启动服务器。
支持通过 url(查询或片段)传递参数,如下例所示:
传递表单数据(密码必须采用base64编码,不支持私钥)
http://localhost:8888/ ? hostname=xx & username=yy & password=str_base64_encoded
传递终端背景颜色
http://localhost:8888/ # bgcolor=green
传递终端字体颜色
http://localhost:8888/ # fontcolor=red
传递用户定义的标题
http://localhost:8888/ ? title=my-ssh-server
传递编码
http://localhost:8888/ # encoding=gbk
传递字体大小
http://localhost:8888/ # fontsize=24
传递登录后立即执行的命令
http://localhost:8888/ ? command=pwd
传递终端类型
http://localhost:8888/ ? term=xterm-256color
启动应用程序
docker-compose up
拆掉应用程序
docker-compose down
要求
pip install pytest pytest-cov codecov flake8 mock
使用unittest运行所有测试
python -m unittest discover tests
使用 pytest 运行所有测试
python -m pytest tests
在 Nginx 服务器后面运行
wssh --address= ' 127.0.0.1 ' --port=8888 --policy=reject
# Nginx config example
location / {
proxy_pass http://127.0.0.1:8888;
proxy_http_version 1.1 ;
proxy_read_timeout 300 ;
proxy_set_header Upgrade $http_upgrade ;
proxy_set_header Connection "upgrade" ;
proxy_set_header Host $http_host ;
proxy_set_header X-Real-IP $remote_addr ;
proxy_set_header X-Real-PORT $remote_port ;
}
作为独立服务器运行
wssh --port=8080 --sslport=4433 --certfile= ' cert.crt ' --keyfile= ' cert.key ' --xheaders=False --policy=reject