]>
Commit | Line | Data |
---|---|---|
a3bcde70 HT |
1 | /** @file\r |
2 | IP6 option support functions and routines.\r | |
3 | \r | |
4 | Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r | |
5 | \r | |
ecf98fbc | 6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
a3bcde70 HT |
7 | \r |
8 | **/\r | |
9 | \r | |
10 | #include "Ip6Impl.h"\r | |
11 | \r | |
12 | /**\r | |
13 | Validate the IP6 option format for both the packets we received\r | |
14 | and that we will transmit. It will compute the ICMPv6 error message fields\r | |
d1c85a17 | 15 | if the option is malformatted.\r |
a3bcde70 HT |
16 | \r |
17 | @param[in] IpSb The IP6 service data.\r | |
18 | @param[in] Packet The to be validated packet.\r | |
19 | @param[in] Option The first byte of the option.\r | |
20 | @param[in] OptionLen The length of the whole option.\r | |
21 | @param[in] Pointer Identifies the octet offset within\r | |
22 | the invoking packet where the error was detected.\r | |
23 | \r | |
24 | \r | |
25 | @retval TRUE The option is properly formatted.\r | |
d1c85a17 | 26 | @retval FALSE The option is malformatted.\r |
a3bcde70 HT |
27 | \r |
28 | **/\r | |
29 | BOOLEAN\r | |
30 | Ip6IsOptionValid (\r | |
31 | IN IP6_SERVICE *IpSb,\r | |
32 | IN NET_BUF *Packet,\r | |
33 | IN UINT8 *Option,\r | |
34 | IN UINT8 OptionLen,\r | |
35 | IN UINT32 Pointer\r | |
36 | )\r | |
37 | {\r | |
38 | UINT8 Offset;\r | |
39 | UINT8 OptionType;\r | |
40 | \r | |
41 | Offset = 0;\r | |
42 | \r | |
43 | while (Offset < OptionLen) {\r | |
44 | OptionType = *(Option + Offset);\r | |
45 | \r | |
46 | switch (OptionType) {\r | |
47 | case Ip6OptionPad1:\r | |
48 | //\r | |
49 | // It is a Pad1 option\r | |
50 | //\r | |
51 | Offset++;\r | |
52 | break;\r | |
53 | case Ip6OptionPadN:\r | |
54 | //\r | |
55 | // It is a PadN option\r | |
56 | //\r | |
57 | Offset = (UINT8) (Offset + *(Option + Offset + 1) + 2);\r | |
58 | break;\r | |
59 | case Ip6OptionRouterAlert:\r | |
60 | //\r | |
61 | // It is a Router Alert Option\r | |
62 | //\r | |
63 | Offset += 4;\r | |
64 | break;\r | |
65 | default:\r | |
66 | //\r | |
67 | // The highest-order two bits specify the action must be taken if\r | |
68 | // the processing IPv6 node does not recognize the option type.\r | |
69 | //\r | |
70 | switch (OptionType & Ip6OptionMask) {\r | |
71 | case Ip6OptionSkip:\r | |
72 | Offset = (UINT8) (Offset + *(Option + Offset + 1));\r | |
73 | break;\r | |
74 | case Ip6OptionDiscard:\r | |
75 | return FALSE;\r | |
76 | case Ip6OptionParameterProblem:\r | |
77 | Pointer = Pointer + Offset + sizeof (EFI_IP6_HEADER);\r | |
78 | Ip6SendIcmpError (\r | |
79 | IpSb,\r | |
80 | Packet,\r | |
81 | NULL,\r | |
82 | &Packet->Ip.Ip6->SourceAddress,\r | |
83 | ICMP_V6_PARAMETER_PROBLEM,\r | |
84 | 2,\r | |
85 | &Pointer\r | |
86 | );\r | |
87 | return FALSE;\r | |
88 | case Ip6OptionMask:\r | |
89 | if (!IP6_IS_MULTICAST (&Packet->Ip.Ip6->DestinationAddress)) {\r | |
90 | Pointer = Pointer + Offset + sizeof (EFI_IP6_HEADER);\r | |
91 | Ip6SendIcmpError (\r | |
92 | IpSb,\r | |
93 | Packet,\r | |
94 | NULL,\r | |
95 | &Packet->Ip.Ip6->SourceAddress,\r | |
96 | ICMP_V6_PARAMETER_PROBLEM,\r | |
97 | 2,\r | |
98 | &Pointer\r | |
99 | );\r | |
100 | }\r | |
101 | \r | |
102 | return FALSE;\r | |
103 | break;\r | |
104 | }\r | |
105 | \r | |
106 | break;\r | |
107 | }\r | |
108 | \r | |
109 | }\r | |
110 | \r | |
111 | return TRUE;\r | |
112 | }\r | |
113 | \r | |
114 | /**\r | |
115 | Validate the IP6 option format for both the packets we received\r | |
116 | and that we will transmit. It supports the defined options in Neighbor\r | |
117 | Discovery messages.\r | |
118 | \r | |
119 | @param[in] Option The first byte of the option.\r | |
120 | @param[in] OptionLen The length of the whole option.\r | |
121 | \r | |
122 | @retval TRUE The option is properly formatted.\r | |
d1c85a17 | 123 | @retval FALSE The option is malformatted.\r |
a3bcde70 HT |
124 | \r |
125 | **/\r | |
126 | BOOLEAN\r | |
127 | Ip6IsNDOptionValid (\r | |
128 | IN UINT8 *Option,\r | |
129 | IN UINT16 OptionLen\r | |
130 | )\r | |
131 | {\r | |
9c20342e | 132 | UINT32 Offset;\r |
a3bcde70 | 133 | UINT16 Length;\r |
9c20342e MR |
134 | IP6_OPTION_HEADER *OptionHeader;\r |
135 | \r | |
136 | if (Option == NULL) {\r | |
137 | ASSERT (Option != NULL);\r | |
138 | return FALSE;\r | |
139 | }\r | |
a3bcde70 HT |
140 | \r |
141 | Offset = 0;\r | |
142 | \r | |
9c20342e MR |
143 | //\r |
144 | // RFC 4861 states that Neighbor Discovery packet can contain zero or more\r | |
145 | // options. Start processing the options if at least Type + Length fields\r | |
146 | // fit within the input buffer.\r | |
147 | //\r | |
148 | while (Offset + sizeof (IP6_OPTION_HEADER) - 1 < OptionLen) {\r | |
149 | OptionHeader = (IP6_OPTION_HEADER*) (Option + Offset);\r | |
150 | Length = (UINT16) OptionHeader->Length * 8;\r | |
a3bcde70 | 151 | \r |
9c20342e | 152 | switch (OptionHeader->Type) {\r |
a3bcde70 HT |
153 | case Ip6OptionPrefixInfo:\r |
154 | if (Length != 32) {\r | |
155 | return FALSE;\r | |
156 | }\r | |
a3bcde70 HT |
157 | break;\r |
158 | \r | |
159 | case Ip6OptionMtu:\r | |
160 | if (Length != 8) {\r | |
161 | return FALSE;\r | |
162 | }\r | |
a3bcde70 HT |
163 | break;\r |
164 | \r | |
165 | default:\r | |
9c20342e | 166 | // RFC 4861 states that Length field cannot be 0.\r |
a3bcde70 HT |
167 | if (Length == 0) {\r |
168 | return FALSE;\r | |
169 | }\r | |
9c20342e MR |
170 | break;\r |
171 | }\r | |
172 | \r | |
173 | //\r | |
174 | // Check whether recognized options are within the input buffer's scope.\r | |
175 | //\r | |
176 | switch (OptionHeader->Type) {\r | |
177 | case Ip6OptionEtherSource:\r | |
178 | case Ip6OptionEtherTarget:\r | |
179 | case Ip6OptionPrefixInfo:\r | |
180 | case Ip6OptionRedirected:\r | |
181 | case Ip6OptionMtu:\r | |
182 | if (Offset + Length > (UINT32) OptionLen) {\r | |
183 | return FALSE;\r | |
184 | }\r | |
185 | break;\r | |
a3bcde70 | 186 | \r |
9c20342e MR |
187 | default:\r |
188 | //\r | |
189 | // Unrecognized options can be either valid (but unused) or invalid\r | |
190 | // (garbage in between or right after valid options). Silently ignore.\r | |
191 | //\r | |
a3bcde70 HT |
192 | break;\r |
193 | }\r | |
194 | \r | |
9c20342e MR |
195 | //\r |
196 | // Advance to the next option.\r | |
197 | // Length already considers option header's Type + Length.\r | |
198 | //\r | |
199 | Offset += Length;\r | |
a3bcde70 HT |
200 | }\r |
201 | \r | |
202 | return TRUE;\r | |
203 | }\r | |
204 | \r | |
205 | \r | |
206 | /**\r | |
207 | Validate whether the NextHeader is a known valid protocol or one of the user configured\r | |
208 | protocols from the upper layer.\r | |
209 | \r | |
210 | @param[in] IpSb The IP6 service instance.\r | |
211 | @param[in] NextHeader The next header field.\r | |
212 | \r | |
213 | @retval TRUE The NextHeader is a known valid protocol or user configured.\r | |
214 | @retval FALSE The NextHeader is not a known valid protocol.\r | |
215 | \r | |
216 | **/\r | |
217 | BOOLEAN\r | |
218 | Ip6IsValidProtocol (\r | |
219 | IN IP6_SERVICE *IpSb,\r | |
220 | IN UINT8 NextHeader\r | |
221 | )\r | |
222 | {\r | |
223 | LIST_ENTRY *Entry;\r | |
224 | IP6_PROTOCOL *IpInstance;\r | |
225 | \r | |
226 | if (NextHeader == EFI_IP_PROTO_TCP ||\r | |
227 | NextHeader == EFI_IP_PROTO_UDP ||\r | |
228 | NextHeader == IP6_ICMP ||\r | |
229 | NextHeader == IP6_ESP\r | |
230 | ) {\r | |
231 | return TRUE;\r | |
232 | }\r | |
233 | \r | |
234 | if (IpSb == NULL) {\r | |
235 | return FALSE;\r | |
236 | }\r | |
237 | \r | |
238 | if (IpSb->Signature != IP6_SERVICE_SIGNATURE) {\r | |
239 | return FALSE;\r | |
240 | }\r | |
241 | \r | |
242 | NET_LIST_FOR_EACH (Entry, &IpSb->Children) {\r | |
243 | IpInstance = NET_LIST_USER_STRUCT_S (Entry, IP6_PROTOCOL, Link, IP6_PROTOCOL_SIGNATURE);\r | |
244 | if (IpInstance->State == IP6_STATE_CONFIGED) {\r | |
245 | if (IpInstance->ConfigData.DefaultProtocol == NextHeader) {\r | |
246 | return TRUE;\r | |
247 | }\r | |
248 | }\r | |
249 | }\r | |
250 | \r | |
251 | return FALSE;\r | |
252 | }\r | |
253 | \r | |
254 | /**\r | |
255 | Validate the IP6 extension header format for both the packets we received\r | |
256 | and that we will transmit. It will compute the ICMPv6 error message fields\r | |
d1c85a17 | 257 | if the option is mal-formatted.\r |
a3bcde70 HT |
258 | \r |
259 | @param[in] IpSb The IP6 service instance. This is an optional parameter.\r | |
260 | @param[in] Packet The data of the packet. Ignored if NULL.\r | |
261 | @param[in] NextHeader The next header field in IPv6 basic header.\r | |
262 | @param[in] ExtHdrs The first byte of the option.\r | |
263 | @param[in] ExtHdrsLen The length of the whole option.\r | |
264 | @param[in] Rcvd The option is from the packet we received if TRUE,\r | |
265 | otherwise, the option we want to transmit.\r | |
266 | @param[out] FormerHeader The offset of NextHeader which points to Fragment\r | |
267 | Header when we received, of the ExtHdrs.\r | |
268 | Ignored if we transmit.\r | |
269 | @param[out] LastHeader The pointer of NextHeader of the last extension\r | |
270 | header processed by IP6.\r | |
271 | @param[out] RealExtsLen The length of extension headers processed by IP6 layer.\r | |
272 | This is an optional parameter that may be NULL.\r | |
273 | @param[out] UnFragmentLen The length of unfragmented length of extension headers.\r | |
274 | This is an optional parameter that may be NULL.\r | |
275 | @param[out] Fragmented Indicate whether the packet is fragmented.\r | |
276 | This is an optional parameter that may be NULL.\r | |
277 | \r | |
d1c85a17 GL |
278 | @retval TRUE The option is properly formatted.\r |
279 | @retval FALSE The option is malformatted.\r | |
a3bcde70 HT |
280 | \r |
281 | **/\r | |
282 | BOOLEAN\r | |
283 | Ip6IsExtsValid (\r | |
284 | IN IP6_SERVICE *IpSb OPTIONAL,\r | |
285 | IN NET_BUF *Packet OPTIONAL,\r | |
286 | IN UINT8 *NextHeader,\r | |
287 | IN UINT8 *ExtHdrs,\r | |
288 | IN UINT32 ExtHdrsLen,\r | |
289 | IN BOOLEAN Rcvd,\r | |
290 | OUT UINT32 *FormerHeader OPTIONAL,\r | |
291 | OUT UINT8 **LastHeader,\r | |
292 | OUT UINT32 *RealExtsLen OPTIONAL,\r | |
293 | OUT UINT32 *UnFragmentLen OPTIONAL,\r | |
294 | OUT BOOLEAN *Fragmented OPTIONAL\r | |
295 | )\r | |
296 | {\r | |
297 | UINT32 Pointer;\r | |
298 | UINT32 Offset;\r | |
299 | UINT8 *Option;\r | |
300 | UINT8 OptionLen;\r | |
301 | BOOLEAN Flag;\r | |
302 | UINT8 CountD;\r | |
303 | UINT8 CountA;\r | |
304 | IP6_FRAGMENT_HEADER *FragmentHead;\r | |
305 | UINT16 FragmentOffset;\r | |
306 | IP6_ROUTING_HEADER *RoutingHead;\r | |
307 | \r | |
308 | if (RealExtsLen != NULL) {\r | |
309 | *RealExtsLen = 0;\r | |
310 | }\r | |
311 | \r | |
312 | if (UnFragmentLen != NULL) {\r | |
313 | *UnFragmentLen = 0;\r | |
314 | }\r | |
315 | \r | |
316 | if (Fragmented != NULL) {\r | |
317 | *Fragmented = FALSE;\r | |
318 | }\r | |
319 | \r | |
320 | *LastHeader = NextHeader;\r | |
321 | \r | |
322 | if (ExtHdrs == NULL && ExtHdrsLen == 0) {\r | |
323 | return TRUE;\r | |
324 | }\r | |
325 | \r | |
326 | if ((ExtHdrs == NULL && ExtHdrsLen != 0) || (ExtHdrs != NULL && ExtHdrsLen == 0)) {\r | |
327 | return FALSE;\r | |
328 | }\r | |
329 | \r | |
330 | Pointer = 0;\r | |
331 | Offset = 0;\r | |
332 | Flag = FALSE;\r | |
333 | CountD = 0;\r | |
334 | CountA = 0;\r | |
335 | \r | |
336 | while (Offset <= ExtHdrsLen) {\r | |
337 | \r | |
338 | switch (*NextHeader) {\r | |
339 | case IP6_HOP_BY_HOP:\r | |
340 | if (Offset != 0) {\r | |
341 | if (!Rcvd) {\r | |
342 | return FALSE;\r | |
343 | }\r | |
344 | //\r | |
345 | // Hop-by-Hop Options header is restricted to appear immediately after an IPv6 header only.\r | |
346 | // If not, generate a ICMP parameter problem message with code value of 1.\r | |
347 | //\r | |
348 | if (Pointer == 0) {\r | |
349 | Pointer = sizeof (EFI_IP6_HEADER);\r | |
350 | } else {\r | |
351 | Pointer = Offset + sizeof (EFI_IP6_HEADER);\r | |
352 | }\r | |
353 | \r | |
354 | if ((IpSb != NULL) && (Packet != NULL) &&\r | |
355 | !IP6_IS_MULTICAST (&Packet->Ip.Ip6->DestinationAddress)) {\r | |
356 | Ip6SendIcmpError (\r | |
357 | IpSb,\r | |
358 | Packet,\r | |
359 | NULL,\r | |
360 | &Packet->Ip.Ip6->SourceAddress,\r | |
361 | ICMP_V6_PARAMETER_PROBLEM,\r | |
362 | 1,\r | |
363 | &Pointer\r | |
364 | );\r | |
365 | }\r | |
366 | return FALSE;\r | |
367 | }\r | |
368 | \r | |
369 | Flag = TRUE;\r | |
370 | \r | |
371 | //\r | |
372 | // Fall through\r | |
373 | //\r | |
374 | case IP6_DESTINATION:\r | |
375 | if (*NextHeader == IP6_DESTINATION) {\r | |
376 | CountD++;\r | |
377 | }\r | |
378 | \r | |
379 | if (CountD > 2) {\r | |
380 | return FALSE;\r | |
381 | }\r | |
382 | \r | |
383 | NextHeader = ExtHdrs + Offset;\r | |
384 | Pointer = Offset;\r | |
385 | \r | |
386 | Offset++;\r | |
387 | Option = ExtHdrs + Offset;\r | |
388 | OptionLen = (UINT8) ((*Option + 1) * 8 - 2);\r | |
389 | Option++;\r | |
390 | Offset++;\r | |
391 | \r | |
392 | if (IpSb != NULL && Packet != NULL && !Ip6IsOptionValid (IpSb, Packet, Option, OptionLen, Offset)) {\r | |
393 | return FALSE;\r | |
394 | }\r | |
395 | \r | |
396 | Offset = Offset + OptionLen;\r | |
397 | \r | |
398 | if (Flag) {\r | |
399 | if (UnFragmentLen != NULL) {\r | |
400 | *UnFragmentLen = Offset;\r | |
401 | }\r | |
402 | \r | |
403 | Flag = FALSE;\r | |
404 | }\r | |
405 | \r | |
406 | break;\r | |
407 | \r | |
408 | case IP6_ROUTING:\r | |
409 | NextHeader = ExtHdrs + Offset;\r | |
410 | RoutingHead = (IP6_ROUTING_HEADER *) NextHeader;\r | |
411 | \r | |
412 | //\r | |
413 | // Type 0 routing header is defined in RFC2460 and deprecated in RFC5095.\r | |
414 | // Thus all routing types are processed as unrecognized.\r | |
415 | //\r | |
416 | if (RoutingHead->SegmentsLeft == 0) {\r | |
417 | //\r | |
418 | // Ignore the routing header and proceed to process the next header.\r | |
419 | //\r | |
420 | Offset = Offset + (RoutingHead->HeaderLen + 1) * 8;\r | |
421 | \r | |
422 | if (UnFragmentLen != NULL) {\r | |
423 | *UnFragmentLen = Offset;\r | |
424 | }\r | |
425 | \r | |
426 | } else {\r | |
427 | //\r | |
428 | // Discard the packet and send an ICMP Parameter Problem, Code 0, message\r | |
429 | // to the packet's source address, pointing to the unrecognized routing\r | |
430 | // type.\r | |
431 | //\r | |
432 | Pointer = Offset + 2 + sizeof (EFI_IP6_HEADER);\r | |
433 | if ((IpSb != NULL) && (Packet != NULL) &&\r | |
434 | !IP6_IS_MULTICAST (&Packet->Ip.Ip6->DestinationAddress)) {\r | |
435 | Ip6SendIcmpError (\r | |
436 | IpSb,\r | |
437 | Packet,\r | |
438 | NULL,\r | |
439 | &Packet->Ip.Ip6->SourceAddress,\r | |
440 | ICMP_V6_PARAMETER_PROBLEM,\r | |
441 | 0,\r | |
442 | &Pointer\r | |
443 | );\r | |
444 | }\r | |
445 | \r | |
446 | return FALSE;\r | |
447 | }\r | |
448 | \r | |
449 | break;\r | |
450 | \r | |
451 | case IP6_FRAGMENT:\r | |
452 | \r | |
453 | //\r | |
454 | // RFC2402, AH header should after fragment header.\r | |
455 | //\r | |
456 | if (CountA > 1) {\r | |
457 | return FALSE;\r | |
458 | }\r | |
459 | \r | |
460 | //\r | |
461 | // RFC2460, ICMP Parameter Problem message with code 0 should be sent\r | |
d1c85a17 | 462 | // if the length of a fragment is not a multiple of 8 octets and the M\r |
a3bcde70 HT |
463 | // flag of that fragment is 1, pointing to the Payload length field of the\r |
464 | // fragment packet.\r | |
465 | //\r | |
466 | if (IpSb != NULL && Packet != NULL && (ExtHdrsLen % 8) != 0) {\r | |
467 | //\r | |
468 | // Check whether it is the last fragment.\r | |
469 | //\r | |
470 | FragmentHead = (IP6_FRAGMENT_HEADER *) (ExtHdrs + Offset);\r | |
471 | if (FragmentHead == NULL) {\r | |
472 | return FALSE;\r | |
473 | }\r | |
474 | \r | |
475 | FragmentOffset = NTOHS (FragmentHead->FragmentOffset);\r | |
476 | \r | |
477 | if (((FragmentOffset & 0x1) == 0x1) &&\r | |
478 | !IP6_IS_MULTICAST (&Packet->Ip.Ip6->DestinationAddress)) {\r | |
479 | Pointer = sizeof (UINT32);\r | |
480 | Ip6SendIcmpError (\r | |
481 | IpSb,\r | |
482 | Packet,\r | |
483 | NULL,\r | |
484 | &Packet->Ip.Ip6->SourceAddress,\r | |
485 | ICMP_V6_PARAMETER_PROBLEM,\r | |
486 | 0,\r | |
487 | &Pointer\r | |
488 | );\r | |
489 | return FALSE;\r | |
490 | }\r | |
491 | }\r | |
492 | \r | |
493 | if (Fragmented != NULL) {\r | |
494 | *Fragmented = TRUE;\r | |
495 | }\r | |
496 | \r | |
497 | if (Rcvd && FormerHeader != NULL) {\r | |
498 | *FormerHeader = (UINT32) (NextHeader - ExtHdrs);\r | |
499 | }\r | |
500 | \r | |
501 | NextHeader = ExtHdrs + Offset;\r | |
502 | Offset = Offset + 8;\r | |
503 | break;\r | |
504 | \r | |
505 | case IP6_AH:\r | |
506 | if (++CountA > 1) {\r | |
507 | return FALSE;\r | |
508 | }\r | |
509 | \r | |
510 | Option = ExtHdrs + Offset;\r | |
511 | NextHeader = Option;\r | |
512 | Option++;\r | |
513 | //\r | |
514 | // RFC2402, Payload length is specified in 32-bit words, minus "2".\r | |
515 | //\r | |
516 | OptionLen = (UINT8) ((*Option + 2) * 4);\r | |
517 | Offset = Offset + OptionLen;\r | |
518 | break;\r | |
519 | \r | |
520 | case IP6_NO_NEXT_HEADER:\r | |
521 | *LastHeader = NextHeader;\r | |
522 | return FALSE;\r | |
523 | break;\r | |
524 | \r | |
525 | default:\r | |
526 | if (Ip6IsValidProtocol (IpSb, *NextHeader)) {\r | |
527 | \r | |
528 | *LastHeader = NextHeader;\r | |
529 | \r | |
530 | if (RealExtsLen != NULL) {\r | |
531 | *RealExtsLen = Offset;\r | |
532 | }\r | |
533 | \r | |
534 | return TRUE;\r | |
535 | }\r | |
536 | \r | |
537 | //\r | |
538 | // The Next Header value is unrecognized by the node, discard the packet and\r | |
539 | // send an ICMP parameter problem message with code value of 1.\r | |
540 | //\r | |
541 | if (Offset == 0) {\r | |
542 | //\r | |
543 | // The Next Header directly follows IPv6 basic header.\r | |
544 | //\r | |
545 | Pointer = 6;\r | |
546 | } else {\r | |
547 | if (Pointer == 0) {\r | |
548 | Pointer = sizeof (EFI_IP6_HEADER);\r | |
549 | } else {\r | |
550 | Pointer = Offset + sizeof (EFI_IP6_HEADER);\r | |
551 | }\r | |
552 | }\r | |
553 | \r | |
554 | if ((IpSb != NULL) && (Packet != NULL) &&\r | |
555 | !IP6_IS_MULTICAST (&Packet->Ip.Ip6->DestinationAddress)) {\r | |
556 | Ip6SendIcmpError (\r | |
557 | IpSb,\r | |
558 | Packet,\r | |
559 | NULL,\r | |
560 | &Packet->Ip.Ip6->SourceAddress,\r | |
561 | ICMP_V6_PARAMETER_PROBLEM,\r | |
562 | 1,\r | |
563 | &Pointer\r | |
564 | );\r | |
565 | }\r | |
566 | return FALSE;\r | |
567 | }\r | |
568 | }\r | |
569 | \r | |
570 | *LastHeader = NextHeader;\r | |
571 | \r | |
572 | if (RealExtsLen != NULL) {\r | |
573 | *RealExtsLen = Offset;\r | |
574 | }\r | |
575 | \r | |
576 | return TRUE;\r | |
577 | }\r | |
578 | \r | |
579 | /**\r | |
580 | Generate an IPv6 router alert option in network order and output it through Buffer.\r | |
581 | \r | |
582 | @param[out] Buffer Points to a buffer to record the generated option.\r | |
583 | @param[in, out] BufferLen The length of Buffer, in bytes.\r | |
584 | @param[in] NextHeader The 8-bit selector indicates the type of header\r | |
585 | immediately following the Hop-by-Hop Options header.\r | |
586 | \r | |
587 | @retval EFI_BUFFER_TOO_SMALL The Buffer is too small to contain the generated\r | |
588 | option. BufferLen is updated for the required size.\r | |
589 | \r | |
590 | @retval EFI_SUCCESS The option is generated and filled in to Buffer.\r | |
591 | \r | |
592 | **/\r | |
593 | EFI_STATUS\r | |
594 | Ip6FillHopByHop (\r | |
595 | OUT UINT8 *Buffer,\r | |
596 | IN OUT UINTN *BufferLen,\r | |
597 | IN UINT8 NextHeader\r | |
598 | )\r | |
599 | {\r | |
600 | UINT8 BufferArray[8];\r | |
601 | \r | |
602 | if (*BufferLen < 8) {\r | |
603 | *BufferLen = 8;\r | |
604 | return EFI_BUFFER_TOO_SMALL;\r | |
605 | }\r | |
606 | \r | |
607 | //\r | |
608 | // Form the Hop-By-Hop option in network order.\r | |
609 | // NextHeader (1 octet) + HdrExtLen (1 octet) + RouterAlertOption(4 octets) + PadN\r | |
610 | // The Hdr Ext Len is the length in 8-octet units, and does not including the first 8 octets.\r | |
611 | //\r | |
612 | ZeroMem (BufferArray, sizeof (BufferArray));\r | |
613 | BufferArray[0] = NextHeader;\r | |
614 | BufferArray[2] = 0x5;\r | |
615 | BufferArray[3] = 0x2;\r | |
616 | BufferArray[6] = 1;\r | |
617 | \r | |
618 | CopyMem (Buffer, BufferArray, sizeof (BufferArray));\r | |
619 | return EFI_SUCCESS;\r | |
620 | }\r | |
621 | \r | |
622 | /**\r | |
623 | Insert a Fragment Header to the Extension headers and output it in UpdatedExtHdrs.\r | |
624 | \r | |
625 | @param[in] IpSb The IP6 service instance to transmit the packet.\r | |
626 | @param[in] NextHeader The extension header type of first extension header.\r | |
627 | @param[in] LastHeader The extension header type of last extension header.\r | |
628 | @param[in] ExtHdrs The length of the original extension header.\r | |
629 | @param[in] ExtHdrsLen The length of the extension headers.\r | |
630 | @param[in] FragmentOffset The fragment offset of the data following the header.\r | |
631 | @param[out] UpdatedExtHdrs The updated ExtHdrs with Fragment header inserted.\r | |
d1c85a17 | 632 | It's caller's responsibility to free this buffer.\r |
a3bcde70 HT |
633 | \r |
634 | @retval EFI_OUT_OF_RESOURCES Failed to finish the operation due to lake of\r | |
635 | resource.\r | |
636 | @retval EFI_UNSUPPORTED The extension header specified in ExtHdrs is not\r | |
637 | supported currently.\r | |
638 | @retval EFI_SUCCESS The operation performed successfully.\r | |
639 | \r | |
640 | **/\r | |
641 | EFI_STATUS\r | |
642 | Ip6FillFragmentHeader (\r | |
643 | IN IP6_SERVICE *IpSb,\r | |
644 | IN UINT8 NextHeader,\r | |
645 | IN UINT8 LastHeader,\r | |
646 | IN UINT8 *ExtHdrs,\r | |
647 | IN UINT32 ExtHdrsLen,\r | |
648 | IN UINT16 FragmentOffset,\r | |
649 | OUT UINT8 **UpdatedExtHdrs\r | |
650 | )\r | |
651 | {\r | |
652 | UINT32 Length;\r | |
653 | UINT8 *Buffer;\r | |
654 | UINT32 FormerHeader;\r | |
655 | UINT32 Offset;\r | |
656 | UINT32 Part1Len;\r | |
657 | UINT32 HeaderLen;\r | |
658 | UINT8 Current;\r | |
659 | IP6_FRAGMENT_HEADER FragmentHead;\r | |
660 | \r | |
661 | if (UpdatedExtHdrs == NULL) {\r | |
662 | return EFI_INVALID_PARAMETER;\r | |
663 | }\r | |
664 | \r | |
665 | Length = ExtHdrsLen + sizeof (IP6_FRAGMENT_HEADER);\r | |
666 | Buffer = AllocatePool (Length);\r | |
667 | if (Buffer == NULL) {\r | |
668 | return EFI_OUT_OF_RESOURCES;\r | |
669 | }\r | |
670 | \r | |
671 | Offset = 0;\r | |
672 | Part1Len = 0;\r | |
673 | FormerHeader = 0;\r | |
674 | Current = NextHeader;\r | |
675 | \r | |
676 | while ((ExtHdrs != NULL) && (Offset <= ExtHdrsLen)) {\r | |
677 | switch (NextHeader) {\r | |
678 | case IP6_ROUTING:\r | |
679 | case IP6_HOP_BY_HOP:\r | |
680 | case IP6_DESTINATION:\r | |
681 | Current = NextHeader;\r | |
682 | NextHeader = *(ExtHdrs + Offset);\r | |
683 | \r | |
684 | if ((Current == IP6_DESTINATION) && (NextHeader != IP6_ROUTING)) {\r | |
685 | //\r | |
686 | // Destination Options header should occur at most twice, once before\r | |
687 | // a Routing header and once before the upper-layer header. Here we\r | |
688 | // find the one before the upper-layer header. Insert the Fragment\r | |
689 | // Header before it.\r | |
690 | //\r | |
691 | CopyMem (Buffer, ExtHdrs, Part1Len);\r | |
692 | *(Buffer + FormerHeader) = IP6_FRAGMENT;\r | |
693 | //\r | |
694 | // Exit the loop.\r | |
695 | //\r | |
696 | Offset = ExtHdrsLen + 1;\r | |
697 | break;\r | |
698 | }\r | |
699 | \r | |
700 | \r | |
701 | FormerHeader = Offset;\r | |
702 | HeaderLen = (*(ExtHdrs + Offset + 1) + 1) * 8;\r | |
703 | Part1Len = Part1Len + HeaderLen;\r | |
704 | Offset = Offset + HeaderLen;\r | |
705 | break;\r | |
706 | \r | |
707 | case IP6_FRAGMENT:\r | |
708 | Current = NextHeader;\r | |
709 | \r | |
710 | if (Part1Len != 0) {\r | |
711 | CopyMem (Buffer, ExtHdrs, Part1Len);\r | |
712 | }\r | |
713 | \r | |
714 | *(Buffer + FormerHeader) = IP6_FRAGMENT;\r | |
715 | \r | |
716 | //\r | |
717 | // Exit the loop.\r | |
718 | //\r | |
719 | Offset = ExtHdrsLen + 1;\r | |
720 | break;\r | |
721 | \r | |
722 | case IP6_AH:\r | |
723 | Current = NextHeader;\r | |
724 | NextHeader = *(ExtHdrs + Offset);\r | |
725 | //\r | |
726 | // RFC2402, Payload length is specified in 32-bit words, minus "2".\r | |
727 | //\r | |
728 | HeaderLen = (*(ExtHdrs + Offset + 1) + 2) * 4;\r | |
729 | Part1Len = Part1Len + HeaderLen;\r | |
730 | Offset = Offset + HeaderLen;\r | |
731 | break;\r | |
732 | \r | |
733 | default:\r | |
734 | if (Ip6IsValidProtocol (IpSb, NextHeader)) {\r | |
735 | Current = NextHeader;\r | |
736 | CopyMem (Buffer, ExtHdrs, Part1Len);\r | |
737 | *(Buffer + FormerHeader) = IP6_FRAGMENT;\r | |
738 | //\r | |
739 | // Exit the loop.\r | |
740 | //\r | |
741 | Offset = ExtHdrsLen + 1;\r | |
742 | break;\r | |
743 | }\r | |
744 | \r | |
745 | FreePool (Buffer);\r | |
746 | return EFI_UNSUPPORTED;\r | |
747 | }\r | |
748 | }\r | |
749 | \r | |
750 | //\r | |
751 | // Append the Fragment header. If the fragment offset indicates the fragment\r | |
752 | // is the first fragment.\r | |
753 | //\r | |
754 | if ((FragmentOffset & IP6_FRAGMENT_OFFSET_MASK) == 0) {\r | |
755 | FragmentHead.NextHeader = Current;\r | |
756 | } else {\r | |
757 | FragmentHead.NextHeader = LastHeader;\r | |
758 | }\r | |
759 | \r | |
760 | FragmentHead.Reserved = 0;\r | |
761 | FragmentHead.FragmentOffset = HTONS (FragmentOffset);\r | |
762 | FragmentHead.Identification = mIp6Id;\r | |
763 | \r | |
764 | CopyMem (Buffer + Part1Len, &FragmentHead, sizeof (IP6_FRAGMENT_HEADER));\r | |
765 | \r | |
766 | if ((ExtHdrs != NULL) && (Part1Len < ExtHdrsLen)) {\r | |
767 | //\r | |
768 | // Append the part2 (fragmentable part) of Extension headers\r | |
769 | //\r | |
770 | CopyMem (\r | |
771 | Buffer + Part1Len + sizeof (IP6_FRAGMENT_HEADER),\r | |
772 | ExtHdrs + Part1Len,\r | |
773 | ExtHdrsLen - Part1Len\r | |
774 | );\r | |
775 | }\r | |
776 | \r | |
777 | *UpdatedExtHdrs = Buffer;\r | |
778 | \r | |
779 | return EFI_SUCCESS;\r | |
780 | }\r | |
781 | \r |