java sshd实现连接ssh操作

已于 2022-04-14 17:20:42 修改
阅读量5.4k 收藏 20
点赞数 7
分类专栏： 开发日常 Java 文章标签： java apache
于 2022-02-11 12:06:32 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_22973811/article/details/122877733
版权

文章目录

说明

  • 本博客每周五更新一次。
  • 日常使用ssh连接工具是jsch实现，但该库从2018年开始停止更新，项目开发中使用免密登录功能时，因为ssh加密算法版本过低失败，最后不得不使用账号密码连接。那次后，萌生了寻找替代方案的想法，并找到了sshd库。

分享

记录

导包

maven导包如下：

<dependency>
    <groupId>org.apache.sshd</groupId>
    <artifactId>sshd-scp</artifactId>
    <version>2.8.0</version>
</dependency>

代码

实例代码实现了远程命令执行、scp文件上传和下载，基于sftp的未实现。


import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

import org.apache.sshd.client.SshClient;
import org.apache.sshd.client.channel.ChannelExec;
import org.apache.sshd.client.session.ClientSession;
import org.apache.sshd.scp.client.DefaultScpClientCreator;
import org.apache.sshd.scp.client.ScpClient;
import org.apache.sshd.scp.client.ScpClientCreator;
import org.apache.sshd.sftp.client.SftpClient;
import org.apache.sshd.sftp.client.impl.DefaultSftpClientFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.tool.cn.model.SshModel;


/**
 * 
 * @author wangzonghui
 * @date 2022年2月7日 上午9:55:58 
 * @Description ssh工具类测试
 */
public final class SshSshdUtil {
	
	private  final static Logger log = LoggerFactory.getLogger(SshSshdUtil.class);
	
	private String host;
	private String user;
	private String password;
	private int port;
	
	 private ClientSession session;
	 private  SshClient client;
	
	/**
	 * 创建一个连接
	 * 
	 * @param host     地址
	 * @param user     用户名
	 * @param port     ssh端口
	 * @param password 密码
	 */
	public SshSshdUtil(String host,String user,int port,String password) {
		this.host = host;
		this.user = user;
		this.port=port;
		this.password=password;
	}

	/**
	 * 登录
	 * @return
	 * @throws Exception
	 */
	public boolean initialSession() {
		if (session == null) {
			
			try {
				// 创建 SSH客户端
				client = SshClient.setUpDefaultClient();
				// 启动 SSH客户端
				client.start();
				// 通过主机IP、端口和用户名，连接主机，获取Session
				session = client.connect(user, host, port).verify().getSession();
				// 给Session添加密码
				session.addPasswordIdentity(password);
				// 校验用户名和密码的有效性
				return session.auth().verify().isSuccess();
				
			} catch (Exception e) {
				log.info("Login Host:"+host+" Error",e);
				return false;
			}
		}
		
		return true;
	}

	/**
	 * 关闭连接
	 * @throws Exception
	 */
	public void close() throws Exception  {
		//关闭session
		if (session != null && session.isOpen()) {
            session.close();
        }
		
		// 关闭 SSH客户端
        if (client != null && client.isOpen()) {
            client.stop();
            client.close();
        }
	}
	
	/**
	 * 下载文件 基于sftp
	 * 
	 * @param localFile  本地文件名，若为空或是*，表示目前下全部文件
	 * @param remotePath 远程路径，若为空，表示当前路径，若服务器上无此目录，则会自动创建
	 * @throws Exception
	 */
	public boolean sftpGetFile(String localFile, String remoteFile) {
		SftpClient sftp=null;
		InputStream is=null;
		try {
			if(this.initialSession()) {
				DefaultSftpClientFactory sftpFactory=new DefaultSftpClientFactory();
				sftp=sftpFactory.createSftpClient(session);
				is=sftp.read(remoteFile);
		        Path dst=Paths.get(localFile);
		        Files.deleteIfExists(dst);
		        Files.copy(is, dst);
		        
			}
		} catch (Exception e) {
			log.error(host+"Local File "+localFile+" Sftp Get File:"+remoteFile+" Error",e);
			return false;
		}finally {
			try {
				if(is!=null) {
					is.close();
				}
				if(sftp!=null) {
					sftp.close();
				}
				
			} catch (Exception e) {
				log.error("Close Error",e);
			}
			
		}
		return true;
	}
	
	/**
	 * 下载文件 基于sftp
	 * 
	 * @param localFile  本地文件名，若为空或是*，表示目前下全部文件
	 * @param remotePath 远程路径，若为空，表示当前路径，若服务器上无此目录，则会自动创建
	 * @param outTime 超时时间 单位毫秒
	 * @throws Exception
	 */
	public boolean sftpGetFile(String localFile, String remoteFile,int timeOut) {
		ProcessWithTimeout process=new ProcessWithTimeout(localFile,remoteFile,1);
		int exitCode=process.waitForProcess(timeOut);
		
		if(exitCode==-1) {
			log.error("{} put Local File {} To Sftp Path:{} Time Out",host,localFile,remoteFile);
		}
		return exitCode==0?true:false;
	}

	/**
	 * 上传文件 基于sftp
	 * 
	 * @param localFile  本地文件名，若为空或是*，表示目前下全部文件
	 * @param remotePath 远程路径，若为空，表示当前路径，若服务器上无此目录，则会自动创建
	 * @param outTime 超时时间 单位毫秒
	 * @throws Exception
	 */
	public boolean sftpPutFile(String localFile, String remoteFile,int timeOut) {
		ProcessWithTimeout process=new ProcessWithTimeout(localFile,remoteFile,0);
		int exitCode=process.waitForProcess(timeOut);
		
		if(exitCode==-1) {
			log.error("{} put Local File {} To Sftp Path:{} Time Out",host,localFile,remoteFile);
		}
		return exitCode==0?true:false;
	}
	
	/**
	 * 
	 * @author wangzonghui
	 * @date 2022年4月13日 下午2:15:17 
	 * @Description 任务执行线程，判断操作超时使用
	 */
	class ProcessWithTimeout extends Thread{
		
		private String localFile;
		private String remoteFile;
		private int type;
		private int exitCode =-1;
		
		/**
		 * 
		 * @param localFile 本地文件
		 * @param remoteFile  sftp服务器文件
		 * @param type 0 上传  1 下载
		 */
		public ProcessWithTimeout(String localFile, String remoteFile,int type) {
			this.localFile=localFile;
			this.remoteFile=remoteFile;
			this.type=type;
		}
		
		public int waitForProcess(int outtime){
			  this.start();
			  
			  try{
			     this.join(outtime);
			  }catch (InterruptedException e){
			   log.error("Wait Is Error",e);
			  }
			  
			  return exitCode;
		 }
		
		@Override
		public void run() {
			super.run();
			boolean state;
			if(type==0) {
				state=sftpPutFile(localFile, remoteFile);
			}else {
				state=sftpGetFile(localFile, remoteFile);
			}
			
			exitCode= state==true?0:1;
		}
	}
	
	/**
	 * 上传文件 基于sftp
	 * 
	 * @param localFile  本地文件名，若为空或是*，表示目前下全部文件
	 * @param remotePath 远程路径，若为空，表示当前路径，若服务器上无此目录，则会自动创建
	 * @throws Exception
	 */
	public boolean sftpPutFile(String localFile, String remoteFile) {
		SftpClient sftp=null;
		OutputStream os=null;
		try {
			if(this.initialSession()) {
				DefaultSftpClientFactory sftpFactory=new DefaultSftpClientFactory();
				sftp=sftpFactory.createSftpClient(session);

				os=sftp.write(remoteFile,1024);
		        Files.copy(Paths.get(localFile), os);
			}

		} catch (Exception e) {
			log.error(host+"Local File "+localFile+" Sftp Upload File:"+remoteFile+" Error",e);
			return false;
		}finally {
			try {
				if(os!=null) {
					os.close();
				}
				if(sftp!=null) {
					sftp.close();
				}
				
			} catch (Exception e) {
				log.error("Close Error",e);
			}
		}
		return true;
	}

	/**
	 * 上传文件 基于scp
	 * 
	 * @param localFile  本地文件名，若为空或是*，表示目前下全部文件
	 * @param remotePath 远程路径，若为空，表示当前路径，若服务器上无此目录，则会自动创建
	 * @throws Exception
	 */
	public boolean scpPutFile( String localFile, String remoteFile) {
		ScpClient scpClient=null;
		try {
			if(this.initialSession()) {
				ScpClientCreator creator = new DefaultScpClientCreator();

	            // 创建 SCP 客户端
	            scpClient = creator.createScpClient(session);

	            // ScpClient.Option.Recursive：递归copy，可以将子文件夹和子文件遍历copy
	            scpClient.upload(localFile, remoteFile, ScpClient.Option.Recursive);
	            
			}else {
				log.error("Host:{} User:{} Upload Local File:{} Error",host,user,localFile);
				return false;
			}
			
		} catch (Exception e) {
			log.error(e.toString(), e);
			return false;
		}finally {
			// 释放 SCP客户端
            if (scpClient != null) {
                scpClient = null;
            }
		}

		return true;
	}

	/**
	 * 下载文件 基于scp
	 * 
	 * @param localPath  本地路径，若为空，表示当前路径
	 * @param localFile  本地文件名，若为空或是*，表示目前下全部文件
	 * @param remotePath 远程路径，若为空，表示当前路径，若服务器上无此目录，则会自动创建
	 * @throws Exception
	 */
	public boolean scpGetFile( String localFile, String remoteFile) {
		ScpClient scpClient=null;
		try {
			if(this.initialSession()) {
				ScpClientCreator creator = new DefaultScpClientCreator();
	            // 创建 SCP 客户端
	            scpClient = creator.createScpClient(session);

	            scpClient.download(remoteFile, localFile);  //下载文件
	            
			}else {
				log.error("Host:{} User:{} Get File:{} Error",host,user,remoteFile);
				return false;
			}
			
		} catch (Exception e) {
			log.error(e.toString(), e);
			return false;
		}finally {
			 // 释放 SCP客户端
            if (scpClient != null) {
                scpClient = null;
            }
            
		}

		return true;
	}
	
	/**
	 * 执行远程命令 
	 * @param command 执行的命令
	 * @return 0成功 1异常
	 * @throws Exception
	 */
	public int runCommand(String command)  {
		ChannelExec channel=null;
		try {
			if(this.initialSession()) {
				channel=session.createExecChannel(command);
				int time = 0;
				boolean run = false;
				
				channel.open();
				ByteArrayOutputStream err = new ByteArrayOutputStream();
				channel.setErr(err);
				
		        
				while (true) {
					if (channel.isClosed() || run) {
						break;
					}
					try {
						Thread.sleep(100);
					} catch (Exception e) {
						
					}
					if (time > 1800) {
						break;
					}
					time++;
				}

				int status=channel.getExitStatus();
				
				if(status>0) {
					log.info("{}  host:{} user:{} Run Is code:{} Message:{}",command,host,user,status,err.toString());
				}
				
				return status;
			}else {
				log.error("Host:{} User:{} Login Error",host,user);
				return 1;
			}
			
		} catch (Exception e) {
			log.error("Host "+host+" Run Command Error:"+command+" " +e.toString(),e);
			return 1;
		}finally {
			if(channel!=null) {
				try {
					channel.close();
				} catch (Exception e) {
					log.error("Close Connection Error");
				}
			}
			
		}
	}

	/**
	 * 执行远程命令 
	 * @param command 执行的命令
	 * @return 0成功 其他 异常
	 * @throws Exception
	 */
	public SshModel run(String command)  {
		SshModel sshModel=new SshModel();
		ChannelExec channel=null;
		try {
			if(this.initialSession()) {
				channel=session.createExecChannel(command);
				int time = 0;
				boolean run = false;

				channel.open();
				ByteArrayOutputStream info = new ByteArrayOutputStream();
				channel.setOut(info);
				ByteArrayOutputStream err = new ByteArrayOutputStream();
				channel.setErr(err);
		        
				while (true) {
					if (channel.isClosed() || run) {
						break;
					}
					try {
						Thread.sleep(100);
					} catch (Exception ee) {
					}
					if (time > 180) {

						break;
					}
					time++;
				}
		        
		        int status=channel.getExitStatus();
				
				sshModel.setCode(status);
				sshModel.setInfo(info.toString());
				sshModel.setError(err.toString());
			}else {
				log.error("Host:{} User:{} Login Error",host,user);
				sshModel.setCode(1);
				sshModel.setError("Loging Error");
			}
			
		} catch (Exception e) {
			log.error("Host "+host+"Run Command Error:"+command+" " +e.toString(),e);
			sshModel.setCode(1);
			
		}finally {
			if(channel!=null) {
				try {
					channel.close();
				} catch (IOException e) {
					log.error("Close Connection Error");
				}
			}
		}
		return sshModel;
	}
}
  • 引用数据模型类SshModel
package ssh.model.cn;

/**
 * 
 * @author wangzonghui
 * @date 2020年8月14日 下午3:09:24 
 * @Description:ssh模型类
 */
public class SshModel {
	
	/**
	 * 状态码
	 */
	private int code;
	
	/**
	 * 信息
	 */
	private String info;
	
	/**
	 * 错误信息
	 */
	private String error;

	public int getCode() {
		return code;
	}

	public void setCode(int code) {
		this.code = code;
	}

	public String getInfo() {
		return info;
	}

	public void setInfo(String info) {
		this.info = info;
	}

	public String getError() {
		return error;
	}

	public void setError(String error) {
		this.error = error;
	}

	@Override
	public String toString() {
		return "SshModel [code=" + code + ", info=" + info + ", error=" + error + "]";
	}
	
}

总结

  • 学习技术是个漫长有趣的过程，同样功能的更好方式实现，更高效执行，功能的快速开发，都是自我的价值体现。
  • 本文为2022年第一篇博客，新开始，新征程，小步慢跑，加油努力，做任何事都不会容易。
羽落风起
关注
  • 7
    点赞
  • 踩
  • 20
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
java ssh连接_Java通过ssh远程连接服务器
weixin_30567751的博客
02-12 2006
直接进入主题~一、服务器登陆公钥秘钥设置步骤如下：1、本机生成私钥公钥文件本机进入到.ssh目录下，c:/Users/UserName/.ssh， 在该目录下执行$ ssh-keygen -t rsa然后一路回车即可。说明：如果原先./ssh目录下有id_rsa id_rsa.pub这两个文件，以上的一路回车操作会生成新的id_rsa id_rsa.pub来覆盖原来的key文件。或者想生成不同...
java ssh连接,使用Java的SSH连接
weixin_28738173的博客
02-12 1094
I am trying to establish an SSH connection through my Java code, but getting below exception .. I tested my connection through Putty/Winscp tools and it works fine. The problem is with my Java code......
SSH服务端 Apache SSHD
06-06
SSH服务端 Apache SSHD
Java【问题 07】SSH不同版本使用jsch问题处理（7.4升级9.7及欧拉原生8.8）
最新发布
Java与大数据相关实践内容分享！
06-07 1287
SSH不同版本使用jsch问题处理（7.4升级9.7及欧拉原生8.8）
Java的SSH连接远程服务器
2401_84411879的博客
04-18 1190
这样，等真的沉下心来学习，不至于被找资料分散了心神。另外，给大家安排了一波学习面试资料：以上就是本文的全部内容，希望对大家的面试有所帮助，祝大家早日升职加薪迎娶白富美走上人生巅峰！《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！家安排了一波学习面试资料：[外链图片转存中…(img-8ALEL915-1713449438057)][外链图片转存中…(img-OrbIxceK-1713449438058)]
java远程连接ssh的实现
ceshiren456的博客
06-06 3710
在开发或者测试的过程中，经常会登录到远程服务器上进行一系列操作（如目录跳转、脚本执行等）；这些动作固定，但是每次重复操作会显得较为繁琐。基于此，开发出一个自动化脚本用以代替手工执行很有必要。这里给大家介绍一种基于java的远程ssh连接实现工具，jsch。jsch作为一种ssh2的纯java实现，能够允许我们连接到一个sshd 服务器，进而进行文件传输、文件下载等操作，能够很轻松的将ssh的功能集成到代码当中。关于ssh的基本原理，我就不再做过多介绍。接下来，介绍下工具的使用（自行在maven仓库中搜索js
踩坑记录：java连接ssh的问题
子龙的博客
12-14 882
手里有个CS架构的老系统，服务端要用SSH的方式传文件。没想到写了两天！遇到一堆问题，于是记录下。（老系统真恶心啊！
Java 连接ssh工具总结
qq_36188688的博客
05-20 531
Java 连接ssh工具总结
java通过SSH连接调用服务器模型运算
weixin_38863607的博客
08-10 586
近期在进行项目开发中，遇到需要使用java进行模型调用的接口封装，在进行Linux服务器模型计算调用中遇到难题，经过在网上查找资料，整理一篇跨平台调用运算的实现。
java 连接SSH工具操作服务器 (构建者模式+Util类) 分享
Record Little
09-07 3526
SSHBuilder 链式操作SSH工具类
SSH服务端 Apache SSHD源码
05-15
Apache SSHD是一个开源项目，由Apache软件基金会维护，它提供了实现Secure Shell (SSH)协议的服务器端实现。SSH是一种网络协议，广泛用于在不安全的网络环境中提供安全的远程登录和其他服务，例如文件传输和命令执行...
基于Java的实例开发源码-SSH服务端 Apache SSHD.zip
06-17
Apache SSHD是一个开源的Java实现，它提供了对SSH（Secure SHell）协议的支持，使得开发者能够在Java应用程序中构建SSH服务器和客户端。SSH是一种用于安全远程登录、文件传输和其他网络服务的协议，它通过加密技术...
基于java的SSH服务端 Apache SSHD.zip
05-27
Apache SSHD是一个基于Java实现的SSH（Secure SHell）服务器端框架，它允许开发者构建自己的SSH服务，提供安全的远程命令执行、文件传输等功能。SSH是一种网络协议，用于在不安全的网络环境中提供安全的通信通道。...
基于Java的SSH服务端 Apache SSHD.zip
06-17
Apache SSHD是一个强大的Java库，它实现了Secure Shell (SSH)协议，允许开发人员在Java环境中构建自己的SSH服务器或客户端。SSH是一种广泛使用的网络协议，用于安全地执行远程命令、文件传输和其他网络服务。Apache ...
使用纯Java实现一个WebSSH项目
weixin_44355857的博客
05-10 2194
webssh需要实时数据交互，选择长连接的WebSocket，为了开发的方便，框架选用SpringBoot，另外还自己了解了Java用户连接ssh的mina sshd和实现前端shell页面的xterm.js-- Mina sshd 支持 -->-- WebSocket 支持 -->5）mina sshd + websocket 核心业务逻辑实现其中涉及到的pojo及util。
java poi 4.1.2 操作excel说明
幻神舞的专栏
10-20 4791
目录 描述 导包 excel写入 excel读取 提醒 描述 poi是Apache下一款java语言excle高效读写工具，本博客将从读、写等方面做说明，xls（2007前版本）和xlsx（2007版本和此后），使用不同类，讲分开讲解，推荐使用xlsx，行数更多，相同数据，存储更小。 导包 import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.
java logback日志系统引入、配置、优化说明
幻神舞的专栏
02-26 1551
文章目录说明使用导包logbackslf4j 日志接口(推荐)commons-logging 日志接口janino 可选配置文件配置加载java代码启动参数项目引入总结 说明 logback是log4j作者 Ceki Gülcü的又一力作，相比log4j在性能与功能上有了很大提升，支持输出日志文件按时间或存储大小或时间加存储大小条件，满足自动删除日志，可设置独立输出指定目录下日志到指定文件，可设置全项目某级别日志输出到指定文件。 logback是我多年日常开发主要日志系统，个人非常喜欢，下面将分别日志接口
java 枚举
幻神舞的专栏
05-06 1018
文章目录说明分享介绍枚举方法枚举判断实例简单枚举复合枚举总结 说明 本博客每周五更新一次。 枚举是日常java开发中重要的数据处理类型，常用作公共状态值管理，以名称方式使用状态值代码直观，集中化的管理方式方便修改和调整。 分享 大数据博客列表 开发记录汇总 个人java工具库 项目https://gitee.com/wangzonghui/object-tool 包含json、string、集合、excel、zip压缩、pdf、bytes、http等多种工具，欢迎使用。 介绍 枚举方法
Java 连接SSH的第三方库
06-08
Java 连接SSH的第三方库有很多，以下是一些常用的库： 1. JSch：它是一个基于 SSH2 协议的纯 Java 实现，提供了连接 SSH 服务器、执行命令、传输文件等功能。 2. SSHJ：它是一个基于 SSH2 协议的高性能 Java 实现，支持连接 SSH 服务器、执行命令、传输文件等操作。 3. Ganymed SSH-2：它是一个轻量级的 SSH2 实现，提供了连接 SSH 服务器、执行命令、传输文件等功能。 4. Apache MINA SSHD：它是一个基于 Apache MINA 框架的 SSH2 实现，支持连接 SSH 服务器、执行命令、传输文件等操作。 以上是一些比较常用的 Java 连接 SSH 的第三方库，选择哪个库可以根据具体需求和个人喜好来决定。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值