2 Provide IPsec Key Exchange (IKE) service general interfaces.
4 Copyright (c) 2010 - 2015, 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"
19 IKE_EXCHANGE_INTERFACE
*mIkeExchange
[] = {
24 EFI_UDP4_CONFIG_DATA mUdp4Conf
= {
45 EFI_UDP6_CONFIG_DATA mUdp6Conf
= {
57 {{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}},
59 {{0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0}},
64 Check if the NIC handle is binded to a Udp service.
66 @param[in] Private Pointer of IPSEC_PRIVATE_DATA.
67 @param[in] Handle The Handle of the NIC card.
68 @param[in] IpVersion The version of the IP stack.
70 @return a pointer of IKE_UDP_SERVICE.
75 IN IPSEC_PRIVATE_DATA
*Private
,
86 Head
= (IpVersion
== IP_VERSION_4
) ? &Private
->Udp4List
: &Private
->Udp6List
;
88 NET_LIST_FOR_EACH_SAFE (Entry
, Next
, Head
) {
90 Udp
= IPSEC_UDP_SERVICE_FROM_LIST (Entry
);
92 // Find the right udp service which installed on the appointed NIC handle.
94 if (Handle
== Udp
->NicHandle
) {
105 Configure a UDPIO's UDP4 instance.
107 This fuction is called by the UdpIoCreateIo() to configures a
110 @param[in] UdpIo The UDP_IO to be configured.
111 @param[in] Context User-defined data when calling UdpIoCreateIo().
113 @retval EFI_SUCCESS The configuration succeeded.
114 @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.
166 EFI_UDP6_PROTOCOL
*Udp6
;
167 EFI_UDP6_CONFIG_DATA Udp6Cfg
;
169 ZeroMem (&Udp6Cfg
, sizeof (EFI_UDP6_CONFIG_DATA
));
171 Udp6
= UdpIo
->Protocol
.Udp6
;
175 sizeof (EFI_UDP6_CONFIG_DATA
)
178 if (Context
!= NULL
) {
180 // Configure instance with a destination address to start source address
181 // selection, and then get the configure data from the mode data to store
182 // the source address.
185 &Udp6Cfg
.RemoteAddress
,
187 sizeof (EFI_IPv6_ADDRESS
)
191 return Udp6
->Configure (Udp6
, &Udp6Cfg
);
195 Open and configure the related output UDPIO for IKE packet sending.
197 If the UdpService is not configured, this fuction calls UdpIoCreatIo() to
198 create UDPIO to bind this UdpService for IKE packet sending. If the UdpService
199 has already been configured, then return.
201 @param[in] UdpService The UDP_IO to be configured.
202 @param[in] RemoteIp User-defined data when calling UdpIoCreateIo().
204 @retval EFI_SUCCESS The configuration is successful.
205 @retval Others The configuration fails.
210 IN IKE_UDP_SERVICE
*UdpService
,
211 IN EFI_IP_ADDRESS
*RemoteIp
215 EFI_IP4_CONFIG2_PROTOCOL
*Ip4Cfg2
;
216 EFI_IP4_CONFIG2_INTERFACE_INFO
*IfInfo
;
218 EFI_IP6_MODE_DATA Ip6ModeData
;
219 EFI_UDP6_PROTOCOL
*Udp6
;
221 Status
= EFI_SUCCESS
;
226 // Check whether the input and output udp io are both configured.
228 if (UdpService
->IsConfigured
) {
232 if (UdpService
->IpVersion
== UDP_IO_UDP4_VERSION
) {
234 // Handle ip4config protocol to get local default address.
236 Status
= gBS
->HandleProtocol (
237 UdpService
->NicHandle
,
238 &gEfiIp4Config2ProtocolGuid
,
242 if (EFI_ERROR (Status
)) {
247 // Get the interface information size.
249 Status
= Ip4Cfg2
->GetData (
251 Ip4Config2DataTypeInterfaceInfo
,
256 if (EFI_ERROR (Status
) && Status
!= EFI_BUFFER_TOO_SMALL
) {
260 IfInfo
= AllocateZeroPool (BufSize
);
262 if (IfInfo
== NULL
) {
263 Status
= EFI_OUT_OF_RESOURCES
;
268 // Get the interface info.
270 Status
= Ip4Cfg2
->GetData (
272 Ip4Config2DataTypeInterfaceInfo
,
277 if (EFI_ERROR (Status
)) {
282 &UdpService
->DefaultAddress
.v4
,
283 &IfInfo
->StationAddress
,
284 sizeof (EFI_IPv4_ADDRESS
)
288 // Create udp4 io for output with local default address.
290 UdpService
->Output
= UdpIoCreateIo (
291 UdpService
->NicHandle
,
292 UdpService
->ImageHandle
,
295 &UdpService
->DefaultAddress
298 if (UdpService
->Output
== NULL
) {
299 Status
= EFI_OUT_OF_RESOURCES
;
305 // Create udp6 io for output with remote address.
307 UdpService
->Output
= UdpIoCreateIo (
308 UdpService
->NicHandle
,
309 UdpService
->ImageHandle
,
315 if (UdpService
->Output
== NULL
) {
316 Status
= EFI_OUT_OF_RESOURCES
;
320 // Get ip6 mode data to get the result of source address selection.
322 ZeroMem (&Ip6ModeData
, sizeof (EFI_IP6_MODE_DATA
));
324 Udp6
= UdpService
->Output
->Protocol
.Udp6
;
325 Status
= Udp6
->GetModeData (Udp6
, NULL
, &Ip6ModeData
, NULL
, NULL
);
327 if (EFI_ERROR (Status
)) {
328 UdpIoFreeIo (UdpService
->Output
);
332 // Reconfigure udp6 io without remote address.
334 Udp6
->Configure (Udp6
, NULL
);
335 Status
= IkeConfigUdp6 (UdpService
->Output
, NULL
);
338 // Record the selected source address for ipsec process later.
341 &UdpService
->DefaultAddress
.v6
,
342 &Ip6ModeData
.ConfigData
.StationAddress
,
343 sizeof (EFI_IPv6_ADDRESS
)
347 UdpService
->IsConfigured
= TRUE
;
350 if (IfInfo
!= NULL
) {
358 Open and configure a UDPIO of Udp4 for IKE packet receiving.
360 This function is called at the IPsecDriverBinding start. IPsec create a UDP4 and
361 UDP4 IO for each NIC handle.
363 @param[in] Private Point to IPSEC_PRIVATE_DATA
364 @param[in] Controller Handler for NIC card.
365 @param[in] ImageHandle The handle that contains the EFI_DRIVER_BINDING_PROTOCOL instance.
367 @retval EFI_SUCCESS The Operation is successful.
368 @retval EFI_OUT_OF_RESOURCE The required system resource can't be allocated.
373 IN IPSEC_PRIVATE_DATA
*Private
,
374 IN EFI_HANDLE Controller
,
375 IN EFI_HANDLE ImageHandle
378 IKE_UDP_SERVICE
*Udp4Srv
;
381 // Check whether udp4 io of the controller has already been opened.
383 Udp4Srv
= IkeLookupUdp (Private
, Controller
, IP_VERSION_4
);
385 if (Udp4Srv
!= NULL
) {
386 return EFI_ALREADY_STARTED
;
389 Udp4Srv
= AllocateZeroPool (sizeof (IKE_UDP_SERVICE
));
391 if (Udp4Srv
== NULL
) {
392 return EFI_OUT_OF_RESOURCES
;
395 // Create udp4 io for iutput.
397 Udp4Srv
->Input
= UdpIoCreateIo (
405 if (Udp4Srv
->Input
== NULL
) {
407 return EFI_OUT_OF_RESOURCES
;
410 Udp4Srv
->NicHandle
= Controller
;
411 Udp4Srv
->ImageHandle
= ImageHandle
;
412 Udp4Srv
->ListHead
= &(Private
->Udp4List
);
413 Udp4Srv
->IpVersion
= UDP_IO_UDP4_VERSION
;
414 Udp4Srv
->IsConfigured
= FALSE
;
416 ZeroMem (&Udp4Srv
->DefaultAddress
, sizeof (EFI_IP_ADDRESS
));
419 // Insert the udp4 io into the list and increase the count.
421 InsertTailList (&Private
->Udp4List
, &Udp4Srv
->List
);
425 UdpIoRecvDatagram (Udp4Srv
->Input
, IkeDispatch
, Udp4Srv
, 0);
431 Open and configure a UDPIO of Udp6 for IKE packet receiving.
433 This function is called at the IPsecDriverBinding start. IPsec create a UDP6 and UDP6
434 IO for each NIC handle.
436 @param[in] Private Point to IPSEC_PRIVATE_DATA
437 @param[in] Controller Handler for NIC card.
438 @param[in] ImageHandle The handle that contains the EFI_DRIVER_BINDING_PROTOCOL instance.
440 @retval EFI_SUCCESS The Operation is successful.
441 @retval EFI_OUT_OF_RESOURCE The required system resource can't be allocated.
446 IN IPSEC_PRIVATE_DATA
*Private
,
447 IN EFI_HANDLE Controller
,
448 IN EFI_HANDLE ImageHandle
451 IKE_UDP_SERVICE
*Udp6Srv
;
453 Udp6Srv
= IkeLookupUdp (Private
, Controller
, IP_VERSION_6
);
455 if (Udp6Srv
!= NULL
) {
456 return EFI_ALREADY_STARTED
;
459 Udp6Srv
= AllocateZeroPool (sizeof (IKE_UDP_SERVICE
));
461 if (Udp6Srv
== NULL
) {
462 return EFI_OUT_OF_RESOURCES
;
465 // Create udp6 io for input.
467 Udp6Srv
->Input
= UdpIoCreateIo (
475 if (Udp6Srv
->Input
== NULL
) {
477 return EFI_OUT_OF_RESOURCES
;
480 Udp6Srv
->NicHandle
= Controller
;
481 Udp6Srv
->ImageHandle
= ImageHandle
;
482 Udp6Srv
->ListHead
= &(Private
->Udp6List
);
483 Udp6Srv
->IpVersion
= UDP_IO_UDP6_VERSION
;
484 Udp6Srv
->IsConfigured
= FALSE
;
486 ZeroMem (&Udp6Srv
->DefaultAddress
, sizeof (EFI_IP_ADDRESS
));
489 // Insert the udp6 io into the list and increase the count.
491 InsertTailList (&Private
->Udp6List
, &Udp6Srv
->List
);
495 UdpIoRecvDatagram (Udp6Srv
->Input
, IkeDispatch
, Udp6Srv
, 0);
501 The general interface of starting IPsec Key Exchange.
503 This function is called when a IKE negotiation to start getting a Key.
505 @param[in] UdpService Point to IKE_UDP_SERVICE which will be used for
507 @param[in] SpdEntry Point to the SPD entry related to the IKE negotiation.
508 @param[in] RemoteIp Point to EFI_IP_ADDRESS related to the IKE negotiation.
510 @retval EFI_SUCCESS The Operation is successful.
511 @retval EFI_ACCESS_DENIED No related PAD entry was found.
512 @retval EFI_INVALID_PARAMETER The IKE version is not supported.
517 IN IKE_UDP_SERVICE
*UdpService
,
518 IN IPSEC_SPD_ENTRY
*SpdEntry
,
519 IN EFI_IP_ADDRESS
*RemoteIp
524 IKE_EXCHANGE_INTERFACE
*Exchange
;
525 IPSEC_PRIVATE_DATA
*Private
;
526 IPSEC_PAD_ENTRY
*PadEntry
;
529 Private
= (UdpService
->IpVersion
== IP_VERSION_4
) ?
530 IPSEC_PRIVATE_DATA_FROM_UDP4LIST(UdpService
->ListHead
) :
531 IPSEC_PRIVATE_DATA_FROM_UDP6LIST(UdpService
->ListHead
);
534 // Try to open udp io for output if it hasn't.
536 Status
= IkeOpenOutputUdp (UdpService
, RemoteIp
);
537 if (EFI_ERROR (Status
)) {
541 // Try to find the IKE SA session in the IKEv1 and IKEv2 established SA session list.
543 IkeSaSession
= (UINT8
*) Ikev2SaSessionLookup (&Private
->Ikev2EstablishedList
, RemoteIp
);
546 if (IkeSaSession
== NULL
) {
548 // Find the pad entry by the remote ip address.
550 PadEntry
= IpSecLookupPadEntry (UdpService
->IpVersion
, RemoteIp
);
551 if (PadEntry
== NULL
) {
552 return EFI_ACCESS_DENIED
;
555 // Determine the IKE exchange instance by the auth protocol in pad entry.
557 ASSERT (PadEntry
->Data
->AuthProtocol
< EfiIPsecAuthProtocolMaximum
);
558 if (PadEntry
->Data
->AuthProtocol
== EfiIPsecAuthProtocolIKEv1
) {
559 return EFI_INVALID_PARAMETER
;
561 Exchange
= mIkeExchange
[PadEntry
->Data
->AuthProtocol
];
563 // Start the main mode stage to negotiate IKE SA.
565 Status
= Exchange
->NegotiateSa (UdpService
, SpdEntry
, PadEntry
, RemoteIp
);
568 // Determine the IKE exchange instance by the IKE version in IKE SA session.
570 IkeVersion
= IkeGetVersionFromSession (IkeSaSession
);
571 if (IkeVersion
!= 2) {
572 return EFI_INVALID_PARAMETER
;
575 Exchange
= mIkeExchange
[IkeVersion
- 1];
577 // Start the quick mode stage to negotiate child SA.
579 Status
= Exchange
->NegotiateChildSa (IkeSaSession
, SpdEntry
, NULL
);
586 The generic interface when receive a IKE packet.
588 This function is called when UDP IO receives a IKE packet.
590 @param[in] Packet Point to received IKE packet.
591 @param[in] EndPoint Point to UDP_END_POINT which contains the information of
593 @param[in] IoStatus The Status of Recieve Token.
594 @param[in] Context Point to data passed from the caller.
601 IN UDP_END_POINT
*EndPoint
,
602 IN EFI_STATUS IoStatus
,
606 IPSEC_PRIVATE_DATA
*Private
;
607 IKE_PACKET
*IkePacket
;
609 IKE_UDP_SERVICE
*UdpService
;
610 IKE_EXCHANGE_INTERFACE
*Exchange
;
613 UdpService
= (IKE_UDP_SERVICE
*) Context
;
615 Private
= (UdpService
->IpVersion
== IP_VERSION_4
) ?
616 IPSEC_PRIVATE_DATA_FROM_UDP4LIST(UdpService
->ListHead
) :
617 IPSEC_PRIVATE_DATA_FROM_UDP6LIST(UdpService
->ListHead
);
619 if (EFI_ERROR (IoStatus
)) {
623 // Check whether the ipsec is enabled or not.
625 if (Private
->IpSec
.DisabledFlag
== TRUE
) {
629 if (EndPoint
->RemotePort
!= IKE_DEFAULT_PORT
) {
634 // Build IKE packet from the received netbuf.
636 IkePacket
= IkePacketFromNetbuf (Packet
);
638 if (IkePacket
== NULL
) {
642 // Get the remote address from the IKE packet.
644 if (UdpService
->IpVersion
== IP_VERSION_4
) {
645 *(UINT32
*) IkePacket
->RemotePeerIp
.Addr
= HTONL ((*(UINT32
*) EndPoint
->RemoteAddr
.Addr
));
648 &IkePacket
->RemotePeerIp
,
649 NTOHLLL (&EndPoint
->RemoteAddr
.v6
),
650 sizeof (EFI_IPv6_ADDRESS
)
654 // Try to open udp io for output if hasn't.
656 Status
= IkeOpenOutputUdp (UdpService
, &IkePacket
->RemotePeerIp
);
658 if (EFI_ERROR (Status
)) {
662 IkeHdr
= IkePacket
->Header
;
665 // Determine the IKE exchange instance by the IKE version in IKE header.
667 if (IKE_MAJOR_VERSION (IkeHdr
->Version
) == 2) {
668 Exchange
= mIkeExchange
[IKE_MAJOR_VERSION (IkeHdr
->Version
) - 1];
673 switch (IkeHdr
->ExchangeType
) {
674 case IKE_XCG_TYPE_IDENTITY_PROTECT
:
675 case IKE_XCG_TYPE_SA_INIT
:
676 case IKE_XCG_TYPE_AUTH
:
677 Exchange
->HandleSa (UdpService
, IkePacket
);
680 case IKE_XCG_TYPE_QM
:
681 case IKE_XCG_TYPE_CREATE_CHILD_SA
:
682 Exchange
->HandleChildSa (UdpService
, IkePacket
);
685 case IKE_XCG_TYPE_INFO
:
686 case IKE_XCG_TYPE_INFO2
:
687 Exchange
->HandleInfo (UdpService
, IkePacket
);
695 if (IkePacket
!= NULL
) {
696 IkePacketFree (IkePacket
);
699 if (Packet
!= NULL
) {
703 UdpIoRecvDatagram (UdpService
->Input
, IkeDispatch
, UdpService
, 0);
709 Delete all established IKE SAs and related Child SAs.
711 This function is the subfunction of the IpSecCleanupAllSa(). It first calls
712 IkeDeleteChildSa() to delete all Child SAs then send out the related
715 @param[in] Private Pointer of the IPSEC_PRIVATE_DATA
716 @param[in] IsDisableIpsec Indicate whether needs to disable IPsec.
721 IN IPSEC_PRIVATE_DATA
*Private
,
722 IN BOOLEAN IsDisableIpsec
726 LIST_ENTRY
*NextEntry
;
727 IKEV2_SA_SESSION
*Ikev2SaSession
;
730 IKE_EXCHANGE_INTERFACE
*Exchange
;
736 // If the IKEv1 is supported, first deal with the Ikev1Estatblished list.
740 // If IKEv2 SAs are under establishing, delete it directly.
742 if (!IsListEmpty (&Private
->Ikev2SessionList
)) {
743 NET_LIST_FOR_EACH_SAFE (Entry
, NextEntry
, &Private
->Ikev2SessionList
) {
744 Ikev2SaSession
= IKEV2_SA_SESSION_BY_SESSION (Entry
);
745 RemoveEntryList (Entry
);
746 Ikev2SaSessionFree (Ikev2SaSession
);
751 // If there is no existing established IKE SA, set the Ipsec DisableFlag to TRUE
752 // and turn off the IsIPsecDisabling flag.
754 if (IsListEmpty (&Private
->Ikev2EstablishedList
) && IsDisableIpsec
) {
755 Value
= IPSEC_STATUS_DISABLED
;
756 Status
= gRT
->SetVariable (
757 IPSECCONFIG_STATUS_NAME
,
758 &gEfiIpSecConfigProtocolGuid
,
759 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
763 if (!EFI_ERROR (Status
)) {
764 Private
->IpSec
.DisabledFlag
= TRUE
;
765 Private
->IsIPsecDisabling
= FALSE
;
771 // Delete established IKEv2 SAs.
773 if (!IsListEmpty (&Private
->Ikev2EstablishedList
)) {
774 for (Entry
= Private
->Ikev2EstablishedList
.ForwardLink
; Entry
!= &Private
->Ikev2EstablishedList
;) {
775 Ikev2SaSession
= IKEV2_SA_SESSION_BY_SESSION (Entry
);
776 Entry
= Entry
->ForwardLink
;
778 Ikev2SaSession
->SessionCommon
.State
= IkeStateSaDeleting
;
781 // Call for Information Exchange.
783 IkeVersion
= IkeGetVersionFromSession ((UINT8
*)Ikev2SaSession
);
784 if (IkeVersion
== 2) {
785 Exchange
= mIkeExchange
[IkeVersion
- 1];
786 Exchange
->NegotiateInfo((UINT8
*)Ikev2SaSession
, NULL
);