forked from jooby-project/jooby
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSslOptions.java
More file actions
331 lines (305 loc) · 9.11 KB
/
SslOptions.java
File metadata and controls
331 lines (305 loc) · 9.11 KB
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
/**
* Jooby https://jooby.io
* Apache License Version 2.0 https://jooby.io/LICENSE.txt
* Copyright 2014 Edgar Espina
*/
package io.jooby;
import com.typesafe.config.Config;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Optional;
import java.util.stream.Stream;
import static io.jooby.SneakyThrows.throwingFunction;
/**
* SSL options for enabling HTTPs in Jooby. Jooby supports two certificate formats:
*
* - PKCS12
* - X.509
*
* Jooby doesn't support JKS format due it is a proprietary format, it favors the use of PKCS12
* format.
*
* @author edgar
* @since 2.3.0
*/
public final class SslOptions {
/** X509 constant. */
public static final String X509 = "X509";
/** PKCS12 constant. */
public static final String PKCS12 = "PKCS12";
private String password;
private String type = PKCS12;
private String cert;
private String privateKey;
/**
* Certificate type. Default is {@link #PKCS12}.
*
* @return Certificate type. Default is {@link #PKCS12}.
*/
public String getType() {
return type;
}
/**
* Set certificate type.
*
* @param type Certificate type.
* @return Ssl options.
*/
public @Nonnull SslOptions setType(@Nonnull String type) {
this.type = type;
return this;
}
/**
* A PKCS12 or X.509 certificate chain file in PEM format. It can be an absolute path or a
* classpath resource. Required.
*
* @return A PKCS12 or X.509 certificate chain file in PEM format. It can be an absolute path or
* a classpath resource. Required.
*/
public @Nonnull String getCert() {
return cert;
}
/**
* Set certificate path. A PKCS12 or X.509 certificate chain file in PEM format.
* It can be an absolute path or a classpath resource. Required.
*
* @param cert Certificate path or location.
* @return Ssl options.
*/
public @Nonnull SslOptions setCert(@Nonnull String cert) {
this.cert = cert;
return this;
}
/**
* Private key file location. A PKCS#8 private key file in PEM format. It can be an absolute path
* or a classpath resource. Required when using X.509 certificates.
*
* @return A PKCS#8 private key file in PEM format. It can be an absolute path or a classpath
* resource. Required when using X.509 certificates.
*/
public @Nullable String getPrivateKey() {
return privateKey;
}
/**
* Set private key file location. A PKCS#8 private key file in PEM format. It can be an absolute
* path or a classpath resource. Required when using X.509 certificates.
*
* @param privateKey Private key file location. A PKCS#8 private key file in PEM format. It can
* be an absolute path or a classpath resource. Required when using X.509 certificates.
* @return Ssl options.
*/
public @Nonnull SslOptions setPrivateKey(@Nullable String privateKey) {
this.privateKey = privateKey;
return this;
}
/**
* Certificate password.
*
* @param password Certificate password.
* @return SSL options.
*/
public @Nonnull SslOptions setPassword(@Nullable String password) {
this.password = password;
return this;
}
/**
* Certificate password.
*
* @return Certificate password.
*/
public @Nullable String getPassword() {
return password;
}
/**
* Search for a resource at the given path. This method uses the following order:
*
* - Look at file system for path as it is (absolute path)
* - Look at file system for path relative to current process dir
* - Look at class path for path
*
* @param loader Class loader.
* @param path Path (file system path or classpath).
* @return Resource.
* @throws IOException If file not found or can't be read it.
*/
public @Nonnull InputStream getResource(@Nonnull ClassLoader loader, @Nonnull String path)
throws IOException {
InputStream resource = Stream
.of(Paths.get(path), Paths.get(System.getProperty("user.dir"), path))
.map(it -> it.normalize().toAbsolutePath())
.filter(Files::exists)
.findFirst()
.map(throwingFunction(file -> Files.newInputStream(file)))
.orElseGet(
() -> loader.getResourceAsStream(path.startsWith("/") ? path.substring(1) : path));
if (resource == null) {
throw new FileNotFoundException(path);
}
return resource;
}
@Override public String toString() {
return type;
}
/**
* Creates SSL options for X.509 certificate type.
*
* @param crt Certificate path or location.
* @param key Private key path or location.
* @return New SSL options.
*/
public static @Nonnull SslOptions x509(@Nonnull String crt, @Nonnull String key) {
return x509(crt, key, null);
}
/**
* Creates SSL options for X.509 certificate type.
*
* @param crt Certificate path or location.
* @param key Private key path or location.
* @param password Password.
* @return New SSL options.
*/
public static @Nonnull SslOptions x509(@Nonnull String crt, @Nonnull String key,
@Nullable String password) {
SslOptions options = new SslOptions();
options.setType(X509);
options.setPrivateKey(key);
options.setCert(crt);
options.setPassword(password);
return options;
}
/**
* Creates SSL options for PKCS12 certificate type.
*
* @param crt Certificate path or location.
* @param password Password.
* @return New SSL options.
*/
public static SslOptions pkcs12(@Nonnull String crt, @Nonnull String password) {
SslOptions options = new SslOptions();
options.setType(PKCS12);
options.setCert(crt);
options.setPassword(password);
return options;
}
/**
* Creates SSL options using a self-signed certificate using PKCS12. Useful for development.
* Certificate works for <code>localhost</code>.
*
* @return New SSL options.
*/
public static SslOptions selfSigned() {
return selfSigned(PKCS12);
}
/**
* Creates SSL options using a self-signed certificate. Useful for development. Certificate works
* for <code>localhost</code>.
*
* @param type Certificate type: <code>PKCS12</code> or <code>X509</code>.
* @return New SSL options.
*/
public static SslOptions selfSigned(final String type) {
switch (type.toUpperCase()) {
case PKCS12:
return pkcs12("io/jooby/ssl/localhost.p12", "changeit");
case X509:
return x509("io/jooby/ssl/localhost.crt", "io/jooby/ssl/localhost.key");
default:
throw new UnsupportedOperationException("SSL type: " + type);
}
}
/**
* Get SSL options from application configuration. Configuration must be at
* <code>server.ssl</code> or <code>ssl</code>.
*
* PKCS12 example:
* <pre>
* server {
* ssl {
* type: PKCS12
* cert: mycertificate.crt
* password: mypassword
* }
* }
* </pre>
*
* X509 example:
* <pre>
* server {
* ssl {
* type: X509
* cert: mycertificate.crt
* key: mykey.key
* }
* }
* </pre>
*
* @param conf Application configuration.
* @return SSl options or empty.
*/
public static @Nonnull Optional<SslOptions> from(@Nonnull Config conf) {
return from(conf, "server.ssl", "ssl");
}
/**
* Get SSL options from application configuration. It looks for ssl options at the given path(s).
*
* PKCS12 example:
* <pre>
* server {
* ssl {
* type: PKCS12
* cert: mycertificate.crt
* password: mypassword
* }
* }
* </pre>
*
* X509 example:
* <pre>
* server {
* ssl {
* type: X509
* cert: mycertificate.crt
* key: mykey.key
* }
* }
* </pre>
*
* @param conf Application configuration.
* @param key Path to use for loading SSL options. Required.
* @return SSl options or empty.
*/
public static @Nonnull Optional<SslOptions> from(@Nonnull Config conf, String... key) {
return Stream.of(key)
.filter(conf::hasPath)
.findFirst()
.map(path -> {
String type = conf.hasPath(path + ".type")
? conf.getString(path + ".type").toUpperCase()
: PKCS12;
if (type.equalsIgnoreCase("self-signed")) {
return SslOptions.selfSigned();
} else {
SslOptions options = new SslOptions();
options.setType(type);
if (X509.equalsIgnoreCase(type)) {
options.setCert(conf.getString(path + ".cert"));
options.setPrivateKey(conf.getString(path + ".key"));
if (conf.hasPath(path + ".password")) {
options.setPassword(conf.getString(path + ".password"));
}
} else if (type.equalsIgnoreCase(PKCS12)) {
options.setCert(conf.getString(path + ".cert"));
options.setPassword(conf.getString(path + ".password"));
} else {
throw new UnsupportedOperationException("SSL type: " + type);
}
return options;
}
});
}
}