Browse Source
We will get an API evolution problem if we expose as API classes and interfaces that derive from upstream classes or interfaces. Upstream interfaces also evolve quite erratically and evolution doesn't seem to follow semantic versioning. Introduce a new KeyPasswordProvider interface so that we don't have to depend on the upstream FilePasswordProvider in our API. (We do need _some_ abstraction for getting passwords for encrypted keys in the API; EGit will need to provide its own implementation.) Move some other upstream dependencies (HostConfigEntry, and various previously protected methods in SshdSessionFactory) out of the API: classes moved to internal space, and methods made private. The only dependencies on upstream interfaces are thus in a few method parameter types. Those cannot be avoided, but should also not pose problems. Bug: 520927 Change-Id: Idc9c6b0f237f29f46343c0fe15179242f2007bec Signed-off-by: Thomas Wolf <thomas.wolf@paranor.ch>stable-5.2
Thomas Wolf
6 years ago
committed by
Matthias Sohn
10 changed files with 343 additions and 94 deletions
@ -0,0 +1,137 @@
|
||||
/* |
||||
* 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.io.IOException; |
||||
import java.net.URISyntaxException; |
||||
import java.security.GeneralSecurityException; |
||||
import java.util.Arrays; |
||||
import java.util.Map; |
||||
import java.util.concurrent.ConcurrentHashMap; |
||||
import java.util.concurrent.atomic.AtomicInteger; |
||||
|
||||
import org.eclipse.jgit.annotations.NonNull; |
||||
import org.eclipse.jgit.transport.CredentialsProvider; |
||||
import org.eclipse.jgit.transport.URIish; |
||||
import org.eclipse.jgit.transport.sshd.KeyPasswordProvider; |
||||
|
||||
/** |
||||
* A bridge from sshd's {@link RepeatingFilePasswordProvider} to our |
||||
* {@link KeyPasswordProvider} API. |
||||
*/ |
||||
public class PasswordProviderWrapper implements RepeatingFilePasswordProvider { |
||||
|
||||
private final KeyPasswordProvider delegate; |
||||
|
||||
private Map<String, AtomicInteger> counts = new ConcurrentHashMap<>(); |
||||
|
||||
/** |
||||
* @param delegate |
||||
*/ |
||||
public PasswordProviderWrapper(@NonNull KeyPasswordProvider delegate) { |
||||
this.delegate = delegate; |
||||
} |
||||
|
||||
@Override |
||||
public void setAttempts(int numberOfPasswordPrompts) { |
||||
delegate.setAttempts(numberOfPasswordPrompts); |
||||
} |
||||
|
||||
@Override |
||||
public int getAttempts() { |
||||
return delegate.getAttempts(); |
||||
} |
||||
|
||||
@Override |
||||
public String getPassword(String resourceKey) throws IOException { |
||||
int attempt = counts |
||||
.computeIfAbsent(resourceKey, k -> new AtomicInteger()).get(); |
||||
char[] passphrase = delegate.getPassphrase(toUri(resourceKey), attempt); |
||||
if (passphrase == null) { |
||||
return null; |
||||
} |
||||
try { |
||||
return new String(passphrase); |
||||
} finally { |
||||
Arrays.fill(passphrase, '\000'); |
||||
} |
||||
} |
||||
|
||||
@Override |
||||
public ResourceDecodeResult handleDecodeAttemptResult(String resourceKey, |
||||
String password, Exception err) |
||||
throws IOException, GeneralSecurityException { |
||||
AtomicInteger count = counts.get(resourceKey); |
||||
int numberOfAttempts = count == null ? 0 : count.incrementAndGet(); |
||||
ResourceDecodeResult result = null; |
||||
try { |
||||
if (delegate.keyLoaded(toUri(resourceKey), numberOfAttempts, err)) { |
||||
result = ResourceDecodeResult.RETRY; |
||||
} else { |
||||
result = ResourceDecodeResult.TERMINATE; |
||||
} |
||||
} finally { |
||||
if (result != ResourceDecodeResult.RETRY) { |
||||
counts.remove(resourceKey); |
||||
} |
||||
} |
||||
return result; |
||||
} |
||||
|
||||
/** |
||||
* Creates a {@link URIish} from a given string. The |
||||
* {@link CredentialsProvider} uses uris as resource identifications. |
||||
* |
||||
* @param resourceKey |
||||
* to convert |
||||
* @return the uri |
||||
*/ |
||||
private URIish toUri(String resourceKey) { |
||||
try { |
||||
return new URIish(resourceKey); |
||||
} catch (URISyntaxException e) { |
||||
return new URIish().setPath(resourceKey); // Doesn't check!!
|
||||
} |
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,117 @@
|
||||
/* |
||||
* 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.transport.sshd; |
||||
|
||||
import java.io.IOException; |
||||
import java.security.GeneralSecurityException; |
||||
|
||||
import org.eclipse.jgit.transport.URIish; |
||||
|
||||
/** |
||||
* A {@code KeyPasswordProvider} provides passwords for encrypted private keys. |
||||
* |
||||
* @since 5.2 |
||||
*/ |
||||
public interface KeyPasswordProvider { |
||||
|
||||
/** |
||||
* Obtains a passphrase to use to decrypt an ecrypted private key. Returning |
||||
* {@code null} or an empty array will skip this key. To cancel completely, |
||||
* the operation should raise |
||||
* {@link java.util.concurrent.CancellationException}. |
||||
* |
||||
* @param uri |
||||
* identifying the key resource that is being attempted to be |
||||
* loaded |
||||
* @param attempt |
||||
* the number of previous attempts to get a passphrase; >= 0 |
||||
* @return the passphrase |
||||
* @throws IOException |
||||
* if no password can be obtained |
||||
*/ |
||||
char[] getPassphrase(URIish uri, int attempt) throws IOException; |
||||
|
||||
/** |
||||
* Define the maximum number of attempts to get a passphrase that should be |
||||
* attempted for one identity resource through this provider. |
||||
* |
||||
* @param maxNumberOfAttempts |
||||
* number of times to ask for a passphrase; |
||||
* {@link IllegalArgumentException} may be thrown if <= 0 |
||||
*/ |
||||
void setAttempts(int maxNumberOfAttempts); |
||||
|
||||
/** |
||||
* Gets the maximum number of attempts to get a passphrase that should be |
||||
* attempted for one identity resource through this provider. The default |
||||
* return 1. |
||||
* |
||||
* @return the number of times to ask for a passphrase; should be >= 1. |
||||
*/ |
||||
default int getAttempts() { |
||||
return 1; |
||||
} |
||||
|
||||
/** |
||||
* Invoked after a key has been loaded. If this raises an exception, the |
||||
* original {@code error} is lost unless it is attached to that exception. |
||||
* |
||||
* @param uri |
||||
* identifying the key resource the key was attempted to be |
||||
* loaded from |
||||
* @param attempt |
||||
* the number of times {@link #getPassphrase(URIish, int)} had |
||||
* been called; zero indicates that {@code uri} refers to a |
||||
* non-encrypted key |
||||
* @param error |
||||
* {@code null} if the key was loaded successfully; otherwise an |
||||
* exception indicating why the key could not be loaded |
||||
* @return {@code true} to re-try again; {@code false} to re-raise the |
||||
* {@code error} exception; Ignored if the key was loaded |
||||
* successfully, i.e., if {@code error == null}. |
||||
* @throws IOException |
||||
* @throws GeneralSecurityException |
||||
*/ |
||||
boolean keyLoaded(URIish uri, int attempt, Exception error) |
||||
throws IOException, GeneralSecurityException; |
||||
} |
||||
Loading…
Reference in new issue