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