forked from apache/pulsar
-
Notifications
You must be signed in to change notification settings - Fork 1
/
KeyStoreSSLContext.java
382 lines (345 loc) · 16.3 KB
/
KeyStoreSSLContext.java
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.pulsar.common.util.keystoretls;
import static org.apache.pulsar.common.util.SecurityUtility.getProvider;
import com.google.common.base.Strings;
import io.netty.handler.ssl.util.InsecureTrustManagerFactory;
import java.io.FileInputStream;
import java.io.IOException;
import java.security.GeneralSecurityException;
import java.security.KeyStore;
import java.security.Provider;
import java.security.SecureRandom;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import javax.net.ssl.KeyManager;
import javax.net.ssl.KeyManagerFactory;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLEngine;
import javax.net.ssl.TrustManagerFactory;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.apache.pulsar.common.util.SecurityUtility;
import org.eclipse.jetty.util.ssl.SslContextFactory;
/**
* KeyStoreSSLContext that mainly wrap a SSLContext to provide SSL context for both webservice and netty.
*/
@Slf4j
public class KeyStoreSSLContext {
public static final String DEFAULT_KEYSTORE_TYPE = "JKS";
public static final String DEFAULT_SSL_PROTOCOL = "TLS";
public static final String DEFAULT_SSL_ENABLED_PROTOCOLS = "TLSv1.3,TLSv1.2";
public static final String DEFAULT_SSL_KEYMANGER_ALGORITHM = KeyManagerFactory.getDefaultAlgorithm();
public static final String DEFAULT_SSL_TRUSTMANAGER_ALGORITHM = TrustManagerFactory.getDefaultAlgorithm();
public static final Provider BC_PROVIDER = getProvider();
/**
* Connection Mode for TLS.
*/
public enum Mode {
CLIENT,
SERVER
}
@Getter
private final Mode mode;
private final String sslProviderString;
private final String keyStoreTypeString;
private final String keyStorePath;
private final String keyStorePassword;
private final boolean allowInsecureConnection;
private final String trustStoreTypeString;
private final String trustStorePath;
private final String trustStorePassword;
private final boolean needClientAuth;
private final Set<String> ciphers;
private final Set<String> protocols;
private SSLContext sslContext;
private final String protocol = DEFAULT_SSL_PROTOCOL;
private final String kmfAlgorithm = DEFAULT_SSL_KEYMANGER_ALGORITHM;
private final String tmfAlgorithm = DEFAULT_SSL_TRUSTMANAGER_ALGORITHM;
// only init vars, before using it, need to call createSSLContext to create ssl context.
public KeyStoreSSLContext(Mode mode,
String sslProviderString,
String keyStoreTypeString,
String keyStorePath,
String keyStorePassword,
boolean allowInsecureConnection,
String trustStoreTypeString,
String trustStorePath,
String trustStorePassword,
boolean requireTrustedClientCertOnConnect,
Set<String> ciphers,
Set<String> protocols) {
this.mode = mode;
this.sslProviderString = sslProviderString;
this.keyStoreTypeString = Strings.isNullOrEmpty(keyStoreTypeString)
? DEFAULT_KEYSTORE_TYPE
: keyStoreTypeString;
this.keyStorePath = keyStorePath;
this.keyStorePassword = keyStorePassword;
this.trustStoreTypeString = Strings.isNullOrEmpty(trustStoreTypeString)
? DEFAULT_KEYSTORE_TYPE
: trustStoreTypeString;
this.trustStorePath = trustStorePath;
this.trustStorePassword = trustStorePassword;
this.needClientAuth = requireTrustedClientCertOnConnect;
if (protocols != null && protocols.size() > 0) {
this.protocols = protocols;
} else {
this.protocols = new HashSet<>(Arrays.asList(DEFAULT_SSL_ENABLED_PROTOCOLS.split("\\s*,\\s*")));
}
if (ciphers != null && ciphers.size() > 0) {
this.ciphers = ciphers;
} else {
this.ciphers = null;
}
this.allowInsecureConnection = allowInsecureConnection;
}
public SSLContext createSSLContext() throws GeneralSecurityException, IOException {
SSLContext sslContext;
if (sslProviderString != null) {
sslContext = SSLContext.getInstance(protocol, sslProviderString);
} else {
sslContext = SSLContext.getInstance(protocol);
}
// key store
KeyManager[] keyManagers = null;
if (!Strings.isNullOrEmpty(keyStorePath)) {
KeyManagerFactory keyManagerFactory = KeyManagerFactory.getInstance(kmfAlgorithm);
KeyStore keyStore = KeyStore.getInstance(keyStoreTypeString);
char[] passwordChars = keyStorePassword.toCharArray();
try (FileInputStream inputStream = new FileInputStream(keyStorePath)) {
keyStore.load(inputStream, passwordChars);
}
keyManagerFactory.init(keyStore, passwordChars);
keyManagers = keyManagerFactory.getKeyManagers();
}
// trust store
TrustManagerFactory trustManagerFactory;
if (this.allowInsecureConnection) {
trustManagerFactory = InsecureTrustManagerFactory.INSTANCE;
} else {
trustManagerFactory = sslProviderString != null
? TrustManagerFactory.getInstance(tmfAlgorithm, sslProviderString)
: TrustManagerFactory.getInstance(tmfAlgorithm);
KeyStore trustStore = KeyStore.getInstance(trustStoreTypeString);
char[] passwordChars = trustStorePassword.toCharArray();
try (FileInputStream inputStream = new FileInputStream(trustStorePath)) {
trustStore.load(inputStream, passwordChars);
}
trustManagerFactory.init(trustStore);
}
// init
sslContext.init(keyManagers, SecurityUtility
.processConscryptTrustManagers(trustManagerFactory.getTrustManagers()),
new SecureRandom());
this.sslContext = sslContext;
return sslContext;
}
public SSLContext getSslContext() {
if (sslContext == null) {
throw new IllegalStateException("createSSLContext hasn't been called.");
}
return sslContext;
}
public SSLEngine createSSLEngine() {
return configureSSLEngine(getSslContext().createSSLEngine());
}
public SSLEngine createSSLEngine(String peerHost, int peerPort) {
return configureSSLEngine(getSslContext().createSSLEngine(peerHost, peerPort));
}
private SSLEngine configureSSLEngine(SSLEngine sslEngine) {
sslEngine.setEnabledProtocols(protocols.toArray(new String[0]));
if (this.ciphers == null) {
sslEngine.setEnabledCipherSuites(sslEngine.getSupportedCipherSuites());
} else {
sslEngine.setEnabledCipherSuites(this.ciphers.toArray(new String[0]));
}
if (this.mode == Mode.SERVER) {
sslEngine.setNeedClientAuth(this.needClientAuth);
sslEngine.setUseClientMode(false);
} else {
sslEngine.setUseClientMode(true);
}
return sslEngine;
}
public static KeyStoreSSLContext createClientKeyStoreSslContext(String sslProviderString,
String keyStoreTypeString,
String keyStorePath,
String keyStorePassword,
boolean allowInsecureConnection,
String trustStoreTypeString,
String trustStorePath,
String trustStorePassword,
Set<String> ciphers,
Set<String> protocols)
throws GeneralSecurityException, IOException {
KeyStoreSSLContext keyStoreSSLContext = new KeyStoreSSLContext(Mode.CLIENT,
sslProviderString,
keyStoreTypeString,
keyStorePath,
keyStorePassword,
allowInsecureConnection,
trustStoreTypeString,
trustStorePath,
trustStorePassword,
false,
ciphers,
protocols);
keyStoreSSLContext.createSSLContext();
return keyStoreSSLContext;
}
public static KeyStoreSSLContext createServerKeyStoreSslContext(String sslProviderString,
String keyStoreTypeString,
String keyStorePath,
String keyStorePassword,
boolean allowInsecureConnection,
String trustStoreTypeString,
String trustStorePath,
String trustStorePassword,
boolean requireTrustedClientCertOnConnect,
Set<String> ciphers,
Set<String> protocols)
throws GeneralSecurityException, IOException {
KeyStoreSSLContext keyStoreSSLContext = new KeyStoreSSLContext(Mode.SERVER,
sslProviderString,
keyStoreTypeString,
keyStorePath,
keyStorePassword,
allowInsecureConnection,
trustStoreTypeString,
trustStorePath,
trustStorePassword,
requireTrustedClientCertOnConnect,
ciphers,
protocols);
keyStoreSSLContext.createSSLContext();
return keyStoreSSLContext;
}
// for web server use case, no need ciphers and protocols
public static SSLContext createServerSslContext(String sslProviderString,
String keyStoreTypeString,
String keyStorePath,
String keyStorePassword,
boolean allowInsecureConnection,
String trustStoreTypeString,
String trustStorePath,
String trustStorePassword,
boolean requireTrustedClientCertOnConnect)
throws GeneralSecurityException, IOException {
return createServerKeyStoreSslContext(
sslProviderString,
keyStoreTypeString,
keyStorePath,
keyStorePassword,
allowInsecureConnection,
trustStoreTypeString,
trustStorePath,
trustStorePassword,
requireTrustedClientCertOnConnect,
null,
null).getSslContext();
}
// for web client
public static SSLContext createClientSslContext(String sslProviderString,
String keyStoreTypeString,
String keyStorePath,
String keyStorePassword,
boolean allowInsecureConnection,
String trustStoreTypeString,
String trustStorePath,
String trustStorePassword,
Set<String> ciphers,
Set<String> protocol)
throws GeneralSecurityException, IOException {
KeyStoreSSLContext keyStoreSSLContext = new KeyStoreSSLContext(Mode.CLIENT,
sslProviderString,
keyStoreTypeString,
keyStorePath,
keyStorePassword,
allowInsecureConnection,
trustStoreTypeString,
trustStorePath,
trustStorePassword,
false,
ciphers,
protocol);
return keyStoreSSLContext.createSSLContext();
}
// for web client
public static SSLContext createClientSslContext(String keyStoreTypeString,
String keyStorePath,
String keyStorePassword,
String trustStoreTypeString,
String trustStorePath,
String trustStorePassword)
throws GeneralSecurityException, IOException {
KeyStoreSSLContext keyStoreSSLContext = new KeyStoreSSLContext(Mode.CLIENT,
null,
keyStoreTypeString,
keyStorePath,
keyStorePassword,
false,
trustStoreTypeString,
trustStorePath,
trustStorePassword,
false,
null,
null);
return keyStoreSSLContext.createSSLContext();
}
// for web server. autoRefresh is default true.
public static SslContextFactory createSslContextFactory(String sslProviderString,
String keyStoreTypeString,
String keyStore,
String keyStorePassword,
boolean allowInsecureConnection,
String trustStoreTypeString,
String trustStore,
String trustStorePassword,
boolean requireTrustedClientCertOnConnect,
long certRefreshInSec)
throws GeneralSecurityException, IOException {
SslContextFactory sslCtxFactory;
if (sslProviderString == null) {
Provider provider = SecurityUtility.CONSCRYPT_PROVIDER;
if (provider != null) {
sslProviderString = provider.getName();
}
}
sslCtxFactory = new SslContextFactoryWithAutoRefresh(
sslProviderString,
keyStoreTypeString,
keyStore,
keyStorePassword,
allowInsecureConnection,
trustStoreTypeString,
trustStore,
trustStorePassword,
requireTrustedClientCertOnConnect,
certRefreshInSec);
if (requireTrustedClientCertOnConnect) {
sslCtxFactory.setNeedClientAuth(true);
} else {
sslCtxFactory.setWantClientAuth(true);
}
sslCtxFactory.setTrustAll(true);
return sslCtxFactory;
}
}