Django實現WebSSH操作物理機或虛擬機
- 2019 年 11 月 6 日
- 筆記
我想用它替換掉xshell、crt之類的工具
WebSSH操作物理機或虛擬機
Django實現WebSSH操作Kubernetes Pod文章發布後，有小夥伴說咖啡哥，我們現在還沒有用上Kubernetes，但我想通過瀏覽器連接我們的物理機和虛擬機該怎麼辦？
這就比較簡單了，既然我們已經實現了瀏覽器操作Kubernetes的Pod，那麼想想操作Pod和物理機虛擬機有什麼區別呢？
整個數據流是一點沒變：用戶打開瀏覽器--》瀏覽器發送websocket請求給Django建立長連接--》Django與要操作的伺服器建立SSH通道，實時的將收到的用戶數據發送給SSH後的主機，並將主機執行的結果數據返回給瀏覽器
唯一不一樣的地方就是Django與要操作的伺服器建立SSH通道的方式，在Kubernetes中是通過Kubernetes提供的API建立的Stream流，而操作物理機或者虛擬機的時候我們可以使用Paramiko模組來建立SSH長連接隧道，Paramiko模組建立SSH長連接通道的方法如下：
# 實例化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文章，小夥伴又說了，你這隻能在連接建立時確定終端窗口的大小，如果我中途調整了瀏覽器的大小，顯示就亂了，這該怎麼辦？
不要著急，接下來就讓我們看看怎麼讓終端窗口隨著瀏覽器大小的調整而改變，上邊的文章中已經說過，終端窗口的大小需要瀏覽器和後端返回的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渲染的窗口的大小
這樣一個完整的動態調整窗口大小的方案就完成了
演示與源碼
我寫了個簡單的Demo來實現上邊的功能，Demo寫完發現還挺好用，我就擴展了一下添加了內網的物理機和虛擬機，歷史原因，有些是帳號密碼認證，有些是密鑰認證，我都給兼容了一下，最終實現的效果如上圖所示
項目裡邊要記錄主機的密碼，為了安全這個密碼是通過RSA加密存放在資料庫的，每次使用的時候進行解密，加解密的實現，可參考這篇文章 Django開發密碼管理表實例【附源碼】
最後，如果你對這個簡單的小玩意感興趣，想要自己實現，卻遇到了一些問題，可以通過公眾號後台加我微信獲取源碼
相關文章推薦閱讀：
