1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
/*
* Copyright (C) 2018, 2022 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;
import static java.text.MessageFormat.format;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.security.GeneralSecurityException;
import java.security.InvalidKeyException;
import java.security.KeyPair;
import java.security.PrivateKey;
import java.security.PublicKey;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.concurrent.CancellationException;
import javax.security.auth.DestroyFailedException;
import org.apache.sshd.common.AttributeRepository.AttributeKey;
import org.apache.sshd.client.session.ClientSession;
import org.apache.sshd.common.NamedResource;
import org.apache.sshd.common.config.keys.FilePasswordProvider;
import org.apache.sshd.common.config.keys.KeyUtils;
import org.apache.sshd.common.keyprovider.FileKeyPairProvider;
import org.apache.sshd.common.session.SessionContext;
import org.apache.sshd.common.util.io.resource.IoResource;
import org.apache.sshd.common.util.security.SecurityUtils;
import org.eclipse.jgit.transport.sshd.KeyCache;
/**
* A {@link FileKeyPairProvider} that uses an external {@link KeyCache}.
*/
public class CachingKeyPairProvider extends FileKeyPairProvider
implements Iterable<KeyPair> {
/**
* An attribute set on the {@link SessionContext} recording loaded keys by
* fingerprint. This enables us to provide nicer output by showing key
* paths, if possible. Users can identify key identities used easier by
* filename than by fingerprint.
*/
public static final AttributeKey<Map<String, Path>> KEY_PATHS_BY_FINGERPRINT = new AttributeKey<>();
private final KeyCache cache;
/**
* Creates a new {@link CachingKeyPairProvider} using the given
* {@link KeyCache}. If the cache is {@code null}, this is a simple
* {@link FileKeyPairProvider}.
*
* @param paths
* to load keys from
* @param cache
* to use, may be {@code null} if no external caching is desired
*/
public CachingKeyPairProvider(List<Path> paths, KeyCache cache) {
super(paths);
this.cache = cache;
}
@Override
public Iterator<KeyPair> iterator() {
return iterator(null);
}
private Iterator<KeyPair> iterator(SessionContext session) {
Collection<? extends Path> resources = getPaths();
if (resources.isEmpty()) {
return Collections.emptyListIterator();
}
return new CancellingKeyPairIterator(session, resources);
}
@Override
public Iterable<KeyPair> loadKeys(SessionContext session) {
return () -> iterator(session);
}
static String getKeyId(ClientSession session, KeyPair identity) {
String fingerprint = KeyUtils.getFingerPrint(identity.getPublic());
Map<String, Path> registered = session
.getAttribute(KEY_PATHS_BY_FINGERPRINT);
if (registered != null) {
Path path = registered.get(fingerprint);
if (path != null) {
Path home = session
.resolveAttribute(JGitSshClient.HOME_DIRECTORY);
if (home != null && path.startsWith(home)) {
try {
path = home.relativize(path);
String pathString = path.toString();
if (!pathString.isEmpty()) {
return "~" + File.separator + pathString; //$NON-NLS-1$
}
} catch (IllegalArgumentException e) {
// Cannot be relativized. Ignore, and work with the
// original path
}
}
return path.toString();
}
}
return fingerprint;
}
private KeyPair loadKey(SessionContext session, Path path)
throws IOException, GeneralSecurityException {
if (!Files.exists(path)) {
log.warn(format(SshdText.get().identityFileNotFound, path));
return null;
}
IoResource<Path> resource = getIoResource(session, path);
if (cache == null) {
return loadKey(session, resource, path, getPasswordFinder());
}
Throwable[] t = { null };
KeyPair key = cache.get(path, p -> {
try {
return loadKey(session, resource, p, getPasswordFinder());
} catch (IOException | GeneralSecurityException e) {
t[0] = e;
return null;
}
});
if (t[0] != null) {
if (t[0] instanceof CancellationException) {
throw (CancellationException) t[0];
}
throw new IOException(
format(SshdText.get().keyLoadFailed, resource), t[0]);
}
return key;
}
private KeyPair loadKey(SessionContext session, NamedResource resource,
Path path, FilePasswordProvider passwordProvider)
throws IOException, GeneralSecurityException {
try (InputStream stream = Files.newInputStream(path)) {
Iterable<KeyPair> ids = SecurityUtils.loadKeyPairIdentities(session,
resource, stream, passwordProvider);
if (ids == null) {
throw new InvalidKeyException(
format(SshdText.get().identityFileNoKey, path));
}
Iterator<KeyPair> keys = ids.iterator();
if (!keys.hasNext()) {
throw new InvalidKeyException(format(
SshdText.get().identityFileUnsupportedFormat, path));
}
KeyPair result = keys.next();
PublicKey pk = result.getPublic();
if (pk != null) {
Map<String, Path> registered = session
.getAttribute(KEY_PATHS_BY_FINGERPRINT);
if (registered == null) {
registered = new HashMap<>();
session.setAttribute(KEY_PATHS_BY_FINGERPRINT, registered);
}
registered.put(KeyUtils.getFingerPrint(pk), path);
}
if (keys.hasNext()) {
log.warn(format(SshdText.get().identityFileMultipleKeys, path));
keys.forEachRemaining(k -> {
PrivateKey priv = k.getPrivate();
if (priv != null) {
try {
priv.destroy();
} catch (DestroyFailedException e) {
// Ignore
}
}
});
}
return result;
}
}
private class CancellingKeyPairIterator implements Iterator<KeyPair> {
private final SessionContext context;
private final Iterator<Path> paths;
private KeyPair nextItem;
private boolean nextSet;
public CancellingKeyPairIterator(SessionContext session,
Collection<? extends Path> resources) {
List<Path> copy = new ArrayList<>(resources.size());
copy.addAll(resources);
paths = copy.iterator();
context = session;
}
@Override
public boolean hasNext() {
if (nextSet) {
return nextItem != null;
}
nextSet = true;
while (nextItem == null && paths.hasNext()) {
try {
nextItem = loadKey(context, paths.next());
} catch (CancellationException cancelled) {
throw cancelled;
} catch (Exception other) {
log.warn(other.getMessage(), other);
}
}
return nextItem != null;
}
@Override
public KeyPair next() {
if (!nextSet && !hasNext()) {
throw new NoSuchElementException();
}
KeyPair result = nextItem;
nextItem = null;
nextSet = false;
if (result == null) {
throw new NoSuchElementException();
}
return result;
}
}
}
|