jgit/org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/internal/transport/sshd/JGitPublicKeyAuthentication.java

/*
 * Copyright (C) 2018, Thomas Wolf <thomas.wolf@paranor.ch>
 * and other copyright owners as documented in the project's IP log.
 *
 * This program and the accompanying materials are made available
 * under the terms of the Eclipse Distribution License v1.0 which
 * accompanies this distribution, is reproduced below, and is
 * available at http://www.eclipse.org/org/documents/edl-v10.php
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 *
 * - Neither the name of the Eclipse Foundation, Inc. nor the
 *   names of its contributors may be used to endorse or promote
 *   products derived from this software without specific prior
 *   written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.eclipse.jgit.internal.transport.sshd;

import java.util.List;

import org.apache.sshd.client.auth.pubkey.UserAuthPublicKey;
import org.apache.sshd.client.session.ClientSession;
import org.apache.sshd.common.NamedFactory;
import org.apache.sshd.common.signature.Signature;

/**
 * A specialized public key authentication handler that uses our own
 * {@link JGitPublicKeyIterator}. The super class creates in
 * {@link #init(ClientSession, String)} a
 * {@link org.apache.sshd.client.auth.pubkey.UserAuthPublicKeyIterator}, which
 * in its constructor does some strange {@link java.util.stream.Stream} "magic"
 * that ends up loading keys prematurely.
 */
public class JGitPublicKeyAuthentication extends UserAuthPublicKey {

	private ClientSession clientSession;

	private String serviceName;

	/**
	 * Creates a new {@link JGitPublicKeyAuthentication}.
	 *
	 * @param factories
	 *            signature factories to use
	 */
	public JGitPublicKeyAuthentication(
			List<NamedFactory<Signature>> factories) {
		super(factories);
	}

	@Override
	public void init(ClientSession session, String service) throws Exception {
		// Do *not* call super.init(); it'll create a UserAuthPublicKeyIterator
		// and that's where things then go wrong. Instead, do the whole
		// initialization directly here.
		clientSession = session;
		serviceName = service;
		releaseKeys();
		// Use our own iterator!
		keys = new JGitPublicKeyIterator(session, this);
	}

	@Override
	public ClientSession getClientSession() {
		return clientSession;
	}

	@Override
	public ClientSession getSession() {
		return clientSession;
	}

	@Override
	public String getService() {
		return serviceName;
	}
}