| /* |
| * 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.proxy; |
| |
| import java.net.InetSocketAddress; |
| import java.util.ArrayList; |
| import java.util.Arrays; |
| import java.util.List; |
| import java.util.concurrent.Callable; |
| import java.util.concurrent.TimeUnit; |
| import java.util.concurrent.atomic.AtomicReference; |
| |
| import org.apache.sshd.client.session.ClientSession; |
| import org.eclipse.jgit.annotations.NonNull; |
| import org.eclipse.jgit.internal.transport.sshd.JGitClientSession; |
| |
| /** |
| * Basic common functionality for a {@link StatefulProxyConnector}. |
| */ |
| public abstract class AbstractClientProxyConnector |
| implements StatefulProxyConnector { |
| |
| private static final long DEFAULT_PROXY_TIMEOUT_MILLIS = TimeUnit.SECONDS |
| .toMillis(30L); |
| |
| /** Guards {@link #done} and {@link #bufferedCommands}. */ |
| private Object lock = new Object(); |
| |
| private boolean done; |
| |
| private List<Callable<Void>> bufferedCommands = new ArrayList<>(); |
| |
| private AtomicReference<Runnable> unregister = new AtomicReference<>(); |
| |
| private long remainingProxyProtocolTime = DEFAULT_PROXY_TIMEOUT_MILLIS; |
| |
| private long lastProxyOperationTime = 0L; |
| |
| /** The ultimate remote address to connect to. */ |
| protected final InetSocketAddress remoteAddress; |
| |
| /** The proxy address. */ |
| protected final InetSocketAddress proxyAddress; |
| |
| /** The user to authenticate at the proxy with. */ |
| protected String proxyUser; |
| |
| /** The password to use for authentication at the proxy. */ |
| protected char[] proxyPassword; |
| |
| /** |
| * Creates a new {@link AbstractClientProxyConnector}. |
| * |
| * @param proxyAddress |
| * of the proxy server we're connecting to |
| * @param remoteAddress |
| * of the target server to connect to |
| * @param proxyUser |
| * to authenticate at the proxy with; may be {@code null} |
| * @param proxyPassword |
| * to authenticate at the proxy with; may be {@code null} |
| */ |
| public AbstractClientProxyConnector(@NonNull InetSocketAddress proxyAddress, |
| @NonNull InetSocketAddress remoteAddress, String proxyUser, |
| char[] proxyPassword) { |
| this.proxyAddress = proxyAddress; |
| this.remoteAddress = remoteAddress; |
| this.proxyUser = proxyUser; |
| this.proxyPassword = proxyPassword == null ? new char[0] |
| : proxyPassword; |
| } |
| |
| /** |
| * Initializes this instance. Installs itself as proxy handler on the |
| * session. |
| * |
| * @param session |
| * to initialize for |
| */ |
| protected void init(ClientSession session) { |
| remainingProxyProtocolTime = session.getLongProperty( |
| StatefulProxyConnector.TIMEOUT_PROPERTY, |
| DEFAULT_PROXY_TIMEOUT_MILLIS); |
| if (remainingProxyProtocolTime <= 0L) { |
| remainingProxyProtocolTime = DEFAULT_PROXY_TIMEOUT_MILLIS; |
| } |
| if (session instanceof JGitClientSession) { |
| JGitClientSession s = (JGitClientSession) session; |
| unregister.set(() -> s.setProxyHandler(null)); |
| s.setProxyHandler(this); |
| } else { |
| // Internal error, no translation |
| throw new IllegalStateException( |
| "Not a JGit session: " + session.getClass().getName()); //$NON-NLS-1$ |
| } |
| } |
| |
| /** |
| * Obtains the timeout for the whole rest of the proxy connection protocol. |
| * |
| * @return the timeout in milliseconds, always > 0L |
| */ |
| protected long getTimeout() { |
| long last = lastProxyOperationTime; |
| long now = System.nanoTime(); |
| lastProxyOperationTime = now; |
| long remaining = remainingProxyProtocolTime; |
| if (last != 0L) { |
| long elapsed = now - last; |
| remaining -= elapsed; |
| if (remaining < 0L) { |
| remaining = 10L; // Give it grace period. |
| } |
| } |
| remainingProxyProtocolTime = remaining; |
| return remaining; |
| } |
| |
| /** |
| * Adjusts the timeout calculation to not account of elapsed time since the |
| * last time the timeout was gotten. Can be used for instance to ignore time |
| * spent in user dialogs be counted against the overall proxy connection |
| * protocol timeout. |
| */ |
| protected void adjustTimeout() { |
| lastProxyOperationTime = System.nanoTime(); |
| } |
| |
| /** |
| * Sets the "done" flag. |
| * |
| * @param success |
| * whether the connector terminated successfully. |
| * @throws Exception |
| * if starting ssh fails |
| */ |
| protected void setDone(boolean success) throws Exception { |
| List<Callable<Void>> buffered; |
| Runnable unset = unregister.getAndSet(null); |
| if (unset != null) { |
| unset.run(); |
| } |
| synchronized (lock) { |
| done = true; |
| buffered = bufferedCommands; |
| bufferedCommands = null; |
| } |
| if (success && buffered != null) { |
| for (Callable<Void> starter : buffered) { |
| starter.call(); |
| } |
| } |
| } |
| |
| @Override |
| public void runWhenDone(Callable<Void> starter) throws Exception { |
| synchronized (lock) { |
| if (!done) { |
| bufferedCommands.add(starter); |
| return; |
| } |
| } |
| starter.call(); |
| } |
| |
| /** |
| * Clears the proxy password. |
| */ |
| protected void clearPassword() { |
| Arrays.fill(proxyPassword, '\000'); |
| proxyPassword = new char[0]; |
| } |
| } |