com.mooregreatsoftware.gitprocess.transport.SshAgentJschConfigSessionFactory.java Source code

Introduction

Here is the source code for com.mooregreatsoftware.gitprocess.transport.SshAgentJschConfigSessionFactory.java

Source

/*
 * Copyright 2016 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.mooregreatsoftware.gitprocess.transport;

import com.jcraft.jsch.IdentityRepository;
import com.jcraft.jsch.JSch;
import com.jcraft.jsch.JSchException;
import com.jcraft.jsch.Session;
import com.jcraft.jsch.agentproxy.AgentProxyException;
import com.jcraft.jsch.agentproxy.Connector;
import com.jcraft.jsch.agentproxy.RemoteIdentityRepository;
import com.jcraft.jsch.agentproxy.USocketFactory;
import com.jcraft.jsch.agentproxy.connector.SSHAgentConnector;
import com.jcraft.jsch.agentproxy.usocket.JNAUSocketFactory;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.eclipse.jgit.transport.JschConfigSessionFactory;
import org.eclipse.jgit.transport.OpenSshConfig;
import org.eclipse.jgit.util.FS;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * An extension of {@link JschConfigSessionFactory} that will use ssh-agent if it is available.
 */
public class SshAgentJschConfigSessionFactory extends JschConfigSessionFactory {
    private static final Logger LOG = LoggerFactory.getLogger(SshAgentJschConfigSessionFactory.class);

    static {
        JSch.setLogger(new com.jcraft.jsch.Logger() {
            @Override
            public boolean isEnabled(int level) {
                return true;
            }

            @Override
            public void log(int level, String message) {
                LOG.debug(message);
            }
        });
    }

    @Override
    protected void configure(OpenSshConfig.Host host, Session session) {
        // empty
    }

    @Override
    @SuppressWarnings("RedundantCast")
    protected JSch createDefaultJSch(FS fs) throws JSchException {
        final JSch jsch = super.createDefaultJSch(fs);

        try {
            if (SSHAgentConnector.isConnectorAvailable()) {
                USocketFactory usf = new JNAUSocketFactory();
                Connector conn = new SSHAgentConnector(usf);
                IdentityRepository identRepo = new RemoteIdentityRepository(conn);
                jsch.setIdentityRepository(identRepo);
            }
        } catch (AgentProxyException e) {
            LOG.error("Could not establish a connection to ssh-agent: {}", (@NonNull String) e.getMessage());
        }

        return jsch;
    }
}