1 // Copyright 2013 The Chromium Authors
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include "net/websockets/websocket_frame.h"
6
7 #include <stdint.h>
8
9 #include <vector>
10
11 #include "base/memory/aligned_memory.h"
12 #include "base/ranges/algorithm.h"
13 #include "net/base/net_errors.h"
14 #include "testing/gtest/include/gtest/gtest.h"
15
16 namespace net {
17
18 namespace {
19
TEST(WebSocketFrameHeaderTest,FrameLengths)20 TEST(WebSocketFrameHeaderTest, FrameLengths) {
21 struct TestCase {
22 const char* frame_header;
23 size_t frame_header_length;
24 uint64_t frame_length;
25 };
26 static const TestCase kTests[] = {
27 {"\x81\x00", 2, UINT64_C(0)},
28 {"\x81\x7D", 2, UINT64_C(125)},
29 {"\x81\x7E\x00\x7E", 4, UINT64_C(126)},
30 {"\x81\x7E\xFF\xFF", 4, UINT64_C(0xFFFF)},
31 {"\x81\x7F\x00\x00\x00\x00\x00\x01\x00\x00", 10, UINT64_C(0x10000)},
32 {"\x81\x7F\x7F\xFF\xFF\xFF\xFF\xFF\xFF\xFF", 10,
33 UINT64_C(0x7FFFFFFFFFFFFFFF)}};
34
35 for (const auto& test : kTests) {
36 WebSocketFrameHeader header(WebSocketFrameHeader::kOpCodeText);
37 header.final = true;
38 header.payload_length = test.frame_length;
39
40 std::vector<char> expected_output(
41 test.frame_header, test.frame_header + test.frame_header_length);
42 std::vector<char> output(expected_output.size());
43 EXPECT_EQ(static_cast<int>(expected_output.size()),
44 WriteWebSocketFrameHeader(header, nullptr, output.data(),
45 output.size()));
46 EXPECT_EQ(expected_output, output);
47 }
48 }
49
TEST(WebSocketFrameHeaderTest,FrameLengthsWithMasking)50 TEST(WebSocketFrameHeaderTest, FrameLengthsWithMasking) {
51 static constexpr base::StringPiece kMaskingKey = "\xDE\xAD\xBE\xEF";
52 static_assert(kMaskingKey.size() == WebSocketFrameHeader::kMaskingKeyLength,
53 "incorrect masking key size");
54
55 struct TestCase {
56 const char* frame_header;
57 size_t frame_header_length;
58 uint64_t frame_length;
59 };
60 static const TestCase kTests[] = {
61 {"\x81\x80\xDE\xAD\xBE\xEF", 6, UINT64_C(0)},
62 {"\x81\xFD\xDE\xAD\xBE\xEF", 6, UINT64_C(125)},
63 {"\x81\xFE\x00\x7E\xDE\xAD\xBE\xEF", 8, UINT64_C(126)},
64 {"\x81\xFE\xFF\xFF\xDE\xAD\xBE\xEF", 8, UINT64_C(0xFFFF)},
65 {"\x81\xFF\x00\x00\x00\x00\x00\x01\x00\x00\xDE\xAD\xBE\xEF", 14,
66 UINT64_C(0x10000)},
67 {"\x81\xFF\x7F\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xDE\xAD\xBE\xEF", 14,
68 UINT64_C(0x7FFFFFFFFFFFFFFF)}};
69
70 WebSocketMaskingKey masking_key;
71 base::ranges::copy(kMaskingKey, masking_key.key);
72
73 for (const auto& test : kTests) {
74 WebSocketFrameHeader header(WebSocketFrameHeader::kOpCodeText);
75 header.final = true;
76 header.masked = true;
77 header.payload_length = test.frame_length;
78
79 std::vector<char> expected_output(
80 test.frame_header, test.frame_header + test.frame_header_length);
81 std::vector<char> output(expected_output.size());
82 EXPECT_EQ(static_cast<int>(expected_output.size()),
83 WriteWebSocketFrameHeader(header, &masking_key, output.data(),
84 output.size()));
85 EXPECT_EQ(expected_output, output);
86 }
87 }
88
TEST(WebSocketFrameHeaderTest,FrameOpCodes)89 TEST(WebSocketFrameHeaderTest, FrameOpCodes) {
90 struct TestCase {
91 const char* frame_header;
92 size_t frame_header_length;
93 WebSocketFrameHeader::OpCode opcode;
94 };
95 static const TestCase kTests[] = {
96 {"\x80\x00", 2, WebSocketFrameHeader::kOpCodeContinuation},
97 {"\x81\x00", 2, WebSocketFrameHeader::kOpCodeText},
98 {"\x82\x00", 2, WebSocketFrameHeader::kOpCodeBinary},
99 {"\x88\x00", 2, WebSocketFrameHeader::kOpCodeClose},
100 {"\x89\x00", 2, WebSocketFrameHeader::kOpCodePing},
101 {"\x8A\x00", 2, WebSocketFrameHeader::kOpCodePong},
102 // These are undefined opcodes, but the builder should accept them anyway.
103 {"\x83\x00", 2, 0x3},
104 {"\x84\x00", 2, 0x4},
105 {"\x85\x00", 2, 0x5},
106 {"\x86\x00", 2, 0x6},
107 {"\x87\x00", 2, 0x7},
108 {"\x8B\x00", 2, 0xB},
109 {"\x8C\x00", 2, 0xC},
110 {"\x8D\x00", 2, 0xD},
111 {"\x8E\x00", 2, 0xE},
112 {"\x8F\x00", 2, 0xF}};
113
114 for (const auto& test : kTests) {
115 WebSocketFrameHeader header(test.opcode);
116 header.final = true;
117 header.payload_length = 0;
118
119 std::vector<char> expected_output(
120 test.frame_header, test.frame_header + test.frame_header_length);
121 std::vector<char> output(expected_output.size());
122 EXPECT_EQ(static_cast<int>(expected_output.size()),
123 WriteWebSocketFrameHeader(header, nullptr, output.data(),
124 output.size()));
125 EXPECT_EQ(expected_output, output);
126 }
127 }
128
TEST(WebSocketFrameHeaderTest,FinalBitAndReservedBits)129 TEST(WebSocketFrameHeaderTest, FinalBitAndReservedBits) {
130 struct TestCase {
131 const char* frame_header;
132 size_t frame_header_length;
133 bool final;
134 bool reserved1;
135 bool reserved2;
136 bool reserved3;
137 };
138 static const TestCase kTests[] = {{"\x81\x00", 2, true, false, false, false},
139 {"\x01\x00", 2, false, false, false, false},
140 {"\xC1\x00", 2, true, true, false, false},
141 {"\xA1\x00", 2, true, false, true, false},
142 {"\x91\x00", 2, true, false, false, true},
143 {"\x71\x00", 2, false, true, true, true},
144 {"\xF1\x00", 2, true, true, true, true}};
145
146 for (const auto& test : kTests) {
147 WebSocketFrameHeader header(WebSocketFrameHeader::kOpCodeText);
148 header.final = test.final;
149 header.reserved1 = test.reserved1;
150 header.reserved2 = test.reserved2;
151 header.reserved3 = test.reserved3;
152 header.payload_length = 0;
153
154 std::vector<char> expected_output(
155 test.frame_header, test.frame_header + test.frame_header_length);
156 std::vector<char> output(expected_output.size());
157 EXPECT_EQ(static_cast<int>(expected_output.size()),
158 WriteWebSocketFrameHeader(header, nullptr, output.data(),
159 output.size()));
160 EXPECT_EQ(expected_output, output);
161 }
162 }
163
TEST(WebSocketFrameHeaderTest,InsufficientBufferSize)164 TEST(WebSocketFrameHeaderTest, InsufficientBufferSize) {
165 struct TestCase {
166 uint64_t payload_length;
167 bool masked;
168 size_t expected_header_size;
169 };
170 static const TestCase kTests[] = {{UINT64_C(0), false, 2u},
171 {UINT64_C(125), false, 2u},
172 {UINT64_C(126), false, 4u},
173 {UINT64_C(0xFFFF), false, 4u},
174 {UINT64_C(0x10000), false, 10u},
175 {UINT64_C(0x7FFFFFFFFFFFFFFF), false, 10u},
176 {UINT64_C(0), true, 6u},
177 {UINT64_C(125), true, 6u},
178 {UINT64_C(126), true, 8u},
179 {UINT64_C(0xFFFF), true, 8u},
180 {UINT64_C(0x10000), true, 14u},
181 {UINT64_C(0x7FFFFFFFFFFFFFFF), true, 14u}};
182
183 for (const auto& test : kTests) {
184 WebSocketFrameHeader header(WebSocketFrameHeader::kOpCodeText);
185 header.final = true;
186 header.opcode = WebSocketFrameHeader::kOpCodeText;
187 header.masked = test.masked;
188 header.payload_length = test.payload_length;
189
190 char dummy_buffer[14];
191 // Set an insufficient size to |buffer_size|.
192 EXPECT_EQ(ERR_INVALID_ARGUMENT,
193 WriteWebSocketFrameHeader(header, nullptr, dummy_buffer,
194 test.expected_header_size - 1));
195 }
196 }
197
TEST(WebSocketFrameTest,MaskPayload)198 TEST(WebSocketFrameTest, MaskPayload) {
199 struct TestCase {
200 const base::StringPiece masking_key;
201 uint64_t frame_offset;
202 const char* input;
203 const char* output;
204 size_t data_length;
205 };
206 static const TestCase kTests[] = {
207 {"\xDE\xAD\xBE\xEF", 0, "FooBar", "\x98\xC2\xD1\xAD\xBF\xDF", 6},
208 {"\xDE\xAD\xBE\xEF", 1, "FooBar", "\xEB\xD1\x80\x9C\xCC\xCC", 6},
209 {"\xDE\xAD\xBE\xEF", 2, "FooBar", "\xF8\x80\xB1\xEF\xDF\x9D", 6},
210 {"\xDE\xAD\xBE\xEF", 3, "FooBar", "\xA9\xB1\xC2\xFC\x8E\xAC", 6},
211 {"\xDE\xAD\xBE\xEF", 4, "FooBar", "\x98\xC2\xD1\xAD\xBF\xDF", 6},
212 {"\xDE\xAD\xBE\xEF", 42, "FooBar", "\xF8\x80\xB1\xEF\xDF\x9D", 6},
213 {"\xDE\xAD\xBE\xEF", 0, "", "", 0},
214 {"\xDE\xAD\xBE\xEF", 0, "\xDE\xAD\xBE\xEF", "\x00\x00\x00\x00", 4},
215 {"\xDE\xAD\xBE\xEF", 0, "\x00\x00\x00\x00", "\xDE\xAD\xBE\xEF", 4},
216 {{"\x00\x00\x00\x00", WebSocketFrameHeader::kMaskingKeyLength}, 0,
217 "FooBar", "FooBar", 6},
218 {"\xFF\xFF\xFF\xFF", 0, "FooBar", "\xB9\x90\x90\xBD\x9E\x8D", 6},
219 };
220
221 for (const auto& test : kTests) {
222 WebSocketMaskingKey masking_key;
223 base::ranges::copy(test.masking_key, masking_key.key);
224 std::vector<char> frame_data(test.input, test.input + test.data_length);
225 std::vector<char> expected_output(test.output,
226 test.output + test.data_length);
227 MaskWebSocketFramePayload(masking_key, test.frame_offset,
228 frame_data.empty() ? nullptr : frame_data.data(),
229 frame_data.size());
230 EXPECT_EQ(expected_output, frame_data);
231 }
232 }
233
234 // Check that all combinations of alignment, frame offset and chunk size work
235 // correctly for MaskWebSocketFramePayload(). This is mainly used to ensure that
236 // vectorisation optimisations don't break anything. We could take a "white box"
237 // approach and only test the edge cases, but since the exhaustive "black box"
238 // approach runs in acceptable time, we don't have to take the risk of being
239 // clever.
240 //
241 // This brute-force approach runs in O(N^3) time where N is the size of the
242 // maximum vector size we want to test again. This might need reconsidering if
243 // MaskWebSocketFramePayload() is ever optimised for a dedicated vector
244 // architecture.
TEST(WebSocketFrameTest,MaskPayloadAlignment)245 TEST(WebSocketFrameTest, MaskPayloadAlignment) {
246 // This reflects what might be implemented in the future, rather than
247 // the current implementation. FMA3 and FMA4 support 256-bit vector ops.
248 static const size_t kMaxVectorSizeInBits = 256;
249 static const size_t kMaxVectorSize = kMaxVectorSizeInBits / 8;
250 static const size_t kMaxVectorAlignment = kMaxVectorSize;
251 static const size_t kMaskingKeyLength =
252 WebSocketFrameHeader::kMaskingKeyLength;
253 static const size_t kScratchBufferSize =
254 kMaxVectorAlignment + kMaxVectorSize * 2;
255 static constexpr base::StringPiece kTestMask = "\xd2\xba\x5a\xbe";
256 // We use 786 bits of random input to reduce the risk of correlated errors.
257 static const char kTestInput[] = {
258 "\x3d\x77\x1d\x1b\x19\x8c\x48\xa3\x19\x6d\xf7\xcc\x39\xe7\x57\x0b"
259 "\x69\x8c\xda\x4b\xfc\xac\x2c\xd3\x49\x96\x6e\x8a\x7b\x5a\x32\x76"
260 "\xd0\x11\x43\xa0\x89\xfc\x76\x2b\x10\x2f\x4c\x7b\x4f\xa6\xdd\xe4"
261 "\xfc\x8e\xd8\x72\xcf\x7e\x37\xcd\x31\xcd\xc1\xc0\x89\x0c\xa7\x4c"
262 "\xda\xa8\x4b\x75\xa1\xcb\xa9\x77\x19\x4d\x6e\xdf\xc8\x08\x1c\xb6"
263 "\x6d\xfb\x38\x04\x44\xd5\xba\x57\x9f\x76\xb0\x2e\x07\x91\xe6\xa8"
264 };
265 static const size_t kTestInputSize = std::size(kTestInput) - 1;
266 static const char kTestOutput[] = {
267 "\xef\xcd\x47\xa5\xcb\x36\x12\x1d\xcb\xd7\xad\x72\xeb\x5d\x0d\xb5"
268 "\xbb\x36\x80\xf5\x2e\x16\x76\x6d\x9b\x2c\x34\x34\xa9\xe0\x68\xc8"
269 "\x02\xab\x19\x1e\x5b\x46\x2c\x95\xc2\x95\x16\xc5\x9d\x1c\x87\x5a"
270 "\x2e\x34\x82\xcc\x1d\xc4\x6d\x73\xe3\x77\x9b\x7e\x5b\xb6\xfd\xf2"
271 "\x08\x12\x11\xcb\x73\x71\xf3\xc9\xcb\xf7\x34\x61\x1a\xb2\x46\x08"
272 "\xbf\x41\x62\xba\x96\x6f\xe0\xe9\x4d\xcc\xea\x90\xd5\x2b\xbc\x16"
273 };
274 static_assert(std::size(kTestInput) == std::size(kTestOutput),
275 "output and input arrays should have the same length");
276 std::unique_ptr<char, base::AlignedFreeDeleter> scratch(static_cast<char*>(
277 base::AlignedAlloc(kScratchBufferSize, kMaxVectorAlignment)));
278 WebSocketMaskingKey masking_key;
279 base::ranges::copy(kTestMask, masking_key.key);
280 for (size_t frame_offset = 0; frame_offset < kMaskingKeyLength;
281 ++frame_offset) {
282 for (size_t alignment = 0; alignment < kMaxVectorAlignment; ++alignment) {
283 char* const aligned_scratch = scratch.get() + alignment;
284 const size_t aligned_len = std::min(kScratchBufferSize - alignment,
285 kTestInputSize - frame_offset);
286 for (size_t chunk_size = 1; chunk_size < kMaxVectorSize; ++chunk_size) {
287 memcpy(aligned_scratch, kTestInput + frame_offset, aligned_len);
288 for (size_t chunk_start = 0; chunk_start < aligned_len;
289 chunk_start += chunk_size) {
290 const size_t this_chunk_size =
291 std::min(chunk_size, aligned_len - chunk_start);
292 MaskWebSocketFramePayload(masking_key,
293 frame_offset + chunk_start,
294 aligned_scratch + chunk_start,
295 this_chunk_size);
296 }
297 // Stop the test if it fails, since we don't want to spew thousands of
298 // failures.
299 ASSERT_TRUE(std::equal(aligned_scratch,
300 aligned_scratch + aligned_len,
301 kTestOutput + frame_offset))
302 << "Output failed to match for frame_offset=" << frame_offset
303 << ", alignment=" << alignment << ", chunk_size=" << chunk_size;
304 }
305 }
306 }
307 }
308
309 // "IsKnownDataOpCode" is currently implemented in an "obviously correct"
310 // manner, but we test is anyway in case it changes to a more complex
311 // implementation in future.
TEST(WebSocketFrameHeaderTest,IsKnownDataOpCode)312 TEST(WebSocketFrameHeaderTest, IsKnownDataOpCode) {
313 // Make the test less verbose.
314 typedef WebSocketFrameHeader Frame;
315
316 // Known opcode, is used for data frames
317 EXPECT_TRUE(Frame::IsKnownDataOpCode(Frame::kOpCodeContinuation));
318 EXPECT_TRUE(Frame::IsKnownDataOpCode(Frame::kOpCodeText));
319 EXPECT_TRUE(Frame::IsKnownDataOpCode(Frame::kOpCodeBinary));
320
321 // Known opcode, is used for control frames
322 EXPECT_FALSE(Frame::IsKnownDataOpCode(Frame::kOpCodeClose));
323 EXPECT_FALSE(Frame::IsKnownDataOpCode(Frame::kOpCodePing));
324 EXPECT_FALSE(Frame::IsKnownDataOpCode(Frame::kOpCodePong));
325
326 // Check that unused opcodes return false
327 EXPECT_FALSE(Frame::IsKnownDataOpCode(Frame::kOpCodeDataUnused));
328 EXPECT_FALSE(Frame::IsKnownDataOpCode(Frame::kOpCodeControlUnused));
329
330 // Check that opcodes with the 4 bit set return false
331 EXPECT_FALSE(Frame::IsKnownDataOpCode(0x6));
332 EXPECT_FALSE(Frame::IsKnownDataOpCode(0xF));
333
334 // Check that out-of-range opcodes return false
335 EXPECT_FALSE(Frame::IsKnownDataOpCode(-1));
336 EXPECT_FALSE(Frame::IsKnownDataOpCode(0xFF));
337 }
338
339 // "IsKnownControlOpCode" is implemented in an "obviously correct" manner but
340 // might be optimised in future.
TEST(WebSocketFrameHeaderTest,IsKnownControlOpCode)341 TEST(WebSocketFrameHeaderTest, IsKnownControlOpCode) {
342 // Make the test less verbose.
343 typedef WebSocketFrameHeader Frame;
344
345 // Known opcode, is used for data frames
346 EXPECT_FALSE(Frame::IsKnownControlOpCode(Frame::kOpCodeContinuation));
347 EXPECT_FALSE(Frame::IsKnownControlOpCode(Frame::kOpCodeText));
348 EXPECT_FALSE(Frame::IsKnownControlOpCode(Frame::kOpCodeBinary));
349
350 // Known opcode, is used for control frames
351 EXPECT_TRUE(Frame::IsKnownControlOpCode(Frame::kOpCodeClose));
352 EXPECT_TRUE(Frame::IsKnownControlOpCode(Frame::kOpCodePing));
353 EXPECT_TRUE(Frame::IsKnownControlOpCode(Frame::kOpCodePong));
354
355 // Check that unused opcodes return false
356 EXPECT_FALSE(Frame::IsKnownControlOpCode(Frame::kOpCodeDataUnused));
357 EXPECT_FALSE(Frame::IsKnownControlOpCode(Frame::kOpCodeControlUnused));
358
359 // Check that opcodes with the 4 bit set return false
360 EXPECT_FALSE(Frame::IsKnownControlOpCode(0x6));
361 EXPECT_FALSE(Frame::IsKnownControlOpCode(0xF));
362
363 // Check that out-of-range opcodes return false
364 EXPECT_FALSE(Frame::IsKnownControlOpCode(-1));
365 EXPECT_FALSE(Frame::IsKnownControlOpCode(0xFF));
366 }
367
368 } // namespace
369
370 } // namespace net
371