36131
|
1 |
/*
|
|
2 |
* Copyright (c) 2015, 2016, Oracle and/or its affiliates. All rights reserved.
|
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
4 |
*
|
|
5 |
* This code is free software; you can redistribute it and/or modify it
|
|
6 |
* under the terms of the GNU General Public License version 2 only, as
|
|
7 |
* published by the Free Software Foundation. Oracle designates this
|
|
8 |
* particular file as subject to the "Classpath" exception as provided
|
|
9 |
* by Oracle in the LICENSE file that accompanied this code.
|
|
10 |
*
|
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that
|
|
15 |
* accompanied this code).
|
|
16 |
*
|
|
17 |
* You should have received a copy of the GNU General Public License version
|
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
20 |
*
|
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
22 |
* or visit www.oracle.com if you need additional information or have any
|
|
23 |
*/
|
|
24 |
package java.net.http;
|
|
25 |
|
|
26 |
import java.io.IOException;
|
|
27 |
import java.nio.ByteBuffer;
|
|
28 |
import java.nio.channels.SocketChannel;
|
|
29 |
import java.util.Arrays;
|
|
30 |
import java.util.concurrent.locks.Lock;
|
|
31 |
import java.util.concurrent.locks.ReentrantLock;
|
|
32 |
import javax.net.ssl.SSLEngineResult.HandshakeStatus;
|
|
33 |
import javax.net.ssl.SSLEngineResult.Status;
|
37720
|
34 |
import javax.net.ssl.*;
|
36131
|
35 |
import static javax.net.ssl.SSLEngineResult.HandshakeStatus.*;
|
|
36 |
|
|
37 |
/**
|
|
38 |
* Implements the mechanics of SSL by managing an SSLEngine object.
|
|
39 |
* One of these is associated with each SSLConnection.
|
|
40 |
*/
|
|
41 |
class SSLDelegate {
|
|
42 |
|
|
43 |
final SSLEngine engine;
|
|
44 |
final EngineWrapper wrapper;
|
|
45 |
final Lock handshaking = new ReentrantLock();
|
|
46 |
final SSLParameters sslParameters;
|
|
47 |
final SocketChannel chan;
|
|
48 |
final HttpClientImpl client;
|
|
49 |
|
|
50 |
// alpn[] may be null
|
|
51 |
SSLDelegate(SocketChannel chan, HttpClientImpl client, String[] alpn)
|
|
52 |
throws IOException
|
|
53 |
{
|
|
54 |
SSLContext context = client.sslContext();
|
|
55 |
engine = context.createSSLEngine();
|
|
56 |
engine.setUseClientMode(true);
|
|
57 |
SSLParameters sslp = client.sslParameters().orElse(null);
|
|
58 |
if (sslp == null) {
|
37720
|
59 |
sslp = context.getSupportedSSLParameters();
|
36131
|
60 |
}
|
|
61 |
sslParameters = Utils.copySSLParameters(sslp);
|
|
62 |
if (alpn != null) {
|
|
63 |
sslParameters.setApplicationProtocols(alpn);
|
|
64 |
Log.logSSL("Setting application protocols: " + Arrays.toString(alpn));
|
|
65 |
} else {
|
37720
|
66 |
Log.logSSL("No application protocols proposed");
|
36131
|
67 |
}
|
|
68 |
engine.setSSLParameters(sslParameters);
|
|
69 |
wrapper = new EngineWrapper(chan, engine);
|
|
70 |
this.chan = chan;
|
|
71 |
this.client = client;
|
|
72 |
}
|
|
73 |
|
|
74 |
SSLParameters getSSLParameters() {
|
|
75 |
return sslParameters;
|
|
76 |
}
|
|
77 |
|
|
78 |
private static long countBytes(ByteBuffer[] buffers, int start, int number) {
|
|
79 |
long c = 0;
|
|
80 |
for (int i=0; i<number; i++) {
|
|
81 |
c+= buffers[start+i].remaining();
|
|
82 |
}
|
|
83 |
return c;
|
|
84 |
}
|
|
85 |
|
|
86 |
|
|
87 |
static class WrapperResult {
|
|
88 |
static WrapperResult createOK() {
|
|
89 |
WrapperResult r = new WrapperResult();
|
|
90 |
r.buf = null;
|
|
91 |
r.result = new SSLEngineResult(Status.OK, NOT_HANDSHAKING, 0, 0);
|
|
92 |
return r;
|
|
93 |
}
|
|
94 |
SSLEngineResult result;
|
|
95 |
|
|
96 |
/* if passed in buffer was not big enough then the a reallocated buffer
|
|
97 |
* is returned here */
|
|
98 |
ByteBuffer buf;
|
|
99 |
}
|
|
100 |
|
|
101 |
int app_buf_size;
|
|
102 |
int packet_buf_size;
|
|
103 |
|
|
104 |
enum BufType {
|
|
105 |
PACKET,
|
|
106 |
APPLICATION
|
|
107 |
};
|
|
108 |
|
|
109 |
ByteBuffer allocate (BufType type) {
|
|
110 |
return allocate (type, -1);
|
|
111 |
}
|
|
112 |
|
|
113 |
// TODO: Use buffer pool for this
|
|
114 |
ByteBuffer allocate (BufType type, int len) {
|
|
115 |
assert engine != null;
|
|
116 |
synchronized (this) {
|
|
117 |
int size;
|
|
118 |
if (type == BufType.PACKET) {
|
|
119 |
if (packet_buf_size == 0) {
|
|
120 |
SSLSession sess = engine.getSession();
|
|
121 |
packet_buf_size = sess.getPacketBufferSize();
|
|
122 |
}
|
|
123 |
if (len > packet_buf_size) {
|
|
124 |
packet_buf_size = len;
|
|
125 |
}
|
|
126 |
size = packet_buf_size;
|
|
127 |
} else {
|
|
128 |
if (app_buf_size == 0) {
|
|
129 |
SSLSession sess = engine.getSession();
|
|
130 |
app_buf_size = sess.getApplicationBufferSize();
|
|
131 |
}
|
|
132 |
if (len > app_buf_size) {
|
|
133 |
app_buf_size = len;
|
|
134 |
}
|
|
135 |
size = app_buf_size;
|
|
136 |
}
|
|
137 |
return ByteBuffer.allocate (size);
|
|
138 |
}
|
|
139 |
}
|
|
140 |
|
|
141 |
/* reallocates the buffer by :-
|
|
142 |
* 1. creating a new buffer double the size of the old one
|
|
143 |
* 2. putting the contents of the old buffer into the new one
|
|
144 |
* 3. set xx_buf_size to the new size if it was smaller than new size
|
|
145 |
*
|
|
146 |
* flip is set to true if the old buffer needs to be flipped
|
|
147 |
* before it is copied.
|
|
148 |
*/
|
|
149 |
private ByteBuffer realloc (ByteBuffer b, boolean flip, BufType type) {
|
|
150 |
synchronized (this) {
|
|
151 |
int nsize = 2 * b.capacity();
|
|
152 |
ByteBuffer n = allocate (type, nsize);
|
|
153 |
if (flip) {
|
|
154 |
b.flip();
|
|
155 |
}
|
|
156 |
n.put(b);
|
|
157 |
b = n;
|
|
158 |
}
|
|
159 |
return b;
|
|
160 |
}
|
|
161 |
|
|
162 |
/**
|
|
163 |
* This is a thin wrapper over SSLEngine and the SocketChannel, which
|
|
164 |
* guarantees the ordering of wraps/unwraps with respect to the underlying
|
|
165 |
* channel read/writes. It handles the UNDER/OVERFLOW status codes
|
|
166 |
* It does not handle the handshaking status codes, or the CLOSED status code
|
|
167 |
* though once the engine is closed, any attempt to read/write to it
|
|
168 |
* will get an exception. The overall result is returned.
|
|
169 |
* It functions synchronously/blocking
|
|
170 |
*/
|
|
171 |
class EngineWrapper {
|
|
172 |
|
|
173 |
SocketChannel chan;
|
|
174 |
SSLEngine engine;
|
|
175 |
Object wrapLock, unwrapLock;
|
|
176 |
ByteBuffer unwrap_src, wrap_dst;
|
|
177 |
boolean closed = false;
|
|
178 |
int u_remaining; // the number of bytes left in unwrap_src after an unwrap()
|
|
179 |
|
|
180 |
EngineWrapper (SocketChannel chan, SSLEngine engine) throws IOException {
|
|
181 |
this.chan = chan;
|
|
182 |
this.engine = engine;
|
|
183 |
wrapLock = new Object();
|
|
184 |
unwrapLock = new Object();
|
|
185 |
unwrap_src = allocate(BufType.PACKET);
|
|
186 |
wrap_dst = allocate(BufType.PACKET);
|
|
187 |
}
|
|
188 |
|
|
189 |
void close () throws IOException {
|
|
190 |
}
|
|
191 |
|
|
192 |
WrapperResult wrapAndSend(ByteBuffer src, boolean ignoreClose)
|
|
193 |
throws IOException
|
|
194 |
{
|
|
195 |
ByteBuffer[] buffers = new ByteBuffer[1];
|
|
196 |
buffers[0] = src;
|
|
197 |
return wrapAndSend(buffers, 0, 1, ignoreClose);
|
|
198 |
}
|
|
199 |
|
|
200 |
/* try to wrap and send the data in src. Handles OVERFLOW.
|
|
201 |
* Might block if there is an outbound blockage or if another
|
|
202 |
* thread is calling wrap(). Also, might not send any data
|
|
203 |
* if an unwrap is needed.
|
|
204 |
*/
|
|
205 |
WrapperResult wrapAndSend(ByteBuffer[] src,
|
|
206 |
int offset,
|
|
207 |
int len,
|
|
208 |
boolean ignoreClose)
|
|
209 |
throws IOException
|
|
210 |
{
|
|
211 |
if (closed && !ignoreClose) {
|
|
212 |
throw new IOException ("Engine is closed");
|
|
213 |
}
|
|
214 |
Status status;
|
|
215 |
WrapperResult r = new WrapperResult();
|
|
216 |
synchronized (wrapLock) {
|
|
217 |
wrap_dst.clear();
|
|
218 |
do {
|
|
219 |
r.result = engine.wrap (src, offset, len, wrap_dst);
|
|
220 |
status = r.result.getStatus();
|
|
221 |
if (status == Status.BUFFER_OVERFLOW) {
|
|
222 |
wrap_dst = realloc (wrap_dst, true, BufType.PACKET);
|
|
223 |
}
|
|
224 |
} while (status == Status.BUFFER_OVERFLOW);
|
|
225 |
if (status == Status.CLOSED && !ignoreClose) {
|
|
226 |
closed = true;
|
|
227 |
return r;
|
|
228 |
}
|
|
229 |
if (r.result.bytesProduced() > 0) {
|
|
230 |
wrap_dst.flip();
|
|
231 |
int l = wrap_dst.remaining();
|
|
232 |
assert l == r.result.bytesProduced();
|
|
233 |
while (l>0) {
|
|
234 |
l -= chan.write (wrap_dst);
|
|
235 |
}
|
|
236 |
}
|
|
237 |
}
|
|
238 |
return r;
|
|
239 |
}
|
|
240 |
|
|
241 |
/* block until a complete message is available and return it
|
|
242 |
* in dst, together with the Result. dst may have been re-allocated
|
|
243 |
* so caller should check the returned value in Result
|
|
244 |
* If handshaking is in progress then, possibly no data is returned
|
|
245 |
*/
|
|
246 |
WrapperResult recvAndUnwrap(ByteBuffer dst) throws IOException {
|
|
247 |
Status status;
|
|
248 |
WrapperResult r = new WrapperResult();
|
|
249 |
r.buf = dst;
|
|
250 |
if (closed) {
|
|
251 |
throw new IOException ("Engine is closed");
|
|
252 |
}
|
|
253 |
boolean needData;
|
|
254 |
if (u_remaining > 0) {
|
|
255 |
unwrap_src.compact();
|
|
256 |
unwrap_src.flip();
|
|
257 |
needData = false;
|
|
258 |
} else {
|
|
259 |
unwrap_src.clear();
|
|
260 |
needData = true;
|
|
261 |
}
|
|
262 |
synchronized (unwrapLock) {
|
|
263 |
int x;
|
|
264 |
do {
|
|
265 |
if (needData) {
|
|
266 |
do {
|
37720
|
267 |
x = chan.read (unwrap_src);
|
36131
|
268 |
} while (x == 0);
|
|
269 |
if (x == -1) {
|
|
270 |
throw new IOException ("connection closed for reading");
|
|
271 |
}
|
|
272 |
unwrap_src.flip();
|
|
273 |
}
|
|
274 |
r.result = engine.unwrap (unwrap_src, r.buf);
|
|
275 |
status = r.result.getStatus();
|
|
276 |
if (status == Status.BUFFER_UNDERFLOW) {
|
|
277 |
if (unwrap_src.limit() == unwrap_src.capacity()) {
|
|
278 |
/* buffer not big enough */
|
|
279 |
unwrap_src = realloc (
|
|
280 |
unwrap_src, false, BufType.PACKET
|
|
281 |
);
|
|
282 |
} else {
|
|
283 |
/* Buffer not full, just need to read more
|
|
284 |
* data off the channel. Reset pointers
|
|
285 |
* for reading off SocketChannel
|
|
286 |
*/
|
|
287 |
unwrap_src.position (unwrap_src.limit());
|
|
288 |
unwrap_src.limit (unwrap_src.capacity());
|
|
289 |
}
|
|
290 |
needData = true;
|
|
291 |
} else if (status == Status.BUFFER_OVERFLOW) {
|
|
292 |
r.buf = realloc (r.buf, true, BufType.APPLICATION);
|
|
293 |
needData = false;
|
|
294 |
} else if (status == Status.CLOSED) {
|
|
295 |
closed = true;
|
|
296 |
r.buf.flip();
|
|
297 |
return r;
|
|
298 |
}
|
|
299 |
} while (status != Status.OK);
|
|
300 |
}
|
|
301 |
u_remaining = unwrap_src.remaining();
|
|
302 |
return r;
|
|
303 |
}
|
|
304 |
}
|
|
305 |
|
|
306 |
WrapperResult sendData (ByteBuffer src) throws IOException {
|
|
307 |
ByteBuffer[] buffers = new ByteBuffer[1];
|
|
308 |
buffers[0] = src;
|
|
309 |
return sendData(buffers, 0, 1);
|
|
310 |
}
|
|
311 |
|
|
312 |
/**
|
|
313 |
* send the data in the given ByteBuffer. If a handshake is needed
|
|
314 |
* then this is handled within this method. When this call returns,
|
|
315 |
* all of the given user data has been sent and any handshake has been
|
|
316 |
* completed. Caller should check if engine has been closed.
|
|
317 |
*/
|
|
318 |
WrapperResult sendData (ByteBuffer[] src, int offset, int len) throws IOException {
|
|
319 |
WrapperResult r = WrapperResult.createOK();
|
|
320 |
while (countBytes(src, offset, len) > 0) {
|
|
321 |
r = wrapper.wrapAndSend(src, offset, len, false);
|
|
322 |
Status status = r.result.getStatus();
|
|
323 |
if (status == Status.CLOSED) {
|
|
324 |
doClosure ();
|
|
325 |
return r;
|
|
326 |
}
|
|
327 |
HandshakeStatus hs_status = r.result.getHandshakeStatus();
|
|
328 |
if (hs_status != HandshakeStatus.FINISHED &&
|
|
329 |
hs_status != HandshakeStatus.NOT_HANDSHAKING)
|
|
330 |
{
|
|
331 |
doHandshake(hs_status);
|
|
332 |
}
|
|
333 |
}
|
|
334 |
return r;
|
|
335 |
}
|
|
336 |
|
|
337 |
/**
|
|
338 |
* read data thru the engine into the given ByteBuffer. If the
|
|
339 |
* given buffer was not large enough, a new one is allocated
|
|
340 |
* and returned. This call handles handshaking automatically.
|
|
341 |
* Caller should check if engine has been closed.
|
|
342 |
*/
|
|
343 |
WrapperResult recvData (ByteBuffer dst) throws IOException {
|
|
344 |
/* we wait until some user data arrives */
|
|
345 |
int mark = dst.position();
|
|
346 |
WrapperResult r = null;
|
|
347 |
assert dst.position() == 0;
|
|
348 |
while (dst.position() == 0) {
|
|
349 |
r = wrapper.recvAndUnwrap (dst);
|
|
350 |
dst = (r.buf != dst) ? r.buf: dst;
|
|
351 |
Status status = r.result.getStatus();
|
|
352 |
if (status == Status.CLOSED) {
|
|
353 |
doClosure ();
|
|
354 |
return r;
|
|
355 |
}
|
|
356 |
|
|
357 |
HandshakeStatus hs_status = r.result.getHandshakeStatus();
|
|
358 |
if (hs_status != HandshakeStatus.FINISHED &&
|
|
359 |
hs_status != HandshakeStatus.NOT_HANDSHAKING)
|
|
360 |
{
|
|
361 |
doHandshake (hs_status);
|
|
362 |
}
|
|
363 |
}
|
|
364 |
Utils.flipToMark(dst, mark);
|
|
365 |
return r;
|
|
366 |
}
|
|
367 |
|
|
368 |
/* we've received a close notify. Need to call wrap to send
|
|
369 |
* the response
|
|
370 |
*/
|
|
371 |
void doClosure () throws IOException {
|
|
372 |
try {
|
|
373 |
handshaking.lock();
|
|
374 |
ByteBuffer tmp = allocate(BufType.APPLICATION);
|
|
375 |
WrapperResult r;
|
|
376 |
do {
|
|
377 |
tmp.clear();
|
|
378 |
tmp.flip ();
|
|
379 |
r = wrapper.wrapAndSend(tmp, true);
|
|
380 |
} while (r.result.getStatus() != Status.CLOSED);
|
|
381 |
} finally {
|
|
382 |
handshaking.unlock();
|
|
383 |
}
|
|
384 |
}
|
|
385 |
|
|
386 |
/* do the (complete) handshake after acquiring the handshake lock.
|
|
387 |
* If two threads call this at the same time, then we depend
|
|
388 |
* on the wrapper methods being idempotent. eg. if wrapAndSend()
|
|
389 |
* is called with no data to send then there must be no problem
|
|
390 |
*/
|
|
391 |
@SuppressWarnings("fallthrough")
|
|
392 |
void doHandshake (HandshakeStatus hs_status) throws IOException {
|
|
393 |
boolean wasBlocking = false;
|
|
394 |
try {
|
|
395 |
wasBlocking = chan.isBlocking();
|
|
396 |
handshaking.lock();
|
|
397 |
chan.configureBlocking(true);
|
|
398 |
ByteBuffer tmp = allocate(BufType.APPLICATION);
|
|
399 |
while (hs_status != HandshakeStatus.FINISHED &&
|
|
400 |
hs_status != HandshakeStatus.NOT_HANDSHAKING)
|
|
401 |
{
|
|
402 |
WrapperResult r = null;
|
|
403 |
switch (hs_status) {
|
|
404 |
case NEED_TASK:
|
|
405 |
Runnable task;
|
|
406 |
while ((task = engine.getDelegatedTask()) != null) {
|
|
407 |
/* run in current thread, because we are already
|
|
408 |
* running an external Executor
|
|
409 |
*/
|
|
410 |
task.run();
|
|
411 |
}
|
|
412 |
/* fall thru - call wrap again */
|
|
413 |
case NEED_WRAP:
|
|
414 |
tmp.clear();
|
|
415 |
tmp.flip();
|
|
416 |
r = wrapper.wrapAndSend(tmp, false);
|
|
417 |
break;
|
|
418 |
|
|
419 |
case NEED_UNWRAP:
|
|
420 |
tmp.clear();
|
|
421 |
r = wrapper.recvAndUnwrap (tmp);
|
|
422 |
if (r.buf != tmp) {
|
|
423 |
tmp = r.buf;
|
|
424 |
}
|
|
425 |
assert tmp.position() == 0;
|
|
426 |
break;
|
|
427 |
}
|
|
428 |
hs_status = r.result.getHandshakeStatus();
|
|
429 |
}
|
|
430 |
Log.logSSL(getSessionInfo());
|
|
431 |
if (!wasBlocking) {
|
|
432 |
chan.configureBlocking(false);
|
|
433 |
}
|
|
434 |
} finally {
|
|
435 |
handshaking.unlock();
|
|
436 |
}
|
|
437 |
}
|
|
438 |
|
37720
|
439 |
static void printParams(SSLParameters p) {
|
|
440 |
System.out.println("SSLParameters:");
|
|
441 |
if (p == null) {
|
|
442 |
System.out.println("Null params");
|
|
443 |
return;
|
|
444 |
}
|
|
445 |
for (String cipher : p.getCipherSuites()) {
|
|
446 |
System.out.printf("cipher: %s\n", cipher);
|
|
447 |
}
|
|
448 |
for (String approto : p.getApplicationProtocols()) {
|
|
449 |
System.out.printf("application protocol: %s\n", approto);
|
|
450 |
}
|
|
451 |
for (String protocol : p.getProtocols()) {
|
|
452 |
System.out.printf("protocol: %s\n", protocol);
|
|
453 |
}
|
|
454 |
if (p.getServerNames() != null)
|
|
455 |
for (SNIServerName sname : p.getServerNames()) {
|
|
456 |
System.out.printf("server name: %s\n", sname.toString());
|
|
457 |
}
|
|
458 |
}
|
|
459 |
|
36131
|
460 |
String getSessionInfo() {
|
|
461 |
StringBuilder sb = new StringBuilder();
|
|
462 |
String application = engine.getApplicationProtocol();
|
|
463 |
SSLSession sess = engine.getSession();
|
|
464 |
String cipher = sess.getCipherSuite();
|
|
465 |
String protocol = sess.getProtocol();
|
|
466 |
sb.append("Handshake complete alpn: ")
|
|
467 |
.append(application)
|
|
468 |
.append(", Cipher: ")
|
|
469 |
.append(cipher)
|
|
470 |
.append(", Protocol: ")
|
|
471 |
.append(protocol);
|
|
472 |
return sb.toString();
|
|
473 |
}
|
|
474 |
}
|