org.eclipse.jgit.ssh.apache.agent/src/org/eclipse/jgit/internal/transport/sshd/agent/connector/Factory.java

/*
 * Copyright (C) 2021, Thomas Wolf <thomas.wolf@paranor.ch> and others
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Distribution License v. 1.0 which is available at
 * https://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
package org.eclipse.jgit.internal.transport.sshd.agent.connector;

import java.io.File;
import java.io.IOException;
import java.text.MessageFormat;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Locale;

import org.eclipse.jgit.transport.sshd.agent.Connector;
import org.eclipse.jgit.transport.sshd.agent.ConnectorFactory;
import org.eclipse.jgit.util.StringUtils;
import org.eclipse.jgit.util.SystemReader;

/**
 * An {@link ConnectorFactory} for connecting to an OpenSSH SSH agent.
 */
public class Factory implements ConnectorFactory {

	private static final String NAME = "jgit-builtin"; //$NON-NLS-1$

	@Override
	public Connector create(String identityAgent, File homeDir)
			throws IOException {
		if (SystemReader.getInstance().isWindows()) {
			if (StringUtils.isEmptyOrNull(identityAgent)) {
				// Default.
				return new PageantConnector();
			}
			String winPath = identityAgent.replace('/', '\\');
			if (PageantConnector.DESCRIPTOR.getIdentityAgent()
					.equalsIgnoreCase(winPath)) {
				return new PageantConnector();
			}
			if (winPath.toLowerCase(Locale.ROOT).startsWith("\\\\.\\pipe\\")) { //$NON-NLS-1$
				return new WinPipeConnector(winPath);
			}
			throw new IOException(MessageFormat.format(
					Texts.get().errUnknownIdentityAgent, identityAgent));
		}
		return new UnixDomainSocketConnector(identityAgent);
	}

	@Override
	public boolean isSupported() {
		return true;
	}

	@Override
	public String getName() {
		return NAME;
	}

	/**
	 * {@inheritDoc}
	 * <p>
	 * This factory returns on Windows a
	 * {@link org.eclipse.jgit.transport.sshd.agent.ConnectorFactory.ConnectorDescriptor
	 * ConnectorDescriptor} for the internal name "pageant"; on Unix one for
	 * "SSH_AUTH_SOCK".
	 * </p>
	 */
	@Override
	public Collection<ConnectorDescriptor> getSupportedConnectors() {
		if (SystemReader.getInstance().isWindows()) {
			return List.of(PageantConnector.DESCRIPTOR,
					WinPipeConnector.DESCRIPTOR);
		}
		return Collections.singleton(UnixDomainSocketConnector.DESCRIPTOR);
	}

	@Override
	public ConnectorDescriptor getDefaultConnector() {
		if (SystemReader.getInstance().isWindows()) {
			return PageantConnector.DESCRIPTOR;
		}
		return UnixDomainSocketConnector.DESCRIPTOR;
	}
}