/
PerMessageDeflateExtension.java
493 lines (434 loc) · 16.7 KB
/
PerMessageDeflateExtension.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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
//
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.websocket.core.internal;
import java.nio.ByteBuffer;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.LongConsumer;
import java.util.zip.DataFormatException;
import java.util.zip.Deflater;
import java.util.zip.Inflater;
import org.eclipse.jetty.util.BufferUtil;
import org.eclipse.jetty.util.Callback;
import org.eclipse.jetty.util.compression.DeflaterPool;
import org.eclipse.jetty.util.compression.InflaterPool;
import org.eclipse.jetty.websocket.core.AbstractExtension;
import org.eclipse.jetty.websocket.core.ExtensionConfig;
import org.eclipse.jetty.websocket.core.Frame;
import org.eclipse.jetty.websocket.core.OpCode;
import org.eclipse.jetty.websocket.core.WebSocketComponents;
import org.eclipse.jetty.websocket.core.exception.BadPayloadException;
import org.eclipse.jetty.websocket.core.exception.MessageTooLargeException;
import org.eclipse.jetty.websocket.core.exception.ProtocolException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Per Message Deflate Compression extension for WebSocket.
* <p>
* Attempts to follow <a href="https://tools.ietf.org/html/rfc7692">Compression Extensions for WebSocket</a>
*/
public class PerMessageDeflateExtension extends AbstractExtension implements DemandChain
{
private static final byte[] TAIL_BYTES = new byte[]{0x00, 0x00, (byte)0xFF, (byte)0xFF};
private static final ByteBuffer TAIL_BYTES_BUF = ByteBuffer.wrap(TAIL_BYTES);
private static final Logger LOG = LoggerFactory.getLogger(PerMessageDeflateExtension.class);
private static final int DEFAULT_BUF_SIZE = 8 * 1024;
private final OutgoingFlusher outgoingFlusher;
private final IncomingFlusher incomingFlusher;
private DeflaterPool.Entry deflaterHolder;
private InflaterPool.Entry inflaterHolder;
private boolean incomingCompressed;
private ExtensionConfig configRequested;
private ExtensionConfig configNegotiated;
private int deflateBufferSize = DEFAULT_BUF_SIZE;
private int inflateBufferSize = DEFAULT_BUF_SIZE;
private boolean incomingContextTakeover = true;
private boolean outgoingContextTakeover = true;
public PerMessageDeflateExtension()
{
outgoingFlusher = new OutgoingFlusher();
incomingFlusher = new IncomingFlusher();
}
@Override
public String getName()
{
return "permessage-deflate";
}
@Override
public boolean isRsv1User()
{
return true;
}
@Override
public void sendFrame(Frame frame, Callback callback, boolean batch)
{
// Compressed frames may increase in size so we need the flusher to fragment them.
outgoingFlusher.sendFrame(frame, callback, batch);
}
@Override
public void onFrame(Frame frame, Callback callback)
{
incomingFlusher.onFrame(frame, callback);
}
@Override
public void init(final ExtensionConfig config, WebSocketComponents components)
{
configRequested = new ExtensionConfig(config);
Map<String, String> paramsNegotiated = new HashMap<>();
for (String key : config.getParameterKeys())
{
key = key.trim();
switch (key)
{
case "client_max_window_bits":
case "server_max_window_bits":
{
// Not supported by Jetty
// Don't negotiate these parameters
break;
}
case "client_no_context_takeover":
{
paramsNegotiated.put("client_no_context_takeover", null);
incomingContextTakeover = false;
break;
}
case "server_no_context_takeover":
{
paramsNegotiated.put("server_no_context_takeover", null);
outgoingContextTakeover = false;
break;
}
case "@deflate_buffer_size":
{
deflateBufferSize = config.getParameter(key, DEFAULT_BUF_SIZE);
break;
}
case "@inflate_buffer_size":
{
inflateBufferSize = config.getParameter(key, DEFAULT_BUF_SIZE);
break;
}
default:
{
throw new IllegalArgumentException();
}
}
}
configNegotiated = new ExtensionConfig(config.getName(), paramsNegotiated);
LOG.debug("config: outgoingContextTakover={}, incomingContextTakeover={} : {}", outgoingContextTakeover, incomingContextTakeover, this);
super.init(configNegotiated, components);
}
@Override
public void close()
{
incomingFlusher.closeFlusher();
outgoingFlusher.closeFlusher();
releaseInflater();
releaseDeflater();
}
private static String toDetail(Inflater inflater)
{
return String.format("Inflater[finished=%b,read=%d,written=%d,remaining=%d,in=%d,out=%d]", inflater.finished(), inflater.getBytesRead(),
inflater.getBytesWritten(), inflater.getRemaining(), inflater.getTotalIn(), inflater.getTotalOut());
}
private static String toDetail(Deflater deflater)
{
return String.format("Deflater[finished=%b,read=%d,written=%d,in=%d,out=%d]", deflater.finished(), deflater.getBytesRead(), deflater.getBytesWritten(),
deflater.getTotalIn(), deflater.getTotalOut());
}
public static boolean endsWithTail(ByteBuffer buf)
{
if ((buf == null) || (buf.remaining() < TAIL_BYTES.length))
{
return false;
}
int limit = buf.limit();
for (int i = TAIL_BYTES.length; i > 0; i--)
{
if (buf.get(limit - i) != TAIL_BYTES[TAIL_BYTES.length - i])
{
return false;
}
}
return true;
}
public Deflater getDeflater()
{
if (deflaterHolder == null)
deflaterHolder = getDeflaterPool().acquire();
return deflaterHolder.get();
}
public Inflater getInflater()
{
if (inflaterHolder == null)
inflaterHolder = getInflaterPool().acquire();
return inflaterHolder.get();
}
public void releaseInflater()
{
if (inflaterHolder != null)
{
inflaterHolder.release();
inflaterHolder = null;
}
}
public void releaseDeflater()
{
if (deflaterHolder != null)
{
deflaterHolder.release();
deflaterHolder = null;
}
}
@Override
public String toString()
{
return String.format("%s[requested=\"%s\", negotiated=\"%s\"]",
getClass().getSimpleName(),
configRequested.getParameterizedName(),
configNegotiated.getParameterizedName());
}
@Override
protected void nextIncomingFrame(Frame frame, Callback callback)
{
if (frame.isFin() && !incomingContextTakeover)
{
LOG.debug("Incoming Context Reset");
releaseInflater();
}
super.nextIncomingFrame(frame, callback);
}
@Override
protected void nextOutgoingFrame(Frame frame, Callback callback, boolean batch)
{
if (frame.isFin() && !outgoingContextTakeover)
{
LOG.debug("Outgoing Context Reset");
releaseDeflater();
}
super.nextOutgoingFrame(frame, callback, batch);
}
@Override
public void setNextDemand(LongConsumer nextDemand)
{
incomingFlusher.setNextDemand(nextDemand);
}
@Override
public void demand(long n)
{
incomingFlusher.demand(n);
}
private class OutgoingFlusher extends TransformingFlusher
{
private boolean _first;
private Frame _frame;
private boolean _batch;
@Override
protected boolean onFrame(Frame frame, Callback callback, boolean batch)
{
if (OpCode.isControlFrame(frame.getOpCode()))
{
nextOutgoingFrame(frame, callback, batch);
return true;
}
_first = true;
_frame = frame;
_batch = batch;
// Provide the frames payload as input to the Deflater.
getDeflater().setInput(frame.getPayload().slice());
callback.succeeded();
return false;
}
@Override
protected boolean transform(Callback callback)
{
boolean finished = deflate(callback);
_first = false;
return finished;
}
private boolean deflate(Callback callback)
{
// Get a buffer for the inflated payload.
long maxFrameSize = getConfiguration().getMaxFrameSize();
int bufferSize = (maxFrameSize <= 0) ? deflateBufferSize : (int)Math.min(maxFrameSize, deflateBufferSize);
final ByteBuffer buffer = getBufferPool().acquire(bufferSize, false);
callback = Callback.from(callback, () -> getBufferPool().release(buffer));
BufferUtil.clear(buffer);
// Fill up the buffer with a max length of bufferSize;
boolean finished = false;
Deflater deflater = getDeflater();
while (true)
{
int compressed = deflater.deflate(buffer.array(), buffer.arrayOffset() + buffer.position(),
bufferSize - buffer.position(), Deflater.SYNC_FLUSH);
buffer.limit(buffer.limit() + compressed);
if (LOG.isDebugEnabled())
LOG.debug("Compressed {} bytes {}", compressed, toDetail(deflater));
if (buffer.limit() == bufferSize)
{
// We need to fragment.
if (!getConfiguration().isAutoFragment())
throw new MessageTooLargeException("Deflated payload exceeded the compress buffer size");
break;
}
if (compressed == 0)
{
finished = true;
break;
}
}
ByteBuffer payload = buffer;
if (payload.hasRemaining())
{
// Handle tail bytes generated by SYNC_FLUSH.
if (finished && _frame.isFin() && endsWithTail(payload))
{
payload.limit(payload.limit() - TAIL_BYTES.length);
if (LOG.isDebugEnabled())
LOG.debug("payload (TAIL_DROP_FIN_ONLY) = {}", BufferUtil.toDetailString(payload));
}
}
else if (_frame.isFin())
{
// Special case: 7.2.3.6. Generating an Empty Fragment Manually
// https://tools.ietf.org/html/rfc7692#section-7.2.3.6
payload = ByteBuffer.wrap(new byte[]{0x00});
}
if (LOG.isDebugEnabled())
LOG.debug("Compressed {}: payload:{}", _frame, payload.remaining());
Frame chunk = new Frame(_first ? _frame.getOpCode() : OpCode.CONTINUATION);
chunk.setRsv1(_first && _frame.getOpCode() != OpCode.CONTINUATION);
chunk.setPayload(payload);
chunk.setFin(_frame.isFin() && finished);
nextOutgoingFrame(chunk, callback, _batch);
return finished;
}
}
private class IncomingFlusher extends DemandingFlusher
{
private boolean _tailBytes;
private AtomicReference<ByteBuffer> _payloadRef = new AtomicReference<>();
public IncomingFlusher()
{
super(PerMessageDeflateExtension.this::nextIncomingFrame);
}
@Override
protected boolean handle(Frame frame, Callback callback, boolean first)
{
if (first)
{
if (OpCode.isControlFrame(frame.getOpCode()))
{
emitFrame(frame, callback);
return true;
}
// This extension requires the RSV1 bit set only in the first frame.
// Subsequent continuation frames don't have RSV1 set, but are compressed.
switch (frame.getOpCode())
{
case OpCode.TEXT:
case OpCode.BINARY:
incomingCompressed = frame.isRsv1();
break;
case OpCode.CONTINUATION:
if (frame.isRsv1())
throw new ProtocolException("Invalid RSV1 set on permessage-deflate CONTINUATION frame");
break;
default:
break;
}
if (!incomingCompressed)
{
emitFrame(frame, callback);
return true;
}
// Provide the frames payload as input to the Inflater.
_tailBytes = false;
getInflater().setInput(frame.getPayload().slice());
}
try
{
return inflate(frame, callback, first);
}
catch (DataFormatException e)
{
throw new BadPayloadException(e);
}
}
private boolean inflate(Frame frame, Callback callback, boolean first) throws DataFormatException
{
// Get a buffer for the inflated payload.
long maxFrameSize = getConfiguration().getMaxFrameSize();
int bufferSize = (maxFrameSize <= 0) ? inflateBufferSize : (int)Math.min(maxFrameSize, inflateBufferSize);
ByteBuffer payload = getBufferPool().acquire(bufferSize, false);
_payloadRef = new AtomicReference<>(payload);
BufferUtil.clear(payload);
// Fill up the ByteBuffer with a max length of bufferSize;
Inflater inflater = getInflater();
boolean complete = false;
while (true)
{
int decompressed = inflater.inflate(payload.array(), payload.arrayOffset() + payload.position(), bufferSize - payload.position());
payload.limit(payload.limit() + decompressed);
if (LOG.isDebugEnabled())
LOG.debug("Decompress: read {} {}", decompressed, toDetail(inflater));
if (payload.limit() == bufferSize)
{
// We need to fragment.
if (!getConfiguration().isAutoFragment())
throw new MessageTooLargeException("Inflated payload exceeded the decompress buffer size");
break;
}
if (decompressed == 0)
{
if (!_tailBytes && frame.isFin())
{
inflater.setInput(TAIL_BYTES_BUF.slice());
_tailBytes = true;
continue;
}
complete = true;
break;
}
}
Frame chunk = new Frame(first ? frame.getOpCode() : OpCode.CONTINUATION);
chunk.setRsv1(false);
chunk.setPayload(payload);
chunk.setFin(frame.isFin() && complete);
boolean succeedCallback = complete;
AtomicReference<ByteBuffer> payloadRef = _payloadRef;
Callback payloadCallback = Callback.from(() ->
{
getBufferPool().release(payloadRef.getAndSet(null));
if (succeedCallback)
callback.succeeded();
}, t ->
{
getBufferPool().release(payloadRef.getAndSet(null));
failFlusher(t);
});
emitFrame(chunk, payloadCallback);
if (LOG.isDebugEnabled())
LOG.debug("Decompress finished: {} {}", complete, chunk);
return complete;
}
@Override
protected void onCompleteFailure(Throwable cause)
{
getBufferPool().release(_payloadRef.getAndSet(null));
super.onCompleteFailure(cause);
}
}
}