Django實現WebSSH操做物理機或虛擬機

時間 2019-11-06

原文原文鏈接

我想用它替換掉xshell、crt之類的工具前端

WebSSH操做物理機或虛擬機

Django實現WebSSH操做Kubernetes Pod文章發佈後，有小夥伴說咖啡哥，咱們如今尚未用上Kubernetes，但我想經過瀏覽器鏈接咱們的物理機和虛擬機該怎麼辦？web

這就比較簡單了，既然咱們已經實現了瀏覽器操做Kubernetes的Pod，那麼想一想操做Pod和物理機虛擬機有什麼區別呢？shell

整個數據流是一點沒變：用戶打開瀏覽器--》瀏覽器發送websocket請求給Django創建長鏈接--》Django與要操做的服務器創建SSH通道，實時的將收到的用戶數據發送給SSH後的主機，並將主機執行的結果數據返回給瀏覽器數據庫

惟一不同的地方就是Django與要操做的服務器創建SSH通道的方式，在Kubernetes中是經過Kubernetes提供的API創建的Stream流，而操做物理機或者虛擬機的時候咱們可使用Paramiko模塊來創建SSH長鏈接隧道，Paramiko模塊創建SSH長鏈接通道的方法以下：json

# 實例化SSHClient
ssh = paramiko.SSHClient()

# 當遠程服務器沒有本地主機的密鑰時自動添加到本地，這樣不用在創建鏈接的時候輸入yes或no進行確認
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())

# 鏈接SSH服務器，這裏以帳號密碼的方式進行認證，也能夠用key
ssh.connect(hostname=host, port=port, username=username, password=password, timeout=8)

# 打開ssh通道，創建長鏈接
transport = ssh.get_transport()
self.ssh_channel = transport.open_session()

# 獲取ssh通道，並設置term和終端大小
self.ssh_channel.get_pty(term=term, width=cols, height=rows)

# 激活終端，這樣就能夠正常登錄了
self.ssh_channel.invoke_shell()
複製代碼

鏈接創建，能夠經過以下方法給SSH通道發送數據後端

self.ssh_channel.send(data)
複製代碼

固然SSH返回的數據也能夠經過以下方法持續的輸出給Websocket瀏覽器

while not self.ssh_channel.exit_status_ready():
    # SSH返回的數據須要轉碼爲utf-8，不然json序列化會失敗
    data = self.ssh_channel.recv(1024).decode('utf-8','ignore')
    if len(data) != 0:
        message = {'flag': 'success', 'message': data}
        self.websocket.send(json.dumps(message))
    else:
        break
複製代碼

有了這些信息，結合Django實現WebSSH操做Kubernetes Pod的文章，實現WebSSH瀏覽器操做物理機或者虛擬機就不算困難了，完整的Consumer代碼以下：安全

import io
import json
import paramiko
from threading import Thread
from channels.generic.websocket import WebsocketConsumer
from cmdb.backends.sshargs import args


class SSHBridge(object):
    def __init__(self, websocket):
        self.websocket = websocket

    def connect(self, host, port, username, authtype, password=None, pkey=None, term='xterm', cols=80, rows=24):
        ssh = paramiko.SSHClient()
        ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())

        try:
            if authtype == 2:
                pkey = paramiko.RSAKey.from_private_key(io.StringIO(pkey))
                ssh.connect(username=username, hostname=host, port=port, pkey=pkey, timeout=8)
            else:
                ssh.connect(hostname=host, port=port, username=username, password=password, timeout=8)
        except Exception as e:
            message = json.dumps({'flag': 'error', 'message': str(e)})
            self.websocket.send(message)

            return False

        # 打開一個ssh通道並創建鏈接
        transport = ssh.get_transport()
        self.ssh_channel = transport.open_session()
        self.ssh_channel.get_pty(term=term, width=cols, height=rows)
        self.ssh_channel.invoke_shell()

        # 鏈接創建一次，以後交互數據不會再進入該方法
        for i in range(2):
            recv = self.ssh_channel.recv(1024).decode('utf-8', 'ignore')
            message = json.dumps({'flag': 'success', 'message': recv})
            self.websocket.send(message)

    def close(self):
        try:
            self.websocket.close()
            self.ssh_channel.close()
        except BaseException as e:
            pass

    def _ws_to_ssh(self, data):
        try:
            self.ssh_channel.send(data)
        except OSError as e:
            self.close()

    def _ssh_to_ws(self):
        try:
            while not self.ssh_channel.exit_status_ready():
                data = self.ssh_channel.recv(1024).decode('utf-8', 'ignore')
                if len(data) != 0:
                    message = {'flag': 'success', 'message': data}
                    self.websocket.send(json.dumps(message))
                else:
                    break
        except Exception as e:
            message = {'flag': 'error', 'message': str(e)}
            self.websocket.send(json.dumps(message))

            self.close()

    def shell(self, data):
        Thread(target=self._ws_to_ssh, args=(data,)).start()
        Thread(target=self._ssh_to_ws).start()

class SSHConsumer(WebsocketConsumer):
    def connect(self):
        self.pk = self.scope['url_route']['kwargs'].get('id')
        self.query = self.scope.get('query_string')
        self.user = self.scope['user']

        self.accept()

        # ssh_connect_args爲SSH鏈接須要的參數
        ssh_connect_args = args(self.pk, self.user, self.query)

        self.ssh = SSHBridge(websocket=self)
        self.ssh.connect(**ssh_connect_args)

    def disconnect(self, close_code):
        self.ssh.close()

    def receive(self, text_data=None):
        text_data = json.loads(text_data)
        self.ssh.shell(data=text_data.get('data', ''))
複製代碼

動態調整終端窗口大小

看了Kubernetes WebSSH終端窗口自適應Resize文章，小夥伴又說了，你這隻能在鏈接創建時肯定終端窗口的大小，若是我中途調整了瀏覽器的大小，顯示就亂了，這該怎麼辦？bash

不要着急，接下來就讓咱們看看怎麼讓終端窗口隨着瀏覽器大小的調整而改變，上邊的文章中已經說過，終端窗口的大小須要瀏覽器和後端返回的Terminal大小保持一致，單單調整頁面窗口大小或者後端返回的Terminal窗口大小都是不行的，那麼從這兩個方向來講明該如何動態調整窗口的大小服務器

首先Paramiko模塊創建的SSH通道能夠經過resize_pty來動態改變返回Terminal窗口的大小，使用方法以下：

def resize_pty(self, cols, rows):
    self.ssh_channel.resize_pty(width=cols, height=rows)
複製代碼

而後Django的Channels每次接收到前端發過來的數據時，判斷一下窗口是否有變化，若是有變化則調用上邊的方法動態改變Terminal輸出窗口的大小

我在實現時會給傳過來的數據加個flag，若是flag是resize，則調用resize_pty的方法動態調整窗口大小，不然就正常調用執行命令的方法，代碼以下：

def receive(self, text_data=None):
    text_data = json.loads(text_data)

    if text_data.get('flag') == 'resize':
        self.ssh.resize_pty(cols=text_data['cols'], rows=text_data['rows'])
    else:
        self.ssh.shell(data=text_data.get('data', ''))
複製代碼

後端都搞定了，那麼來看看前端如何處理吧

首先有一個terminal_size的方法根據瀏覽器窗口大小除以每一個字符所佔用的大小計算出cols和rows的值，不管是xterm.js仍是Paramiko都是根據這兩個值來調整窗口大小的

function terminal_size() {
    return {
        cols: Math.floor($('#terminal').width() / 9),
        rows: Math.floor($(window).height() / 17),
    }
}
複製代碼

而後經過$(window).resize()來檢測瀏覽器窗口的變化，一旦發生變化，則發送一個帶resize標記的數據給Django，同時傳遞的數據還有新的cols和rows

// terminal resize
$(window).resize(function () {
    let cols = terminal_size().cols;
    let rows = terminal_size().rows;

    send_data = JSON.stringify({
        'flag': 'resize',
        'cols': cols,
        'rows': rows
    });

    socket.send(send_data);
    term.resize(cols, rows)
})
複製代碼

最後經過term.resize來調整xterm渲染的窗口的大小

這樣一個完整的動態調整窗口大小的方案就完成了