-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
LocalFuzzer.java
368 lines (319 loc) · 13.2 KB
/
LocalFuzzer.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
//
// ========================================================================
// Copyright (c) 1995-2017 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.websocket.tests;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.junit.Assert.assertThat;
import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Map;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.TimeUnit;
import org.eclipse.jetty.http.HttpTester;
import org.eclipse.jetty.server.LocalConnector;
import org.eclipse.jetty.toolchain.test.ByteBufferAssert;
import org.eclipse.jetty.util.BufferUtil;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.websocket.api.WebSocketConstants;
import org.eclipse.jetty.websocket.api.WebSocketPolicy;
import org.eclipse.jetty.websocket.common.CloseInfo;
import org.eclipse.jetty.websocket.common.Generator;
import org.eclipse.jetty.websocket.common.OpCode;
import org.eclipse.jetty.websocket.common.Parser;
import org.eclipse.jetty.websocket.common.WebSocketFrame;
import org.hamcrest.Matchers;
public class LocalFuzzer implements AutoCloseable
{
private static final Logger LOG = Log.getLogger(LocalFuzzer.class);
public final LocalFuzzer.Provider provider;
public final UnitGenerator generator;
public final LocalConnector.LocalEndPoint endPoint;
public final HttpTester.Response upgradeResponse;
public LocalFuzzer(LocalFuzzer.Provider provider) throws Exception
{
this(provider, null);
}
public LocalFuzzer(LocalFuzzer.Provider provider, CharSequence requestPath) throws Exception
{
this(provider, requestPath, UpgradeUtils.newDefaultUpgradeRequestHeaders());
}
public LocalFuzzer(LocalFuzzer.Provider provider, CharSequence requestPath, Map<String, String> headers) throws Exception
{
this.provider = provider;
String upgradeRequest = UpgradeUtils.generateUpgradeRequest(requestPath, headers);
LOG.debug("Request: {}", upgradeRequest);
ByteBuffer upgradeRequestBytes = BufferUtil.toBuffer(upgradeRequest.toString(), StandardCharsets.UTF_8);
this.endPoint = this.provider.newLocalConnection();
this.upgradeResponse = performUpgrade(endPoint, upgradeRequestBytes);
this.generator = new UnitGenerator(WebSocketPolicy.newClientPolicy());
}
public void addInputInSegments(LocalConnector.LocalEndPoint endPoint, ByteBuffer outgoing, int segmentSize)
{
while (outgoing.remaining() > 0)
{
int len = Math.min(segmentSize, outgoing.remaining());
ByteBuffer slice = outgoing.slice();
slice.limit(len);
endPoint.addInput(slice);
outgoing.position(outgoing.position() + len);
}
}
public void expectMessage(BlockingQueue<WebSocketFrame> framesQueue, byte expectedDataOp, ByteBuffer expectedMessage) throws InterruptedException
{
ByteBuffer actualPayload = ByteBuffer.allocate(expectedMessage.remaining());
WebSocketFrame frame = framesQueue.poll(1, TimeUnit.SECONDS);
assertThat("Initial Frame.opCode", frame.getOpCode(), is(expectedDataOp));
actualPayload.put(frame.getPayload());
while (!frame.isFin())
{
frame = framesQueue.poll(1, TimeUnit.SECONDS);
assertThat("Frame.opCode", frame.getOpCode(), is(OpCode.CONTINUATION));
actualPayload.put(frame.getPayload());
}
actualPayload.flip();
ByteBufferAssert.assertEquals("Actual Message Payload", actualPayload, expectedMessage);
}
public ByteBuffer asNetworkBuffer(List<WebSocketFrame> frames)
{
int bufferLength = 0;
for (WebSocketFrame f : frames)
{
bufferLength += f.getPayloadLength() + Generator.MAX_HEADER_LENGTH;
}
ByteBuffer buffer = ByteBuffer.allocate(bufferLength);
for (WebSocketFrame f : frames)
{
generator.generate(buffer, f);
}
BufferUtil.flipToFlush(buffer, 0);
return buffer;
}
public void assertExpected(BlockingQueue<WebSocketFrame> framesQueue, List<WebSocketFrame> expect) throws InterruptedException
{
int expectedCount = expect.size();
String prefix;
for (int i = 0; i < expectedCount; i++)
{
prefix = "Frame[" + i + "]";
WebSocketFrame expected = expect.get(i);
WebSocketFrame actual = framesQueue.poll(10, TimeUnit.SECONDS);
assertThat(prefix + ".poll", actual, notNullValue());
if (LOG.isDebugEnabled())
{
if (actual.getOpCode() == OpCode.CLOSE)
LOG.debug("{} CloseFrame: {}", prefix, new CloseInfo(actual));
else
LOG.debug("{} {}", prefix, actual);
}
assertThat(prefix + ".opcode", OpCode.name(actual.getOpCode()), Matchers.is(OpCode.name(expected.getOpCode())));
prefix += "(op=" + actual.getOpCode() + "," + (actual.isFin() ? "" : "!") + "fin)";
if (expected.getOpCode() == OpCode.CLOSE)
{
CloseInfo expectedClose = new CloseInfo(expected);
CloseInfo actualClose = new CloseInfo(actual);
assertThat(prefix + ".statusCode", actualClose.getStatusCode(), Matchers.is(expectedClose.getStatusCode()));
}
else if (expected.hasPayload())
{
if (expected.getOpCode() == OpCode.TEXT)
{
String expectedText = expected.getPayloadAsUTF8();
String actualText = actual.getPayloadAsUTF8();
assertThat(prefix + ".text-payload", actualText, is(expectedText));
}
else
{
assertThat(prefix + ".payloadLength", actual.getPayloadLength(), Matchers.is(expected.getPayloadLength()));
ByteBufferAssert.assertEquals(prefix + ".payload", expected.getPayload(), actual.getPayload());
}
}
else
{
assertThat(prefix + ".payloadLength", actual.getPayloadLength(), Matchers.is(0));
}
}
}
public void close() throws Exception
{
endPoint.close();
}
/**
* Send the EOF signal
*/
public void eof()
{
endPoint.addInputEOF();
}
public void expect(List<WebSocketFrame> expected) throws InterruptedException
{
// Get incoming frames
// Wait for server to close
endPoint.waitUntilClosed();
// Get the server send echo bytes
ByteBuffer incoming = endPoint.getOutput();
// Parse those bytes into frames
ParserCapture capture = new ParserCapture();
Parser parser = provider.newClientParser(capture);
parser.parse(incoming);
assertExpected(capture.framesQueue, expected);
}
public BlockingQueue<WebSocketFrame> getOutputFrames()
{
// Get incoming frames
// Wait for server to close
endPoint.waitUntilClosed();
// Get the server send echo bytes
ByteBuffer incoming = endPoint.getOutput();
// Parse those bytes into frames
ParserCapture capture = new ParserCapture();
Parser parser = provider.newClientParser(capture);
parser.parse(incoming);
return capture.framesQueue;
}
/**
* Send raw bytes
*/
public void send(ByteBuffer buffer)
{
endPoint.addInput(buffer);
}
/**
* Send some of the raw bytes
*
* @param buffer the buffer
* @param length the number of bytes to send from buffer
*/
public void send(ByteBuffer buffer, int length)
{
int limit = Math.min(length, buffer.remaining());
ByteBuffer sliced = buffer.slice();
sliced.limit(limit);
endPoint.addInput(sliced);
buffer.position(buffer.position() + limit);
}
/**
* Generate a single ByteBuffer representing the entire
* list of generated frames, and submit it to {@link org.eclipse.jetty.server.LocalConnector.LocalEndPoint#addInput(ByteBuffer)}
*
* @param frames the list of frames to send
*/
public void sendBulk(List<WebSocketFrame> frames)
{
int bufferLength = 0;
for (WebSocketFrame f : frames)
{
bufferLength += f.getPayloadLength() + Generator.MAX_HEADER_LENGTH;
}
ByteBuffer outgoing = ByteBuffer.allocate(bufferLength);
boolean eof = false;
for (WebSocketFrame f : frames)
{
generator.generate(outgoing, f);
if (f.getOpCode() == OpCode.CLOSE)
eof = true;
}
BufferUtil.flipToFlush(outgoing, 0);
endPoint.addInput(outgoing);
if (eof)
endPoint.addInputEOF();
}
/**
* Generate a ByteBuffer for each frame, and submit each to
* {@link org.eclipse.jetty.server.LocalConnector.LocalEndPoint#addInput(ByteBuffer)}
*
* @param frames the list of frames to send
*/
public void sendFrames(List<WebSocketFrame> frames)
{
boolean eof = false;
for (WebSocketFrame f : frames)
{
ByteBuffer buffer = generator.generate(f);
endPoint.addInput(buffer);
if (f.getOpCode() == OpCode.CLOSE)
eof = true;
}
if (eof)
endPoint.addInputEOF();
}
/**
* Generate a ByteBuffer for each frame, and submit each to
* {@link org.eclipse.jetty.server.LocalConnector.LocalEndPoint#addInput(ByteBuffer)}
*
* @param frames the list of frames to send
*/
public void sendFrames(WebSocketFrame ... frames)
{
boolean eof = false;
for (WebSocketFrame f : frames)
{
ByteBuffer buffer = generator.generate(f);
endPoint.addInput(buffer);
if (f.getOpCode() == OpCode.CLOSE)
eof = true;
}
if (eof)
endPoint.addInputEOF();
}
/**
* Generate a ByteBuffer for each frame, and submit each to
* {@link org.eclipse.jetty.server.LocalConnector.LocalEndPoint#addInput(ByteBuffer)}
*
* @param frames the list of frames to send
*/
public void sendSegmented(List<WebSocketFrame> frames, int segmentSize)
{
int bufferLength = 0;
for (WebSocketFrame f : frames)
{
bufferLength += f.getPayloadLength() + Generator.MAX_HEADER_LENGTH;
}
ByteBuffer outgoing = ByteBuffer.allocate(bufferLength);
boolean eof = false;
for (WebSocketFrame f : frames)
{
generator.generate(outgoing, f);
if (f.getOpCode() == OpCode.CLOSE)
eof = true;
}
BufferUtil.flipToFlush(outgoing, 0);
addInputInSegments(endPoint, outgoing, segmentSize);
if (eof)
endPoint.addInputEOF();
}
private HttpTester.Response performUpgrade(LocalConnector.LocalEndPoint endPoint, ByteBuffer buf) throws Exception
{
endPoint.addInput(buf);
// Get response
ByteBuffer response = endPoint.waitForResponse(false, 1, TimeUnit.SECONDS);
HttpTester.Response parsedResponse = HttpTester.parseResponse(response);
LOG.debug("Response: {}", parsedResponse);
assertThat("Is Switching Protocols", parsedResponse.getStatus(), is(101));
assertThat("Is Connection Upgrade", parsedResponse.get(WebSocketConstants.SEC_WEBSOCKET_ACCEPT), notNullValue());
assertThat("Is Connection Upgrade", parsedResponse.get("Connection"), is("Upgrade"));
assertThat("Is WebSocket Upgrade", parsedResponse.get("Upgrade"), is("WebSocket"));
return parsedResponse;
}
public interface Provider
{
Parser newClientParser(Parser.Handler parserHandler);
LocalConnector.LocalEndPoint newLocalConnection();
}
}