Python Flask框架開發(fā)之運用SocketIO實現(xiàn)WebSSH方法詳解

更新時間：2022年10月08日 16:27:35 作者：LyShark 孤風洗劍

Socket.IO本是一個面向實時web應用的JavaScript庫，現(xiàn)在已成為擁有眾多語言支持的Web即時通訊應用的框架。這篇文章主要介紹了Python 運用SocketIO實現(xiàn)WebSSH方法

Flask 框架中如果想要實現(xiàn)WebSocket功能有許多種方式，運用SocketIO庫來實現(xiàn)無疑是最簡單的一種方式，F(xiàn)lask中封裝了一個flask_socketio庫該庫可以直接通過pip倉庫安裝，如下內(nèi)容將重點簡述SocketIO庫在Flask框架中是如何被應用的，最終實現(xiàn)WebSSH命令行終端功能，其可用于在Web瀏覽器內(nèi)實現(xiàn)SSH命令行執(zhí)行。

首先我們先來看一下SocketIO庫是如何進行通信的，對于前端部分需要引入socket.io這個框架，然后就是利用該框架內(nèi)提供的各類函數(shù)實現(xiàn)創(chuàng)建WS通道，如下代碼：

代碼中通過調(diào)用io.connect來連接后端，socket.emit則是用于向后端推送一條消息，而socket.on則是一個回調(diào)函數(shù)，一旦有數(shù)據(jù)被傳出則第一時間執(zhí)行回調(diào)函數(shù)內(nèi)的代碼。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <script type="text/javascript" src="https://cdn.lyshark.com/javascript/jquery/3.5.1/jquery.min.js"></script>
    <script type="text/javascript" src="https://cdn.lyshark.com/javascript/socket.io/socket.io.min.js"></script>
</head>
<body>
<script type="text/javascript" charset="UTF-8">
    $(document).ready(function() {
        namespace = '/Socket';
        var socket = io.connect("http://" + document.domain + ":" + location.port + namespace);
        // 初始化完成后,發(fā)送一條消息
        socket.emit("message",{"data":"hello lyshark"});
        // 收到數(shù)據(jù)后,執(zhí)行輸出
        socket.on('response', function(recv) {
            console.log('hello lyshark ' + recv.Data)
        });
    });
</script>
</body>
</html>

接著就是后端，后端部分代碼如下所示，代碼中app.config['SECRET_KEY']是配置一個安全密鑰這里可以隨意填寫，通過socketio = SocketIO(app)初始化一個SOCKET對象，當有消息出現(xiàn)時SocketIO會自動執(zhí)行相應的處理函數(shù)，常見的處理方法也就如下這三種。

message 出現(xiàn)消息后,率先執(zhí)行此處
connect 當websocket連接成功時,自動觸發(fā)connect默認方法
disconnect 當websocket連接失敗時,自動觸發(fā)disconnect默認方法

from flask import Flask,render_template,request
from flask_socketio import SocketIO
async_mode = None
app = Flask(import_name=__name__,
            static_url_path='/python',   # 配置靜態(tài)文件的訪問url前綴
            static_folder='static',      # 配置靜態(tài)文件的文件夾
            template_folder='templates') # 配置模板文件的文件夾
app.config['SECRET_KEY'] = "lyshark"
socketio = SocketIO(app)
@app.route("/")
def index():
    return render_template("index.html")
# 出現(xiàn)消息后,率先執(zhí)行此處
@socketio.on("message",namespace="/Socket")
def socket(message):
    print("接收到消息:",message['data'])
    for i in range(1,100):
        socketio.sleep(1)
        socketio.emit("response",           # 綁定通信
                      {"Data":i},           # 返回socket數(shù)據(jù)
                      namespace="/Socket")
# 當websocket連接成功時,自動觸發(fā)connect默認方法
@socketio.on("connect",namespace="/Socket")
def connect():
    print("鏈接建立成功..")
# 當websocket連接失敗時,自動觸發(fā)disconnect默認方法
@socketio.on("disconnect",namespace="/Socket")
def disconnect():
    print("鏈接建立失敗..")
if __name__ == '__main__':
    socketio.run(app,debug=True,host="0.0.0.0")

如上就是前后端所有的代碼，當我們運行Flask后端時，打開前端頁面并查看控制臺，可以看到效果，后臺會每隔一段時間自動向前端推送一個消息此時這個通道也算是建立成功了。

原理明白了以后，再去實現(xiàn)一個WebSSH終端就會變得很容易，WebSSH終端我們需要xterm這個前端庫來實現(xiàn)，其原理就是當后臺有數(shù)據(jù)輸出或前臺有輸入時第一時間傳遞給SSH模塊執(zhí)行然后返回結果，我們先來看前端部分是如何實現(xiàn)這段功能的。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <script type="text/javascript" src="https://cdn.lyshark.com/javascript/jquery/3.5.1/jquery.min.js"></script>
    <script type="text/javascript" src="https://cdn.lyshark.com/javascript/socket.io/socket.io.min.js"></script>
    <link rel="stylesheet"  rel="external nofollow"  />
    <link rel="stylesheet"  rel="external nofollow"  />
    <script type="text/javascript" src="https://cdn.lyshark.com/javascript/xterm/xterm.js"></script>
</head>
<body>
    <div id="terminal"></div>
    <script>
      var window_width = $(window).width();
      var window_height = $(window).height();
      var term = new Terminal(
            {
                cols: Math.floor(window_width/9),
                rows: Math.floor(window_height/20),
                useStyle:false,
                convertEol: true,
                cursorBlink:true,
                cursorStyle:null,
            });
        console.log("高度" + window_height + "寬度" + window_width);
        $(document).ready(function() {
            namespace = '/Socket';
            var socket = io.connect("http://" + document.domain + ":" + location.port + namespace);
            socket.on("connect",function(){
                term.open(document.getElementById('terminal'));
            });
            // 接受后端數(shù)據(jù),并寫到控制臺
            socket.on("response",function(recv){
                term.write(recv.Data);
            });
            // 發(fā)送消息到對端
            term.on("data",function(data){
               socket.send(data);
               //socket.emit("message",{"data":data});
            });
        });
</script>
</body>
</html>

上方代碼中當鏈接SOCKET成功后，則socket.on("response",function(recv)用于接收后臺的輸出，一旦后臺有輸出數(shù)據(jù)則直接調(diào)用term.write(recv.Data);將該數(shù)據(jù)寫出到控制臺，而term.on則是xterm中提供的接收方法，其作用是接收用戶的輸入并將該輸入傳遞給后臺來處理。

那后臺是如何處理的呢，其實后端只是使用paramiko模塊建立一個SSH隧道，并在message函數(shù)內(nèi)處理發(fā)送接收數(shù)據(jù)。

from flask import Flask,render_template,request
from flask_socketio import SocketIO
import paramiko
async_mode = None
app = Flask(import_name=__name__,
            static_url_path='/python',   # 配置靜態(tài)文件的訪問url前綴
            static_folder='static',      # 配置靜態(tài)文件的文件夾
            template_folder='templates') # 配置模板文件的文件夾
app.config['SECRET_KEY'] = "lyshark"
socketio = SocketIO(app)
def ssh_cmd():
    tran = paramiko.Transport(('192.168.150.129', 22,))
    tran.start_client()
    tran.auth_password('root', '1233')
    chan = tran.open_session()
    chan.get_pty(height=492,width=1312)
    chan.invoke_shell()
    return chan
sessions = ssh_cmd()
@app.route("/")
def index():
    return render_template("index.html")
# 出現(xiàn)消息后,率先執(zhí)行此處
@socketio.on("message",namespace="/Socket")
def socket(message):
    print("接收到消息:",message)
    sessions.send(message)
    ret = sessions.recv(4096)
    socketio.emit("response", {"Data": ret.decode("utf-8")}, namespace="/Socket")
    print(message)
# 當websocket連接成功時,自動觸發(fā)connect默認方法
@socketio.on("connect",namespace="/Socket")
def connect():
    ret = sessions.recv(4096)
    socketio.emit("response", {"Data": ret.decode("utf-8")}, namespace="/Socket")
    print("鏈接建立成功..")
# 當websocket連接失敗時,自動觸發(fā)disconnect默認方法
@socketio.on("disconnect",namespace="/Socket")
def disconnect():
    print("鏈接建立失敗..")
if __name__ == '__main__':
    socketio.run(app,debug=True,host="0.0.0.0")

代碼運行后我們訪問Web頁面，即可成功登錄到Linux主機，并執(zhí)行任意命令。