JGit与JSch7集成时如何实现带SSH密钥的Git仓库克隆？

Question

在使用JGit与JSch7集成时，如何实现带SSH密钥的Git仓库克隆是一个常见的技术问题。具体来说，当尝试通过SSH协议克隆私有Git仓库时，如何正确配置JSch作为JGit的SSH传输层，并指定私钥文件以完成身份验证？开发者经常遇到的问题包括：如何设置JSch的`UserInfo`或`HostKeyRepository`以避免主机密钥验证失败？如何通过JGit的`SshSessionFactory`自定义SSH连接参数？此外，如果私钥带有密码保护，又该如何处理用户交互或提供密码？这些问题若未妥善解决，可能导致克隆失败或安全风险。因此，明确JSch与JGit的集成细节及SSH密钥配置流程至关重要。

Answer 1

1. 基础概念：JGit与JSch7集成概述

JGit 是一个纯 Java 实现的 Git 库，允许开发者在 Java 程序中操作 Git 仓库。而 JSch 是一个用于执行 SSH 协议的 Java 库。将 JGit 与 JSch 集成时，可以通过 JSch 提供的 SSH 功能来克隆带私钥保护的 Git 仓库。

以下是一些常见的技术问题：

• 如何配置 JSch 的 `UserInfo` 或 `HostKeyRepository`？
• 如何通过 JGit 的 `SshSessionFactory` 自定义连接参数？
• 如果私钥带有密码保护，如何提供密码或实现用户交互？

这些问题若未妥善解决，可能导致克隆失败或安全风险。

2. 配置 JSch 的 UserInfo 和 HostKeyRepository

JSch 提供了 `UserInfo` 接口，用于处理用户认证和主机密钥验证。开发者可以通过自定义 `UserInfo` 类来避免主机密钥验证失败。

public class MyUserInfo implements com.jcraft.jsch.UserInfo {
    @Override
    public String getPassphrase() { return null; }
    @Override
    public String getPassword() { return null; }
    @Override
    public boolean promptPassword(String message) { return false; }
    @Override
    public boolean promptPassphrase(String message) { return false; }
    @Override
    public boolean promptYesNo(String message) { return true; } // 忽略主机密钥验证
    @Override
    public void showMessage(String message) {}
}

同时，可以使用 `HostKeyRepository` 来管理已知主机密钥：

HostKeyRepository repo = new KnownHosts(new File("/path/to/known_hosts"));
JSch.setConfig("StrictHostKeyChecking", "no");

3. 使用 SshSessionFactory 自定义 SSH 连接参数

JGit 提供了 `SshSessionFactory`，允许开发者自定义 SSH 连接行为。以下是一个示例代码：

SshSessionFactory sshSessionFactory = new JschConfigSessionFactory() {
    @Override
    protected void configure(OpenSshConfig.Host host, Session session) {
        session.setConfig("StrictHostKeyChecking", "no");
    }

    @Override
    protected JSch createJSch(OpenSshConfig.Host host, FS fs) throws JSchException {
        JSch jsch = super.createJSch(host, fs);
        jsch.addIdentity("/path/to/private/key");
        return jsch;
    }
};
Git.cloneRepository()
    .setURI("ssh://[e-mail]/user/repo.git")
    .setTransportConfigCallback(transport -> transport.setSshSessionFactory(sshSessionFactory))
    .call();

4. 处理带密码保护的私钥

如果私钥带有密码保护，可以通过 `UserInfo` 提供密码：

public class PasswordProtectedUserInfo implements UserInfo {
    private final String passphrase;

    public PasswordProtectedUserInfo(String passphrase) {
        this.passphrase = passphrase;
    }

    @Override
    public String getPassphrase() {
        return passphrase;
    }
    // 其他方法保持默认实现
}

然后将其传递给 JSch：

JSch jsch = new JSch();
jsch.addIdentity("/path/to/private/key", passphrase);

5. 集成流程图

以下是 JGit 与 JSch 集成的整体流程：

graph TD;
    A[开始] --> B[加载 JSch];
    B --> C[设置私钥路径];
    C --> D[配置 UserInfo];
    D --> E[创建 SshSessionFactory];
    E --> F[绑定到 JGit];
    F --> G[执行克隆操作];