2 Provide IPsec Key Exchange (IKE) service general interfaces.
4 Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "IkeService.h"
17 #include "IpSecConfigImpl.h"
18 #include "Ikev2/Utility.h"
20 IKE_EXCHANGE_INTERFACE
*mIkeExchange
[] = {
25 EFI_UDP4_CONFIG_DATA mUdp4Conf
= {
46 EFI_UDP6_CONFIG_DATA mUdp6Conf
= {
58 {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0},
60 {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0},
65 Check if the NIC handle is binded to a Udp service.
67 @param[in] Private Pointer of IPSEC_PRIVATE_DATA.
68 @param[in] NicHandle The Handle of the NIC card.
69 @param[in] IpVersion The version of the IP stack.
71 @return a pointer of IKE_UDP_SERVICE.
76 IN IPSEC_PRIVATE_DATA
*Private
,
87 Head
= (IpVersion
== IP_VERSION_4
) ? &Private
->Udp4List
: &Private
->Udp6List
;
89 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Head
) {
91 Udp
= IPSEC_UDP_SERVICE_FROM_LIST (Entry
);
93 // Find the right udp service which installed on the appointed NIC handle.
95 if (Handle
== Udp
->NicHandle
) {
106 Configure a UDPIO's UDP4 instance.
108 This fuction is called by the UdpIoCreateIo() to configures a
111 @param[in] UdpIo The UDP_IO to be configured.
112 @param[in] Context User-defined data when calling UdpIoCreateIo().
114 @retval EFI_SUCCESS The configuration succeeded.
115 @retval Others The UDP4 instance fails to configure.
124 EFI_UDP4_CONFIG_DATA Udp4Cfg
;
125 EFI_UDP4_PROTOCOL
*Udp4
;
127 ZeroMem (&Udp4Cfg
, sizeof (EFI_UDP4_CONFIG_DATA
));
129 Udp4
= UdpIo
->Protocol
.Udp4
;
133 sizeof (EFI_UDP4_CONFIG_DATA
)
136 if (Context
!= NULL
) {
138 // Configure udp4 io with local default address.
140 Udp4Cfg
.UseDefaultAddress
= TRUE
;
143 return Udp4
->Configure (Udp4
, &Udp4Cfg
);
147 Configure a UDPIO's UDP6 instance.
149 This fuction is called by the UdpIoCreateIo()to configure a
152 @param[in] UdpIo The UDP_IO to be configured.
153 @param[in] Context User-defined data when calling UdpIoCreateIo().
155 @retval EFI_SUCCESS The configuration succeeded.
156 @retval Others The configuration fails.
165 EFI_UDP6_PROTOCOL
*Udp6
;
166 EFI_UDP6_CONFIG_DATA Udp6Cfg
;
168 ZeroMem (&Udp6Cfg
, sizeof (EFI_UDP6_CONFIG_DATA
));
170 Udp6
= UdpIo
->Protocol
.Udp6
;
174 sizeof (EFI_UDP6_CONFIG_DATA
)
177 if (Context
!= NULL
) {
179 // Configure instance with a destination address to start source address
180 // selection, and then get the configure data from the mode data to store
181 // the source address.
184 &Udp6Cfg
.RemoteAddress
,
186 sizeof (EFI_IPv6_ADDRESS
)
190 return Udp6
->Configure (Udp6
, &Udp6Cfg
);
194 Open and configure the related output UDPIO for IKE packet sending.
196 If the UdpService is not configured, this fuction calls UdpIoCreatIo() to
197 create UDPIO to bind this UdpService for IKE packet sending. If the UdpService
198 has already been configured, then return.
200 @param[in] UdpService The UDP_IO to be configured.
201 @param[in] RemoteIp User-defined data when calling UdpIoCreateIo().
203 @retval EFI_SUCCESS The configuration is successful.
204 @retval Others The configuration fails.
209 IN IKE_UDP_SERVICE
*UdpService
,
210 IN EFI_IP_ADDRESS
*RemoteIp
214 EFI_IP4_CONFIG_PROTOCOL
*Ip4Cfg
;
215 EFI_IP4_IPCONFIG_DATA
*Ip4CfgData
;
217 EFI_IP6_MODE_DATA Ip6ModeData
;
218 EFI_UDP6_PROTOCOL
*Udp6
;
220 Status
= EFI_SUCCESS
;
225 // Check whether the input and output udp io are both configured.
227 if (UdpService
->IsConfigured
) {
231 if (UdpService
->IpVersion
== UDP_IO_UDP4_VERSION
) {
233 // Handle ip4config protocol to get local default address.
235 Status
= gBS
->HandleProtocol (
236 UdpService
->NicHandle
,
237 &gEfiIp4ConfigProtocolGuid
,
241 if (EFI_ERROR (Status
)) {
245 Status
= Ip4Cfg
->GetData (Ip4Cfg
, &BufSize
, NULL
);
247 if (EFI_ERROR (Status
) && Status
!= EFI_BUFFER_TOO_SMALL
) {
251 Ip4CfgData
= AllocateZeroPool (BufSize
);
253 if (Ip4CfgData
== NULL
) {
254 Status
= EFI_OUT_OF_RESOURCES
;
258 Status
= Ip4Cfg
->GetData (Ip4Cfg
, &BufSize
, Ip4CfgData
);
259 if (EFI_ERROR (Status
)) {
264 &UdpService
->DefaultAddress
.v4
,
265 &Ip4CfgData
->StationAddress
,
266 sizeof (EFI_IPv4_ADDRESS
)
270 // Create udp4 io for output with local default address.
272 UdpService
->Output
= UdpIoCreateIo (
273 UdpService
->NicHandle
,
274 UdpService
->ImageHandle
,
277 &UdpService
->DefaultAddress
280 if (UdpService
->Output
== NULL
) {
281 Status
= EFI_OUT_OF_RESOURCES
;
287 // Create udp6 io for output with remote address.
289 UdpService
->Output
= UdpIoCreateIo (
290 UdpService
->NicHandle
,
291 UdpService
->ImageHandle
,
297 if (UdpService
->Output
== NULL
) {
298 Status
= EFI_OUT_OF_RESOURCES
;
302 // Get ip6 mode data to get the result of source address selection.
304 ZeroMem (&Ip6ModeData
, sizeof (EFI_IP6_MODE_DATA
));
306 Udp6
= UdpService
->Output
->Protocol
.Udp6
;
307 Status
= Udp6
->GetModeData (Udp6
, NULL
, &Ip6ModeData
, NULL
, NULL
);
309 if (EFI_ERROR (Status
)) {
310 UdpIoFreeIo (UdpService
->Output
);
314 // Reconfigure udp6 io without remote address.
316 Udp6
->Configure (Udp6
, NULL
);
317 Status
= IkeConfigUdp6 (UdpService
->Output
, NULL
);
320 // Record the selected source address for ipsec process later.
323 &UdpService
->DefaultAddress
.v6
,
324 &Ip6ModeData
.ConfigData
.StationAddress
,
325 sizeof (EFI_IPv6_ADDRESS
)
329 UdpService
->IsConfigured
= TRUE
;
332 if (Ip4CfgData
!= NULL
) {
333 FreePool (Ip4CfgData
);
340 Open and configure a UDPIO of Udp4 for IKE packet receiving.
342 This function is called at the IPsecDriverBinding start. IPsec create a UDP4 and
343 UDP4 IO for each NIC handle.
345 @param[in] Private Point to IPSEC_PRIVATE_DATA
346 @param[in] Controller Handler for NIC card.
348 @retval EFI_SUCCESS The Operation is successful.
349 @retval EFI_OUT_OF_RESOURCE The required system resource can't be allocated.
354 IN IPSEC_PRIVATE_DATA
*Private
,
355 IN EFI_HANDLE Controller
358 IKE_UDP_SERVICE
*Udp4Srv
;
361 // Check whether udp4 io of the controller has already been opened.
363 Udp4Srv
= IkeLookupUdp (Private
, Controller
, IP_VERSION_4
);
365 if (Udp4Srv
!= NULL
) {
366 return EFI_ALREADY_STARTED
;
369 Udp4Srv
= AllocateZeroPool (sizeof (IKE_UDP_SERVICE
));
371 if (Udp4Srv
== NULL
) {
372 return EFI_OUT_OF_RESOURCES
;
375 // Create udp4 io for iutput.
377 Udp4Srv
->Input
= UdpIoCreateIo (
379 Private
->ImageHandle
,
385 if (Udp4Srv
->Input
== NULL
) {
387 return EFI_OUT_OF_RESOURCES
;
390 Udp4Srv
->NicHandle
= Controller
;
391 Udp4Srv
->ImageHandle
= Private
->ImageHandle
;
392 Udp4Srv
->ListHead
= &(Private
->Udp4List
);
393 Udp4Srv
->IpVersion
= UDP_IO_UDP4_VERSION
;
394 Udp4Srv
->IsConfigured
= FALSE
;
396 ZeroMem (&Udp4Srv
->DefaultAddress
, sizeof (EFI_IP_ADDRESS
));
399 // Insert the udp4 io into the list and increase the count.
401 InsertTailList (&Private
->Udp4List
, &Udp4Srv
->List
);
405 UdpIoRecvDatagram (Udp4Srv
->Input
, IkeDispatch
, Udp4Srv
, 0);
411 Open and configure a UDPIO of Udp6 for IKE packet receiving.
413 This function is called at the IPsecDriverBinding start. IPsec create a UDP6 and UDP6
414 IO for each NIC handle.
416 @param[in] Private Point to IPSEC_PRIVATE_DATA
417 @param[in] Controller Handler for NIC card.
419 @retval EFI_SUCCESS The Operation is successful.
420 @retval EFI_OUT_OF_RESOURCE The required system resource can't be allocated.
425 IN IPSEC_PRIVATE_DATA
*Private
,
426 IN EFI_HANDLE Controller
429 IKE_UDP_SERVICE
*Udp6Srv
;
431 Udp6Srv
= IkeLookupUdp (Private
, Controller
, IP_VERSION_6
);
433 if (Udp6Srv
!= NULL
) {
434 return EFI_ALREADY_STARTED
;
437 Udp6Srv
= AllocateZeroPool (sizeof (IKE_UDP_SERVICE
));
439 if (Udp6Srv
== NULL
) {
440 return EFI_OUT_OF_RESOURCES
;
443 // Create udp6 io for input.
445 Udp6Srv
->Input
= UdpIoCreateIo (
447 Private
->ImageHandle
,
453 if (Udp6Srv
->Input
== NULL
) {
455 return EFI_OUT_OF_RESOURCES
;
458 Udp6Srv
->NicHandle
= Controller
;
459 Udp6Srv
->ImageHandle
= Private
->ImageHandle
;
460 Udp6Srv
->ListHead
= &(Private
->Udp6List
);
461 Udp6Srv
->IpVersion
= UDP_IO_UDP6_VERSION
;
462 Udp6Srv
->IsConfigured
= FALSE
;
464 ZeroMem (&Udp6Srv
->DefaultAddress
, sizeof (EFI_IP_ADDRESS
));
467 // Insert the udp6 io into the list and increase the count.
469 InsertTailList (&Private
->Udp6List
, &Udp6Srv
->List
);
473 UdpIoRecvDatagram (Udp6Srv
->Input
, IkeDispatch
, Udp6Srv
, 0);
479 The general interface of starting IPsec Key Exchange.
481 This function is called when a IKE negotiation to start getting a Key.
483 @param[in] UdpService Point to IKE_UDP_SERVICE which will be used for
485 @param[in] SpdEntry Point to the SPD entry related to the IKE negotiation.
486 @param[in] RemoteIp Point to EFI_IP_ADDRESS related to the IKE negotiation.
488 @retval EFI_SUCCESS The Operation is successful.
489 @retval EFI_ACCESS_DENIED No related PAD entry was found.
490 @retval EFI_INVALID_PARAMETER The IKE version is not supported.
495 IN IKE_UDP_SERVICE
*UdpService
,
496 IN IPSEC_SPD_ENTRY
*SpdEntry
,
497 IN EFI_IP_ADDRESS
*RemoteIp
502 IKE_EXCHANGE_INTERFACE
*Exchange
;
503 IPSEC_PRIVATE_DATA
*Private
;
504 IPSEC_PAD_ENTRY
*PadEntry
;
507 Private
= (UdpService
->IpVersion
== IP_VERSION_4
) ?
508 IPSEC_PRIVATE_DATA_FROM_UDP4LIST(UdpService
->ListHead
) :
509 IPSEC_PRIVATE_DATA_FROM_UDP6LIST(UdpService
->ListHead
);
512 // Try to open udp io for output if it hasn't.
514 Status
= IkeOpenOutputUdp (UdpService
, RemoteIp
);
515 if (EFI_ERROR (Status
)) {
519 // Try to find the IKE SA session in the IKEv1 and IKEv2 established SA session list.
521 IkeSaSession
= (UINT8
*) Ikev2SaSessionLookup (&Private
->Ikev2EstablishedList
, RemoteIp
);
524 if (IkeSaSession
== NULL
) {
526 // Find the pad entry by the remote ip address.
528 PadEntry
= IpSecLookupPadEntry (UdpService
->IpVersion
, RemoteIp
);
529 if (PadEntry
== NULL
) {
530 return EFI_ACCESS_DENIED
;
533 // Determine the IKE exchange instance by the auth protocol in pad entry.
535 ASSERT (PadEntry
->Data
->AuthProtocol
< EfiIPsecAuthProtocolMaximum
);
536 if (PadEntry
->Data
->AuthProtocol
== EfiIPsecAuthProtocolIKEv1
) {
537 return EFI_INVALID_PARAMETER
;
539 Exchange
= mIkeExchange
[PadEntry
->Data
->AuthProtocol
];
541 // Start the main mode stage to negotiate IKE SA.
543 Status
= Exchange
->NegotiateSa (UdpService
, SpdEntry
, PadEntry
, RemoteIp
);
546 // Determine the IKE exchange instance by the IKE version in IKE SA session.
548 IkeVersion
= IkeGetVersionFromSession (IkeSaSession
);
549 if (IkeVersion
!= 2) {
550 return EFI_INVALID_PARAMETER
;
553 Exchange
= mIkeExchange
[IkeVersion
- 1];
555 // Start the quick mode stage to negotiate child SA.
557 Status
= Exchange
->NegotiateChildSa (IkeSaSession
, SpdEntry
, NULL
);
564 The generic interface when receive a IKE packet.
566 This function is called when UDP IO receives a IKE packet.
568 @param[in] Packet Point to received IKE packet.
569 @param[in] EndPoint Point to UDP_END_POINT which contains the information of
571 @param[in] IoStatus The Status of Recieve Token.
572 @param[in] Context Point to data passed from the caller.
578 IN UDP_END_POINT
*EndPoint
,
579 IN EFI_STATUS IoStatus
,
583 IPSEC_PRIVATE_DATA
*Private
;
584 IKE_PACKET
*IkePacket
;
586 IKE_UDP_SERVICE
*UdpService
;
587 IKE_EXCHANGE_INTERFACE
*Exchange
;
590 UdpService
= (IKE_UDP_SERVICE
*) Context
;
592 Private
= (UdpService
->IpVersion
== IP_VERSION_4
) ?
593 IPSEC_PRIVATE_DATA_FROM_UDP4LIST(UdpService
->ListHead
) :
594 IPSEC_PRIVATE_DATA_FROM_UDP6LIST(UdpService
->ListHead
);
596 if (EFI_ERROR (IoStatus
)) {
600 // Check whether the ipsec is enabled or not.
602 if (Private
->IpSec
.DisabledFlag
== TRUE
) {
606 if (EndPoint
->RemotePort
!= IKE_DEFAULT_PORT
) {
611 // Build IKE packet from the received netbuf.
613 IkePacket
= IkePacketFromNetbuf (Packet
);
615 if (IkePacket
== NULL
) {
619 // Get the remote address from the IKE packet.
621 if (UdpService
->IpVersion
== IP_VERSION_4
) {
622 *(UINT32
*) IkePacket
->RemotePeerIp
.Addr
= HTONL ((*(UINT32
*) EndPoint
->RemoteAddr
.Addr
));
625 &IkePacket
->RemotePeerIp
,
626 NTOHLLL (&EndPoint
->RemoteAddr
.v6
),
627 sizeof (EFI_IPv6_ADDRESS
)
631 // Try to open udp io for output if hasn't.
633 Status
= IkeOpenOutputUdp (UdpService
, &IkePacket
->RemotePeerIp
);
635 if (EFI_ERROR (Status
)) {
639 IkeHdr
= IkePacket
->Header
;
642 // Determine the IKE exchange instance by the IKE version in IKE header.
644 if (IKE_MAJOR_VERSION (IkeHdr
->Version
) == 2) {
645 Exchange
= mIkeExchange
[IKE_MAJOR_VERSION (IkeHdr
->Version
) - 1];
650 switch (IkeHdr
->ExchangeType
) {
651 case IKE_XCG_TYPE_IDENTITY_PROTECT
:
652 case IKE_XCG_TYPE_SA_INIT
:
653 case IKE_XCG_TYPE_AUTH
:
654 Exchange
->HandleSa (UdpService
, IkePacket
);
657 case IKE_XCG_TYPE_QM
:
658 case IKE_XCG_TYPE_CREATE_CHILD_SA
:
659 Exchange
->HandleChildSa (UdpService
, IkePacket
);
662 case IKE_XCG_TYPE_INFO
:
663 case IKE_XCG_TYPE_INFO2
:
664 Exchange
->HandleInfo (UdpService
, IkePacket
);
672 if (IkePacket
!= NULL
) {
673 IkePacketFree (IkePacket
);
676 if (Packet
!= NULL
) {
680 UdpIoRecvDatagram (UdpService
->Input
, IkeDispatch
, UdpService
, 0);
686 Delete all established IKE SAs and related Child SAs.
688 This function is the subfunction of the IpSecCleanupAllSa(). It first calls
689 IkeDeleteChildSa() to delete all Child SAs then send out the related
692 @param[in] Private Pointer of the IPSEC_PRIVATE_DATA
697 IN IPSEC_PRIVATE_DATA
*Private
701 LIST_ENTRY
*NextEntry
;
702 IKEV2_SA_SESSION
*Ikev2SaSession
;
705 IKE_EXCHANGE_INTERFACE
*Exchange
;
711 // If the IKEv1 is supported, first deal with the Ikev1Estatblished list.
715 // If IKEv2 SAs are under establishing, delete it directly.
717 if (!IsListEmpty (&Private
->Ikev2SessionList
)) {
718 NET_LIST_FOR_EACH_SAFE (Entry
, NextEntry
, &Private
->Ikev2SessionList
) {
719 Ikev2SaSession
= IKEV2_SA_SESSION_BY_SESSION (Entry
);
720 RemoveEntryList (Entry
);
721 Ikev2SaSessionFree (Ikev2SaSession
);
726 // If there is no existing established IKE SA, set the Ipsec DisableFlag to TRUE
727 // and turn off the IsIPsecDisabling flag.
729 if (IsListEmpty (&Private
->Ikev2EstablishedList
)) {
730 Value
= IPSEC_STATUS_DISABLED
;
731 Status
= gRT
->SetVariable (
732 IPSECCONFIG_STATUS_NAME
,
733 &gEfiIpSecConfigProtocolGuid
,
734 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
738 if (!EFI_ERROR (Status
)) {
739 Private
->IpSec
.DisabledFlag
= TRUE
;
740 Private
->IsIPsecDisabling
= FALSE
;
746 // Delete established IKEv2 SAs.
748 if (!IsListEmpty (&Private
->Ikev2EstablishedList
)) {
749 for (Entry
= Private
->Ikev2EstablishedList
.ForwardLink
; Entry
!= &Private
->Ikev2EstablishedList
;) {
750 Ikev2SaSession
= IKEV2_SA_SESSION_BY_SESSION (Entry
);
751 Entry
= Entry
->ForwardLink
;
753 Ikev2SaSession
->SessionCommon
.State
= IkeStateSaDeleting
;
756 // Call for Information Exchange.
758 IkeVersion
= IkeGetVersionFromSession ((UINT8
*)Ikev2SaSession
);
759 if (IkeVersion
== 2) {
760 Exchange
= mIkeExchange
[IkeVersion
- 1];
761 Exchange
->NegotiateInfo((UINT8
*)Ikev2SaSession
, NULL
);