1. SSH簡介

        SSH是Secure Shell的縮寫，一種建立在應用層和傳輸層基礎上的安全協議。SSH在連線和傳送過程中會加密所有資料，可以用來在不同系統或者伺服器之間進行安全連線。SSH提供兩種的安全驗證方式：基於密碼的認證和基於密匙的認證。其中，基於密碼的認證比較簡單，只要知道遠端主機的使用者名稱和密碼，就可以進行登入。基於密匙的認證比較麻煩，而且連線比較耗時，這裡不詳細介紹。         有很多基於SSH協議的客戶端，例如：PuTTY、OpenSSH、Xshell 4等，可以遠端連線幾乎所有UNIX平臺。同時，可以通過Linux命令列ssh [email protected]連線到某主機。         在專案中，如何利用程式碼實現SSH，遠端執行Shell指令碼呢？JSch是Java Secure Channel的縮寫，是一個SSH2功能的純Java實現，具體資訊可以參考JSch官網。它允許你連線到一個SSH伺服器，並且可以使用埠轉發，X11轉發，檔案傳輸等，同時你也可以整合它的功能到你自己的應用程式。在使用前，需要下載並匯入JSch包：jsch-0.1.50.jar。

2. 實現原理

        1. 根據遠端主機的IP地址，使用者名稱和埠，建立會話（Session）；         2. 設定使用者資訊（包括密碼和Userinfo），然後連線session；         3. 在session上建立指定型別的通道（Channel），本文示例中採用ChannelExec型別的；         4. 設定channel上需要遠端執行的Shell指令碼，連線channel，就可以遠端執行該Shell指令碼；         5. 可以讀取遠端執行Shell指令碼的輸出，然後依次斷開channel和session的連線。

3. 示例程式碼及分析

• SSHCommandExecutor.java：

import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.util.Vector;

import com.jcraft.jsch.Channel;
import com.jcraft.jsch.ChannelExec;
import com.jcraft.jsch.JSch;
import com.jcraft.jsch.JSchException;
import com.jcraft.jsch.Session;

/**
 * This class provide interface to execute command on remote Linux.
 */

public class SSHCommandExecutor {
    private String ipAddress;

    private String username;

    private String password;

    public static final int DEFAULT_SSH_PORT = 22;

    private Vector<String> stdout;

    public SSHCommandExecutor(final String ipAddress, final String username, final String password) {
        this.ipAddress = ipAddress;
        this.username = username;
        this.password = password;
        stdout = new Vector<String>();
    }

    public int execute(final String command) {
        int returnCode = 0;
        JSch jsch = new JSch();
        MyUserInfo userInfo = new MyUserInfo();

        try {
            // Create and connect session.
            Session session = jsch.getSession(username, ipAddress, DEFAULT_SSH_PORT);
            session.setPassword(password);
            session.setUserInfo(userInfo);
            session.connect();

            // Create and connect channel.
            Channel channel = session.openChannel("exec");
            ((ChannelExec) channel).setCommand(command);

            channel.setInputStream(null);
            BufferedReader input = new BufferedReader(new InputStreamReader(channel
                    .getInputStream()));

            channel.connect();
            System.out.println("The remote command is: " + command);

            // Get the output of remote command.
            String line;
            while ((line = input.readLine()) != null) {
                stdout.add(line);
            }
            input.close();

            // Get the return code only after the channel is closed.
            if (channel.isClosed()) {
                returnCode = channel.getExitStatus();
            }

            // Disconnect the channel and session.
            channel.disconnect();
            session.disconnect();
        } catch (JSchException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return returnCode;
    }

    public Vector<String> getStandardOutput() {
        return stdout;
    }

    public static void main(final String [] args) {
        SSHCommandExecutor sshExecutor = new SSHCommandExecutor("xx.xx.xx.xx", "username", "password");
        sshExecutor.execute("uname -s -r -v");
        
        Vector<String> stdout = sshExecutor.getStandardOutput();
        for (String str : stdout) {
            System.out.println(str);
        }
    }
}
 

        getSession()只是建立一個session，需要設定必要的認證資訊之後，呼叫connect()才能建立連線。         呼叫openChannel(String type) 可以在session上開啟指定型別的channel。該channel只是被初始化，使用前需要先呼叫connect()進行連線。         Channel的型別可以為如下型別：

• shell - ChannelShell 
• exec - ChannelExec 
• direct-tcpip - ChannelDirectTCPIP 
• sftp - ChannelSftp 
• subsystem - ChannelSubsystem

        其中，ChannelShell和ChannelExec比較類似，都可以作為執行Shell指令碼的Channel型別。它們有一個比較重要的區別：ChannelShell可以看作是執行一個互動式的Shell，而ChannelExec是執行一個Shell指令碼。

• MyUserInfo：

import com.jcraft.jsch.UserInfo;

/**
 * This class provide interface to feedback information to the user.
 */
public class MyUserInfo implements UserInfo {
    private String password;

    private String passphrase;

    @Override
    public String getPassphrase() {
        System.out.println("MyUserInfo.getPassphrase()");
        return null;
    }

    @Override
    public String getPassword() {
        System.out.println("MyUserInfo.getPassword()");
        return null;
    }

    @Override
    public boolean promptPassphrase(final String arg0) {
        System.out.println("MyUserInfo.promptPassphrase()");
        System.out.println(arg0);
        return false;
    }

    @Override
    public boolean promptPassword(final String arg0) {
        System.out.println("MyUserInfo.promptPassword()");
        System.out.println(arg0);
        return false;
    }

    @Override
    public boolean promptYesNo(final String arg0) {
        System.out.println("MyUserInfo.promptYesNo()");
        System.out.println(arg0);
        if (arg0.contains("The authenticity of host")) {
            return true;
        }
        return false;
    }

    @Override
    public void showMessage(final String arg0) {
        System.out.println("MyUserInfo.showMessage()");
    }
}

        MyUserInfo實現了介面UserInfo，主要是為獲得執行執行的使用者資訊提供介面。大部分實現方法中，沒有做實質性的工作，只是輸出一下trace資訊，幫助判斷哪個方法被執行過。

4. 執行結果分析

        1. 如果不設定UserInfo，會丟擲JSchException異常，提示找不到host：
        2. 如果MyUserInfo實現了介面UserInfo，但是隻是@Override一些函式，會出現如下錯誤：
             雖然可以找到host，但是會拒絕訪問host。發現所有@Override函式中，get方法返回的都是null，prompt方法返回的都是false。         3. 為了判斷這些Override的methods中，那些是有用的，在每個method中加入trace資訊。發現只有promptYesNo(final String)會被呼叫到，輸出如下圖所示：
        4. promptYesNo(final String)是向用戶提出一個yes或者no的問題，來決定是否允許連線遠端主機。這才是決定連線是否成功的一個關鍵函式。如果返回值為true，則允許連線；如果返回值為false，則拒絕連線。最後正確連線後的輸出入下圖所示：

Reference