webssh

WebSSH

導入

SSH サーバーに接続するための SSH クライアントとして使用される単純な Web アプリケーション。これは、tornado、paramiko、xterm.js に基づいて Python で書かれています。

特徴

• SSH パスワード認証がサポートされています (空のパスワードを含む)。
• DSA RSA ECDSA Ed25519 キーを含む SSH 公開キー認証がサポートされています。
• 暗号化キーがサポートされています。
• 二要素認証（時間ベースのワンタイムパスワード）をサポートします。
• フルスクリーン端末がサポートされています。
• ターミナルウィンドウのサイズ変更可能。
• SSH サーバーのデフォルトのエンコーディングを自動検出します。
• Chrome、Firefox、Safari、Edge、Opera などの最新ブラウザがサポートされています。

プレビュー

仕組み

 +---------+     http     +--------+    ssh    +-----------+
| browser | <==========> | webssh | <=======> | ssh server|
+---------+   websocket  +--------+    ssh    +-----------+

要件

• Python 3.8+

クイックスタート

1. このアプリをインストールし、コマンドpip install websshを実行します
2. Webサーバーを起動し、 wsshコマンドを実行します。
3. ブラウザを開き、 127.0.0.1:8888に移動します。
4. データを入力し、フォームを送信します。

サーバーオプション

 # 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 引数

次の例のように、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 を使用する

アプリを起動する

 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

ヒント

• どのような展開を選択する場合でも、SSL を有効にすることを忘れないでください。
• デフォルトでは、パブリック ネットワークからのプレーン http リクエストはリダイレクトまたはブロックされ、リダイレクトされる方がブロックされるよりも優先されます。
• 検証済みの known_hosts とともに、不足しているホスト キー ポリシーとして拒否ポリシーを使用してみてください。これにより、中間者攻撃が防止されます。 SSH サーバーのホスト名が見つからない場合、またはキーが見つからない場合は、システム ホスト キー ファイル ("~/.ssh/known_hosts") とアプリケーション ホスト キー ファイル ("./known_hosts") を順番にチェックするという考えです。一致すると、接続は中止されます。