From 726b55a742c886ae8edc6c3e73ba7615bb34979e Mon Sep 17 00:00:00 2001
From: Looly <loolly@gmail.com>
Date: Fri, 11 Dec 2020 02:45:22 +0800
Subject: [PATCH] add GanymedUtil

---
 CHANGELOG.md                                  |   1 +
 hutool-extra/pom.xml                          |   7 +
 .../java/cn/hutool/extra/ssh/GanymedUtil.java | 130 ++++++++++++++++++
 .../java/cn/hutool/extra/ssh/JschUtil.java    |   2 +-
 4 files changed, 139 insertions(+), 1 deletion(-)
 create mode 100644 hutool-extra/src/main/java/cn/hutool/extra/ssh/GanymedUtil.java

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 8deccb205..381188e2a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,6 +19,7 @@
 * 【core   】     CollUtil.addAll增加判空（pr#228@Gitee）
 * 【core   】     修正DateUtil.betweenXXX注释错误（issue#I28XGW@Gitee）
 * 【core   】     增加NioUtil
+* 【core   】     增加GanymedUtil
 
 ### Bug修复
 * 【cache  】     修复Cache中get重复misCount计数问题（issue#1281@Github）
diff --git a/hutool-extra/pom.xml b/hutool-extra/pom.xml
index 524fe3c25..646a16e3f 100644
--- a/hutool-extra/pom.xml
+++ b/hutool-extra/pom.xml
@@ -130,6 +130,13 @@
 			<scope>compile</scope>
 			<optional>true</optional>
 		</dependency>
+		<dependency>
+			<groupId>ch.ethz.ganymed</groupId>
+			<artifactId>ganymed-ssh2</artifactId>
+			<version>262</version>
+			<scope>compile</scope>
+			<optional>true</optional>
+		</dependency>
 		<!-- 二维码 -->
 		<dependency>
 			<groupId>com.google.zxing</groupId>
diff --git a/hutool-extra/src/main/java/cn/hutool/extra/ssh/GanymedUtil.java b/hutool-extra/src/main/java/cn/hutool/extra/ssh/GanymedUtil.java
new file mode 100644
index 000000000..33ea88ed1
--- /dev/null
+++ b/hutool-extra/src/main/java/cn/hutool/extra/ssh/GanymedUtil.java
@@ -0,0 +1,130 @@
+package cn.hutool.extra.ssh;
+
+import ch.ethz.ssh2.Connection;
+import ch.ethz.ssh2.Session;
+import ch.ethz.ssh2.StreamGobbler;
+import cn.hutool.core.io.IORuntimeException;
+import cn.hutool.core.io.IoUtil;
+import cn.hutool.core.util.StrUtil;
+
+import java.io.IOException;
+import java.io.OutputStream;
+import java.nio.charset.Charset;
+
+/**
+ * Ganymed-SSH2封装，见：http://www.ganymed.ethz.ch/ssh2/
+ *
+ * @author looly
+ * @since 5.5.3
+ */
+public class GanymedUtil {
+
+	/**
+	 * 连接到服务器
+	 *
+	 * @param sshHost 主机
+	 * @param sshPort 端口
+	 * @return {@link Connection}
+	 */
+	public static Connection connect(String sshHost, int sshPort) {
+		Connection conn = new Connection(sshHost, sshPort);
+		try {
+			conn.connect();
+		} catch (IOException e) {
+			throw new IORuntimeException(e);
+		}
+		return conn;
+	}
+
+	/**
+	 * 打开远程会话
+	 *
+	 * @param sshHost 主机
+	 * @param sshPort 端口
+	 * @param sshUser 用户名，如果为null，默认root
+	 * @param sshPass 密码
+	 * @return {@link Session}
+	 */
+	public static Session openSession(String sshHost, int sshPort, String sshUser, String sshPass) {
+		// 默认root用户
+		if (StrUtil.isEmpty(sshUser)) {
+			sshUser = "root";
+		}
+
+		final Connection connect = connect(sshHost, sshPort);
+		try {
+			connect.authenticateWithPassword(sshUser, sshPass);
+			return connect.openSession();
+		} catch (IOException e) {
+			throw new IORuntimeException(e);
+		}
+	}
+
+	/**
+	 * 执行Shell命令（使用EXEC方式）
+	 * <p>
+	 * 此方法单次发送一个命令到服务端，不读取环境变量，执行结束后自动关闭Session，不会产生阻塞。
+	 * </p>
+	 *
+	 * @param session   Session会话
+	 * @param cmd       命令
+	 * @param charset   发送和读取内容的编码
+	 * @param errStream 错误信息输出到的位置
+	 */
+	public static String exec(Session session, String cmd, Charset charset, OutputStream errStream) {
+		final String result;
+		try {
+			session.execCommand(cmd, charset.name());
+			result = IoUtil.read(new StreamGobbler(session.getStdout()), charset);
+
+			// 错误输出
+			IoUtil.copy(new StreamGobbler(session.getStdout()), errStream);
+		} catch (IOException e) {
+			throw new IORuntimeException(e);
+		} finally {
+			close(session);
+		}
+		return result;
+	}
+
+	/**
+	 * 执行Shell命令
+	 * <p>
+	 * 此方法单次发送一个命令到服务端，自动读取环境变量，执行结束后自动关闭Session，不会产生阻塞。
+	 * </p>
+	 *
+	 * @param session   Session会话
+	 * @param cmd       命令
+	 * @param charset   发送和读取内容的编码
+	 * @param errStream 错误信息输出到的位置
+	 */
+	public static String execByShell(Session session, String cmd, Charset charset, OutputStream errStream) {
+		final String result;
+		try {
+			session.requestDumbPTY();
+			IoUtil.write(session.getStdin(), charset, true, cmd);
+
+			result = IoUtil.read(new StreamGobbler(session.getStdout()), charset);
+			if(null != errStream){
+				// 错误输出
+				IoUtil.copy(new StreamGobbler(session.getStdout()), errStream);
+			}
+		} catch (IOException e) {
+			throw new IORuntimeException(e);
+		} finally {
+			close(session);
+		}
+		return result;
+	}
+
+	/**
+	 * 关闭会话
+	 *
+	 * @param session 会话通道
+	 */
+	public static void close(Session session) {
+		if (session != null) {
+			session.close();
+		}
+	}
+}
diff --git a/hutool-extra/src/main/java/cn/hutool/extra/ssh/JschUtil.java b/hutool-extra/src/main/java/cn/hutool/extra/ssh/JschUtil.java
index 8d2df2a45..9222dc315 100644
--- a/hutool-extra/src/main/java/cn/hutool/extra/ssh/JschUtil.java
+++ b/hutool-extra/src/main/java/cn/hutool/extra/ssh/JschUtil.java
@@ -417,7 +417,7 @@ public class JschUtil {
 	 * @param cmd       命令
 	 * @param charset   发送和读取内容的编码
 	 * @param errStream 错误信息输出到的位置
-	 * @return {@link ChannelExec}
+	 * @return 执行结果内容
 	 * @since 4.3.1
 	 */
 	public static String exec(Session session, String cmd, Charset charset, OutputStream errStream) {