projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| a3bcde70 | 1 | /** @file\r |
| 9166f840 | 2 | The implementation of IPsec.\r |
| a3bcde70 | 3 | \r |
| 47b27101 | 4 | Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r |
| a3bcde70 HT |
5 | \r |
| 6 | This program and the accompanying materials\r | |
| 7 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 8 | which accompanies this distribution. The full text of the license may be found at\r | |
| 9 | http://opensource.org/licenses/bsd-license.php.\r | |
| 10 | \r | |
| 11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 13 | \r | |
| 14 | **/\r | |
| 15 | \r | |
| 9166f840 | 16 | #include "IpSecImpl.h"\r |
| 17 | #include "IkeService.h"\r | |
| 18 | #include "IpSecDebug.h"\r | |
| 19 | #include "IpSecCryptIo.h"\r | |
| a3bcde70 HT |
20 | #include "IpSecConfigImpl.h"\r |
| 21 | \r | |
| a3bcde70 HT |
22 | /**\r |
| 23 | Check if the specified Address is the Valid Address Range.\r | |
| 24 | \r | |
| 25 | This function checks if the bytes after prefixed length are all Zero in this\r | |
| 9166f840 | 26 | Address. This Address is supposed to point to a range address. That means it \r |
| 27 | should gives the correct prefixed address and the bytes outside the prefixed are\r | |
| 28 | zero.\r | |
| a3bcde70 HT |
29 | \r |
| 30 | @param[in] IpVersion The IP version.\r | |
| 31 | @param[in] Address Points to EFI_IP_ADDRESS to be checked.\r | |
| 32 | @param[in] PrefixLength The PrefixeLength of this address.\r | |
| 33 | \r | |
| 34 | @retval TRUE The address is a vaild address range.\r | |
| 35 | @retval FALSE The address is not a vaild address range.\r | |
| 36 | \r | |
| 37 | **/\r | |
| 38 | BOOLEAN\r | |
| 39 | IpSecValidAddressRange (\r | |
| 40 | IN UINT8 IpVersion,\r | |
| 41 | IN EFI_IP_ADDRESS *Address,\r | |
| 42 | IN UINT8 PrefixLength\r | |
| 43 | )\r | |
| 44 | {\r | |
| 45 | UINT8 Div;\r | |
| 46 | UINT8 Mod;\r | |
| 47 | UINT8 Mask;\r | |
| 48 | UINT8 AddrLen;\r | |
| 49 | UINT8 *Addr;\r | |
| 50 | EFI_IP_ADDRESS ZeroAddr;\r | |
| 51 | \r | |
| 52 | if (PrefixLength == 0) {\r | |
| 53 | return TRUE;\r | |
| 54 | }\r | |
| 55 | \r | |
| 56 | AddrLen = (UINT8) ((IpVersion == IP_VERSION_4) ? 32 : 128);\r | |
| 57 | \r | |
| 58 | if (AddrLen <= PrefixLength) {\r | |
| 59 | return FALSE;\r | |
| 60 | }\r | |
| 61 | \r | |
| 62 | Div = (UINT8) (PrefixLength / 8);\r | |
| 63 | Mod = (UINT8) (PrefixLength % 8);\r | |
| 64 | Addr = (UINT8 *) Address;\r | |
| 65 | ZeroMem (&ZeroAddr, sizeof (EFI_IP_ADDRESS));\r | |
| 66 | \r | |
| 67 | //\r | |
| 68 | // Check whether the mod part of host scope is zero or not.\r | |
| 69 | //\r | |
| 70 | if (Mod > 0) {\r | |
| 71 | Mask = (UINT8) (0xFF << (8 - Mod));\r | |
| 72 | \r | |
| 73 | if ((Addr[Div] | Mask) != Mask) {\r | |
| 74 | return FALSE;\r | |
| 75 | }\r | |
| 76 | \r | |
| 77 | Div++;\r | |
| 78 | }\r | |
| 79 | //\r | |
| 80 | // Check whether the div part of host scope is zero or not.\r | |
| 81 | //\r | |
| 82 | if (CompareMem (\r | |
| 83 | &Addr[Div],\r | |
| 84 | &ZeroAddr,\r | |
| 85 | sizeof (EFI_IP_ADDRESS) - Div\r | |
| 86 | ) != 0) {\r | |
| 87 | return FALSE;\r | |
| 88 | }\r | |
| 89 | \r | |
| 90 | return TRUE;\r | |
| 91 | }\r | |
| 92 | \r | |
| 93 | /**\r | |
| 94 | Extrct the Address Range from a Address.\r | |
| 95 | \r | |
| 96 | This function keep the prefix address and zero other part address.\r | |
| 97 | \r | |
| 98 | @param[in] Address Point to a specified address.\r | |
| 99 | @param[in] PrefixLength The prefix length.\r | |
| 100 | @param[out] Range Contain the return Address Range.\r | |
| 101 | \r | |
| 102 | **/\r | |
| 103 | VOID\r | |
| 104 | IpSecExtractAddressRange (\r | |
| 105 | IN EFI_IP_ADDRESS *Address,\r | |
| 106 | IN UINT8 PrefixLength,\r | |
| 107 | OUT EFI_IP_ADDRESS *Range\r | |
| 108 | )\r | |
| 109 | {\r | |
| 110 | UINT8 Div;\r | |
| 111 | UINT8 Mod;\r | |
| 112 | UINT8 Mask;\r | |
| 113 | UINT8 *Addr;\r | |
| 114 | \r | |
| 115 | if (PrefixLength == 0) {\r | |
| 116 | return ;\r | |
| 117 | }\r | |
| 118 | \r | |
| 119 | Div = (UINT8) (PrefixLength / 8);\r | |
| 120 | Mod = (UINT8) (PrefixLength % 8);\r | |
| 121 | Addr = (UINT8 *) Range;\r | |
| 122 | \r | |
| 123 | CopyMem (Range, Address, sizeof (EFI_IP_ADDRESS));\r | |
| 124 | \r | |
| 125 | //\r | |
| 126 | // Zero the mod part of host scope.\r | |
| 127 | //\r | |
| 128 | if (Mod > 0) {\r | |
| 129 | Mask = (UINT8) (0xFF << (8 - Mod));\r | |
| 130 | Addr[Div] = (UINT8) (Addr[Div] & Mask);\r | |
| 131 | Div++;\r | |
| 132 | }\r | |
| 133 | //\r | |
| 134 | // Zero the div part of host scope.\r | |
| 135 | //\r | |
| 136 | ZeroMem (&Addr[Div], sizeof (EFI_IP_ADDRESS) - Div);\r | |
| 137 | \r | |
| 138 | }\r | |
| 139 | \r | |
| 140 | /**\r | |
| 141 | Checks if the IP Address in the address range of AddressInfos specified.\r | |
| 142 | \r | |
| 143 | @param[in] IpVersion The IP version.\r | |
| 144 | @param[in] IpAddr Point to EFI_IP_ADDRESS to be check.\r | |
| 145 | @param[in] AddressInfo A list of EFI_IP_ADDRESS_INFO that is used to check\r | |
| 146 | the IP Address is matched.\r | |
| 147 | @param[in] AddressCount The total numbers of the AddressInfo.\r | |
| 148 | \r | |
| 149 | @retval TRUE If the Specified IP Address is in the range of the AddressInfos specified.\r | |
| 150 | @retval FALSE If the Specified IP Address is not in the range of the AddressInfos specified.\r | |
| 151 | \r | |
| 152 | **/\r | |
| 153 | BOOLEAN\r | |
| 154 | IpSecMatchIpAddress (\r | |
| 155 | IN UINT8 IpVersion,\r | |
| 156 | IN EFI_IP_ADDRESS *IpAddr,\r | |
| 157 | IN EFI_IP_ADDRESS_INFO *AddressInfo,\r | |
| 158 | IN UINT32 AddressCount\r | |
| 159 | )\r | |
| 160 | {\r | |
| 161 | EFI_IP_ADDRESS Range;\r | |
| 162 | UINT32 Index;\r | |
| 163 | BOOLEAN IsMatch;\r | |
| 164 | \r | |
| 165 | IsMatch = FALSE;\r | |
| 166 | \r | |
| 167 | for (Index = 0; Index < AddressCount; Index++) {\r | |
| 168 | //\r | |
| 169 | // Check whether the target address is in the address range\r | |
| 170 | // if it's a valid range of address.\r | |
| 171 | //\r | |
| 172 | if (IpSecValidAddressRange (\r | |
| 173 | IpVersion,\r | |
| 174 | &AddressInfo[Index].Address,\r | |
| 175 | AddressInfo[Index].PrefixLength\r | |
| 176 | )) {\r | |
| 177 | //\r | |
| 178 | // Get the range of the target address belongs to.\r | |
| 179 | //\r | |
| 180 | ZeroMem (&Range, sizeof (EFI_IP_ADDRESS));\r | |
| 181 | IpSecExtractAddressRange (\r | |
| 182 | IpAddr,\r | |
| 183 | AddressInfo[Index].PrefixLength,\r | |
| 184 | &Range\r | |
| 185 | );\r | |
| 186 | \r | |
| 187 | if (CompareMem (\r | |
| 188 | &Range,\r | |
| 189 | &AddressInfo[Index].Address,\r | |
| 190 | sizeof (EFI_IP_ADDRESS)\r | |
| 191 | ) == 0) {\r | |
| 192 | //\r | |
| 193 | // The target address is in the address range.\r | |
| 194 | //\r | |
| 195 | IsMatch = TRUE;\r | |
| 196 | break;\r | |
| 197 | }\r | |
| 198 | }\r | |
| 199 | \r | |
| 200 | if (CompareMem (\r | |
| 201 | IpAddr,\r | |
| 202 | &AddressInfo[Index].Address,\r | |
| 203 | sizeof (EFI_IP_ADDRESS)\r | |
| 204 | ) == 0) {\r | |
| 205 | //\r | |
| 206 | // The target address is exact same as the address.\r | |
| 207 | //\r | |
| 208 | IsMatch = TRUE;\r | |
| 209 | break;\r | |
| 210 | }\r | |
| 211 | }\r | |
| a3bcde70 HT |
212 | return IsMatch;\r |
| 213 | }\r | |
| 214 | \r | |
| 215 | /**\r | |
| 216 | Check if the specified Protocol and Prot is supported by the specified SPD Entry.\r | |
| 217 | \r | |
| 218 | This function is the subfunction of IPsecLookUpSpdEntry() that is used to\r | |
| 219 | check if the sent/received IKE packet has the related SPD entry support.\r | |
| 220 | \r | |
| 221 | @param[in] Protocol The Protocol to be checked.\r | |
| 222 | @param[in] IpPayload Point to IP Payload to be check.\r | |
| 223 | @param[in] SpdProtocol The Protocol supported by SPD.\r | |
| 224 | @param[in] SpdLocalPort The Local Port in SPD.\r | |
| 225 | @param[in] SpdRemotePort The Remote Port in SPD.\r | |
| 226 | @param[in] IsOutbound Flag to indicate the is for IKE Packet sending or recieving.\r | |
| 227 | \r | |
| 228 | @retval TRUE The Protocol and Port are supported by the SPD Entry.\r | |
| 229 | @retval FALSE The Protocol and Port are not supported by the SPD Entry.\r | |
| 230 | \r | |
| 231 | **/\r | |
| 232 | BOOLEAN\r | |
| 233 | IpSecMatchNextLayerProtocol (\r | |
| 234 | IN UINT8 Protocol,\r | |
| 235 | IN UINT8 *IpPayload,\r | |
| 236 | IN UINT16 SpdProtocol,\r | |
| 237 | IN UINT16 SpdLocalPort,\r | |
| 238 | IN UINT16 SpdRemotePort,\r | |
| 239 | IN BOOLEAN IsOutbound\r | |
| 240 | )\r | |
| 241 | {\r | |
| 242 | BOOLEAN IsMatch;\r | |
| 243 | \r | |
| 244 | if (SpdProtocol == EFI_IPSEC_ANY_PROTOCOL) {\r | |
| 245 | return TRUE;\r | |
| 246 | }\r | |
| 247 | \r | |
| 248 | IsMatch = FALSE;\r | |
| 249 | \r | |
| 250 | if (SpdProtocol == Protocol) {\r | |
| 251 | switch (Protocol) {\r | |
| 252 | case EFI_IP_PROTO_UDP:\r | |
| 253 | case EFI_IP_PROTO_TCP:\r | |
| 254 | //\r | |
| 255 | // For udp and tcp, (0, 0) means no need to check local and remote\r | |
| 256 | // port. The payload is passed from upper level, which means it should\r | |
| 257 | // be in network order.\r | |
| 258 | //\r | |
| 259 | IsMatch = (BOOLEAN) (SpdLocalPort == 0 && SpdRemotePort == 0);\r | |
| 260 | IsMatch = (BOOLEAN) (IsMatch ||\r | |
| 261 | (IsOutbound &&\r | |
| 262 | (BOOLEAN)(\r | |
| 263 | NTOHS (((EFI_UDP_HEADER *) IpPayload)->SrcPort) == SpdLocalPort &&\r | |
| 264 | NTOHS (((EFI_UDP_HEADER *) IpPayload)->DstPort) == SpdRemotePort\r | |
| 265 | )\r | |
| 266 | ));\r | |
| 267 | \r | |
| 268 | IsMatch = (BOOLEAN) (IsMatch ||\r | |
| 269 | (!IsOutbound &&\r | |
| 270 | (BOOLEAN)(\r | |
| 271 | NTOHS (((EFI_UDP_HEADER *) IpPayload)->DstPort) == SpdLocalPort &&\r | |
| 272 | NTOHS (((EFI_UDP_HEADER *) IpPayload)->SrcPort) == SpdRemotePort\r | |
| 273 | )\r | |
| 274 | ));\r | |
| 275 | break;\r | |
| 276 | \r | |
| 277 | case EFI_IP_PROTO_ICMP:\r | |
| 278 | //\r | |
| 279 | // For icmpv4, type code is replaced with local port and remote port,\r | |
| 280 | // and (0, 0) means no need to check.\r | |
| 281 | //\r | |
| 282 | IsMatch = (BOOLEAN) (SpdLocalPort == 0 && SpdRemotePort == 0);\r | |
| 283 | IsMatch = (BOOLEAN) (IsMatch ||\r | |
| 284 | (BOOLEAN) (((IP4_ICMP_HEAD *) IpPayload)->Type == SpdLocalPort &&\r | |
| 285 | ((IP4_ICMP_HEAD *) IpPayload)->Code == SpdRemotePort\r | |
| 286 | )\r | |
| 287 | );\r | |
| 288 | break;\r | |
| 289 | \r | |
| 290 | case IP6_ICMP:\r | |
| 291 | //\r | |
| 292 | // For icmpv6, type code is replaced with local port and remote port,\r | |
| 293 | // and (0, 0) means no need to check.\r | |
| 294 | //\r | |
| 295 | IsMatch = (BOOLEAN) (SpdLocalPort == 0 && SpdRemotePort == 0);\r | |
| 296 | \r | |
| 297 | IsMatch = (BOOLEAN) (IsMatch ||\r | |
| 298 | (BOOLEAN) (((IP6_ICMP_HEAD *) IpPayload)->Type == SpdLocalPort &&\r | |
| 299 | ((IP6_ICMP_HEAD *) IpPayload)->Code == SpdRemotePort\r | |
| 300 | )\r | |
| 301 | );\r | |
| 302 | break;\r | |
| 303 | \r | |
| 304 | default:\r | |
| 305 | IsMatch = TRUE;\r | |
| 306 | break;\r | |
| 307 | }\r | |
| 308 | }\r | |
| 309 | \r | |
| 310 | return IsMatch;\r | |
| 311 | }\r | |
| 312 | \r | |
| 313 | /**\r | |
| 314 | Find the SAD through a specified SPD's SAD list.\r | |
| 315 | \r | |
| 316 | @param[in] SadList SAD list related to a specified SPD entry.\r | |
| 317 | @param[in] DestAddress The destination address used to find the SAD entry.\r | |
| 9166f840 | 318 | @param[in] IpVersion The IP version. Ip4 or Ip6.\r |
| a3bcde70 HT |
319 | \r |
| 320 | @return The pointer to a certain SAD entry.\r | |
| 321 | \r | |
| 322 | **/\r | |
| 323 | IPSEC_SAD_ENTRY *\r | |
| 324 | IpSecLookupSadBySpd (\r | |
| 325 | IN LIST_ENTRY *SadList,\r | |
| 9166f840 | 326 | IN EFI_IP_ADDRESS *DestAddress,\r |
| 327 | IN UINT8 IpVersion\r | |
| a3bcde70 HT |
328 | )\r |
| 329 | {\r | |
| 330 | LIST_ENTRY *Entry;\r | |
| 331 | IPSEC_SAD_ENTRY *SadEntry;\r | |
| 9166f840 | 332 | \r |
| 333 | NET_LIST_FOR_EACH (Entry, SadList) {\r | |
| a3bcde70 HT |
334 | \r |
| 335 | SadEntry = IPSEC_SAD_ENTRY_FROM_SPD (Entry);\r | |
| 336 | //\r | |
| 9166f840 | 337 | // Find the right SAD entry which contains the appointed dest address.\r |
| a3bcde70 | 338 | //\r |
| 9166f840 | 339 | if (IpSecMatchIpAddress (\r |
| 340 | IpVersion,\r | |
| a3bcde70 | 341 | DestAddress,\r |
| 9166f840 | 342 | SadEntry->Data->SpdSelector->RemoteAddress,\r |
| 343 | SadEntry->Data->SpdSelector->RemoteAddressCount\r | |
| 344 | )){ \r | |
| a3bcde70 HT |
345 | return SadEntry;\r |
| 346 | }\r | |
| 347 | }\r | |
| 348 | \r | |
| 349 | return NULL;\r | |
| 350 | }\r | |
| 351 | \r | |
| 352 | /**\r | |
| 353 | Find the SAD through whole SAD list.\r | |
| 354 | \r | |
| 355 | @param[in] Spi The SPI used to search the SAD entry.\r | |
| 356 | @param[in] DestAddress The destination used to search the SAD entry.\r | |
| 9166f840 | 357 | @param[in] IpVersion The IP version. Ip4 or Ip6.\r |
| a3bcde70 HT |
358 | \r |
| 359 | @return the pointer to a certain SAD entry.\r | |
| 360 | \r | |
| 361 | **/\r | |
| 362 | IPSEC_SAD_ENTRY *\r | |
| 363 | IpSecLookupSadBySpi (\r | |
| 364 | IN UINT32 Spi,\r | |
| 9166f840 | 365 | IN EFI_IP_ADDRESS *DestAddress,\r |
| 366 | IN UINT8 IpVersion\r | |
| a3bcde70 HT |
367 | )\r |
| 368 | {\r | |
| 369 | LIST_ENTRY *Entry;\r | |
| 370 | LIST_ENTRY *SadList;\r | |
| 371 | IPSEC_SAD_ENTRY *SadEntry;\r | |
| 372 | \r | |
| 373 | SadList = &mConfigData[IPsecConfigDataTypeSad];\r | |
| 374 | \r | |
| 9166f840 | 375 | NET_LIST_FOR_EACH (Entry, SadList) {\r |
| a3bcde70 HT |
376 | \r |
| 377 | SadEntry = IPSEC_SAD_ENTRY_FROM_LIST (Entry);\r | |
| 9166f840 | 378 | \r |
| a3bcde70 | 379 | //\r |
| 9166f840 | 380 | // Find the right SAD entry which contain the appointed spi and dest addr.\r |
| a3bcde70 | 381 | //\r |
| 9166f840 | 382 | if (SadEntry->Id->Spi == Spi) {\r |
| 383 | if (SadEntry->Data->Mode == EfiIPsecTunnel) {\r | |
| 384 | if (CompareMem (\r | |
| 385 | &DestAddress, \r | |
| 386 | &SadEntry->Data->TunnelDestAddress,\r | |
| 387 | sizeof (EFI_IP_ADDRESS)\r | |
| 388 | )) {\r | |
| 389 | return SadEntry;\r | |
| 390 | }\r | |
| 391 | } else {\r | |
| 392 | if (SadEntry->Data->SpdSelector != NULL &&\r | |
| 393 | IpSecMatchIpAddress (\r | |
| 394 | IpVersion, \r | |
| 395 | DestAddress, \r | |
| 396 | SadEntry->Data->SpdSelector->RemoteAddress,\r | |
| 397 | SadEntry->Data->SpdSelector->RemoteAddressCount\r | |
| 398 | )\r | |
| 399 | ) {\r | |
| 400 | return SadEntry;\r | |
| 401 | } \r | |
| 402 | }\r | |
| a3bcde70 HT |
403 | }\r |
| 404 | }\r | |
| a3bcde70 HT |
405 | return NULL;\r |
| 406 | }\r | |
| 407 | \r | |
| 408 | /**\r | |
| 409 | Look up if there is existing SAD entry for specified IP packet sending.\r | |
| 410 | \r | |
| 411 | This function is called by the IPsecProcess when there is some IP packet needed to\r | |
| 412 | send out. This function checks if there is an existing SAD entry that can be serviced\r | |
| 413 | to this IP packet sending. If no existing SAD entry could be used, this\r | |
| 414 | function will invoke an IPsec Key Exchange Negotiation.\r | |
| 415 | \r | |
| 416 | @param[in] Private Points to private data.\r | |
| 417 | @param[in] NicHandle Points to a NIC handle.\r | |
| 418 | @param[in] IpVersion The version of IP.\r | |
| 419 | @param[in] IpHead The IP Header of packet to be sent out.\r | |
| 420 | @param[in] IpPayload The IP Payload to be sent out.\r | |
| 421 | @param[in] OldLastHead The Last protocol of the IP packet.\r | |
| 422 | @param[in] SpdEntry Points to a related SPD entry.\r | |
| 423 | @param[out] SadEntry Contains the Point of a related SAD entry.\r | |
| 424 | \r | |
| 425 | @retval EFI_DEVICE_ERROR One of following conditions is TRUE:\r | |
| 426 | - If don't find related UDP service.\r | |
| 427 | - Sequence Number is used up.\r | |
| 428 | - Extension Sequence Number is used up.\r | |
| a3bcde70 HT |
429 | @retval EFI_NOT_READY No existing SAD entry could be used.\r |
| 430 | @retval EFI_SUCCESS Find the related SAD entry.\r | |
| 431 | \r | |
| 432 | **/\r | |
| 433 | EFI_STATUS\r | |
| 434 | IpSecLookupSadEntry (\r | |
| 435 | IN IPSEC_PRIVATE_DATA *Private,\r | |
| 436 | IN EFI_HANDLE NicHandle,\r | |
| 437 | IN UINT8 IpVersion,\r | |
| 438 | IN VOID *IpHead,\r | |
| 439 | IN UINT8 *IpPayload,\r | |
| 440 | IN UINT8 OldLastHead,\r | |
| 441 | IN IPSEC_SPD_ENTRY *SpdEntry,\r | |
| 442 | OUT IPSEC_SAD_ENTRY **SadEntry\r | |
| 443 | )\r | |
| 444 | {\r | |
| 9166f840 | 445 | IKE_UDP_SERVICE *UdpService;\r |
| a3bcde70 HT |
446 | IPSEC_SAD_ENTRY *Entry;\r |
| 447 | IPSEC_SAD_DATA *Data;\r | |
| 448 | EFI_IP_ADDRESS DestIp;\r | |
| 449 | UINT32 SeqNum32;\r | |
| 450 | \r | |
| 451 | *SadEntry = NULL;\r | |
| 9166f840 | 452 | UdpService = IkeLookupUdp (Private, NicHandle, IpVersion);\r |
| 453 | \r | |
| 454 | if (UdpService == NULL) {\r | |
| 455 | return EFI_DEVICE_ERROR;\r | |
| 456 | }\r | |
| a3bcde70 HT |
457 | //\r |
| 458 | // Parse the destination address from ip header.\r | |
| 459 | //\r | |
| 460 | ZeroMem (&DestIp, sizeof (EFI_IP_ADDRESS));\r | |
| 461 | if (IpVersion == IP_VERSION_4) {\r | |
| 462 | CopyMem (\r | |
| 463 | &DestIp,\r | |
| 464 | &((IP4_HEAD *) IpHead)->Dst,\r | |
| 465 | sizeof (IP4_ADDR)\r | |
| 466 | );\r | |
| 467 | } else {\r | |
| 468 | CopyMem (\r | |
| 469 | &DestIp,\r | |
| 470 | &((EFI_IP6_HEADER *) IpHead)->DestinationAddress,\r | |
| 471 | sizeof (EFI_IP_ADDRESS)\r | |
| 472 | );\r | |
| 473 | }\r | |
| 9166f840 | 474 | \r |
| a3bcde70 | 475 | //\r |
| 9166f840 | 476 | // Find the SAD entry in the spd.sas list according to the dest address.\r |
| a3bcde70 | 477 | //\r |
| 9166f840 | 478 | Entry = IpSecLookupSadBySpd (&SpdEntry->Data->Sas, &DestIp, IpVersion);\r |
| a3bcde70 HT |
479 | \r |
| 480 | if (Entry == NULL) {\r | |
| 481 | \r | |
| 482 | if (OldLastHead != IP6_ICMP ||\r | |
| 483 | (OldLastHead == IP6_ICMP && *IpPayload == ICMP_V6_ECHO_REQUEST)\r | |
| 484 | ) {\r | |
| 485 | //\r | |
| 9166f840 | 486 | // Start ike negotiation process except the request packet of ping.\r |
| a3bcde70 | 487 | //\r |
| 9166f840 | 488 | if (SpdEntry->Data->ProcessingPolicy->Mode == EfiIPsecTunnel) {\r |
| 489 | IkeNegotiate (\r | |
| 490 | UdpService,\r | |
| 491 | SpdEntry,\r | |
| 492 | &SpdEntry->Data->ProcessingPolicy->TunnelOption->RemoteTunnelAddress\r | |
| 493 | );\r | |
| 494 | } else {\r | |
| 495 | IkeNegotiate (\r | |
| 496 | UdpService,\r | |
| 497 | SpdEntry,\r | |
| 498 | &DestIp\r | |
| 499 | );\r | |
| 500 | }\r | |
| 501 | \r | |
| a3bcde70 HT |
502 | }\r |
| 503 | \r | |
| 504 | return EFI_NOT_READY;\r | |
| 505 | }\r | |
| 506 | \r | |
| 507 | Data = Entry->Data;\r | |
| 508 | \r | |
| 509 | if (!Data->ManualSet) {\r | |
| 510 | if (Data->ESNEnabled) {\r | |
| 511 | //\r | |
| 512 | // Validate the 64bit sn number if 64bit sn enabled.\r | |
| 513 | //\r | |
| 9166f840 | 514 | if ((UINT64) (Data->SequenceNumber + 1) == 0) {\r |
| a3bcde70 HT |
515 | //\r |
| 516 | // TODO: Re-negotiate SA\r | |
| 517 | //\r | |
| 518 | return EFI_DEVICE_ERROR;\r | |
| 519 | }\r | |
| 520 | } else {\r | |
| 521 | //\r | |
| 522 | // Validate the 32bit sn number if 64bit sn disabled.\r | |
| 523 | //\r | |
| 524 | SeqNum32 = (UINT32) Data->SequenceNumber;\r | |
| 9166f840 | 525 | if ((UINT32) (SeqNum32 + 1) == 0) {\r |
| a3bcde70 HT |
526 | //\r |
| 527 | // TODO: Re-negotiate SA\r | |
| 528 | //\r | |
| 529 | return EFI_DEVICE_ERROR;\r | |
| 530 | }\r | |
| 531 | }\r | |
| 532 | }\r | |
| 533 | \r | |
| 534 | *SadEntry = Entry;\r | |
| 535 | \r | |
| 536 | return EFI_SUCCESS;\r | |
| 537 | }\r | |
| 538 | \r | |
| 539 | /**\r | |
| 540 | Find a PAD entry according to a remote IP address.\r | |
| 541 | \r | |
| 542 | @param[in] IpVersion The version of IP.\r | |
| 543 | @param[in] IpAddr Points to remote IP address.\r | |
| 544 | \r | |
| 545 | @return the pointer of related PAD entry.\r | |
| 546 | \r | |
| 547 | **/\r | |
| 548 | IPSEC_PAD_ENTRY *\r | |
| 549 | IpSecLookupPadEntry (\r | |
| 550 | IN UINT8 IpVersion,\r | |
| 551 | IN EFI_IP_ADDRESS *IpAddr\r | |
| 552 | )\r | |
| 553 | {\r | |
| 554 | LIST_ENTRY *PadList;\r | |
| 555 | LIST_ENTRY *Entry;\r | |
| 556 | EFI_IP_ADDRESS_INFO *IpAddrInfo;\r | |
| 557 | IPSEC_PAD_ENTRY *PadEntry;\r | |
| 558 | \r | |
| 559 | PadList = &mConfigData[IPsecConfigDataTypePad];\r | |
| 560 | \r | |
| 561 | for (Entry = PadList->ForwardLink; Entry != PadList; Entry = Entry->ForwardLink) {\r | |
| 562 | \r | |
| 563 | PadEntry = IPSEC_PAD_ENTRY_FROM_LIST (Entry);\r | |
| 564 | IpAddrInfo = &PadEntry->Id->Id.IpAddress;\r | |
| 565 | //\r | |
| 566 | // Find the right pad entry which contain the appointed dest addr.\r | |
| 567 | //\r | |
| 568 | if (IpSecMatchIpAddress (IpVersion, IpAddr, IpAddrInfo, 1)) {\r | |
| 569 | return PadEntry;\r | |
| 570 | }\r | |
| 571 | }\r | |
| 572 | \r | |
| 573 | return NULL;\r | |
| 574 | }\r | |
| 575 | \r | |
| 576 | /**\r | |
| 577 | Check if the specified IP packet can be serviced by this SPD entry.\r | |
| 578 | \r | |
| 579 | @param[in] SpdEntry Point to SPD entry.\r | |
| 580 | @param[in] IpVersion Version of IP.\r | |
| 581 | @param[in] IpHead Point to IP header.\r | |
| 582 | @param[in] IpPayload Point to IP payload.\r | |
| 583 | @param[in] Protocol The Last protocol of IP packet.\r | |
| 584 | @param[in] IsOutbound Traffic direction.\r | |
| 9166f840 | 585 | @param[out] Action The support action of SPD entry.\r |
| a3bcde70 | 586 | \r |
| 9166f840 | 587 | @retval EFI_SUCCESS Find the related SPD.\r |
| 588 | @retval EFI_NOT_FOUND Not find the related SPD entry;\r | |
| a3bcde70 HT |
589 | \r |
| 590 | **/\r | |
| 9166f840 | 591 | EFI_STATUS\r |
| a3bcde70 | 592 | IpSecLookupSpdEntry (\r |
| 9166f840 | 593 | IN IPSEC_SPD_ENTRY *SpdEntry,\r |
| 594 | IN UINT8 IpVersion,\r | |
| 595 | IN VOID *IpHead,\r | |
| 596 | IN UINT8 *IpPayload,\r | |
| 597 | IN UINT8 Protocol,\r | |
| 598 | IN BOOLEAN IsOutbound, \r | |
| 599 | OUT EFI_IPSEC_ACTION *Action\r | |
| a3bcde70 HT |
600 | )\r |
| 601 | {\r | |
| 602 | EFI_IPSEC_SPD_SELECTOR *SpdSel;\r | |
| 603 | IP4_HEAD *Ip4;\r | |
| 604 | EFI_IP6_HEADER *Ip6;\r | |
| 605 | EFI_IP_ADDRESS SrcAddr;\r | |
| 606 | EFI_IP_ADDRESS DstAddr;\r | |
| 607 | BOOLEAN SpdMatch;\r | |
| 608 | \r | |
| 609 | ASSERT (SpdEntry != NULL);\r | |
| 610 | SpdSel = SpdEntry->Selector;\r | |
| 611 | Ip4 = (IP4_HEAD *) IpHead;\r | |
| 612 | Ip6 = (EFI_IP6_HEADER *) IpHead;\r | |
| 613 | \r | |
| 614 | ZeroMem (&SrcAddr, sizeof (EFI_IP_ADDRESS));\r | |
| 615 | ZeroMem (&DstAddr, sizeof (EFI_IP_ADDRESS));\r | |
| 616 | \r | |
| 617 | //\r | |
| 618 | // Parse the source and destination address from ip header.\r | |
| 619 | //\r | |
| 620 | if (IpVersion == IP_VERSION_4) {\r | |
| 621 | CopyMem (&SrcAddr, &Ip4->Src, sizeof (IP4_ADDR));\r | |
| 622 | CopyMem (&DstAddr, &Ip4->Dst, sizeof (IP4_ADDR));\r | |
| 623 | } else {\r | |
| 624 | CopyMem (&SrcAddr, &Ip6->SourceAddress, sizeof (EFI_IPv6_ADDRESS));\r | |
| 625 | CopyMem (&DstAddr, &Ip6->DestinationAddress, sizeof (EFI_IPv6_ADDRESS));\r | |
| 626 | }\r | |
| 627 | //\r | |
| 628 | // Check the local and remote addresses for outbound traffic\r | |
| 629 | //\r | |
| 630 | SpdMatch = (BOOLEAN)(IsOutbound &&\r | |
| 631 | IpSecMatchIpAddress (\r | |
| 632 | IpVersion,\r | |
| 633 | &SrcAddr,\r | |
| 634 | SpdSel->LocalAddress,\r | |
| 635 | SpdSel->LocalAddressCount\r | |
| 636 | ) &&\r | |
| 637 | IpSecMatchIpAddress (\r | |
| 638 | IpVersion,\r | |
| 639 | &DstAddr,\r | |
| 640 | SpdSel->RemoteAddress,\r | |
| 641 | SpdSel->RemoteAddressCount\r | |
| 642 | )\r | |
| 643 | );\r | |
| 644 | \r | |
| 645 | //\r | |
| 646 | // Check the local and remote addresses for inbound traffic\r | |
| 647 | //\r | |
| 648 | SpdMatch = (BOOLEAN) (SpdMatch ||\r | |
| 649 | (!IsOutbound &&\r | |
| 650 | IpSecMatchIpAddress (\r | |
| 651 | IpVersion,\r | |
| 652 | &DstAddr,\r | |
| 653 | SpdSel->LocalAddress,\r | |
| 654 | SpdSel->LocalAddressCount\r | |
| 655 | ) &&\r | |
| 656 | IpSecMatchIpAddress (\r | |
| 657 | IpVersion,\r | |
| 658 | &SrcAddr,\r | |
| 659 | SpdSel->RemoteAddress,\r | |
| 660 | SpdSel->RemoteAddressCount\r | |
| 661 | )\r | |
| 662 | ));\r | |
| 663 | \r | |
| 664 | //\r | |
| 665 | // Check the next layer protocol and local and remote ports.\r | |
| 666 | //\r | |
| 667 | SpdMatch = (BOOLEAN) (SpdMatch &&\r | |
| 668 | IpSecMatchNextLayerProtocol (\r | |
| 669 | Protocol,\r | |
| 670 | IpPayload,\r | |
| 671 | SpdSel->NextLayerProtocol,\r | |
| 672 | SpdSel->LocalPort,\r | |
| 673 | SpdSel->RemotePort,\r | |
| 674 | IsOutbound\r | |
| 675 | )\r | |
| 676 | );\r | |
| 677 | \r | |
| 678 | if (SpdMatch) {\r | |
| 679 | //\r | |
| 9166f840 | 680 | // Find the right SPD entry if match the 5 key elements.\r |
| a3bcde70 | 681 | //\r |
| 9166f840 | 682 | *Action = SpdEntry->Data->Action;\r |
| 683 | return EFI_SUCCESS;\r | |
| a3bcde70 HT |
684 | }\r |
| 685 | \r | |
| 9166f840 | 686 | return EFI_NOT_FOUND;\r |
| a3bcde70 HT |
687 | }\r |
| 688 | \r | |
| 689 | /**\r | |
| 9166f840 | 690 | The call back function of NetbufFromExt.\r |
| 691 | \r | |
| 692 | @param[in] Arg The argument passed from the caller.\r | |
| a3bcde70 HT |
693 | \r |
| 694 | **/\r | |
| 9166f840 | 695 | VOID\r |
| a3bcde70 | 696 | EFIAPI\r |
| 9166f840 | 697 | IpSecOnRecyclePacket (\r |
| 698 | IN VOID *Arg\r | |
| a3bcde70 HT |
699 | )\r |
| 700 | {\r | |
| 9166f840 | 701 | }\r |
| 702 | \r | |
| 703 | /**\r | |
| 704 | This is a Notification function. It is called when the related IP6_TXTOKEN_WRAP\r | |
| 705 | is released.\r | |
| 706 | \r | |
| 707 | @param[in] Event The related event.\r | |
| 708 | @param[in] Context The data passed by the caller.\r | |
| 709 | \r | |
| 710 | **/\r | |
| 711 | VOID\r | |
| 712 | EFIAPI\r | |
| 713 | IpSecRecycleCallback (\r | |
| 714 | IN EFI_EVENT Event,\r | |
| 715 | IN VOID *Context\r | |
| 716 | )\r | |
| 717 | {\r | |
| 718 | IPSEC_RECYCLE_CONTEXT *RecycleContext;\r | |
| 719 | \r | |
| 720 | RecycleContext = (IPSEC_RECYCLE_CONTEXT *) Context;\r | |
| 721 | \r | |
| 722 | if (RecycleContext->FragmentTable != NULL) {\r | |
| 723 | FreePool (RecycleContext->FragmentTable);\r | |
| 724 | }\r | |
| 725 | \r | |
| 726 | if (RecycleContext->PayloadBuffer != NULL) {\r | |
| 727 | FreePool (RecycleContext->PayloadBuffer);\r | |
| 728 | }\r | |
| 729 | \r | |
| 730 | FreePool (RecycleContext);\r | |
| 731 | gBS->CloseEvent (Event);\r | |
| 732 | \r | |
| 733 | }\r | |
| 734 | \r | |
| 735 | /**\r | |
| 736 | Calculate the extension hader of IP. The return length only doesn't contain \r | |
| 737 | the fixed IP header length.\r | |
| 738 | \r | |
| 739 | @param[in] IpHead Points to an IP head to be calculated.\r | |
| 740 | @param[in] LastHead Points to the last header of the IP header.\r | |
| 741 | \r | |
| 742 | @return The length of the extension header.\r | |
| 743 | \r | |
| 744 | **/\r | |
| 745 | UINT16\r | |
| 746 | IpSecGetPlainExtHeadSize (\r | |
| 747 | IN VOID *IpHead,\r | |
| 748 | IN UINT8 *LastHead\r | |
| 749 | )\r | |
| 750 | {\r | |
| 751 | UINT16 Size;\r | |
| 752 | \r | |
| 753 | Size = (UINT16) (LastHead - (UINT8 *) IpHead);\r | |
| 754 | \r | |
| 755 | if (Size > sizeof (EFI_IP6_HEADER)) {\r | |
| 756 | //\r | |
| 757 | // * (LastHead+1) point the last header's length but not include the first\r | |
| 758 | // 8 octers, so this formluation add 8 at the end.\r | |
| 759 | //\r | |
| 760 | Size = (UINT16) (Size - sizeof (EFI_IP6_HEADER) + *(LastHead + 1) + 8);\r | |
| 761 | } else {\r | |
| 762 | Size = 0;\r | |
| 763 | }\r | |
| 764 | \r | |
| 765 | return Size;\r | |
| 766 | }\r | |
| 767 | \r | |
| 768 | /**\r | |
| 769 | Verify if the Authentication payload is correct.\r | |
| 770 | \r | |
| 771 | @param[in] EspBuffer Points to the ESP wrapped buffer.\r | |
| 772 | @param[in] EspSize The size of the ESP wrapped buffer.\r | |
| 773 | @param[in] SadEntry The related SAD entry to store the authentication\r | |
| 774 | algorithm key.\r | |
| 775 | @param[in] IcvSize The length of ICV.\r | |
| 776 | \r | |
| 777 | @retval EFI_SUCCESS The authentication data is correct.\r | |
| 778 | @retval EFI_ACCESS_DENIED The authentication data is not correct.\r | |
| 779 | \r | |
| 780 | **/\r | |
| 781 | EFI_STATUS\r | |
| 782 | IpSecEspAuthVerifyPayload (\r | |
| 783 | IN UINT8 *EspBuffer,\r | |
| 784 | IN UINTN EspSize,\r | |
| 785 | IN IPSEC_SAD_ENTRY *SadEntry,\r | |
| 786 | IN UINTN *IcvSize\r | |
| 787 | )\r | |
| 788 | {\r | |
| 789 | EFI_STATUS Status;\r | |
| 790 | UINTN AuthSize;\r | |
| 791 | UINT8 IcvBuffer[12];\r | |
| 792 | HASH_DATA_FRAGMENT HashFragment[1];\r | |
| 793 | \r | |
| 794 | //\r | |
| 795 | // Calculate the size of authentication payload.\r | |
| 796 | //\r | |
| 797 | *IcvSize = IpSecGetIcvLength (SadEntry->Data->AlgoInfo.EspAlgoInfo.AuthAlgoId);\r | |
| 798 | AuthSize = EspSize - *IcvSize;\r | |
| 799 | \r | |
| 800 | //\r | |
| 801 | // Calculate the icv buffer and size of the payload.\r | |
| 802 | //\r | |
| 803 | HashFragment[0].Data = EspBuffer;\r | |
| 804 | HashFragment[0].DataSize = AuthSize;\r | |
| 805 | \r | |
| 806 | Status = IpSecCryptoIoHmac (\r | |
| 807 | SadEntry->Data->AlgoInfo.EspAlgoInfo.AuthAlgoId,\r | |
| 808 | SadEntry->Data->AlgoInfo.EspAlgoInfo.AuthKey,\r | |
| 809 | SadEntry->Data->AlgoInfo.EspAlgoInfo.AuthKeyLength,\r | |
| 810 | HashFragment,\r | |
| 811 | 1,\r | |
| 812 | IcvBuffer,\r | |
| 813 | *IcvSize\r | |
| 814 | );\r | |
| 815 | if (EFI_ERROR (Status)) {\r | |
| 816 | return Status;\r | |
| 817 | }\r | |
| 818 | \r | |
| 819 | //\r | |
| 820 | // Compare the calculated icv and the appended original icv.\r | |
| 821 | //\r | |
| 822 | if (CompareMem (EspBuffer + AuthSize, IcvBuffer, *IcvSize) == 0) {\r | |
| 823 | return EFI_SUCCESS;\r | |
| 824 | }\r | |
| 825 | \r | |
| 826 | DEBUG ((DEBUG_ERROR, "Error auth verify payload\n"));\r | |
| 827 | return EFI_ACCESS_DENIED;\r | |
| 828 | }\r | |
| 829 | \r | |
| 830 | /**\r | |
| 831 | Search the related SAD entry by the input .\r | |
| 832 | \r | |
| 833 | @param[in] IpHead The pointer to IP header.\r | |
| 834 | @param[in] IpVersion The version of IP (IP4 or IP6).\r | |
| 835 | @param[in] Spi The SPI used to search the related SAD entry.\r | |
| 836 | \r | |
| 837 | \r | |
| 838 | @retval NULL Not find the related SAD entry.\r | |
| 839 | @retval IPSEC_SAD_ENTRY Return the related SAD entry. \r | |
| 840 | \r | |
| 841 | **/\r | |
| 842 | IPSEC_SAD_ENTRY *\r | |
| 843 | IpSecFoundSadFromInboundPacket (\r | |
| 844 | UINT8 *IpHead,\r | |
| 845 | UINT8 IpVersion,\r | |
| 846 | UINT32 Spi\r | |
| 847 | ) \r | |
| 848 | {\r | |
| 849 | EFI_IP_ADDRESS DestIp;\r | |
| 850 | \r | |
| 851 | //\r | |
| 852 | // Parse destination address from ip header.\r | |
| 853 | //\r | |
| 854 | ZeroMem (&DestIp, sizeof (EFI_IP_ADDRESS));\r | |
| 855 | if (IpVersion == IP_VERSION_4) {\r | |
| 856 | CopyMem (\r | |
| 857 | &DestIp,\r | |
| 858 | &((IP4_HEAD *) IpHead)->Dst,\r | |
| 859 | sizeof (IP4_ADDR)\r | |
| 860 | );\r | |
| 861 | } else {\r | |
| 862 | CopyMem (\r | |
| 863 | &DestIp,\r | |
| 864 | &((EFI_IP6_HEADER *) IpHead)->DestinationAddress,\r | |
| 865 | sizeof (EFI_IPv6_ADDRESS)\r | |
| 866 | );\r | |
| 867 | }\r | |
| 868 | \r | |
| 869 | //\r | |
| 870 | // Lookup SAD entry according to the spi and dest address.\r | |
| 871 | // \r | |
| 872 | return IpSecLookupSadBySpi (Spi, &DestIp, IpVersion);\r | |
| 873 | }\r | |
| 874 | \r | |
| 875 | /**\r | |
| 876 | Validate the IP6 extension header format for both the packets we received\r | |
| 877 | and that we will transmit.\r | |
| 878 | \r | |
| 879 | @param[in] NextHeader The next header field in IPv6 basic header.\r | |
| 880 | @param[in] ExtHdrs The first bye of the option.\r | |
| 881 | @param[in] ExtHdrsLen The length of the whole option.\r | |
| 882 | @param[out] LastHeader The pointer of NextHeader of the last extension\r | |
| 883 | header processed by IP6.\r | |
| 884 | @param[out] RealExtsLen The length of extension headers processed by IP6 layer.\r | |
| 885 | This is an optional parameter that may be NULL.\r | |
| 886 | \r | |
| 887 | @retval TRUE The option is properly formated.\r | |
| 888 | @retval FALSE The option is malformated.\r | |
| 889 | \r | |
| 890 | **/\r | |
| 891 | BOOLEAN\r | |
| 892 | IpSecIsIp6ExtsValid (\r | |
| 893 | IN UINT8 *NextHeader,\r | |
| 894 | IN UINT8 *ExtHdrs,\r | |
| 895 | IN UINT32 ExtHdrsLen,\r | |
| 896 | OUT UINT8 **LastHeader,\r | |
| 897 | OUT UINT32 *RealExtsLen OPTIONAL\r | |
| 898 | )\r | |
| 899 | {\r | |
| 900 | UINT32 Pointer;\r | |
| 901 | UINT8 *Option;\r | |
| 902 | UINT8 OptionLen;\r | |
| 903 | BOOLEAN Flag;\r | |
| 904 | UINT8 CountD;\r | |
| 905 | UINT8 CountF;\r | |
| 906 | UINT8 CountA;\r | |
| 907 | \r | |
| 908 | if (RealExtsLen != NULL) {\r | |
| 909 | *RealExtsLen = 0;\r | |
| 910 | }\r | |
| 911 | \r | |
| 912 | *LastHeader = NextHeader;\r | |
| a3bcde70 | 913 | \r |
| 9166f840 | 914 | if (ExtHdrs == NULL && ExtHdrsLen == 0) {\r |
| 915 | return TRUE;\r | |
| 916 | }\r | |
| 917 | \r | |
| 918 | if ((ExtHdrs == NULL && ExtHdrsLen != 0) || (ExtHdrs != NULL && ExtHdrsLen == 0)) {\r | |
| 919 | return FALSE;\r | |
| 920 | }\r | |
| 921 | \r | |
| 922 | Pointer = 0;\r | |
| 923 | Flag = FALSE;\r | |
| 924 | CountD = 0;\r | |
| 925 | CountF = 0;\r | |
| 926 | CountA = 0;\r | |
| 927 | \r | |
| 928 | while (Pointer <= ExtHdrsLen) {\r | |
| 929 | \r | |
| 930 | switch (*NextHeader) {\r | |
| 931 | case IP6_HOP_BY_HOP:\r | |
| 932 | if (Pointer != 0) {\r | |
| 933 | return FALSE;\r | |
| 934 | }\r | |
| 935 | \r | |
| 936 | Flag = TRUE;\r | |
| 937 | \r | |
| 938 | //\r | |
| 939 | // Fall through\r | |
| 940 | //\r | |
| 941 | case IP6_DESTINATION:\r | |
| 942 | if (*NextHeader == IP6_DESTINATION) {\r | |
| 943 | CountD++;\r | |
| 944 | }\r | |
| 945 | \r | |
| 946 | if (CountD > 2) {\r | |
| 947 | return FALSE;\r | |
| 948 | }\r | |
| 949 | \r | |
| 950 | NextHeader = ExtHdrs + Pointer;\r | |
| 951 | \r | |
| 952 | Pointer++;\r | |
| 953 | Option = ExtHdrs + Pointer;\r | |
| 954 | OptionLen = (UINT8) ((*Option + 1) * 8 - 2);\r | |
| 955 | Option++;\r | |
| 956 | Pointer++;\r | |
| 957 | \r | |
| 958 | Pointer = Pointer + OptionLen;\r | |
| 959 | break;\r | |
| 960 | \r | |
| 961 | case IP6_FRAGMENT:\r | |
| 962 | if (++CountF > 1) {\r | |
| 963 | return FALSE;\r | |
| 964 | }\r | |
| a3bcde70 | 965 | //\r |
| 9166f840 | 966 | // RFC2402, AH header should after fragment header.\r |
| a3bcde70 | 967 | //\r |
| 9166f840 | 968 | if (CountA > 1) {\r |
| 969 | return FALSE;\r | |
| 970 | }\r | |
| 971 | \r | |
| 972 | NextHeader = ExtHdrs + Pointer;\r | |
| 973 | Pointer = Pointer + 8;\r | |
| 974 | break;\r | |
| a3bcde70 | 975 | \r |
| 9166f840 | 976 | case IP6_AH:\r |
| 977 | if (++CountA > 1) {\r | |
| 978 | return FALSE;\r | |
| 979 | }\r | |
| 980 | \r | |
| 981 | Option = ExtHdrs + Pointer;\r | |
| 982 | NextHeader = Option;\r | |
| 983 | Option++;\r | |
| a3bcde70 | 984 | //\r |
| 9166f840 | 985 | // RFC2402, Payload length is specified in 32-bit words, minus "2".\r |
| a3bcde70 | 986 | //\r |
| 9166f840 | 987 | OptionLen = (UINT8) ((*Option + 2) * 4);\r |
| 988 | Pointer = Pointer + OptionLen;\r | |
| 989 | break;\r | |
| 990 | \r | |
| 991 | default:\r | |
| 992 | *LastHeader = NextHeader;\r | |
| 993 | if (RealExtsLen != NULL) {\r | |
| 994 | *RealExtsLen = Pointer;\r | |
| 995 | }\r | |
| 996 | \r | |
| 997 | return TRUE;\r | |
| 998 | } \r | |
| 999 | }\r | |
| 1000 | \r | |
| 1001 | *LastHeader = NextHeader;\r | |
| 1002 | \r | |
| 1003 | if (RealExtsLen != NULL) {\r | |
| 1004 | *RealExtsLen = Pointer;\r | |
| 1005 | }\r | |
| 1006 | \r | |
| 1007 | return TRUE;\r | |
| 1008 | }\r | |
| 1009 | \r | |
| 1010 | /**\r | |
| 1011 | The actual entry to process the tunnel header and inner header for tunnel mode \r | |
| 1012 | outbound traffic.\r | |
| 1013 | \r | |
| 1014 | This function is the subfunction of IpSecEspInboundPacket(). It change the destination \r | |
| 1015 | Ip address to the station address and recalculate the uplayyer's checksum.\r | |
| 1016 | \r | |
| 1017 | \r | |
| 1018 | @param[in, out] IpHead Points to the IP header containing the ESP header \r | |
| 1019 | to be trimed on input, and without ESP header\r | |
| 1020 | on return.\r | |
| 1021 | @param[in] IpPayload The decrypted Ip payload. It start from the inner\r | |
| 1022 | header.\r | |
| 1023 | @param[in] IpVersion The version of IP.\r | |
| 1024 | @param[in] SadData Pointer of the relevant SAD.\r | |
| 1025 | @param[in, out] LastHead The Last Header in IP header on return.\r | |
| 1026 | \r | |
| 1027 | **/\r | |
| 1028 | VOID\r | |
| 1029 | IpSecTunnelInboundPacket (\r | |
| 1030 | IN OUT UINT8 *IpHead,\r | |
| 1031 | IN UINT8 *IpPayload,\r | |
| 1032 | IN UINT8 IpVersion,\r | |
| 1033 | IN IPSEC_SAD_DATA *SadData,\r | |
| 1034 | IN OUT UINT8 *LastHead\r | |
| 1035 | )\r | |
| 1036 | {\r | |
| 1037 | EFI_UDP_HEADER *UdpHeader;\r | |
| 1038 | TCP_HEAD *TcpHeader;\r | |
| 1039 | UINT16 *Checksum;\r | |
| 1040 | UINT16 PseudoChecksum;\r | |
| 1041 | UINT16 PacketChecksum;\r | |
| 1042 | UINT32 OptionLen;\r | |
| 1043 | IP6_ICMP_HEAD *Icmp6Head;\r | |
| 1044 | \r | |
| 1045 | Checksum = NULL;\r | |
| 1046 | \r | |
| 1047 | if (IpVersion == IP_VERSION_4) {\r | |
| 1048 | //\r | |
| 1049 | // Zero OutIP header use this to indicate the input packet is under \r | |
| 1050 | // IPsec Tunnel protected.\r | |
| 1051 | //\r | |
| 1052 | ZeroMem (\r | |
| 1053 | (IP4_HEAD *)IpHead,\r | |
| 1054 | sizeof (IP4_HEAD)\r | |
| 1055 | );\r | |
| 1056 | CopyMem (\r | |
| 1057 | &((IP4_HEAD *)IpPayload)->Dst,\r | |
| 1058 | &SadData->TunnelDestAddress.v4,\r | |
| 1059 | sizeof (EFI_IPv4_ADDRESS)\r | |
| 1060 | );\r | |
| 1061 | \r | |
| 1062 | //\r | |
| 1063 | // Recalculate IpHeader Checksum\r | |
| 1064 | //\r | |
| 1065 | if (((IP4_HEAD *)(IpPayload))->Checksum != 0 ) {\r | |
| 1066 | ((IP4_HEAD *)(IpPayload))->Checksum = 0;\r | |
| 1067 | ((IP4_HEAD *)(IpPayload))->Checksum = (UINT16) (~NetblockChecksum (\r | |
| 1068 | (UINT8 *)IpPayload, \r | |
| 1069 | ((IP4_HEAD *)IpPayload)->HeadLen << 2\r | |
| 1070 | ));\r | |
| 1071 | \r | |
| 1072 | \r | |
| 1073 | }\r | |
| 1074 | \r | |
| 1075 | //\r | |
| 1076 | // Recalcualte PseudoChecksum\r | |
| 1077 | //\r | |
| 1078 | switch (((IP4_HEAD *)IpPayload)->Protocol) {\r | |
| 1079 | case EFI_IP_PROTO_UDP :\r | |
| 1080 | UdpHeader = (EFI_UDP_HEADER *)((UINT8 *)IpPayload + (((IP4_HEAD *)IpPayload)->HeadLen << 2));\r | |
| 1081 | Checksum = & UdpHeader->Checksum;\r | |
| 1082 | *Checksum = 0;\r | |
| 1083 | break;\r | |
| 1084 | \r | |
| 1085 | case EFI_IP_PROTO_TCP:\r | |
| 1086 | TcpHeader = (TCP_HEAD *) ((UINT8 *)IpPayload + (((IP4_HEAD *)IpPayload)->HeadLen << 2));\r | |
| 1087 | Checksum = &TcpHeader->Checksum;\r | |
| 1088 | *Checksum = 0;\r | |
| 1089 | break;\r | |
| 1090 | \r | |
| 1091 | default:\r | |
| 1092 | break;\r | |
| a3bcde70 | 1093 | }\r |
| 9166f840 | 1094 | PacketChecksum = NetblockChecksum (\r |
| 1095 | (UINT8 *)IpPayload + (((IP4_HEAD *)IpPayload)->HeadLen << 2), \r | |
| 1096 | NTOHS (((IP4_HEAD *)IpPayload)->TotalLen) - (((IP4_HEAD *)IpPayload)->HeadLen << 2)\r | |
| 1097 | );\r | |
| 1098 | PseudoChecksum = NetPseudoHeadChecksum (\r | |
| 1099 | ((IP4_HEAD *)IpPayload)->Src,\r | |
| 1100 | ((IP4_HEAD *)IpPayload)->Dst,\r | |
| 1101 | ((IP4_HEAD *)IpPayload)->Protocol,\r | |
| 1102 | 0\r | |
| 1103 | );\r | |
| 1104 | \r | |
| 1105 | if (Checksum != NULL) {\r | |
| 1106 | *Checksum = NetAddChecksum (PacketChecksum, PseudoChecksum);\r | |
| 1107 | *Checksum = (UINT16) ~(NetAddChecksum (*Checksum, HTONS((UINT16)(NTOHS (((IP4_HEAD *)IpPayload)->TotalLen) - (((IP4_HEAD *)IpPayload)->HeadLen << 2)))));\r | |
| a3bcde70 | 1108 | }\r |
| 9166f840 | 1109 | }else {\r |
| 1110 | //\r | |
| 1111 | // Zero OutIP header use this to indicate the input packet is under \r | |
| 1112 | // IPsec Tunnel protected.\r | |
| 1113 | //\r | |
| 1114 | ZeroMem (\r | |
| 1115 | IpHead,\r | |
| 1116 | sizeof (EFI_IP6_HEADER)\r | |
| 1117 | );\r | |
| 1118 | CopyMem (\r | |
| 1119 | &((EFI_IP6_HEADER*)IpPayload)->DestinationAddress,\r | |
| 1120 | &SadData->TunnelDestAddress.v6,\r | |
| 1121 | sizeof (EFI_IPv6_ADDRESS)\r | |
| 1122 | );\r | |
| 1123 | \r | |
| 1124 | //\r | |
| 1125 | // Get the Extension Header and Header length.\r | |
| 1126 | //\r | |
| 1127 | IpSecIsIp6ExtsValid (\r | |
| 1128 | &((EFI_IP6_HEADER *)IpPayload)->NextHeader,\r | |
| 1129 | IpPayload + sizeof (EFI_IP6_HEADER),\r | |
| 1130 | ((EFI_IP6_HEADER *)IpPayload)->PayloadLength,\r | |
| 1131 | &LastHead,\r | |
| 1132 | &OptionLen\r | |
| 1133 | );\r | |
| 1134 | \r | |
| 1135 | //\r | |
| 1136 | // Recalcualte PseudoChecksum\r | |
| 1137 | //\r | |
| 1138 | switch (*LastHead) {\r | |
| 1139 | case EFI_IP_PROTO_UDP:\r | |
| 1140 | UdpHeader = (EFI_UDP_HEADER *)((UINT8 *)IpPayload + sizeof (EFI_IP6_HEADER) + OptionLen);\r | |
| 1141 | Checksum = &UdpHeader->Checksum;\r | |
| 1142 | *Checksum = 0;\r | |
| 1143 | break;\r | |
| a3bcde70 | 1144 | \r |
| 9166f840 | 1145 | case EFI_IP_PROTO_TCP:\r |
| 1146 | TcpHeader = (TCP_HEAD *)(IpPayload + sizeof (EFI_IP6_HEADER) + OptionLen);\r | |
| 1147 | Checksum = &TcpHeader->Checksum;\r | |
| 1148 | *Checksum = 0;\r | |
| 1149 | break;\r | |
| 1150 | \r | |
| 1151 | case IP6_ICMP:\r | |
| 1152 | Icmp6Head = (IP6_ICMP_HEAD *) (IpPayload + sizeof (EFI_IP6_HEADER) + OptionLen);\r | |
| 1153 | Checksum = &Icmp6Head->Checksum;\r | |
| 1154 | *Checksum = 0;\r | |
| 1155 | break;\r | |
| 1156 | }\r | |
| 1157 | PacketChecksum = NetblockChecksum (\r | |
| 1158 | IpPayload + sizeof (EFI_IP6_HEADER) + OptionLen, \r | |
| 1159 | NTOHS(((EFI_IP6_HEADER *)IpPayload)->PayloadLength) - OptionLen\r | |
| 1160 | );\r | |
| 1161 | PseudoChecksum = NetIp6PseudoHeadChecksum (\r | |
| 1162 | &((EFI_IP6_HEADER *)IpPayload)->SourceAddress,\r | |
| 1163 | &((EFI_IP6_HEADER *)IpPayload)->DestinationAddress,\r | |
| 1164 | *LastHead,\r | |
| 1165 | 0\r | |
| 1166 | );\r | |
| 1167 | \r | |
| 1168 | if (Checksum != NULL) {\r | |
| 1169 | *Checksum = NetAddChecksum (PacketChecksum, PseudoChecksum);\r | |
| 1170 | *Checksum = (UINT16) ~(NetAddChecksum (\r | |
| 1171 | *Checksum,\r | |
| 1172 | HTONS ((UINT16)((NTOHS (((EFI_IP6_HEADER *)(IpPayload))->PayloadLength)) - OptionLen))\r | |
| 1173 | ));\r | |
| a3bcde70 | 1174 | }\r |
| 9166f840 | 1175 | } \r |
| 1176 | }\r | |
| 1177 | \r | |
| 1178 | /**\r | |
| 1179 | The actual entry to create inner header for tunnel mode inbound traffic.\r | |
| 1180 | \r | |
| 1181 | This function is the subfunction of IpSecEspOutboundPacket(). It create \r | |
| 1182 | the sending packet by encrypting its payload and inserting ESP header in the orginal \r | |
| 1183 | IP header, then return the IpHeader and IPsec protected Fragmentable.\r | |
| 1184 | \r | |
| 1185 | @param[in, out] IpHead Points to IP header containing the orginal IP header \r | |
| 1186 | to be processed on input, and inserted ESP header\r | |
| 1187 | on return.\r | |
| 1188 | @param[in] IpVersion The version of IP.\r | |
| 1189 | @param[in] SadData The related SAD data.\r | |
| 1190 | @param[in, out] LastHead The Last Header in IP header. \r | |
| 47b27101 | 1191 | @param[in] OptionsBuffer Pointer to the options buffer.\r |
| 1192 | @param[in] OptionsLength Length of the options buffer.\r | |
| 9166f840 | 1193 | @param[in, out] FragmentTable Pointer to a list of fragments to be protected by\r |
| 1194 | IPsec on input, and with IPsec protected\r | |
| 1195 | on return.\r | |
| 1196 | @param[in] FragmentCount The number of fragments.\r | |
| 1197 | \r | |
| 1198 | @retval EFI_SUCCESS The operation was successful.\r | |
| 1199 | @retval EFI_OUT_OF_RESOURCES The required system resources can't be allocated.\r | |
| 1200 | \r | |
| 1201 | **/\r | |
| 1202 | UINT8 *\r | |
| 1203 | IpSecTunnelOutboundPacket (\r | |
| 1204 | IN OUT UINT8 *IpHead,\r | |
| 1205 | IN UINT8 IpVersion,\r | |
| 1206 | IN IPSEC_SAD_DATA *SadData,\r | |
| 1207 | IN OUT UINT8 *LastHead,\r | |
| 1208 | IN VOID **OptionsBuffer,\r | |
| 1209 | IN UINT32 *OptionsLength,\r | |
| 1210 | IN OUT EFI_IPSEC_FRAGMENT_DATA **FragmentTable,\r | |
| 1211 | IN UINT32 *FragmentCount\r | |
| 1212 | )\r | |
| 1213 | {\r | |
| 1214 | UINT8 *InnerHead;\r | |
| 1215 | NET_BUF *Packet;\r | |
| 1216 | UINT16 PacketChecksum;\r | |
| 1217 | UINT16 *Checksum;\r | |
| 1218 | UINT16 PseudoChecksum;\r | |
| 1219 | IP6_ICMP_HEAD *IcmpHead;\r | |
| 1220 | \r | |
| 1221 | Checksum = NULL;\r | |
| 1222 | if (OptionsLength == NULL) {\r | |
| 1223 | return NULL;\r | |
| a3bcde70 | 1224 | }\r |
| 9166f840 | 1225 | \r |
| 1226 | if (IpVersion == IP_VERSION_4) {\r | |
| 1227 | InnerHead = AllocateZeroPool (sizeof (IP4_HEAD) + *OptionsLength);\r | |
| 1228 | ASSERT (InnerHead != NULL);\r | |
| 1229 | CopyMem (\r | |
| 1230 | InnerHead,\r | |
| 1231 | IpHead,\r | |
| 1232 | sizeof (IP4_HEAD)\r | |
| 1233 | );\r | |
| 1234 | CopyMem (\r | |
| 1235 | InnerHead + sizeof (IP4_HEAD),\r | |
| 1236 | *OptionsBuffer,\r | |
| 1237 | *OptionsLength\r | |
| 1238 | );\r | |
| 1239 | } else {\r | |
| 1240 | InnerHead = AllocateZeroPool (sizeof (EFI_IP6_HEADER) + *OptionsLength);\r | |
| 1241 | CopyMem (\r | |
| 1242 | InnerHead,\r | |
| 1243 | IpHead,\r | |
| 1244 | sizeof (EFI_IP6_HEADER)\r | |
| 1245 | );\r | |
| 1246 | CopyMem (\r | |
| 1247 | InnerHead + sizeof (EFI_IP6_HEADER),\r | |
| 1248 | *OptionsBuffer,\r | |
| 1249 | *OptionsLength\r | |
| 1250 | );\r | |
| 1251 | }\r | |
| 1252 | if (OptionsBuffer != NULL) {\r | |
| 1253 | if (*OptionsLength != 0) {\r | |
| a3bcde70 | 1254 | \r |
| 9166f840 | 1255 | *OptionsBuffer = NULL;\r |
| 1256 | *OptionsLength = 0;\r | |
| 1257 | }\r | |
| 1258 | }\r | |
| 1259 | \r | |
| 1260 | //\r | |
| 1261 | // 2. Reassamlbe Fragment into Packet\r | |
| 1262 | //\r | |
| 1263 | Packet = NetbufFromExt (\r | |
| 1264 | (NET_FRAGMENT *)(*FragmentTable),\r | |
| 1265 | *FragmentCount,\r | |
| 1266 | 0,\r | |
| 1267 | 0,\r | |
| 1268 | IpSecOnRecyclePacket,\r | |
| 1269 | NULL\r | |
| 1270 | );\r | |
| 1271 | ASSERT (Packet != NULL);\r | |
| 1272 | //\r | |
| 1273 | // 3. Check the Last Header, if it is TCP, UDP or ICMP recalcualate its pesudo\r | |
| 1274 | // CheckSum.\r | |
| 1275 | //\r | |
| 1276 | switch (*LastHead) {\r | |
| 1277 | case EFI_IP_PROTO_UDP:\r | |
| 1278 | Packet->Udp = (EFI_UDP_HEADER *) NetbufGetByte (Packet, 0, 0);\r | |
| 1279 | ASSERT (Packet->Udp != NULL);\r | |
| 1280 | Checksum = &Packet->Udp->Checksum;\r | |
| 1281 | *Checksum = 0;\r | |
| 1282 | break;\r | |
| 1283 | \r | |
| 1284 | case EFI_IP_PROTO_TCP:\r | |
| 1285 | Packet->Tcp = (TCP_HEAD *) NetbufGetByte (Packet, 0, 0);\r | |
| 1286 | ASSERT (Packet->Tcp != NULL);\r | |
| 1287 | Checksum = &Packet->Tcp->Checksum;\r | |
| 1288 | *Checksum = 0;\r | |
| 1289 | break;\r | |
| 1290 | \r | |
| 1291 | case IP6_ICMP:\r | |
| 1292 | IcmpHead = (IP6_ICMP_HEAD *) NetbufGetByte (Packet, 0, NULL);\r | |
| 1293 | ASSERT (IcmpHead != NULL);\r | |
| 1294 | Checksum = &IcmpHead->Checksum;\r | |
| 1295 | *Checksum = 0;\r | |
| 1296 | break;\r | |
| 1297 | \r | |
| 1298 | default: \r | |
| 1299 | break;\r | |
| 1300 | }\r | |
| a3bcde70 | 1301 | \r |
| 9166f840 | 1302 | PacketChecksum = NetbufChecksum (Packet);\r |
| 1303 | \r | |
| 1304 | if (IpVersion == IP_VERSION_4) {\r | |
| a3bcde70 | 1305 | //\r |
| 9166f840 | 1306 | // Replace the source address of Inner Header.\r |
| a3bcde70 | 1307 | //\r |
| 9166f840 | 1308 | CopyMem (\r |
| 1309 | &((IP4_HEAD *)InnerHead)->Src,\r | |
| 1310 | &SadData->SpdSelector->LocalAddress[0].Address.v4,\r | |
| 1311 | sizeof (EFI_IPv4_ADDRESS)\r | |
| 1312 | );\r | |
| 1313 | \r | |
| 1314 | PacketChecksum = NetbufChecksum (Packet);\r | |
| 1315 | PseudoChecksum = NetPseudoHeadChecksum (\r | |
| 1316 | ((IP4_HEAD *)InnerHead)->Src,\r | |
| 1317 | ((IP4_HEAD *)InnerHead)->Dst,\r | |
| 1318 | *LastHead,\r | |
| 1319 | 0\r | |
| 1320 | );\r | |
| 1321 | \r | |
| 1322 | } else {\r | |
| 1323 | //\r | |
| 1324 | // Replace the source address of Inner Header.\r | |
| 1325 | //\r | |
| 1326 | CopyMem (\r | |
| 1327 | &((EFI_IP6_HEADER *)InnerHead)->SourceAddress,\r | |
| 1328 | &(SadData->SpdSelector->LocalAddress[0].Address.v6),\r | |
| 1329 | sizeof (EFI_IPv6_ADDRESS)\r | |
| 1330 | );\r | |
| 1331 | PacketChecksum = NetbufChecksum (Packet);\r | |
| 1332 | PseudoChecksum = NetIp6PseudoHeadChecksum (\r | |
| 1333 | &((EFI_IP6_HEADER *)InnerHead)->SourceAddress,\r | |
| 1334 | &((EFI_IP6_HEADER *)InnerHead)->DestinationAddress,\r | |
| 1335 | *LastHead,\r | |
| 1336 | 0\r | |
| 1337 | );\r | |
| 1338 | \r | |
| 1339 | }\r | |
| 1340 | if (Checksum != NULL) {\r | |
| 1341 | *Checksum = NetAddChecksum (PacketChecksum, PseudoChecksum);\r | |
| 1342 | *Checksum = (UINT16) ~(NetAddChecksum ((UINT16)*Checksum, HTONS ((UINT16) Packet->TotalSize)));\r | |
| 1343 | }\r | |
| 1344 | \r | |
| 1345 | if (Packet != NULL) {\r | |
| 1346 | NetbufFree (Packet);\r | |
| 1347 | }\r | |
| 1348 | return InnerHead;\r | |
| 1349 | }\r | |
| 1350 | \r | |
| 1351 | /**\r | |
| 1352 | The actual entry to relative function processes the inbound traffic of ESP header.\r | |
| 1353 | \r | |
| 1354 | This function is the subfunction of IpSecProtectInboundPacket(). It checks the \r | |
| 1355 | received packet security property and trim the ESP header and then returns without\r | |
| 1356 | an IPsec protected IP Header and FramgmentTable.\r | |
| 1357 | \r | |
| 1358 | @param[in] IpVersion The version of IP.\r | |
| 1359 | @param[in, out] IpHead Points to the IP header containing the ESP header \r | |
| 1360 | to be trimed on input, and without ESP header\r | |
| 1361 | on return.\r | |
| 1362 | @param[out] LastHead The Last Header in IP header on return.\r | |
| 47b27101 | 1363 | @param[in, out] OptionsBuffer Pointer to the options buffer.\r |
| 1364 | @param[in, out] OptionsLength Length of the options buffer.\r | |
| 9166f840 | 1365 | @param[in, out] FragmentTable Pointer to a list of fragments in the form of IPsec\r |
| 1366 | protected on input, and without IPsec protected\r | |
| 1367 | on return.\r | |
| 1368 | @param[in, out] FragmentCount The number of fragments.\r | |
| 1369 | @param[out] SpdSelector Pointer to contain the address of SPD selector on return.\r | |
| 1370 | @param[out] RecycleEvent The event for recycling of resources.\r | |
| 1371 | \r | |
| 1372 | @retval EFI_SUCCESS The operation was successful.\r | |
| 1373 | @retval EFI_ACCESS_DENIED One or more following conditions is TRUE:\r | |
| 1374 | - ESP header was not found.\r | |
| 1375 | - The related SAD entry was not found.\r | |
| 1376 | - The related SAD entry does not support the ESP protocol.\r | |
| 1377 | @retval EFI_OUT_OF_RESOURCES The required system resource can't be allocated.\r | |
| 1378 | \r | |
| 1379 | **/\r | |
| 1380 | EFI_STATUS\r | |
| 1381 | IpSecEspInboundPacket (\r | |
| 1382 | IN UINT8 IpVersion,\r | |
| 1383 | IN OUT VOID *IpHead,\r | |
| 1384 | OUT UINT8 *LastHead,\r | |
| 47b27101 | 1385 | IN OUT VOID **OptionsBuffer,\r |
| 1386 | IN OUT UINT32 *OptionsLength,\r | |
| 9166f840 | 1387 | IN OUT EFI_IPSEC_FRAGMENT_DATA **FragmentTable,\r |
| 1388 | IN OUT UINT32 *FragmentCount,\r | |
| 1389 | OUT EFI_IPSEC_SPD_SELECTOR **SpdSelector,\r | |
| 1390 | OUT EFI_EVENT *RecycleEvent\r | |
| 1391 | )\r | |
| 1392 | {\r | |
| 1393 | EFI_STATUS Status;\r | |
| 1394 | NET_BUF *Payload;\r | |
| 1395 | UINTN EspSize;\r | |
| 1396 | UINTN IvSize;\r | |
| 1397 | UINTN PlainPayloadSize;\r | |
| 1398 | UINTN PaddingSize;\r | |
| 1399 | UINTN IcvSize;\r | |
| 1400 | UINT8 *ProcessBuffer;\r | |
| 1401 | EFI_ESP_HEADER *EspHeader;\r | |
| 1402 | EFI_ESP_TAIL *EspTail;\r | |
| 1403 | EFI_IPSEC_SA_ID *SaId;\r | |
| 1404 | IPSEC_SAD_DATA *SadData;\r | |
| 1405 | IPSEC_SAD_ENTRY *SadEntry;\r | |
| 1406 | IPSEC_RECYCLE_CONTEXT *RecycleContext;\r | |
| 1407 | UINT8 NextHeader;\r | |
| 1408 | UINT16 IpSecHeadSize;\r | |
| 1409 | UINT8 *InnerHead;\r | |
| 1410 | \r | |
| 1411 | Status = EFI_SUCCESS;\r | |
| 1412 | Payload = NULL;\r | |
| 1413 | ProcessBuffer = NULL;\r | |
| 1414 | RecycleContext = NULL;\r | |
| 1415 | *RecycleEvent = NULL;\r | |
| 1416 | PlainPayloadSize = 0;\r | |
| 1417 | NextHeader = 0;\r | |
| 1418 | \r | |
| 1419 | //\r | |
| 1420 | // Build netbuf from fragment table first.\r | |
| 1421 | //\r | |
| 1422 | Payload = NetbufFromExt (\r | |
| 1423 | (NET_FRAGMENT *) *FragmentTable,\r | |
| 1424 | *FragmentCount,\r | |
| 1425 | 0,\r | |
| 1426 | sizeof (EFI_ESP_HEADER),\r | |
| 1427 | IpSecOnRecyclePacket,\r | |
| 1428 | NULL\r | |
| a3bcde70 | 1429 | );\r |
| 9166f840 | 1430 | if (Payload == NULL) {\r |
| 1431 | Status = EFI_OUT_OF_RESOURCES;\r | |
| 1432 | goto ON_EXIT;\r | |
| 1433 | }\r | |
| 1434 | \r | |
| 1435 | //\r | |
| 1436 | // Get the esp size and esp header from netbuf.\r | |
| 1437 | //\r | |
| 1438 | EspSize = Payload->TotalSize;\r | |
| 1439 | EspHeader = (EFI_ESP_HEADER *) NetbufGetByte (Payload, 0, NULL);\r | |
| 1440 | \r | |
| 1441 | if (EspHeader == NULL) {\r | |
| 1442 | Status = EFI_ACCESS_DENIED;\r | |
| 1443 | goto ON_EXIT;\r | |
| 1444 | }\r | |
| 1445 | \r | |
| 1446 | //\r | |
| 1447 | // Parse destination address from ip header and found the related SAD Entry.\r | |
| 1448 | //\r | |
| 1449 | SadEntry = IpSecFoundSadFromInboundPacket (\r | |
| 1450 | IpHead, \r | |
| 1451 | IpVersion,\r | |
| 1452 | NTOHL (EspHeader->Spi)\r | |
| 1453 | );\r | |
| 1454 | \r | |
| 1455 | if (SadEntry == NULL) {\r | |
| 1456 | Status = EFI_ACCESS_DENIED;\r | |
| 1457 | goto ON_EXIT;\r | |
| 1458 | }\r | |
| a3bcde70 | 1459 | \r |
| 9166f840 | 1460 | SaId = SadEntry->Id;\r |
| 1461 | SadData = SadEntry->Data;\r | |
| a3bcde70 | 1462 | \r |
| 9166f840 | 1463 | //\r |
| 1464 | // Only support esp protocol currently.\r | |
| 1465 | //\r | |
| 1466 | if (SaId->Proto != EfiIPsecESP) {\r | |
| 1467 | Status = EFI_ACCESS_DENIED;\r | |
| 1468 | goto ON_EXIT;\r | |
| 1469 | }\r | |
| a3bcde70 | 1470 | \r |
| 9166f840 | 1471 | if (!SadData->ManualSet) {\r |
| 1472 | //\r | |
| 1473 | // TODO: Check SA lifetime and sequence number\r | |
| 1474 | //\r | |
| 1475 | }\r | |
| 1476 | \r | |
| 1477 | //\r | |
| 1478 | // Allocate buffer for decryption and authentication.\r | |
| 1479 | //\r | |
| 1480 | ProcessBuffer = AllocateZeroPool (EspSize);\r | |
| 1481 | if (ProcessBuffer == NULL) {\r | |
| 1482 | Status = EFI_OUT_OF_RESOURCES;\r | |
| 1483 | goto ON_EXIT;\r | |
| 1484 | }\r | |
| 1485 | \r | |
| 1486 | NetbufCopy (Payload, 0, (UINT32) EspSize, ProcessBuffer);\r | |
| 1487 | \r | |
| 1488 | //\r | |
| 1489 | // Authenticate the esp wrapped buffer by the auth keys which is from SAD entry.\r | |
| 1490 | //\r | |
| 1491 | IcvSize = 0;\r | |
| 1492 | if (SadData->AlgoInfo.EspAlgoInfo.AuthKey != NULL) {\r | |
| 1493 | Status = IpSecEspAuthVerifyPayload (\r | |
| 1494 | ProcessBuffer,\r | |
| 1495 | EspSize,\r | |
| 1496 | SadEntry,\r | |
| 1497 | &IcvSize\r | |
| 1498 | );\r | |
| 1499 | if (EFI_ERROR (Status)) {\r | |
| 1500 | goto ON_EXIT;\r | |
| 1501 | }\r | |
| 1502 | }\r | |
| 1503 | //\r | |
| 1504 | // Decrypt the payload by the SAD entry if it has decrypt key.\r | |
| 1505 | //\r | |
| 1506 | IvSize = IpSecGetEncryptIvLength (SadEntry->Data->AlgoInfo.EspAlgoInfo.EncAlgoId);\r | |
| 1507 | if (SadData->AlgoInfo.EspAlgoInfo.EncKey != NULL) {\r | |
| 1508 | Status = IpSecCryptoIoDecrypt (\r | |
| 1509 | SadEntry->Data->AlgoInfo.EspAlgoInfo.EncAlgoId,\r | |
| 1510 | SadEntry->Data->AlgoInfo.EspAlgoInfo.EncKey,\r | |
| 1511 | SadEntry->Data->AlgoInfo.EspAlgoInfo.EncKeyLength << 3,\r | |
| 1512 | ProcessBuffer + sizeof (EFI_ESP_HEADER),\r | |
| 1513 | ProcessBuffer + sizeof (EFI_ESP_HEADER) + IvSize,\r | |
| 1514 | EspSize - sizeof (EFI_ESP_HEADER) - IvSize - IcvSize,\r | |
| 1515 | ProcessBuffer + sizeof (EFI_ESP_HEADER) + IvSize\r | |
| 1516 | );\r | |
| 1517 | if (EFI_ERROR (Status)) {\r | |
| 1518 | goto ON_EXIT;\r | |
| 1519 | }\r | |
| 1520 | }\r | |
| 1521 | \r | |
| 1522 | //\r | |
| 1523 | // Parse EspTail and compute the plain payload size.\r | |
| 1524 | //\r | |
| 1525 | EspTail = (EFI_ESP_TAIL *) (ProcessBuffer + EspSize - IcvSize - sizeof (EFI_ESP_TAIL));\r | |
| 1526 | PaddingSize = EspTail->PaddingLength;\r | |
| 1527 | NextHeader = EspTail->NextHeader;\r | |
| 1528 | PlainPayloadSize = EspSize - sizeof (EFI_ESP_HEADER) - IvSize - IcvSize - sizeof (EFI_ESP_TAIL) - PaddingSize;\r | |
| 1529 | \r | |
| 1530 | //\r | |
| 1531 | // TODO: handle anti-replay window\r | |
| 1532 | //\r | |
| 1533 | //\r | |
| 1534 | // Decryption and authentication with esp has been done, so it's time to\r | |
| 1535 | // reload the new packet, create recycle event and fixup ip header.\r | |
| 1536 | //\r | |
| 1537 | RecycleContext = AllocateZeroPool (sizeof (IPSEC_RECYCLE_CONTEXT));\r | |
| 1538 | if (RecycleContext == NULL) {\r | |
| 1539 | Status = EFI_OUT_OF_RESOURCES;\r | |
| 1540 | goto ON_EXIT;\r | |
| 1541 | }\r | |
| 1542 | \r | |
| 1543 | Status = gBS->CreateEvent (\r | |
| 1544 | EVT_NOTIFY_SIGNAL,\r | |
| 1545 | TPL_NOTIFY,\r | |
| 1546 | IpSecRecycleCallback,\r | |
| 1547 | RecycleContext,\r | |
| 1548 | RecycleEvent\r | |
| 1549 | );\r | |
| 1550 | if (EFI_ERROR (Status)) {\r | |
| 1551 | goto ON_EXIT;\r | |
| 1552 | }\r | |
| 1553 | \r | |
| 1554 | //\r | |
| 1555 | // The caller will take responsible to handle the original fragment table\r | |
| 1556 | //\r | |
| 1557 | *FragmentTable = AllocateZeroPool (sizeof (EFI_IPSEC_FRAGMENT_DATA));\r | |
| 1558 | if (*FragmentTable == NULL) {\r | |
| 1559 | Status = EFI_OUT_OF_RESOURCES;\r | |
| 1560 | goto ON_EXIT;\r | |
| 1561 | }\r | |
| 1562 | \r | |
| 1563 | RecycleContext->PayloadBuffer = ProcessBuffer;\r | |
| 1564 | RecycleContext->FragmentTable = *FragmentTable;\r | |
| 1565 | \r | |
| 1566 | //\r | |
| 1567 | // If Tunnel, recalculate upper-layyer PesudoCheckSum and trim the out\r | |
| 1568 | //\r | |
| 1569 | if (SadData->Mode == EfiIPsecTunnel) {\r | |
| 1570 | InnerHead = ProcessBuffer + sizeof (EFI_ESP_HEADER) + IvSize;\r | |
| 1571 | IpSecTunnelInboundPacket (\r | |
| 1572 | IpHead,\r | |
| 1573 | InnerHead,\r | |
| 1574 | IpVersion,\r | |
| 1575 | SadData,\r | |
| 1576 | LastHead\r | |
| 1577 | );\r | |
| 1578 | \r | |
| 1579 | if (IpVersion == IP_VERSION_4) {\r | |
| 1580 | (*FragmentTable)[0].FragmentBuffer = InnerHead ;\r | |
| 1581 | (*FragmentTable)[0].FragmentLength = (UINT32) PlainPayloadSize;\r | |
| 1582 | \r | |
| 1583 | }else { \r | |
| 1584 | (*FragmentTable)[0].FragmentBuffer = InnerHead;\r | |
| 1585 | (*FragmentTable)[0].FragmentLength = (UINT32) PlainPayloadSize;\r | |
| 1586 | } \r | |
| 1587 | } else {\r | |
| 1588 | (*FragmentTable)[0].FragmentBuffer = ProcessBuffer + sizeof (EFI_ESP_HEADER) + IvSize;\r | |
| 1589 | (*FragmentTable)[0].FragmentLength = (UINT32) PlainPayloadSize;\r | |
| 1590 | }\r | |
| 1591 | \r | |
| 1592 | *FragmentCount = 1;\r | |
| 1593 | \r | |
| 1594 | //\r | |
| 1595 | // Update the total length field in ip header since processed by esp.\r | |
| 1596 | //\r | |
| 1597 | if (!SadData->Mode == EfiIPsecTunnel) {\r | |
| 1598 | if (IpVersion == IP_VERSION_4) {\r | |
| 1599 | ((IP4_HEAD *) IpHead)->TotalLen = HTONS ((UINT16) (((IP4_HEAD *) IpHead)->HeadLen + PlainPayloadSize));\r | |
| 1600 | } else {\r | |
| 1601 | IpSecHeadSize = IpSecGetPlainExtHeadSize (IpHead, LastHead);\r | |
| 1602 | ((EFI_IP6_HEADER *) IpHead)->PayloadLength = HTONS ((UINT16)(IpSecHeadSize + PlainPayloadSize));\r | |
| 1603 | }\r | |
| 1604 | //\r | |
| 1605 | // Update the next layer field in ip header since esp header inserted.\r | |
| 1606 | //\r | |
| 1607 | *LastHead = NextHeader;\r | |
| 1608 | }\r | |
| 1609 | \r | |
| 1610 | \r | |
| 1611 | //\r | |
| 1612 | // Update the SPD association of the SAD entry.\r | |
| 1613 | //\r | |
| 1614 | *SpdSelector = SadData->SpdSelector;\r | |
| 1615 | \r | |
| 1616 | ON_EXIT:\r | |
| 1617 | if (Payload != NULL) {\r | |
| 1618 | NetbufFree (Payload);\r | |
| 1619 | }\r | |
| 1620 | \r | |
| 1621 | if (EFI_ERROR (Status)) {\r | |
| 1622 | if (ProcessBuffer != NULL) {\r | |
| 1623 | FreePool (ProcessBuffer);\r | |
| 1624 | }\r | |
| 1625 | \r | |
| 1626 | if (RecycleContext != NULL) {\r | |
| 1627 | FreePool (RecycleContext);\r | |
| 1628 | }\r | |
| 1629 | \r | |
| 1630 | if (*RecycleEvent != NULL) {\r | |
| 1631 | gBS->CloseEvent (*RecycleEvent);\r | |
| 1632 | }\r | |
| 1633 | }\r | |
| 1634 | \r | |
| 1635 | return Status;\r | |
| 1636 | }\r | |
| 1637 | \r | |
| 1638 | /**\r | |
| 1639 | The actual entry to the relative function processes the output traffic using the ESP protocol.\r | |
| 1640 | \r | |
| 1641 | This function is the subfunction of IpSecProtectOutboundPacket(). It protected\r | |
| 1642 | the sending packet by encrypting its payload and inserting ESP header in the orginal\r | |
| 1643 | IP header, then return the IpHeader and IPsec protected Fragmentable.\r | |
| 1644 | \r | |
| 1645 | @param[in] IpVersion The version of IP.\r | |
| 1646 | @param[in, out] IpHead Points to IP header containing the orginal IP header\r | |
| 1647 | to be processed on input, and inserted ESP header\r | |
| 1648 | on return.\r | |
| 1649 | @param[in, out] LastHead The Last Header in IP header.\r | |
| 47b27101 | 1650 | @param[in, out] OptionsBuffer Pointer to the options buffer.\r |
| 1651 | @param[in, out] OptionsLength Length of the options buffer.\r | |
| 9166f840 | 1652 | @param[in, out] FragmentTable Pointer to a list of fragments to be protected by\r |
| 1653 | IPsec on input, and with IPsec protected\r | |
| 1654 | on return.\r | |
| 1655 | @param[in, out] FragmentCount The number of fragments.\r | |
| 1656 | @param[in] SadEntry The related SAD entry.\r | |
| 1657 | @param[out] RecycleEvent The event for recycling of resources.\r | |
| 1658 | \r | |
| 1659 | @retval EFI_SUCCESS The operation was successful.\r | |
| 1660 | @retval EFI_OUT_OF_RESOURCES The required system resources can't be allocated.\r | |
| 1661 | \r | |
| 1662 | **/\r | |
| 1663 | EFI_STATUS\r | |
| 1664 | IpSecEspOutboundPacket (\r | |
| 1665 | IN UINT8 IpVersion,\r | |
| 1666 | IN OUT VOID *IpHead,\r | |
| 1667 | IN OUT UINT8 *LastHead,\r | |
| 47b27101 | 1668 | IN OUT VOID **OptionsBuffer,\r |
| 1669 | IN OUT UINT32 *OptionsLength,\r | |
| 9166f840 | 1670 | IN OUT EFI_IPSEC_FRAGMENT_DATA **FragmentTable,\r |
| 1671 | IN OUT UINT32 *FragmentCount,\r | |
| 1672 | IN IPSEC_SAD_ENTRY *SadEntry,\r | |
| 1673 | OUT EFI_EVENT *RecycleEvent\r | |
| 1674 | )\r | |
| 1675 | {\r | |
| 1676 | EFI_STATUS Status;\r | |
| 1677 | UINTN Index;\r | |
| 1678 | EFI_IPSEC_SA_ID *SaId;\r | |
| 1679 | IPSEC_SAD_DATA *SadData;\r | |
| 1680 | IPSEC_RECYCLE_CONTEXT *RecycleContext;\r | |
| 1681 | UINT8 *ProcessBuffer;\r | |
| 1682 | UINTN BytesCopied;\r | |
| 1683 | INTN EncryptBlockSize;// Size of encryption block, 4 bytes aligned and >= 4\r | |
| 1684 | UINTN EspSize; // Total size of esp wrapped ip payload\r | |
| 1685 | UINTN IvSize; // Size of IV, optional, might be 0\r | |
| 1686 | UINTN PlainPayloadSize;// Original IP payload size\r | |
| 1687 | UINTN PaddingSize; // Size of padding\r | |
| 1688 | UINTN EncryptSize; // Size of data to be encrypted, start after IV and\r | |
| 1689 | // stop before ICV\r | |
| 1690 | UINTN IcvSize; // Size of ICV, optional, might be 0\r | |
| 1691 | UINT8 *RestOfPayload; // Start of Payload after IV\r | |
| 1692 | UINT8 *Padding; // Start address of padding\r | |
| 1693 | EFI_ESP_HEADER *EspHeader; // Start address of ESP frame\r | |
| 1694 | EFI_ESP_TAIL *EspTail; // Address behind padding\r | |
| 1695 | UINT8 *InnerHead;\r | |
| 1696 | HASH_DATA_FRAGMENT HashFragment[1];\r | |
| 1697 | \r | |
| 1698 | Status = EFI_ACCESS_DENIED;\r | |
| 1699 | SaId = SadEntry->Id;\r | |
| 1700 | SadData = SadEntry->Data;\r | |
| 1701 | ProcessBuffer = NULL;\r | |
| 1702 | RecycleContext = NULL;\r | |
| 1703 | *RecycleEvent = NULL;\r | |
| 1704 | InnerHead = NULL;\r | |
| 1705 | \r | |
| 1706 | if (!SadData->ManualSet &&\r | |
| 1707 | SadData->AlgoInfo.EspAlgoInfo.EncKey == NULL &&\r | |
| 1708 | SadData->AlgoInfo.EspAlgoInfo.AuthKey == NULL\r | |
| 1709 | ) {\r | |
| 1710 | //\r | |
| 1711 | // Invalid manual SAD entry configuration.\r | |
| 1712 | //\r | |
| 1713 | goto ON_EXIT;\r | |
| 1714 | }\r | |
| 1715 | \r | |
| 1716 | //\r | |
| 1717 | // Create OutHeader according to Inner Header\r | |
| 1718 | //\r | |
| 1719 | if (SadData->Mode == EfiIPsecTunnel) {\r | |
| 1720 | InnerHead = IpSecTunnelOutboundPacket (\r | |
| a3bcde70 | 1721 | IpHead,\r |
| 9166f840 | 1722 | IpVersion,\r |
| 1723 | SadData,\r | |
| 1724 | LastHead,\r | |
| 1725 | OptionsBuffer,\r | |
| 1726 | OptionsLength,\r | |
| 1727 | FragmentTable,\r | |
| 1728 | FragmentCount\r | |
| a3bcde70 | 1729 | );\r |
| 9166f840 | 1730 | \r |
| 1731 | if (InnerHead == NULL) {\r | |
| 1732 | return EFI_INVALID_PARAMETER;\r | |
| 1733 | }\r | |
| a3bcde70 | 1734 | \r |
| 9166f840 | 1735 | }\r |
| a3bcde70 | 1736 | \r |
| 9166f840 | 1737 | //\r |
| 1738 | // Calculate enctrypt block size, need iv by default and 4 bytes alignment.\r | |
| 1739 | //\r | |
| 1740 | EncryptBlockSize = 4;\r | |
| 1741 | \r | |
| 1742 | if (SadData->AlgoInfo.EspAlgoInfo.EncKey != NULL) {\r | |
| 1743 | EncryptBlockSize = IpSecGetEncryptBlockSize (SadEntry->Data->AlgoInfo.EspAlgoInfo.EncAlgoId);\r | |
| a3bcde70 | 1744 | \r |
| 9166f840 | 1745 | if (EncryptBlockSize < 0 || (EncryptBlockSize != 1 && EncryptBlockSize % 4 != 0)) {\r |
| a3bcde70 | 1746 | goto ON_EXIT;\r |
| 9166f840 | 1747 | }\r |
| 1748 | }\r | |
| 1749 | \r | |
| 1750 | //\r | |
| 1751 | // Calculate the plain payload size accroding to the fragment table.\r | |
| 1752 | //\r | |
| 1753 | PlainPayloadSize = 0;\r | |
| 1754 | for (Index = 0; Index < *FragmentCount; Index++) {\r | |
| 1755 | PlainPayloadSize += (*FragmentTable)[Index].FragmentLength;\r | |
| 1756 | }\r | |
| 1757 | \r | |
| 1758 | //\r | |
| 1759 | // Add IPHeader size for Tunnel Mode\r | |
| 1760 | //\r | |
| 1761 | if (SadData->Mode == EfiIPsecTunnel) {\r | |
| 1762 | if (IpVersion == IP_VERSION_4) {\r | |
| 1763 | PlainPayloadSize += sizeof (IP4_HEAD);\r | |
| 1764 | } else {\r | |
| 1765 | PlainPayloadSize += sizeof (EFI_IP6_HEADER);\r | |
| 1766 | }\r | |
| 1767 | //\r | |
| 1768 | // OPtions should be encryption into it\r | |
| 1769 | //\r | |
| 1770 | PlainPayloadSize += *OptionsLength; \r | |
| 1771 | }\r | |
| 1772 | \r | |
| a3bcde70 | 1773 | \r |
| 9166f840 | 1774 | //\r |
| 1775 | // Calculate icv size, optional by default and 4 bytes alignment.\r | |
| 1776 | //\r | |
| 1777 | IcvSize = 0;\r | |
| 1778 | if (SadData->AlgoInfo.EspAlgoInfo.AuthKey != NULL) {\r | |
| 1779 | IcvSize = IpSecGetIcvLength (SadEntry->Data->AlgoInfo.EspAlgoInfo.AuthAlgoId);\r | |
| 1780 | if (IcvSize % 4 != 0) {\r | |
| a3bcde70 | 1781 | goto ON_EXIT;\r |
| 9166f840 | 1782 | }\r |
| 1783 | }\r | |
| a3bcde70 | 1784 | \r |
| 9166f840 | 1785 | //\r |
| 1786 | // Calcuate the total size of esp wrapped ip payload.\r | |
| 1787 | //\r | |
| 1788 | IvSize = IpSecGetEncryptIvLength (SadEntry->Data->AlgoInfo.EspAlgoInfo.EncAlgoId);\r | |
| 1789 | EncryptSize = (PlainPayloadSize + sizeof (EFI_ESP_TAIL) + EncryptBlockSize - 1) / EncryptBlockSize * EncryptBlockSize;\r | |
| 1790 | PaddingSize = EncryptSize - PlainPayloadSize - sizeof (EFI_ESP_TAIL);\r | |
| 1791 | EspSize = sizeof (EFI_ESP_HEADER) + IvSize + EncryptSize + IcvSize;\r | |
| 1792 | \r | |
| 1793 | ProcessBuffer = AllocateZeroPool (EspSize);\r | |
| 1794 | if (ProcessBuffer == NULL) {\r | |
| 1795 | Status = EFI_OUT_OF_RESOURCES;\r | |
| 1796 | goto ON_EXIT;\r | |
| 1797 | }\r | |
| 1798 | \r | |
| 1799 | //\r | |
| 1800 | // Calculate esp header and esp tail including header, payload and padding.\r | |
| 1801 | //\r | |
| 1802 | EspHeader = (EFI_ESP_HEADER *) ProcessBuffer;\r | |
| 1803 | RestOfPayload = (UINT8 *) (EspHeader + 1) + IvSize;\r | |
| 1804 | Padding = RestOfPayload + PlainPayloadSize;\r | |
| 1805 | EspTail = (EFI_ESP_TAIL *) (Padding + PaddingSize);\r | |
| 1806 | \r | |
| 1807 | //\r | |
| 1808 | // Fill the sn and spi fields in esp header.\r | |
| 1809 | //\r | |
| 1810 | EspHeader->SequenceNumber = HTONL ((UINT32) SadData->SequenceNumber + 1);\r | |
| 1811 | //EspHeader->SequenceNumber = HTONL ((UINT32) SadData->SequenceNumber);\r | |
| 1812 | EspHeader->Spi = HTONL (SaId->Spi);\r | |
| 1813 | \r | |
| 1814 | //\r | |
| 1815 | // Copy the rest of payload (after iv) from the original fragment buffer.\r | |
| 1816 | //\r | |
| 1817 | BytesCopied = 0;\r | |
| 1818 | \r | |
| 1819 | //\r | |
| 1820 | // For Tunnel Mode\r | |
| 1821 | //\r | |
| 1822 | if (SadData->Mode == EfiIPsecTunnel) {\r | |
| 1823 | if (IpVersion == IP_VERSION_4) {\r | |
| a3bcde70 | 1824 | //\r |
| 9166f840 | 1825 | // HeadLen, Total Length\r |
| a3bcde70 | 1826 | //\r |
| 9166f840 | 1827 | ((IP4_HEAD *)InnerHead)->HeadLen = (UINT8) ((sizeof (IP4_HEAD) + *OptionsLength) >> 2);\r |
| 1828 | ((IP4_HEAD *)InnerHead)->TotalLen = HTONS ((UINT16) PlainPayloadSize); \r | |
| 1829 | ((IP4_HEAD *)InnerHead)->Checksum = 0;\r | |
| 1830 | ((IP4_HEAD *)InnerHead)->Checksum = (UINT16) (~NetblockChecksum (\r | |
| 1831 | (UINT8 *)InnerHead,\r | |
| 1832 | sizeof(IP4_HEAD)\r | |
| 1833 | ));\r | |
| 1834 | CopyMem (\r | |
| 1835 | RestOfPayload + BytesCopied,\r | |
| 1836 | InnerHead,\r | |
| 1837 | sizeof (IP4_HEAD) + *OptionsLength\r | |
| 1838 | );\r | |
| 1839 | BytesCopied += sizeof (IP4_HEAD) + *OptionsLength;\r | |
| 1840 | \r | |
| 1841 | } else {\r | |
| 1842 | ((EFI_IP6_HEADER *)InnerHead)->PayloadLength = HTONS ((UINT16) (PlainPayloadSize - sizeof (EFI_IP6_HEADER)));\r | |
| 1843 | CopyMem (\r | |
| 1844 | RestOfPayload + BytesCopied,\r | |
| 1845 | InnerHead,\r | |
| 1846 | sizeof (EFI_IP6_HEADER) + *OptionsLength\r | |
| 1847 | );\r | |
| 1848 | BytesCopied += sizeof (EFI_IP6_HEADER) + *OptionsLength;\r | |
| a3bcde70 HT |
1849 | }\r |
| 1850 | }\r | |
| 1851 | \r | |
| 9166f840 | 1852 | for (Index = 0; Index < *FragmentCount; Index++) {\r |
| 1853 | CopyMem (\r | |
| 1854 | (RestOfPayload + BytesCopied),\r | |
| 1855 | (*FragmentTable)[Index].FragmentBuffer,\r | |
| 1856 | (*FragmentTable)[Index].FragmentLength\r | |
| 1857 | );\r | |
| 1858 | BytesCopied += (*FragmentTable)[Index].FragmentLength;\r | |
| 1859 | }\r | |
| 1860 | //\r | |
| 1861 | // Fill the padding buffer by natural number sequence.\r | |
| 1862 | //\r | |
| 1863 | for (Index = 0; Index < PaddingSize; Index++) {\r | |
| 1864 | Padding[Index] = (UINT8) (Index + 1);\r | |
| 1865 | }\r | |
| 1866 | //\r | |
| 1867 | // Fill the padding length and next header fields in esp tail.\r | |
| 1868 | //\r | |
| 1869 | EspTail->PaddingLength = (UINT8) PaddingSize;\r | |
| 1870 | EspTail->NextHeader = *LastHead;\r | |
| 1871 | \r | |
| 1872 | //\r | |
| 1873 | // Fill the next header for Tunnel mode.\r | |
| 1874 | //\r | |
| 1875 | if (SadData->Mode == EfiIPsecTunnel) {\r | |
| 1876 | if (IpVersion == IP_VERSION_4) {\r | |
| 1877 | EspTail->NextHeader = 4;\r | |
| 1878 | } else {\r | |
| 1879 | EspTail->NextHeader = 41;\r | |
| 1880 | } \r | |
| 1881 | }\r | |
| 1882 | \r | |
| 1883 | //\r | |
| 1884 | // Generate iv at random by crypt library.\r | |
| 1885 | //\r | |
| 1886 | Status = IpSecGenerateIv (\r | |
| 1887 | (UINT8 *) (EspHeader + 1),\r | |
| 1888 | IvSize\r | |
| 1889 | );\r | |
| 1890 | \r | |
| 1891 | \r | |
| 1892 | if (EFI_ERROR (Status)) {\r | |
| 1893 | goto ON_EXIT;\r | |
| 1894 | }\r | |
| 1895 | \r | |
| 1896 | //\r | |
| 1897 | // Encryption the payload (after iv) by the SAD entry if has encrypt key.\r | |
| 1898 | //\r | |
| 1899 | if (SadData->AlgoInfo.EspAlgoInfo.EncKey != NULL) {\r | |
| 1900 | Status = IpSecCryptoIoEncrypt (\r | |
| 1901 | SadEntry->Data->AlgoInfo.EspAlgoInfo.EncAlgoId,\r | |
| 1902 | SadEntry->Data->AlgoInfo.EspAlgoInfo.EncKey,\r | |
| 1903 | SadEntry->Data->AlgoInfo.EspAlgoInfo.EncKeyLength << 3,\r | |
| 1904 | (UINT8 *)(EspHeader + 1),\r | |
| 1905 | RestOfPayload,\r | |
| 1906 | EncryptSize,\r | |
| 1907 | RestOfPayload\r | |
| 1908 | );\r | |
| 1909 | \r | |
| 1910 | if (EFI_ERROR (Status)) {\r | |
| 1911 | goto ON_EXIT;\r | |
| 1912 | }\r | |
| 1913 | }\r | |
| 1914 | \r | |
| 1915 | //\r | |
| 1916 | // Authenticate the esp wrapped buffer by the SAD entry if it has auth key.\r | |
| 1917 | //\r | |
| 1918 | if (SadData->AlgoInfo.EspAlgoInfo.AuthKey != NULL) {\r | |
| 1919 | \r | |
| 1920 | HashFragment[0].Data = ProcessBuffer;\r | |
| 1921 | HashFragment[0].DataSize = EspSize - IcvSize;\r | |
| 1922 | Status = IpSecCryptoIoHmac (\r | |
| 1923 | SadEntry->Data->AlgoInfo.EspAlgoInfo.AuthAlgoId,\r | |
| 1924 | SadEntry->Data->AlgoInfo.EspAlgoInfo.AuthKey,\r | |
| 1925 | SadEntry->Data->AlgoInfo.EspAlgoInfo.AuthKeyLength,\r | |
| 1926 | HashFragment,\r | |
| 1927 | 1,\r | |
| 1928 | ProcessBuffer + EspSize - IcvSize,\r | |
| 1929 | IcvSize\r | |
| 1930 | );\r | |
| 1931 | if (EFI_ERROR (Status)) {\r | |
| 1932 | goto ON_EXIT;\r | |
| 1933 | }\r | |
| 1934 | }\r | |
| 1935 | \r | |
| 1936 | //\r | |
| 1937 | // Encryption and authentication with esp has been done, so it's time to\r | |
| 1938 | // reload the new packet, create recycle event and fixup ip header.\r | |
| 1939 | //\r | |
| 1940 | RecycleContext = AllocateZeroPool (sizeof (IPSEC_RECYCLE_CONTEXT));\r | |
| 1941 | if (RecycleContext == NULL) {\r | |
| 1942 | Status = EFI_OUT_OF_RESOURCES;\r | |
| 1943 | goto ON_EXIT;\r | |
| 1944 | }\r | |
| 1945 | \r | |
| 1946 | Status = gBS->CreateEvent (\r | |
| 1947 | EVT_NOTIFY_SIGNAL,\r | |
| 1948 | TPL_NOTIFY,\r | |
| 1949 | IpSecRecycleCallback,\r | |
| 1950 | RecycleContext,\r | |
| 1951 | RecycleEvent\r | |
| 1952 | );\r | |
| 1953 | if (EFI_ERROR (Status)) {\r | |
| 1954 | goto ON_EXIT;\r | |
| 1955 | }\r | |
| 1956 | //\r | |
| 1957 | // Caller take responsible to handle the original fragment table.\r | |
| 1958 | //\r | |
| 1959 | *FragmentTable = AllocateZeroPool (sizeof (EFI_IPSEC_FRAGMENT_DATA));\r | |
| 1960 | if (*FragmentTable == NULL) {\r | |
| 1961 | Status = EFI_OUT_OF_RESOURCES;\r | |
| 1962 | goto ON_EXIT;\r | |
| 1963 | }\r | |
| 1964 | \r | |
| 1965 | RecycleContext->FragmentTable = *FragmentTable;\r | |
| 1966 | RecycleContext->PayloadBuffer = ProcessBuffer;\r | |
| 1967 | (*FragmentTable)[0].FragmentBuffer = ProcessBuffer;\r | |
| 1968 | (*FragmentTable)[0].FragmentLength = (UINT32) EspSize;\r | |
| 1969 | *FragmentCount = 1;\r | |
| 1970 | \r | |
| 1971 | //\r | |
| 1972 | // Update the total length field in ip header since processed by esp.\r | |
| 1973 | //\r | |
| 1974 | if (IpVersion == IP_VERSION_4) {\r | |
| 1975 | ((IP4_HEAD *) IpHead)->TotalLen = HTONS ((UINT16) ((((IP4_HEAD *) IpHead)->HeadLen << 2) + EspSize));\r | |
| 1976 | } else {\r | |
| 1977 | ((EFI_IP6_HEADER *) IpHead)->PayloadLength = (UINT16) (IpSecGetPlainExtHeadSize (IpHead, LastHead) + EspSize);\r | |
| 1978 | }\r | |
| 1979 | \r | |
| 1980 | //\r | |
| 1981 | // If tunnel mode, it should change the outer Ip header with tunnel source address\r | |
| 1982 | // and destination tunnel address.\r | |
| 1983 | //\r | |
| 1984 | if (SadData->Mode == EfiIPsecTunnel) {\r | |
| 1985 | if (IpVersion == IP_VERSION_4) {\r | |
| 1986 | CopyMem (\r | |
| 1987 | &((IP4_HEAD *) IpHead)->Src, \r | |
| 1988 | &SadData->TunnelSourceAddress.v4,\r | |
| 1989 | sizeof (EFI_IPv4_ADDRESS)\r | |
| 1990 | ); \r | |
| 1991 | CopyMem (\r | |
| 1992 | &((IP4_HEAD *) IpHead)->Dst,\r | |
| 1993 | &SadData->TunnelDestAddress.v4,\r | |
| 1994 | sizeof (EFI_IPv4_ADDRESS)\r | |
| 1995 | );\r | |
| 1996 | } else {\r | |
| 1997 | CopyMem (\r | |
| 1998 | &((EFI_IP6_HEADER *) IpHead)->SourceAddress,\r | |
| 1999 | &SadData->TunnelSourceAddress.v6,\r | |
| 2000 | sizeof (EFI_IPv6_ADDRESS)\r | |
| 2001 | );\r | |
| 2002 | CopyMem (\r | |
| 2003 | &((EFI_IP6_HEADER *) IpHead)->DestinationAddress,\r | |
| 2004 | &SadData->TunnelDestAddress.v6,\r | |
| 2005 | sizeof (EFI_IPv6_ADDRESS)\r | |
| 2006 | );\r | |
| 2007 | }\r | |
| 2008 | }\r | |
| 2009 | \r | |
| 2010 | //\r | |
| 2011 | // Update the next layer field in ip header since esp header inserted.\r | |
| 2012 | //\r | |
| 2013 | *LastHead = IPSEC_ESP_PROTOCOL;\r | |
| 2014 | \r | |
| 2015 | //\r | |
| 2016 | // Increase the sn number in SAD entry according to rfc4303.\r | |
| 2017 | //\r | |
| 2018 | SadData->SequenceNumber++;\r | |
| 2019 | \r | |
| a3bcde70 | 2020 | ON_EXIT:\r |
| 9166f840 | 2021 | if (EFI_ERROR (Status)) {\r |
| 2022 | if (ProcessBuffer != NULL) {\r | |
| 2023 | FreePool (ProcessBuffer);\r | |
| 2024 | }\r | |
| 2025 | \r | |
| 2026 | if (RecycleContext != NULL) {\r | |
| 2027 | FreePool (RecycleContext);\r | |
| 2028 | }\r | |
| 2029 | \r | |
| 2030 | if (*RecycleEvent != NULL) {\r | |
| 2031 | gBS->CloseEvent (*RecycleEvent);\r | |
| 2032 | }\r | |
| 2033 | }\r | |
| 2034 | \r | |
| a3bcde70 HT |
2035 | return Status;\r |
| 2036 | }\r | |
| 2037 | \r | |
| 9166f840 | 2038 | /**\r |
| 2039 | This function processes the inbound traffic with IPsec.\r | |
| 2040 | \r | |
| 2041 | It checks the received packet security property, trims the ESP/AH header, and then \r | |
| 2042 | returns without an IPsec protected IP Header and FragmentTable.\r | |
| 2043 | \r | |
| 2044 | @param[in] IpVersion The version of IP.\r | |
| 2045 | @param[in, out] IpHead Points to IP header containing the ESP/AH header \r | |
| 2046 | to be trimed on input, and without ESP/AH header\r | |
| 2047 | on return.\r | |
| 2048 | @param[in, out] LastHead The Last Header in IP header on return.\r | |
| 47b27101 | 2049 | @param[in, out] OptionsBuffer Pointer to the options buffer.\r |
| 2050 | @param[in, out] OptionsLength Length of the options buffer.\r | |
| 9166f840 | 2051 | @param[in, out] FragmentTable Pointer to a list of fragments in form of IPsec\r |
| 2052 | protected on input, and without IPsec protected\r | |
| 2053 | on return.\r | |
| 2054 | @param[in, out] FragmentCount The number of fragments.\r | |
| 2055 | @param[out] SpdEntry Pointer to contain the address of SPD entry on return.\r | |
| 2056 | @param[out] RecycleEvent The event for recycling of resources.\r | |
| 2057 | \r | |
| 2058 | @retval EFI_SUCCESS The operation was successful.\r | |
| 2059 | @retval EFI_UNSUPPORTED The IPSEC protocol is not supported.\r | |
| 2060 | \r | |
| 2061 | **/\r | |
| 2062 | EFI_STATUS\r | |
| 2063 | IpSecProtectInboundPacket (\r | |
| 2064 | IN UINT8 IpVersion,\r | |
| 2065 | IN OUT VOID *IpHead,\r | |
| 2066 | IN OUT UINT8 *LastHead,\r | |
| 47b27101 | 2067 | IN OUT VOID **OptionsBuffer,\r |
| 2068 | IN OUT UINT32 *OptionsLength,\r | |
| 9166f840 | 2069 | IN OUT EFI_IPSEC_FRAGMENT_DATA **FragmentTable,\r |
| 2070 | IN OUT UINT32 *FragmentCount,\r | |
| 2071 | OUT EFI_IPSEC_SPD_SELECTOR **SpdEntry,\r | |
| 2072 | OUT EFI_EVENT *RecycleEvent\r | |
| 2073 | )\r | |
| 2074 | {\r | |
| 2075 | if (*LastHead == IPSEC_ESP_PROTOCOL) {\r | |
| 2076 | //\r | |
| 2077 | // Process the esp ipsec header of the inbound traffic.\r | |
| 2078 | //\r | |
| 2079 | return IpSecEspInboundPacket (\r | |
| 2080 | IpVersion,\r | |
| 2081 | IpHead,\r | |
| 2082 | LastHead,\r | |
| 2083 | OptionsBuffer,\r | |
| 2084 | OptionsLength,\r | |
| 2085 | FragmentTable,\r | |
| 2086 | FragmentCount,\r | |
| 2087 | SpdEntry,\r | |
| 2088 | RecycleEvent\r | |
| 2089 | );\r | |
| 2090 | }\r | |
| 2091 | //\r | |
| 2092 | // The other protocols are not supported.\r | |
| 2093 | //\r | |
| 2094 | return EFI_UNSUPPORTED;\r | |
| 2095 | }\r | |
| 2096 | \r | |
| 2097 | /**\r | |
| 2098 | This fucntion processes the output traffic with IPsec.\r | |
| 2099 | \r | |
| 2100 | It protected the sending packet by encrypting it payload and inserting ESP/AH header\r | |
| 2101 | in the orginal IP header, then return the IpHeader and IPsec protected Fragmentable.\r | |
| 2102 | \r | |
| 2103 | @param[in] IpVersion The version of IP.\r | |
| 2104 | @param[in, out] IpHead Point to IP header containing the orginal IP header\r | |
| 2105 | to be processed on input, and inserted ESP/AH header\r | |
| 2106 | on return.\r | |
| 2107 | @param[in, out] LastHead The Last Header in IP header.\r | |
| 47b27101 | 2108 | @param[in, out] OptionsBuffer Pointer to the options buffer.\r |
| 2109 | @param[in, out] OptionsLength Length of the options buffer.\r | |
| 9166f840 | 2110 | @param[in, out] FragmentTable Pointer to a list of fragments to be protected by\r |
| 2111 | IPsec on input, and with IPsec protected\r | |
| 2112 | on return.\r | |
| 2113 | @param[in, out] FragmentCount Number of fragments.\r | |
| 2114 | @param[in] SadEntry Related SAD entry.\r | |
| 2115 | @param[out] RecycleEvent Event for recycling of resources.\r | |
| 2116 | \r | |
| 2117 | @retval EFI_SUCCESS The operation is successful.\r | |
| 2118 | @retval EFI_UNSUPPORTED If the IPSEC protocol is not supported.\r | |
| 2119 | \r | |
| 2120 | **/\r | |
| 2121 | EFI_STATUS\r | |
| 2122 | IpSecProtectOutboundPacket (\r | |
| 2123 | IN UINT8 IpVersion,\r | |
| 2124 | IN OUT VOID *IpHead,\r | |
| 2125 | IN OUT UINT8 *LastHead,\r | |
| 47b27101 | 2126 | IN OUT VOID **OptionsBuffer,\r |
| 2127 | IN OUT UINT32 *OptionsLength,\r | |
| 9166f840 | 2128 | IN OUT EFI_IPSEC_FRAGMENT_DATA **FragmentTable,\r |
| 2129 | IN OUT UINT32 *FragmentCount,\r | |
| 2130 | IN IPSEC_SAD_ENTRY *SadEntry,\r | |
| 2131 | OUT EFI_EVENT *RecycleEvent\r | |
| 2132 | )\r | |
| 2133 | {\r | |
| 2134 | if (SadEntry->Id->Proto == EfiIPsecESP) {\r | |
| 2135 | //\r | |
| 2136 | // Process the esp ipsec header of the outbound traffic.\r | |
| 2137 | //\r | |
| 2138 | return IpSecEspOutboundPacket (\r | |
| 2139 | IpVersion,\r | |
| 2140 | IpHead,\r | |
| 2141 | LastHead,\r | |
| 2142 | OptionsBuffer,\r | |
| 2143 | OptionsLength,\r | |
| 2144 | FragmentTable,\r | |
| 2145 | FragmentCount,\r | |
| 2146 | SadEntry,\r | |
| 2147 | RecycleEvent\r | |
| 2148 | );\r | |
| 2149 | }\r | |
| 2150 | //\r | |
| 2151 | // The other protocols are not supported.\r | |
| 2152 | //\r | |
| 2153 | return EFI_UNSUPPORTED;\r | |
| 2154 | }\r |