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
|
/** @file
Tests for Ip6Option.c.
Copyright (c) Microsoft Corporation
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <gtest/gtest.h>
extern "C" {
#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include "../Ip6Impl.h"
#include "../Ip6Option.h"
#include "Ip6OptionGoogleTest.h"
}
/////////////////////////////////////////////////////////////////////////
// Defines
///////////////////////////////////////////////////////////////////////
#define IP6_PREFIX_INFO_OPTION_DATA_LEN 32
#define OPTION_HEADER_IP6_PREFIX_DATA_LEN (sizeof (IP6_OPTION_HEADER) + IP6_PREFIX_INFO_OPTION_DATA_LEN)
////////////////////////////////////////////////////////////////////////
// Symbol Definitions
// These functions are not directly under test - but required to compile
////////////////////////////////////////////////////////////////////////
UINT32 mIp6Id;
EFI_STATUS
Ip6SendIcmpError (
IN IP6_SERVICE *IpSb,
IN NET_BUF *Packet,
IN EFI_IPv6_ADDRESS *SourceAddress OPTIONAL,
IN EFI_IPv6_ADDRESS *DestinationAddress,
IN UINT8 Type,
IN UINT8 Code,
IN UINT32 *Pointer OPTIONAL
)
{
// ..
return EFI_SUCCESS;
}
////////////////////////////////////////////////////////////////////////
// Ip6OptionValidation Tests
////////////////////////////////////////////////////////////////////////
// Define a fixture for your tests if needed
class Ip6OptionValidationTest : public ::testing::Test {
protected:
// Add any setup code if needed
virtual void
SetUp (
)
{
// Initialize any resources or variables
}
// Add any cleanup code if needed
virtual void
TearDown (
)
{
// Clean up any resources or variables
}
};
// Test Description:
// Null option should return false
TEST_F (Ip6OptionValidationTest, NullOptionShouldReturnFalse) {
UINT8 *option = nullptr;
UINT16 optionLen = 10; // Provide a suitable length
EXPECT_FALSE (Ip6IsNDOptionValid (option, optionLen));
}
// Test Description:
// Truncated option should return false
TEST_F (Ip6OptionValidationTest, TruncatedOptionShouldReturnFalse) {
UINT8 option[] = { 0x01 }; // Provide a truncated option
UINT16 optionLen = 1;
EXPECT_FALSE (Ip6IsNDOptionValid (option, optionLen));
}
// Test Description:
// Ip6OptionPrefixInfo Option with zero length should return false
TEST_F (Ip6OptionValidationTest, OptionWithZeroLengthShouldReturnFalse) {
IP6_OPTION_HEADER optionHeader;
optionHeader.Type = Ip6OptionPrefixInfo;
optionHeader.Length = 0;
UINT8 option[sizeof (IP6_OPTION_HEADER)];
CopyMem (option, &optionHeader, sizeof (IP6_OPTION_HEADER));
UINT16 optionLen = sizeof (IP6_OPTION_HEADER);
EXPECT_FALSE (Ip6IsNDOptionValid (option, optionLen));
}
// Test Description:
// Ip6OptionPrefixInfo Option with valid length should return true
TEST_F (Ip6OptionValidationTest, ValidPrefixInfoOptionShouldReturnTrue) {
IP6_OPTION_HEADER optionHeader;
optionHeader.Type = Ip6OptionPrefixInfo;
optionHeader.Length = 4; // Length 4 * 8 = 32
UINT8 option[OPTION_HEADER_IP6_PREFIX_DATA_LEN];
CopyMem (option, &optionHeader, sizeof (IP6_OPTION_HEADER));
EXPECT_TRUE (Ip6IsNDOptionValid (option, IP6_PREFIX_INFO_OPTION_DATA_LEN));
}
// Test Description:
// Ip6OptionPrefixInfo Option with invalid length should return false
TEST_F (Ip6OptionValidationTest, InvalidPrefixInfoOptionLengthShouldReturnFalse) {
IP6_OPTION_HEADER optionHeader;
optionHeader.Type = Ip6OptionPrefixInfo;
optionHeader.Length = 3; // Length 3 * 8 = 24 (Invalid)
UINT8 option[sizeof (IP6_OPTION_HEADER)];
CopyMem (option, &optionHeader, sizeof (IP6_OPTION_HEADER));
UINT16 optionLen = sizeof (IP6_OPTION_HEADER);
EXPECT_FALSE (Ip6IsNDOptionValid (option, optionLen));
}
////////////////////////////////////////////////////////////////////////
// Ip6IsOptionValid Tests
////////////////////////////////////////////////////////////////////////
// Define a fixture for your tests if needed
class Ip6IsOptionValidTest : public ::testing::Test {
protected:
// Add any setup code if needed
virtual void
SetUp (
)
{
// Initialize any resources or variables
}
// Add any cleanup code if needed
virtual void
TearDown (
)
{
// Clean up any resources or variables
}
};
// Test Description
// Verify that a NULL option is Invalid
TEST_F (Ip6IsOptionValidTest, NullOptionShouldReturnTrue) {
NET_BUF Packet = { 0 };
// we need to define enough of the packet to make the function work
// The function being tested will pass IpSb to Ip6SendIcmpError which is defined above
IP6_SERVICE *IpSb = NULL;
EFI_IPv6_ADDRESS SourceAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IPv6_ADDRESS DestinationAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IP6_HEADER Ip6Header = { 0 };
Ip6Header.SourceAddress = SourceAddress;
Ip6Header.DestinationAddress = DestinationAddress;
Packet.Ip.Ip6 = &Ip6Header;
EXPECT_FALSE (Ip6IsOptionValid (IpSb, &Packet, NULL, 0, 0));
}
// Test Description
// Verify that an unknown option with a length of 0 and type of <unknown> does not cause an infinite loop
TEST_F (Ip6IsOptionValidTest, VerifyNoInfiniteLoopOnUnknownOptionLength0) {
NET_BUF Packet = { 0 };
// we need to define enough of the packet to make the function work
// The function being tested will pass IpSb to Ip6SendIcmpError which is defined above
UINT32 DeadCode = 0xDeadC0de;
// Don't actually use this pointer, just pass it to the function, nothing will be done with it
IP6_SERVICE *IpSb = (IP6_SERVICE *)&DeadCode;
EFI_IPv6_ADDRESS SourceAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IPv6_ADDRESS DestinationAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IP6_HEADER Ip6Header = { 0 };
Ip6Header.SourceAddress = SourceAddress;
Ip6Header.DestinationAddress = DestinationAddress;
Packet.Ip.Ip6 = &Ip6Header;
IP6_OPTION_HEADER optionHeader;
optionHeader.Type = 23; // Unknown Option
optionHeader.Length = 0; // This will cause an infinite loop if the function is not working correctly
// This should be a valid option even though the length is 0
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
}
// Test Description
// Verify that an unknown option with a length of 1 and type of <unknown> does not cause an infinite loop
TEST_F (Ip6IsOptionValidTest, VerifyNoInfiniteLoopOnUnknownOptionLength1) {
NET_BUF Packet = { 0 };
// we need to define enough of the packet to make the function work
// The function being tested will pass IpSb to Ip6SendIcmpError which is defined above
UINT32 DeadCode = 0xDeadC0de;
// Don't actually use this pointer, just pass it to the function, nothing will be done with it
IP6_SERVICE *IpSb = (IP6_SERVICE *)&DeadCode;
EFI_IPv6_ADDRESS SourceAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IPv6_ADDRESS DestinationAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IP6_HEADER Ip6Header = { 0 };
Ip6Header.SourceAddress = SourceAddress;
Ip6Header.DestinationAddress = DestinationAddress;
Packet.Ip.Ip6 = &Ip6Header;
IP6_OPTION_HEADER optionHeader;
optionHeader.Type = 23; // Unknown Option
optionHeader.Length = 1; // This will cause an infinite loop if the function is not working correctly
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
}
// Test Description
// Verify that an unknown option with a length of 2 and type of <unknown> does not cause an infinite loop
TEST_F (Ip6IsOptionValidTest, VerifyIpSkipUnknownOption) {
NET_BUF Packet = { 0 };
// we need to define enough of the packet to make the function work
// The function being tested will pass IpSb to Ip6SendIcmpError which is defined above
UINT32 DeadCode = 0xDeadC0de;
// Don't actually use this pointer, just pass it to the function, nothing will be done with it
IP6_SERVICE *IpSb = (IP6_SERVICE *)&DeadCode;
EFI_IPv6_ADDRESS SourceAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IPv6_ADDRESS DestinationAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IP6_HEADER Ip6Header = { 0 };
Ip6Header.SourceAddress = SourceAddress;
Ip6Header.DestinationAddress = DestinationAddress;
Packet.Ip.Ip6 = &Ip6Header;
IP6_OPTION_HEADER optionHeader;
optionHeader.Type = 23; // Unknown Option
optionHeader.Length = 2; // Valid length for an unknown option
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
}
// Test Description
// Verify that Ip6OptionPad1 is valid with a length of 0
TEST_F (Ip6IsOptionValidTest, VerifyIp6OptionPad1) {
NET_BUF Packet = { 0 };
// we need to define enough of the packet to make the function work
// The function being tested will pass IpSb to Ip6SendIcmpError which is defined above
UINT32 DeadCode = 0xDeadC0de;
// Don't actually use this pointer, just pass it to the function, nothing will be done with it
IP6_SERVICE *IpSb = (IP6_SERVICE *)&DeadCode;
EFI_IPv6_ADDRESS SourceAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IPv6_ADDRESS DestinationAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IP6_HEADER Ip6Header = { 0 };
Ip6Header.SourceAddress = SourceAddress;
Ip6Header.DestinationAddress = DestinationAddress;
Packet.Ip.Ip6 = &Ip6Header;
IP6_OPTION_HEADER optionHeader;
optionHeader.Type = Ip6OptionPad1;
optionHeader.Length = 0;
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
}
// Test Description
// Verify that Ip6OptionPadN doesn't overflow with various lengths
TEST_F (Ip6IsOptionValidTest, VerifyIp6OptionPadN) {
NET_BUF Packet = { 0 };
// we need to define enough of the packet to make the function work
// The function being tested will pass IpSb to Ip6SendIcmpError which is defined above
UINT32 DeadCode = 0xDeadC0de;
// Don't actually use this pointer, just pass it to the function, nothing will be done with it
IP6_SERVICE *IpSb = (IP6_SERVICE *)&DeadCode;
EFI_IPv6_ADDRESS SourceAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IPv6_ADDRESS DestinationAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IP6_HEADER Ip6Header = { 0 };
Ip6Header.SourceAddress = SourceAddress;
Ip6Header.DestinationAddress = DestinationAddress;
Packet.Ip.Ip6 = &Ip6Header;
IP6_OPTION_HEADER optionHeader;
optionHeader.Type = Ip6OptionPadN;
optionHeader.Length = 0xFF;
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
optionHeader.Length = 0xFE;
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
optionHeader.Length = 0xFD;
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
optionHeader.Length = 0xFC;
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
}
// Test Description
// Verify an unknown option doesn't cause an infinite loop with various lengths
TEST_F (Ip6IsOptionValidTest, VerifyNoInfiniteLoopOnUnknownOptionLengthAttemptOverflow) {
NET_BUF Packet = { 0 };
// we need to define enough of the packet to make the function work
// The function being tested will pass IpSb to Ip6SendIcmpError which is defined above
UINT32 DeadCode = 0xDeadC0de;
// Don't actually use this pointer, just pass it to the function, nothing will be done with it
IP6_SERVICE *IpSb = (IP6_SERVICE *)&DeadCode;
EFI_IPv6_ADDRESS SourceAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IPv6_ADDRESS DestinationAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IP6_HEADER Ip6Header = { 0 };
Ip6Header.SourceAddress = SourceAddress;
Ip6Header.DestinationAddress = DestinationAddress;
Packet.Ip.Ip6 = &Ip6Header;
IP6_OPTION_HEADER optionHeader;
optionHeader.Type = 23; // Unknown Option
optionHeader.Length = 0xFF;
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
optionHeader.Length = 0xFE;
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
optionHeader.Length = 0xFD;
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
optionHeader.Length = 0xFC;
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, (UINT8 *)&optionHeader, sizeof (optionHeader), 0));
}
// Test Description
// Verify that the function supports multiple options
TEST_F (Ip6IsOptionValidTest, MultiOptionSupport) {
UINT16 HdrLen;
NET_BUF Packet = { 0 };
// we need to define enough of the packet to make the function work
// The function being tested will pass IpSb to Ip6SendIcmpError which is defined above
UINT32 DeadCode = 0xDeadC0de;
// Don't actually use this pointer, just pass it to the function, nothing will be done with it
IP6_SERVICE *IpSb = (IP6_SERVICE *)&DeadCode;
EFI_IPv6_ADDRESS SourceAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IPv6_ADDRESS DestinationAddress = { 0x20, 0x01, 0x0d, 0xb8, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0x00, 0x42, 0x83, 0x29 };
EFI_IP6_HEADER Ip6Header = { 0 };
Ip6Header.SourceAddress = SourceAddress;
Ip6Header.DestinationAddress = DestinationAddress;
Packet.Ip.Ip6 = &Ip6Header;
UINT8 ExtHdr[1024] = { 0 };
UINT8 *Cursor = ExtHdr;
IP6_OPTION_HEADER *Option = (IP6_OPTION_HEADER *)ExtHdr;
// Let's start chaining options
Option->Type = 23; // Unknown Option
Option->Length = 0xFC;
Cursor += sizeof (IP6_OPTION_HEADER) + 0xFC;
Option = (IP6_OPTION_HEADER *)Cursor;
Option->Type = Ip6OptionPad1;
Cursor += sizeof (1);
// Type and length aren't processed, instead it just moves the pointer forward by 4 bytes
Option = (IP6_OPTION_HEADER *)Cursor;
Option->Type = Ip6OptionRouterAlert;
Option->Length = 4;
Cursor += sizeof (IP6_OPTION_HEADER) + 4;
Option = (IP6_OPTION_HEADER *)Cursor;
Option->Type = Ip6OptionPadN;
Option->Length = 0xFC;
Cursor += sizeof (IP6_OPTION_HEADER) + 0xFC;
Option = (IP6_OPTION_HEADER *)Cursor;
Option->Type = Ip6OptionRouterAlert;
Option->Length = 4;
Cursor += sizeof (IP6_OPTION_HEADER) + 4;
// Total 524
HdrLen = (UINT16)(Cursor - ExtHdr);
EXPECT_TRUE (Ip6IsOptionValid (IpSb, &Packet, ExtHdr, HdrLen, 0));
}
|
