SSHJ 教程：Java实现安全Shell连接

SSHJ 教程：Java实现安全Shell连接

sshjssh, scp and sftp for java项目地址:https://gitcode.com/gh_mirrors/ss/sshj

1. 项目介绍

SSHJ 是一个由 Hierynomus 开发并维护的开源 Java 库，它提供了对 SSH（Secure Shell）协议的支持，使得用户可以在 Java 应用程序中实现安全的远程命令执行、文件传输等功能。SSHJ 底层使用 Apache SSHD，但其API设计更加简洁易用。

2. 项目快速启动

要开始使用 SSHJ，首先确保你的项目已经集成了 SSHJ 的依赖。如果你使用的是 Maven，添加以下依赖到你的 pom.xml 文件：

<dependency>
    <groupId>com.hierynomus</groupId>
    <artifactId>sshj</artifactId>
    <version>0.35.0</version> <!-- 最新版本可能不同，请检查 https://mvnrepository.com/artifact/com.hierynomus/sshj -->
</dependency>

然后，你可以尝试一下简单的 SSH 连接示例：

import net.schmizz.sshj.SSHClient;
import net.schmizz.sshj.common.IOUtils;
import net.schmizz.sshj.connection.Connection;

public class SSHJQuickStart {
    public static void main(String[] args) throws Exception {
        SSHClient sshClient = new SSHClient();
        sshClient.addHostKeyVerifier(new PromiscuousVerifier()); // 不安全的验证，仅用于演示
        sshClient.connect("your-server-ip", 22);
        try {
            sshClient.authPassword("username", "password");
            Connection conn = sshClient.getConnection();
            System.out.println("Connected to server...");
            
            // 在这里执行远程命令或进行其他操作
        } finally {
            sshClient.disconnect();
        }
    }
}

3. 应用案例和最佳实践

执行远程命令

public void execRemoteCommand() throws IOException {
    SSHClient sshClient = new SSHClient();
    sshClient.addHostKeyVerifier(new PromiscuousVerifier());
    sshClient.connect("your-server-ip", 22);
    
    try {
        sshClient.authPublicKey("username", new File("path/to/your/id_rsa.pem")); // 使用公钥认证
        Session session = sshClient.startSession();
        Command cmd = session.exec("ls -l");
        
        IOUtils.readFully(cmd.getInputStream()).toString(Charset.defaultCharset());
        cmd.close();
        session.close();
    } finally {
        sshClient.disconnect();
    }
}

SCP 文件传输

import net.schmizz.sshj.xfer.scp.SCPFileTransfer;

// ... 忽略 SSH 客户端设置部分 ...

SCPFileTransfer scpTransfer = sshClient.getFileTransfer();
scpTransfer.put(new File("/local/path/file.txt"), "/remote/path/");
scpTransfer.shutdown();

// 或者下载文件
scpTransfer.get(new File("/remote/path/file.txt"), "/local/path/");

4. 典型生态项目

SSHJ 可以和其他 Java 工具和框架结合使用，例如 Spring Boot、Jenkins 等。它还能够与其他基于 SSH 的工具（如 Ansible）互操作，因为它们都是通过 SSH 协议通信的。

示例：Spring Boot 集成

在 Spring Boot 中配置 SSHJ，可以通过创建一个 Bean 来实现：

@Configuration
public class SSHConfig {

    @Bean
    public SSHClient sshClient() {
        SSHClient sshClient = new SSHClient();
        sshClient.addHostKeyVerifier(new PromiscuousVerifier());
        return sshClient;
    }

}

随后，你可以在其他服务类中注入这个 SSHClient Bean 并使用它。

以上就是 SSHJ 的基本介绍及使用教程。请务必在实际生产环境中替换掉不安全的 PromiscuousVerifier，并考虑使用更安全的主机键验证机制。更多详细信息请参考 SSHJ 的官方文档：https://github.com/hierynomus/sshj/blob/master/docs/README.md 。

sshjssh, scp and sftp for java项目地址:https://gitcode.com/gh_mirrors/ss/sshj