Java 打造一款 SSH 客戶端，已開源～-有解無憂

來源：https://blog.csdn.net/NoCortY/article/details/104772431

前言

最近由于專案需求，專案中需要實作一個WebSSH連接終端的功能，由于自己第一次做這型別功能，所以首先上了GitHub找了找有沒有現成的輪子可以拿來直接用，當時看到了很多這方面的專案，例如：GateOne、webssh、shellinabox等，

這些專案都可以很好地實作webssh的功能，但是最終并沒有采用，原因是在于這些底層大都是python寫的，需要依賴很多檔案，自己用的時候可以使用這種方案，快捷省事，但是做到專案中供用戶使用時，總不能要求用戶做到服務器中必須包含這些底層依賴，這顯然不太合理，所以我決定自己動手寫一個WebSSH的功能，并且作為一個獨立的專案開源出來，（文末附專案開源地址）

技術選型

由于webssh需要實時資料互動，所以會選用長連接的WebSocket，為了開發的方便，框架選用SpringBoot，另外還自己了解了Java用戶連接ssh的jsch和實作前端shell頁面的xterm.js.所以，最終的技術選型就是 SpringBoot+Websocket+jsch+xterm.js，

匯入依賴

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.7.RELEASE</version>
    <relativePath /> <!-- lookup parent from repository -->
</parent>
<dependencies>
    <!-- Web相關 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- jsch支持 -->
    <dependency>
        <groupId>com.jcraft</groupId>
        <artifactId>jsch</artifactId>
        <version>0.1.54</version>
    </dependency>
    <!-- WebSocket 支持 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-websocket</artifactId>
    </dependency>
    <!-- 檔案上傳決議器 -->
    <dependency>
        <groupId>commons-io</groupId>
        <artifactId>commons-io</artifactId>
        <version>1.4</version>
    </dependency>
    <dependency>
        <groupId>commons-fileupload</groupId>
        <artifactId>commons-fileupload</artifactId>
        <version>1.3.1</version>
    </dependency>
</dependencies>

一個簡單的xterm案例

由于xterm是一個冷門技術，所以很多同學并沒有這方面的知識支撐，我也是為了實作這個功能所以臨時學的，所以在這給大家介紹一下，

xterm.js是一個基于WebSocket的容器，它可以幫助我們在前端實作命令列的樣式，就像是我們平常再用SecureCRT或者XShell連接服務器時一樣，下面是官網上的入門案例：

<!doctype html>
 <html>
  <head>
    <link rel="stylesheet" href="https://www.cnblogs.com/javastack/p/node_modules/xterm/css/xterm.css" />
    <script src="https://www.cnblogs.com/javastack/p/node_modules/xterm/lib/xterm.js"></script>
  </head>
  <body>
    <div id="terminal"></div>
    <script>
      var term = new Terminal();
      term.open(document.getElementById('terminal'));
      term.write('Hello from \x1B[1;3;31mxterm.js\x1B[0m $ ')
</script>
  </body>
 </html>

最終測驗，頁面就是下面這個樣子：可以看到頁面已經出現了類似與shell的樣式，那就根據這個繼續深入，實作一個webssh，

后端實作

由于xterm只要只是實作了前端的樣式，并不能真正地實作與服務器互動，與服務器互動主要還是靠我們Java后端來進行控制的，所以我們從后端開始，使用jsch+websocket實作這部分內容，

WebSocket配置

由于訊息實時推送到前端需要用到WebSocket，不了解WebSocket的同學可以先去自行了解一下，這里就不過多介紹了，我們直接開始進行WebSocket的配置，

/**
* @Description: websocket配置
* @Author: NoCortY
* @Date: 2020/3/8
*/
@Configuration
@EnableWebSocket
public class WebSSHWebSocketConfig implements WebSocketConfigurer{
    @Autowired
    WebSSHWebSocketHandler webSSHWebSocketHandler;
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry webSocketHandlerRegistry) {
        //socket通道
        //指定處理器和路徑，并設定跨域
        webSocketHandlerRegistry.addHandler(webSSHWebSocketHandler, "/webssh")
                .addInterceptors(new WebSocketInterceptor())
                .setAllowedOrigins("*");
    }
}

處理器(Handler)和攔截器(Interceptor)的實作

剛才我們完成了WebSocket的配置，并指定了一個處理器和攔截器，所以接下來就是處理器和攔截器的實作，攔截器：

public class WebSocketInterceptor implements HandshakeInterceptor {
    /**
     * @Description: Handler處理前呼叫
     * @Param: [serverHttpRequest, serverHttpResponse, webSocketHandler, map]
     * @return: boolean
     * @Author: NoCortY
     * @Date: 2020/3/1
     */
    @Override
    public boolean beforeHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Map<String, Object> map) throws Exception {
        if (serverHttpRequest instanceof ServletServerHttpRequest) {
            ServletServerHttpRequest request = (ServletServerHttpRequest) serverHttpRequest;
            //生成一個UUID，這里由于是獨立的專案，沒有用戶模塊，所以可以用隨機的UUID
            //但是如果要集成到自己的專案中，需要將其改為自己識別用戶的標識
            String uuid = UUID.randomUUID().toString().replace("-","");
            //將uuid放到websocketsession中
            map.put(ConstantPool.USER_UUID_KEY, uuid);
            return true;
        } else {
            return false;
        }
    }

    @Override
    public void afterHandshake(ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse, WebSocketHandler webSocketHandler, Exception e) {

    }
}

處理器：

/**
* @Description: WebSSH的WebSocket處理器
* @Author: NoCortY
* @Date: 2020/3/8
*/
@Component
public class WebSSHWebSocketHandler implements WebSocketHandler{
    @Autowired
    private WebSSHService webSSHService;
    private Logger logger = LoggerFactory.getLogger(WebSSHWebSocketHandler.class);

    /**
     * @Description: 用戶連接上WebSocket的回呼
     * @Param: [webSocketSession]
     * @return: void
     * @Author: Object
     * @Date: 2020/3/8
     */
    @Override
    public void afterConnectionEstablished(WebSocketSession webSocketSession) throws Exception {
        logger.info("用戶:{},連接WebSSH", webSocketSession.getAttributes().get(ConstantPool.USER_UUID_KEY));
        //呼叫初始化連接
        webSSHService.initConnection(webSocketSession);
    }

    /**
     * @Description: 收到訊息的回呼
     * @Param: [webSocketSession, webSocketMessage]
     * @return: void
     * @Author: NoCortY
     * @Date: 2020/3/8
     */
    @Override
    public void handleMessage(WebSocketSession webSocketSession, WebSocketMessage<?> webSocketMessage) throws Exception {
        if (webSocketMessage instanceof TextMessage) {
            logger.info("用戶:{},發送命令:{}", webSocketSession.getAttributes().get(ConstantPool.USER_UUID_KEY), webSocketMessage.toString());
            //呼叫service接收訊息
            webSSHService.recvHandle(((TextMessage) webSocketMessage).getPayload(), webSocketSession);
        } else if (webSocketMessage instanceof BinaryMessage) {

        } else if (webSocketMessage instanceof PongMessage) {

        } else {
            System.out.println("Unexpected WebSocket message type: " + webSocketMessage);
        }
    }

    /**
     * @Description: 出現錯誤的回呼
     * @Param: [webSocketSession, throwable]
     * @return: void
     * @Author: Object
     * @Date: 2020/3/8
     */
    @Override
    public void handleTransportError(WebSocketSession webSocketSession, Throwable throwable) throws Exception {
        logger.error("資料傳輸錯誤");
    }

    /**
     * @Description: 連接關閉的回呼
     * @Param: [webSocketSession, closeStatus]
     * @return: void
     * @Author: NoCortY
     * @Date: 2020/3/8
     */
    @Override
    public void afterConnectionClosed(WebSocketSession webSocketSession, CloseStatus closeStatus) throws Exception {
        logger.info("用戶:{}斷開webssh連接", String.valueOf(webSocketSession.getAttributes().get(ConstantPool.USER_UUID_KEY)));
        //呼叫service關閉連接
        webSSHService.close(webSocketSession);
    }

    @Override
    public boolean supportsPartialMessages() {
        return false;
    }
}

需要注意的是，我在攔截器中加入的用戶標識是使用了隨機的UUID，這是因為作為一個獨立的websocket專案，沒有用戶模塊，如果需要將這個專案集成到自己的專案中，需要修改這部分代碼，將其改為自己專案中識別一個用戶所用的用戶標識，

WebSSH的業務邏輯實作（核心）

剛才我們實作了websocket的配置，都是一些死代碼，實作了介面再根據自身需求即可實作，現在我們將進行后端主要業務邏輯的實作，在實作這個邏輯之前，我們先來想想，WebSSH，我們主要想要呈現一個什么效果，我這里做了一個總結：

1.首先我們得先連接上終端（初始化連接）2.其次我們的服務端需要處理來自前端的訊息（接收并處理前端訊息）3.我們需要將終端回傳的訊息回寫到前端（資料回寫前端）4.關閉連接

根據這四個需求，我們先定義一個介面，這樣可以讓需求明了起來，

/**
 * @Description: WebSSH的業務邏輯
 * @Author: NoCortY
 * @Date: 2020/3/7
 */
public interface WebSSHService {
    /**
     * @Description: 初始化ssh連接
     * @Param:
     * @return:
     * @Author: NoCortY
     * @Date: 2020/3/7
     */
    public void initConnection(WebSocketSession session);

    /**
     * @Description: 處理客戶段發的資料
     * @Param:
     * @return:
     * @Author: NoCortY
     * @Date: 2020/3/7
     */
    public void recvHandle(String buffer, WebSocketSession session);

    /**
     * @Description: 資料寫回前端 for websocket
     * @Param:
     * @return:
     * @Author: NoCortY
     * @Date: 2020/3/7
     */
    public void sendMessage(WebSocketSession session, byte[] buffer) throws IOException;

    /**
     * @Description: 關閉連接
     * @Param:
     * @return:
     * @Author: NoCortY
     * @Date: 2020/3/7
     */
    public void close(WebSocketSession session);
}

現在我們可以根據這個介面去實作我們定義的功能了，1. 初始化連接由于我們的底層是依賴jsch實作的，所以這里是需要使用jsch去建立連接的，而所謂初始化連接，實際上就是將我們所需要的連接資訊，保存在一個Map中，這里并不進行任何的真實連接操作，為什么這里不直接進行連接？因為這里前端只是連接上了WebSocket，但是我們還需要前端給我們發來linux終端的用戶名和密碼，沒有這些資訊，我們是無法進行連接的，

public void initConnection(WebSocketSession session) {
        JSch jSch = new JSch();
        SSHConnectInfo sshConnectInfo = new SSHConnectInfo();
        sshConnectInfo.setjSch(jSch);
        sshConnectInfo.setWebSocketSession(session);
        String uuid = String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));
        //將這個ssh連接資訊放入map中
        sshMap.put(uuid, sshConnectInfo);
}

2. 處理客戶端發送的資料在這一步驟中，我們會分為兩個分支，第一個分支：如果客戶端發來的是終端的用戶名和密碼等資訊，那么我們進行終端的連接，第二個分支：如果客戶端發來的是操作終端的命令，那么我們就直接轉發到終端并且獲取終端的執行結果，具體代碼實作：

public void recvHandle(String buffer, WebSocketSession session) {
        ObjectMapper objectMapper = new ObjectMapper();
        WebSSHData webSSHData = https://www.cnblogs.com/javastack/p/null;
        try {
            //轉換前端發送的JSON
            webSSHData = objectMapper.readValue(buffer, WebSSHData.class);
        } catch (IOException e) {
            logger.error("Json轉換例外");
            logger.error("例外資訊:{}", e.getMessage());
            return;
        }
    //獲取剛才設定的隨機的uuid
        String userId = String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));
        if (ConstantPool.WEBSSH_OPERATE_CONNECT.equals(webSSHData.getOperate())) {
            //如果是連接請求
            //找到剛才存盤的ssh連接物件
            SSHConnectInfo sshConnectInfo = (SSHConnectInfo) sshMap.get(userId);
            //啟動執行緒異步處理
            WebSSHData finalWebSSHData = https://www.cnblogs.com/javastack/p/webSSHData;
            executorService.execute(new Runnable() {
                @Override
                public void run() {
                    try {
                        //連接到終端
                        connectToSSH(sshConnectInfo, finalWebSSHData, session);
                    } catch (JSchException | IOException e) {
                        logger.error("webssh連接例外");
                        logger.error("例外資訊:{}", e.getMessage());
                        close(session);
                    }
                }
            });
        } else if (ConstantPool.WEBSSH_OPERATE_COMMAND.equals(webSSHData.getOperate())) {
            //如果是發送命令的請求
            String command = webSSHData.getCommand();
            SSHConnectInfo sshConnectInfo = (SSHConnectInfo) sshMap.get(userId);
            if (sshConnectInfo != null) {
                try {
                    //發送命令到終端
                    transToSSH(sshConnectInfo.getChannel(), command);
                } catch (IOException e) {
                    logger.error("webssh連接例外");
                    logger.error("例外資訊:{}", e.getMessage());
                    close(session);
                }
            }
        } else {
            logger.error("不支持的操作");
            close(session);
        }
}

3. 資料通過websocket發送到前端

public void sendMessage(WebSocketSession session, byte[] buffer) throws IOException {
        session.sendMessage(new TextMessage(buffer));
}

4. 關閉連接

public void close(WebSocketSession session) {
    //獲取隨機生成的uuid
        String userId = String.valueOf(session.getAttributes().get(ConstantPool.USER_UUID_KEY));
        SSHConnectInfo sshConnectInfo = (SSHConnectInfo) sshMap.get(userId);
        if (sshConnectInfo != null) {
            //斷開連接
            if (sshConnectInfo.getChannel() != null) sshConnectInfo.getChannel().disconnect();
            //map中移除該ssh連接資訊
            sshMap.remove(userId);
        }
}

至此，我們的整個后端實作就結束了，由于篇幅有限，這里將一些操作封裝成了方法，就不做過多展示了，重點講邏輯實作的思路吧，接下來我們將進行前端的實作，

前端實作

前端作業主要分為這么幾個步驟：

頁面的實作
連接WebSocket并完成資料的接收并回寫
資料的發送

所以我們一步一步來實作它，

頁面實作

頁面的實作很簡單，我們只不過需要在一整個螢屏上都顯示終端那種大黑螢屏，所以我們并不用寫什么樣式，只需要創建一個div，之后將terminal實體通過xterm放到這個div中，就可以實作了，

<!doctype html>
<html>
<head>
    <title>WebSSH</title>
    <link rel="stylesheet" href="https://www.cnblogs.com/javastack/css/xterm.css" />
</head>
<body>
<div id="terminal" style="width: 100%;height: 100%"></div>

<script src="https://www.cnblogs.com/javastack/lib/jquery-3.4.1/jquery-3.4.1.min.js"></script>
<script src="https://www.cnblogs.com/javastack/js/xterm.js" charset="utf-8"></script>
<script src="https://www.cnblogs.com/javastack/js/webssh.js" charset="utf-8"></script>
<script src="https://www.cnblogs.com/javastack/js/base64.js" charset="utf-8"></script>
</body>
</html>

連接WebSocket并完成資料的發送、接收、回寫

openTerminal( {
    //這里的內容可以寫死，但是要整合到專案中時，需要通過引數的方式傳入，可以動態連接某個終端，
        operate:'connect',
        host: 'ip地址',
        port: '埠號',
        username: '用戶名',
        password: '密碼'
    });
    function openTerminal(options){
        var client = new WSSHClient();
        var term = new Terminal({
            cols: 97,
            rows: 37,
            cursorBlink: true, // 游標閃爍
            cursorStyle: "block", // 游標樣式  null | 'block' | 'underline' | 'bar'
            scrollback: 800, //回滾
            tabStopWidth: 8, //制表寬度
            screenKeys: true
        });

        term.on('data', function (data) {
            //鍵盤輸入時的回呼函式
            client.sendClientData(data);
        });
        term.open(document.getElementById('terminal'));
        //在頁面上顯示連接中...
        term.write('Connecting...');
        //執行連接操作
        client.connect({
            one rror: function (error) {
                //連接失敗回調
                term.write('Error: ' + error + '\r\n');
            },
            onConnect: function () {
                //連接成功回呼
                client.sendInitData(options);
            },
            onClose: function () {
                //連接關倍訓呼
                term.write("\rconnection closed");
            },
            onData: function (data) {
                //收到資料時回呼
                term.write(data);
            }
        });
    }