]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/IpSecDxe/Ikev2/Utility.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
NetworkPkg: Fix hang issue after system reconnected when IPSec has set up
[mirror_edk2.git] / NetworkPkg / IpSecDxe / Ikev2 / Utility.c
CommitLineData
9166f840 1/** @file\r
2 The Common operations used by IKE Exchange Process.\r
3\r
e8837edd 4 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
5dd08a46 5 Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>\r
9166f840 6\r
7 This program and the accompanying materials\r
8 are licensed and made available under the terms and conditions of the BSD License\r
9 which accompanies this distribution. The full text of the license may be found at\r
10 http://opensource.org/licenses/bsd-license.php.\r
11\r
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15**/\r
16\r
17#include "Utility.h"\r
18#include "IpSecDebug.h"\r
19#include "IkeService.h"\r
20#include "IpSecConfigImpl.h"\r
21\r
22UINT16 mIkev2EncryptAlgorithmList[IKEV2_SUPPORT_ENCRYPT_ALGORITHM_NUM] = {\r
23 IKEV2_TRANSFORM_ID_ENCR_3DES,\r
24 IKEV2_TRANSFORM_ID_ENCR_AES_CBC, \r
25};\r
26\r
27UINT16 mIkev2PrfAlgorithmList[IKEV2_SUPPORT_PRF_ALGORITHM_NUM] = {\r
28 IKEV2_TRANSFORM_ID_PRF_HMAC_SHA1,\r
29};\r
30\r
31UINT16 mIkev2DhGroupAlgorithmList[IKEV2_SUPPORT_DH_ALGORITHM_NUM] = {\r
32 IKEV2_TRANSFORM_ID_DH_1024MODP,\r
33 IKEV2_TRANSFORM_ID_DH_2048MODP,\r
34};\r
35\r
36UINT16 mIkev2AuthAlgorithmList[IKEV2_SUPPORT_AUTH_ALGORITHM_NUM] = {\r
37 IKEV2_TRANSFORM_ID_AUTH_HMAC_SHA1_96,\r
38};\r
39\r
40/**\r
41 Allocate buffer for IKEV2_SA_SESSION and initialize it.\r
42\r
43 @param[in] Private Pointer to IPSEC_PRIVATE_DATA.\r
44 @param[in] UdpService Pointer to IKE_UDP_SERVICE related to this IKE SA Session.\r
45\r
46 @return Pointer to IKEV2_SA_SESSION or NULL.\r
47\r
48**/\r
49IKEV2_SA_SESSION *\r
50Ikev2SaSessionAlloc (\r
51 IN IPSEC_PRIVATE_DATA *Private,\r
52 IN IKE_UDP_SERVICE *UdpService\r
53 )\r
54{\r
55 EFI_STATUS Status;\r
56 IKEV2_SESSION_COMMON *SessionCommon;\r
57 IKEV2_SA_SESSION *IkeSaSession;\r
58\r
59 IkeSaSession = AllocateZeroPool (sizeof (IKEV2_SA_SESSION));\r
60 ASSERT (IkeSaSession != NULL);\r
61\r
62 //\r
63 // Initialize the fields of IkeSaSession and its SessionCommon.\r
64 //\r
65 IkeSaSession->NCookie = NULL;\r
66 IkeSaSession->Signature = IKEV2_SA_SESSION_SIGNATURE;\r
67 IkeSaSession->InitiatorCookie = IkeGenerateCookie ();\r
68 IkeSaSession->ResponderCookie = 0;\r
69 //\r
70 // BUGBUG: Message ID starts from 2 is to match the OpenSwan requirement, but it \r
71 // might not match the IPv6 Logo. In its test specification, it mentions that\r
72 // the Message ID should start from zero after the IKE_SA_INIT exchange.\r
73 //\r
74 IkeSaSession->MessageId = 2;\r
75 SessionCommon = &IkeSaSession->SessionCommon;\r
76 SessionCommon->UdpService = UdpService;\r
77 SessionCommon->Private = Private;\r
78 SessionCommon->IkeSessionType = IkeSessionTypeIkeSa;\r
79 SessionCommon->IkeVer = 2;\r
80 SessionCommon->AfterEncodePayload = NULL;\r
81 SessionCommon->BeforeDecodePayload = NULL;\r
82\r
83 //\r
84 // Create a resend notfiy event for retry.\r
85 //\r
86 Status = gBS->CreateEvent (\r
87 EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
88 TPL_CALLBACK,\r
89 Ikev2ResendNotify,\r
90 SessionCommon,\r
91 &SessionCommon->TimeoutEvent\r
92 );\r
93\r
94 if (EFI_ERROR (Status)) {\r
95 FreePool (IkeSaSession);\r
96 return NULL;\r
97 }\r
98\r
99 //\r
100 // Initialize the lists in IkeSaSession.\r
101 //\r
102 InitializeListHead (&IkeSaSession->ChildSaSessionList);\r
103 InitializeListHead (&IkeSaSession->ChildSaEstablishSessionList);\r
104 InitializeListHead (&IkeSaSession->InfoMIDList);\r
105 InitializeListHead (&IkeSaSession->DeleteSaList);\r
106\r
107 return IkeSaSession;\r
108}\r
109\r
110/**\r
111 Register the established IKEv2 SA into Private->Ikev2EstablishedList. If there is\r
112 IKEV2_SA_SESSION with same remote peer IP, remove the old one then register the\r
113 new one.\r
114\r
115 @param[in] IkeSaSession Pointer to IKEV2_SA_SESSION to be registered.\r
116 @param[in] Private Pointer to IPSEC_PRAVATE_DATA.\r
117\r
118**/\r
119VOID\r
120Ikev2SaSessionReg (\r
121 IN IKEV2_SA_SESSION *IkeSaSession,\r
122 IN IPSEC_PRIVATE_DATA *Private\r
123 )\r
124{\r
125 IKEV2_SESSION_COMMON *SessionCommon;\r
126 IKEV2_SA_SESSION *OldIkeSaSession;\r
127 EFI_STATUS Status;\r
128 UINT64 Lifetime;\r
129\r
130 //\r
131 // Keep IKE SA exclusive to remote ip address.\r
132 //\r
133 SessionCommon = &IkeSaSession->SessionCommon;\r
134 OldIkeSaSession = Ikev2SaSessionRemove (&Private->Ikev2EstablishedList, &SessionCommon->RemotePeerIp);\r
135 if (OldIkeSaSession != NULL) {\r
136 //\r
137 // TODO: It should delete all child SAs if rekey the IKE SA.\r
138 //\r
139 Ikev2SaSessionFree (OldIkeSaSession);\r
140 }\r
141\r
142 //\r
143 // Cleanup the fields of SessionCommon for processing.\r
144 // \r
145 Ikev2SessionCommonRefresh (SessionCommon);\r
146\r
147 //\r
148 // Insert the ready IKE SA session into established list.\r
149 //\r
150 Ikev2SaSessionInsert (&Private->Ikev2EstablishedList, IkeSaSession, &SessionCommon->RemotePeerIp);\r
151\r
152 //\r
153 // Create a notfiy event for the IKE SA life time counting.\r
154 //\r
155 Status = gBS->CreateEvent (\r
156 EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
157 TPL_CALLBACK,\r
158 Ikev2LifetimeNotify,\r
159 SessionCommon,\r
160 &SessionCommon->TimeoutEvent\r
161 );\r
162 if (EFI_ERROR(Status)){\r
163 //\r
164 // If TimerEvent creation failed, the SA will be alive untill user disable it or \r
165 // receiving a Delete Payload from peer. \r
166 //\r
167 return;\r
168 }\r
169\r
170 //\r
171 // Start to count the lifetime of the IKE SA.\r
172 //\r
173 if (IkeSaSession->Spd->Data->ProcessingPolicy->SaLifetime.HardLifetime == 0) {\r
174 Lifetime = IKE_SA_DEFAULT_LIFETIME;\r
175 } else {\r
176 Lifetime = IkeSaSession->Spd->Data->ProcessingPolicy->SaLifetime.HardLifetime;\r
177 }\r
178 \r
179 Status = gBS->SetTimer (\r
180 SessionCommon->TimeoutEvent,\r
181 TimerRelative,\r
182 MultU64x32(Lifetime, 10000000) // ms->100ns\r
183 );\r
184 if (EFI_ERROR(Status)){\r
185 //\r
186 // If SetTimer failed, the SA will be alive untill user disable it or \r
187 // receiving a Delete Payload from peer. \r
188 //\r
189 return ;\r
190 }\r
191\r
192 DEBUG ((\r
193 DEBUG_INFO,\r
194 "\n------IkeSa established and start to count down %d seconds lifetime\n",\r
195 Lifetime\r
196 ));\r
197\r
198 return ;\r
199}\r
200\r
201/**\r
202 Find a IKEV2_SA_SESSION by the remote peer IP.\r
203\r
204 @param[in] SaSessionList SaSession List to be searched.\r
205 @param[in] RemotePeerIp Pointer to specified IP address.\r
206\r
207 @return Pointer to IKEV2_SA_SESSION if find one or NULL.\r
208\r
209**/\r
210IKEV2_SA_SESSION *\r
211Ikev2SaSessionLookup (\r
212 IN LIST_ENTRY *SaSessionList,\r
213 IN EFI_IP_ADDRESS *RemotePeerIp\r
214 )\r
215{\r
216 LIST_ENTRY *Entry;\r
217 IKEV2_SA_SESSION *IkeSaSession;\r
218\r
219 NET_LIST_FOR_EACH (Entry, SaSessionList) {\r
220 IkeSaSession = IKEV2_SA_SESSION_BY_SESSION (Entry);\r
221\r
222 if (CompareMem (\r
223 &IkeSaSession->SessionCommon.RemotePeerIp,\r
224 RemotePeerIp,\r
225 sizeof (EFI_IP_ADDRESS)\r
226 ) == 0) {\r
227\r
228 return IkeSaSession;\r
229 }\r
230 }\r
231\r
232 return NULL;\r
233}\r
234\r
235/**\r
236 Insert a IKE_SA_SESSION into IkeSaSession list. The IkeSaSession list is either\r
237 Private->Ikev2SaSession list or Private->Ikev2EstablishedList list.\r
238\r
239 @param[in] SaSessionList Pointer to list to be inserted into.\r
240 @param[in] IkeSaSession Pointer to IKEV2_SA_SESSION to be inserted. \r
241 @param[in] RemotePeerIp Pointer to EFI_IP_ADDRESSS to indicate the \r
242 unique IKEV2_SA_SESSION.\r
243\r
244**/\r
245VOID\r
246Ikev2SaSessionInsert (\r
247 IN LIST_ENTRY *SaSessionList,\r
248 IN IKEV2_SA_SESSION *IkeSaSession,\r
249 IN EFI_IP_ADDRESS *RemotePeerIp\r
250 )\r
251{\r
252 Ikev2SaSessionRemove (SaSessionList, RemotePeerIp);\r
253 InsertTailList (SaSessionList, &IkeSaSession->BySessionTable);\r
254}\r
255\r
256/**\r
257 Remove the SA Session by Remote Peer IP.\r
258\r
259 @param[in] SaSessionList Pointer to list to be searched.\r
260 @param[in] RemotePeerIp Pointer to EFI_IP_ADDRESS to use for SA Session search.\r
261\r
262 @retval Pointer to IKEV2_SA_SESSION with the specified remote IP address or NULL. \r
263\r
264**/\r
265IKEV2_SA_SESSION *\r
266Ikev2SaSessionRemove (\r
267 IN LIST_ENTRY *SaSessionList,\r
268 IN EFI_IP_ADDRESS *RemotePeerIp\r
269 )\r
270{\r
271 LIST_ENTRY *Entry;\r
272 IKEV2_SA_SESSION *IkeSaSession;\r
273\r
274 NET_LIST_FOR_EACH (Entry, SaSessionList) {\r
275 IkeSaSession = IKEV2_SA_SESSION_BY_SESSION (Entry);\r
276\r
277 if (CompareMem (\r
278 &IkeSaSession->SessionCommon.RemotePeerIp,\r
279 RemotePeerIp,\r
280 sizeof (EFI_IP_ADDRESS)\r
281 ) == 0) {\r
282\r
283 RemoveEntryList (Entry);\r
284 return IkeSaSession;\r
285 }\r
286 }\r
287\r
288 return NULL;\r
289}\r
290\r
291/**\r
292 Marking a SA session as on deleting.\r
293\r
294 @param[in] IkeSaSession Pointer to IKEV2_SA_SESSION.\r
295\r
296 @retval EFI_SUCCESS Find the related SA session and marked it.\r
297\r
298**/\r
299EFI_STATUS\r
300Ikev2SaSessionOnDeleting (\r
301 IN IKEV2_SA_SESSION *IkeSaSession\r
302 )\r
303{\r
304 return EFI_SUCCESS;\r
305}\r
306\r
307/**\r
308 Free specified Seession Common. The session common would belong to a IKE SA or \r
309 a Child SA.\r
310\r
311 @param[in] SessionCommon Pointer to a Session Common.\r
312\r
313**/\r
314VOID\r
315Ikev2SaSessionCommonFree (\r
316 IN IKEV2_SESSION_COMMON *SessionCommon\r
317 )\r
318{\r
319\r
320 ASSERT (SessionCommon != NULL);\r
321\r
322 if (SessionCommon->LastSentPacket != NULL) {\r
323 IkePacketFree (SessionCommon->LastSentPacket);\r
324 }\r
325\r
326 if (SessionCommon->SaParams != NULL) {\r
327 FreePool (SessionCommon->SaParams);\r
328 }\r
329 if (SessionCommon->TimeoutEvent != NULL) {\r
330 gBS->CloseEvent (SessionCommon->TimeoutEvent);\r
331 }\r
332}\r
333\r
334/**\r
335 After IKE/Child SA is estiblished, close the time event and free sent packet.\r
336\r
337 @param[in] SessionCommon Pointer to a Session Common.\r
338\r
339**/\r
340VOID\r
341Ikev2SessionCommonRefresh (\r
342 IN IKEV2_SESSION_COMMON *SessionCommon\r
343 )\r
344{\r
345 ASSERT (SessionCommon != NULL);\r
346\r
347 gBS->CloseEvent (SessionCommon->TimeoutEvent);\r
348 SessionCommon->TimeoutEvent = NULL;\r
349 SessionCommon->TimeoutInterval = 0;\r
350 SessionCommon->RetryCount = 0;\r
351 if (SessionCommon->LastSentPacket != NULL) {\r
352 IkePacketFree (SessionCommon->LastSentPacket);\r
353 SessionCommon->LastSentPacket = NULL;\r
354 }\r
355\r
356 return ;\r
357}\r
358/**\r
359 Free specified IKEV2 SA Session. \r
360\r
361 @param[in] IkeSaSession Pointer to IKEV2_SA_SESSION to be freed.\r
362\r
363**/\r
364VOID\r
365Ikev2SaSessionFree (\r
366 IN IKEV2_SA_SESSION *IkeSaSession\r
367 )\r
368{\r
369 IKEV2_SESSION_KEYS *IkeKeys;\r
370 LIST_ENTRY *Entry;\r
371 IKEV2_CHILD_SA_SESSION *ChildSa;\r
372 IKEV2_DH_BUFFER *DhBuffer;\r
373\r
374 ASSERT (IkeSaSession != NULL);\r
375 \r
376 //\r
377 // Delete Common Session\r
378 //\r
379 Ikev2SaSessionCommonFree (&IkeSaSession->SessionCommon);\r
380\r
381 //\r
382 // Delete ChildSaEstablish List and SAD\r
383 //\r
384 for (Entry = IkeSaSession->ChildSaEstablishSessionList.ForwardLink;\r
385 Entry != &IkeSaSession->ChildSaEstablishSessionList;\r
386 ) {\r
387\r
388 ChildSa = IKEV2_CHILD_SA_SESSION_BY_IKE_SA (Entry);\r
389 Entry = Entry->ForwardLink;\r
390 Ikev2ChildSaSilentDelete (ChildSa->IkeSaSession, ChildSa->LocalPeerSpi);\r
391\r
392 }\r
393\r
394 //\r
395 // Delete ChildSaSessionList\r
396 //\r
397 for ( Entry = IkeSaSession->ChildSaSessionList.ForwardLink;\r
398 Entry != &IkeSaSession->ChildSaSessionList;\r
399 ){\r
400 ChildSa = IKEV2_CHILD_SA_SESSION_BY_IKE_SA (Entry);\r
401 Entry = Entry->ForwardLink;\r
402 RemoveEntryList (Entry->BackLink);\r
403 Ikev2ChildSaSessionFree (ChildSa);\r
404 }\r
405\r
406 //\r
407 // Delete DhBuffer and Keys\r
408 //\r
409 if (IkeSaSession->IkeKeys != NULL) {\r
410 IkeKeys = IkeSaSession->IkeKeys;\r
411 DhBuffer = IkeKeys->DhBuffer;\r
412\r
413 //\r
414 // Delete DhBuffer\r
415 //\r
416 Ikev2DhBufferFree (DhBuffer);\r
417\r
418 //\r
419 // Delete Keys\r
420 // \r
421 if (IkeKeys->SkAiKey != NULL) {\r
422 FreePool (IkeKeys->SkAiKey);\r
423 }\r
424 if (IkeKeys->SkArKey != NULL) {\r
425 FreePool (IkeKeys->SkArKey);\r
426 }\r
427 if (IkeKeys->SkdKey != NULL) {\r
428 FreePool (IkeKeys->SkdKey);\r
429 }\r
430 if (IkeKeys->SkEiKey != NULL) {\r
431 FreePool (IkeKeys->SkEiKey);\r
432 }\r
433 if (IkeKeys->SkErKey != NULL) {\r
434 FreePool (IkeKeys->SkErKey);\r
435 }\r
436 if (IkeKeys->SkPiKey != NULL) {\r
437 FreePool (IkeKeys->SkPiKey);\r
438 }\r
439 if (IkeKeys->SkPrKey != NULL) {\r
440 FreePool (IkeKeys->SkPrKey);\r
441 }\r
442 FreePool (IkeKeys);\r
443 }\r
444\r
445 if (IkeSaSession->SaData != NULL) {\r
446 FreePool (IkeSaSession->SaData);\r
447 }\r
448\r
449 if (IkeSaSession->NiBlock != NULL) {\r
450 FreePool (IkeSaSession->NiBlock);\r
451 }\r
452\r
453 if (IkeSaSession->NrBlock != NULL) {\r
454 FreePool (IkeSaSession->NrBlock);\r
455 }\r
456\r
457 if (IkeSaSession->NCookie != NULL) {\r
458 FreePool (IkeSaSession->NCookie);\r
459 }\r
460\r
461 if (IkeSaSession->InitPacket != NULL) {\r
462 FreePool (IkeSaSession->InitPacket);\r
463 }\r
464\r
465 if (IkeSaSession->RespPacket != NULL) {\r
466 FreePool (IkeSaSession->RespPacket);\r
467 }\r
468\r
469 FreePool (IkeSaSession);\r
470\r
471 return ;\r
472}\r
473\r
474/**\r
475 Increase the MessageID in IkeSaSession.\r
476\r
477 @param[in] IkeSaSession Pointer to a specified IKEV2_SA_SESSION.\r
478\r
479**/\r
480VOID\r
481Ikev2SaSessionIncreaseMessageId (\r
482 IN IKEV2_SA_SESSION *IkeSaSession\r
483 )\r
484{\r
485 if (IkeSaSession->MessageId < 0xffffffff) {\r
486 IkeSaSession->MessageId ++;\r
487 } else {\r
488 //\r
489 // TODO: Trigger Rekey process.\r
490 //\r
491 }\r
492}\r
493\r
494/**\r
495 Allocate memory for IKEV2 Child SA Session.\r
496 \r
497 @param[in] UdpService Pointer to IKE_UDP_SERVICE.\r
498 @param[in] IkeSaSession Pointer to IKEV2_SA_SESSION related to this Child SA \r
499 Session.\r
500\r
501 @retval Pointer of a new created IKEV2 Child SA Session or NULL.\r
502\r
503**/\r
504IKEV2_CHILD_SA_SESSION *\r
505Ikev2ChildSaSessionAlloc (\r
506 IN IKE_UDP_SERVICE *UdpService,\r
507 IN IKEV2_SA_SESSION *IkeSaSession\r
508 )\r
509{\r
510 EFI_STATUS Status;\r
511 IKEV2_CHILD_SA_SESSION *ChildSaSession;\r
512 IKEV2_SESSION_COMMON *ChildSaCommon;\r
513 IKEV2_SESSION_COMMON *SaCommon;\r
514\r
515 ChildSaSession = AllocateZeroPool (sizeof (IKEV2_CHILD_SA_SESSION));\r
516 if (ChildSaSession == NULL) {\r
517 return NULL;\r
518 }\r
519\r
520 //\r
521 // Initialize the fields of ChildSaSession and its SessionCommon.\r
522 //\r
523 ChildSaSession->Signature = IKEV2_CHILD_SA_SESSION_SIGNATURE;\r
524 ChildSaSession->IkeSaSession = IkeSaSession;\r
525 ChildSaSession->MessageId = IkeSaSession->MessageId;\r
526 ChildSaSession->LocalPeerSpi = IkeGenerateSpi ();\r
527 ChildSaCommon = &ChildSaSession->SessionCommon;\r
528 ChildSaCommon->UdpService = UdpService;\r
529 ChildSaCommon->Private = IkeSaSession->SessionCommon.Private;\r
530 ChildSaCommon->IkeSessionType = IkeSessionTypeChildSa;\r
531 ChildSaCommon->IkeVer = 2;\r
532 ChildSaCommon->AfterEncodePayload = Ikev2ChildSaAfterEncodePayload;\r
533 ChildSaCommon->BeforeDecodePayload = Ikev2ChildSaBeforeDecodePayload;\r
534 SaCommon = &ChildSaSession->IkeSaSession->SessionCommon;\r
535\r
536 //\r
537 // Create a resend notfiy event for retry.\r
538 //\r
539 Status = gBS->CreateEvent (\r
540 EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
541 TPL_CALLBACK,\r
542 Ikev2ResendNotify,\r
543 ChildSaCommon,\r
544 &ChildSaCommon->TimeoutEvent\r
545 );\r
546 if (EFI_ERROR (Status)) {\r
547 FreePool (ChildSaSession);\r
548 return NULL;\r
549 }\r
550\r
551 CopyMem (&ChildSaCommon->LocalPeerIp, &SaCommon->LocalPeerIp, sizeof (EFI_IP_ADDRESS));\r
552 CopyMem (&ChildSaCommon->RemotePeerIp, &SaCommon->RemotePeerIp, sizeof (EFI_IP_ADDRESS));\r
553\r
554 return ChildSaSession;\r
555}\r
556\r
557/**\r
558 Register a established IKEv2 Child SA into IkeSaSession->ChildSaEstablishSessionList. \r
559 If the there is IKEV2_CHILD_SA_SESSION with same remote peer IP, remove the old one \r
560 then register the new one.\r
561\r
562 @param[in] ChildSaSession Pointer to IKEV2_CHILD_SA_SESSION to be registered.\r
563 @param[in] Private Pointer to IPSEC_PRAVATE_DATA.\r
564\r
565**/\r
566VOID\r
567Ikev2ChildSaSessionReg (\r
568 IN IKEV2_CHILD_SA_SESSION *ChildSaSession,\r
569 IN IPSEC_PRIVATE_DATA *Private\r
570 )\r
571{\r
572 IKEV2_SESSION_COMMON *SessionCommon;\r
573 IKEV2_CHILD_SA_SESSION *OldChildSaSession;\r
574 IKEV2_SA_SESSION *IkeSaSession;\r
9166f840 575 EFI_STATUS Status;\r
576 UINT64 Lifetime;\r
577\r
578 //\r
579 // Keep the IKE SA exclusive.\r
580 //\r
581 SessionCommon = &ChildSaSession->SessionCommon;\r
582 IkeSaSession = ChildSaSession->IkeSaSession;\r
583 OldChildSaSession = Ikev2ChildSaSessionRemove (\r
584 &IkeSaSession->ChildSaEstablishSessionList,\r
585 ChildSaSession->LocalPeerSpi,\r
586 IKEV2_ESTABLISHED_CHILDSA_LIST\r
587 );\r
588 if (OldChildSaSession != NULL) {\r
589 //\r
590 // Free the old one.\r
591 //\r
592 Ikev2ChildSaSessionFree (OldChildSaSession);\r
593 }\r
594\r
595 //\r
596 // Store the ready child SA into SAD.\r
597 //\r
598 Ikev2StoreSaData (ChildSaSession);\r
599\r
600 //\r
601 // Cleanup the fields of SessionCommon for processing.\r
602 // \r
603 Ikev2SessionCommonRefresh (SessionCommon);\r
604 \r
605 //\r
606 // Insert the ready child SA session into established list.\r
607 //\r
608 Ikev2ChildSaSessionInsert (&IkeSaSession->ChildSaEstablishSessionList, ChildSaSession);\r
609\r
610 //\r
611 // Create a Notify event for the IKE SA life time counting.\r
612 //\r
613 Status = gBS->CreateEvent (\r
614 EVT_TIMER | EVT_NOTIFY_SIGNAL,\r
615 TPL_CALLBACK,\r
616 Ikev2LifetimeNotify,\r
617 SessionCommon,\r
618 &SessionCommon->TimeoutEvent\r
619 );\r
620 if (EFI_ERROR(Status)){\r
621 return ;\r
622 }\r
623\r
624 //\r
625 // Start to count the lifetime of the IKE SA.\r
626 //\r
9166f840 627 if (ChildSaSession->Spd->Data->ProcessingPolicy->SaLifetime.HardLifetime != 0){\r
628 Lifetime = ChildSaSession->Spd->Data->ProcessingPolicy->SaLifetime.HardLifetime;\r
629 } else {\r
630 Lifetime = CHILD_SA_DEFAULT_LIFETIME;\r
631 }\r
632\r
633 Status = gBS->SetTimer (\r
634 SessionCommon->TimeoutEvent,\r
635 TimerRelative,\r
636 MultU64x32(Lifetime, 10000000) // ms->100ns\r
637 );\r
638 if (EFI_ERROR(Status)){\r
639 return ;\r
640 }\r
641\r
642 DEBUG ((\r
643 DEBUG_INFO,\r
644 "\n------ChildSa established and start to count down %d seconds lifetime\n",\r
645 Lifetime\r
646 ));\r
647\r
648 return ;\r
649}\r
650\r
651/**\r
652 Find the ChildSaSession by it's MessagId.\r
653\r
654 @param[in] SaSessionList Pointer to a ChildSaSession List.\r
655 @param[in] Mid The messageId used to search ChildSaSession.\r
656\r
657 @return Pointer to IKEV2_CHILD_SA_SESSION or NULL.\r
658\r
659**/\r
660IKEV2_CHILD_SA_SESSION *\r
661Ikev2ChildSaSessionLookupByMid (\r
662 IN LIST_ENTRY *SaSessionList,\r
663 IN UINT32 Mid\r
664 )\r
665{\r
666 LIST_ENTRY *Entry;\r
667 IKEV2_CHILD_SA_SESSION *ChildSaSession;\r
44de1013 668\r
9166f840 669 NET_LIST_FOR_EACH (Entry, SaSessionList) {\r
670 ChildSaSession = IKEV2_CHILD_SA_SESSION_BY_IKE_SA (Entry);\r
44de1013 671\r
9166f840 672 if (ChildSaSession->MessageId == Mid) {\r
44de1013
HT		 673 return ChildSaSession;\r
674 }\r
9166f840 675 }\r
676 return NULL;\r
677}\r
678\r
679/**\r
680 This function find the Child SA by the specified SPI.\r
44de1013
HT		 681\r
682 This functin find a ChildSA session by searching the ChildSaSessionlist of\r
9166f840 683 the input IKEV2_SA_SESSION by specified MessageID.\r
44de1013 684 \r
9166f840 685 @param[in] SaSessionList Pointer to List to be searched.\r
686 @param[in] Spi Specified SPI.\r
44de1013 687\r
9166f840 688 @return Pointer to IKEV2_CHILD_SA_SESSION or NULL.\r
689\r
690**/\r
691IKEV2_CHILD_SA_SESSION *\r
692Ikev2ChildSaSessionLookupBySpi (\r
693 IN LIST_ENTRY *SaSessionList,\r
694 IN UINT32 Spi\r
695 )\r
696{\r
697 LIST_ENTRY *Entry;\r
698 IKEV2_CHILD_SA_SESSION *ChildSaSession;\r
44de1013 699\r
9166f840 700 NET_LIST_FOR_EACH (Entry, SaSessionList) {\r
701 ChildSaSession = IKEV2_CHILD_SA_SESSION_BY_IKE_SA (Entry);\r
44de1013 702\r
9166f840 703 if (ChildSaSession->RemotePeerSpi == Spi || ChildSaSession->LocalPeerSpi == Spi) {\r
44de1013
HT		 704 return ChildSaSession;\r
705 }\r
706 }\r
9166f840 707\r
708 return NULL;\r
709}\r
710\r
711/**\r
712 Insert a Child SA Session into the specified ChildSa list.\r
713\r
714 @param[in] SaSessionList Pointer to list to be inserted in.\r
715 @param[in] ChildSaSession Pointer to IKEV2_CHILD_SA_SESSION to be inserted.\r
716\r
717**/\r
718VOID\r
719Ikev2ChildSaSessionInsert (\r
720 IN LIST_ENTRY *SaSessionList,\r
721 IN IKEV2_CHILD_SA_SESSION *ChildSaSession\r
722 )\r
723{\r
724 InsertTailList (SaSessionList, &ChildSaSession->ByIkeSa);\r
725}\r
726\r
727/**\r
728 Remove the IKEV2_CHILD_SA_SESSION from IkeSaSessionList.\r
729 \r
730 @param[in] SaSessionList The SA Session List to be iterated.\r
731 @param[in] Spi Spi used to identified the IKEV2_CHILD_SA_SESSION.\r
732 @param[in] ListType The type of the List to indicate whether it is a \r
733 Established. \r
734\r
735 @return The point to IKEV2_CHILD_SA_SESSION or NULL.\r
736 \r
737**/\r
738IKEV2_CHILD_SA_SESSION *\r
739Ikev2ChildSaSessionRemove (\r
740 IN LIST_ENTRY *SaSessionList,\r
741 IN UINT32 Spi, \r
742 IN UINT8 ListType\r
743 )\r
744{\r
745 LIST_ENTRY *Entry;\r
746 LIST_ENTRY *NextEntry;\r
747 IKEV2_CHILD_SA_SESSION *ChildSaSession;\r
748\r
749 NET_LIST_FOR_EACH_SAFE (Entry, NextEntry, SaSessionList) {\r
750 \r
751 if (ListType == IKEV2_ESTABLISHED_CHILDSA_LIST || ListType == IKEV2_ESTABLISHING_CHILDSA_LIST) {\r
752 ChildSaSession = IKEV2_CHILD_SA_SESSION_BY_IKE_SA (Entry);\r
753 } else if (ListType == IKEV2_DELET_CHILDSA_LIST) {\r
754 ChildSaSession = IKEV2_CHILD_SA_SESSION_BY_DEL_SA (Entry);\r
755 } else {\r
756 return NULL;\r
757 }\r
758\r
759 if (ChildSaSession->RemotePeerSpi == Spi || ChildSaSession->LocalPeerSpi == Spi) {\r
760 RemoveEntryList (Entry);\r
761 return ChildSaSession;\r
762 }\r
763 }\r
764\r
765 return NULL;\r
766}\r
767\r
768/**\r
769 Mark a specified Child SA Session as on deleting.\r
770\r
771 @param[in] ChildSaSession Pointer to IKEV2_CHILD_SA_SESSION.\r
772\r
773 @retval EFI_SUCCESS Operation is successful.\r
774\r
775**/\r
776EFI_STATUS\r
777Ikev2ChildSaSessionOnDeleting (\r
778 IN IKEV2_CHILD_SA_SESSION *ChildSaSession\r
779 )\r
780{\r
781 return EFI_SUCCESS;\r
782}\r
783\r
784/**\r
785 Free the memory located for the specified IKEV2_CHILD_SA_SESSION. \r
786\r
787 @param[in] ChildSaSession Pointer to IKEV2_CHILD_SA_SESSION.\r
788\r
789**/\r
790VOID\r
791Ikev2ChildSaSessionFree (\r
792 IN IKEV2_CHILD_SA_SESSION *ChildSaSession\r
793 )\r
794{\r
795 IKEV2_SESSION_COMMON *SessionCommon;\r
796\r
797 SessionCommon = &ChildSaSession->SessionCommon;\r
798 if (ChildSaSession->SaData != NULL) {\r
799 FreePool (ChildSaSession->SaData);\r
800 }\r
801\r
802 if (ChildSaSession->NiBlock != NULL) {\r
803 FreePool (ChildSaSession->NiBlock);\r
804 }\r
805\r
806 if (ChildSaSession->NrBlock != NULL) {\r
807 FreePool (ChildSaSession->NrBlock);\r
808 }\r
809\r
810 if (ChildSaSession->ChildKeymats.LocalPeerInfo.EspAlgoInfo.AuthKey != NULL) {\r
811 FreePool (ChildSaSession->ChildKeymats.LocalPeerInfo.EspAlgoInfo.AuthKey);\r
812 }\r
813\r
814 if (ChildSaSession->ChildKeymats.LocalPeerInfo.EspAlgoInfo.EncKey != NULL) {\r
815 FreePool (ChildSaSession->ChildKeymats.LocalPeerInfo.EspAlgoInfo.EncKey);\r
816 }\r
817\r
818 if (ChildSaSession->ChildKeymats.RemotePeerInfo.EspAlgoInfo.AuthKey != NULL) {\r
819 FreePool (ChildSaSession->ChildKeymats.RemotePeerInfo.EspAlgoInfo.AuthKey);\r
820 }\r
821\r
822 if (ChildSaSession->ChildKeymats.RemotePeerInfo.EspAlgoInfo.EncKey != NULL) {\r
823 FreePool (ChildSaSession->ChildKeymats.RemotePeerInfo.EspAlgoInfo.EncKey);\r
824 }\r
825\r
826 //\r
827 // Delete DhBuffer\r
828 //\r
829 Ikev2DhBufferFree (ChildSaSession->DhBuffer);\r
830\r
831 //\r
832 // Delete SpdSelector\r
833 //\r
834 if (ChildSaSession->SpdSelector != NULL) {\r
835 if (ChildSaSession->SpdSelector->LocalAddress != NULL) {\r
836 FreePool (ChildSaSession->SpdSelector->LocalAddress);\r
837 }\r
838 if (ChildSaSession->SpdSelector->RemoteAddress != NULL) {\r
839 FreePool (ChildSaSession->SpdSelector->RemoteAddress);\r
840 }\r
841 FreePool (ChildSaSession->SpdSelector);\r
842 }\r
843 Ikev2SaSessionCommonFree (SessionCommon);\r
844 FreePool (ChildSaSession);\r
845\r
846 return ;\r
847}\r
848\r
849/**\r
850 Delete the specified established Child SA.\r
851\r
852 This function delete the Child SA directly and don't send the Information Packet to\r
853 remote peer.\r
854\r
855 @param[in] IkeSaSession Pointer to a IKE SA Session used to be searched for.\r
856 @param[in] Spi SPI used to find the Child SA.\r
857\r
858 @retval EFI_NOT_FOUND Pointer of IKE SA Session is NULL.\r
859 @retval EFI_NOT_FOUND There is no specified Child SA related with the input\r
860 SPI under this IKE SA Session.\r
861 @retval EFI_SUCCESS Delete the Child SA successfully.\r
862\r
863**/\r
864EFI_STATUS\r
865Ikev2ChildSaSilentDelete (\r
866 IN IKEV2_SA_SESSION *IkeSaSession,\r
867 IN UINT32 Spi\r
868 )\r
869{\r
870 EFI_STATUS Status;\r
871 EFI_IPSEC_CONFIG_SELECTOR *Selector;\r
872 UINTN SelectorSize;\r
873 BOOLEAN IsLocalFound;\r
874 BOOLEAN IsRemoteFound;\r
875 UINT32 LocalSpi;\r
876 UINT32 RemoteSpi;\r
877 IKEV2_CHILD_SA_SESSION *ChildSession;\r
878 EFI_IPSEC_CONFIG_SELECTOR *LocalSelector;\r
879 EFI_IPSEC_CONFIG_SELECTOR *RemoteSelector;\r
880 IKE_UDP_SERVICE *UdpService;\r
881 IPSEC_PRIVATE_DATA *Private;\r
882\r
883 if (IkeSaSession == NULL) {\r
884 return EFI_NOT_FOUND;\r
885 }\r
886\r
887 IsLocalFound = FALSE;\r
888 IsRemoteFound = FALSE;\r
889 ChildSession = NULL;\r
890 LocalSelector = NULL;\r
891 RemoteSelector = NULL;\r
892 UdpService = IkeSaSession->SessionCommon.UdpService;\r
893\r
5dd08a46 894 Private = IkeSaSession->SessionCommon.Private;\r
9166f840 895\r
896 //\r
897 // Remove the Established SA from ChildSaEstablishlist.\r
898 //\r
899 ChildSession = Ikev2ChildSaSessionRemove(\r
900 &(IkeSaSession->ChildSaEstablishSessionList),\r
901 Spi, \r
902 IKEV2_ESTABLISHED_CHILDSA_LIST\r
903 );\r
904 if (ChildSession == NULL) {\r
905 return EFI_NOT_FOUND;\r
906 }\r
907\r
908 LocalSpi = ChildSession->LocalPeerSpi;\r
909 RemoteSpi = ChildSession->RemotePeerSpi;\r
910 \r
911 SelectorSize = sizeof (EFI_IPSEC_CONFIG_SELECTOR);\r
912 Selector = AllocateZeroPool (SelectorSize);\r
913 ASSERT (Selector != NULL);\r
914\r
915 \r
916\r
917 while (1) {\r
918 Status = EfiIpSecConfigGetNextSelector (\r
919 &Private->IpSecConfig,\r
920 IPsecConfigDataTypeSad,\r
921 &SelectorSize,\r
922 Selector\r
923 );\r
924 if (Status == EFI_BUFFER_TOO_SMALL) {\r
925 FreePool (Selector);\r
926\r
927 Selector = AllocateZeroPool (SelectorSize);\r
393a3169 928 ASSERT (Selector != NULL);\r
9166f840 929 Status = EfiIpSecConfigGetNextSelector (\r
930 &Private->IpSecConfig,\r
931 IPsecConfigDataTypeSad,\r
932 &SelectorSize,\r
933 Selector\r
934 );\r
935 }\r
936\r
937 if (EFI_ERROR (Status)) {\r
938 break;\r
939 }\r
940\r
941 if (Selector->SaId.Spi == RemoteSpi) {\r
942 //\r
943 // SPI is unique. There is only one SAD whose SPI is\r
944 // same with RemoteSpi.\r
945 //\r
946 IsRemoteFound = TRUE;\r
947 RemoteSelector = AllocateZeroPool (SelectorSize);\r
02a758cb 948 ASSERT (RemoteSelector != NULL);\r
9166f840 949 CopyMem (RemoteSelector, Selector, SelectorSize);\r
950 }\r
951\r
952 if (Selector->SaId.Spi == LocalSpi) {\r
953 //\r
954 // SPI is unique. There is only one SAD whose SPI is\r
955 // same with LocalSpi.\r
956 //\r
957 IsLocalFound = TRUE;\r
958 LocalSelector = AllocateZeroPool (SelectorSize);\r
02a758cb 959 ASSERT (LocalSelector != NULL);\r
9166f840 960 CopyMem (LocalSelector, Selector, SelectorSize);\r
961 }\r
962 }\r
963 //\r
964 // Delete SA from the Variable.\r
965 //\r
966 if (IsLocalFound) {\r
967 Status = EfiIpSecConfigSetData (\r
968 &Private->IpSecConfig,\r
969 IPsecConfigDataTypeSad,\r
970 LocalSelector,\r
971 NULL,\r
972 NULL\r
973 );\r
974 }\r
975\r
976 if (IsRemoteFound) {\r
977 Status = EfiIpSecConfigSetData (\r
978 &Private->IpSecConfig,\r
979 IPsecConfigDataTypeSad,\r
980 RemoteSelector,\r
981 NULL,\r
982 NULL\r
983 );\r
984\r
985 }\r
986\r
987 DEBUG (\r
988 (DEBUG_INFO,\r
989 "\n------IKEV2 deleted ChildSa(local spi, remote spi):(0x%x, 0x%x)------\n",\r
990 LocalSpi,\r
991 RemoteSpi)\r
992 );\r
993 Ikev2ChildSaSessionFree (ChildSession);\r
994\r
995 if (RemoteSelector != NULL) {\r
996 FreePool (RemoteSelector);\r
997 }\r
998\r
999 if (LocalSelector != NULL) {\r
1000 FreePool (LocalSelector);\r
1001 }\r
1002\r
1003 if (Selector != NULL) {\r
1004 FreePool (Selector);\r
1005 }\r
1006\r
1007 return Status;\r
1008}\r
1009\r
1010/**\r
1011 Free the specified DhBuffer.\r
1012\r
1013 @param[in] DhBuffer Pointer to IKEV2_DH_BUFFER to be freed.\r
1014 \r
1015**/\r
1016VOID\r
1017Ikev2DhBufferFree (\r
1018 IKEV2_DH_BUFFER *DhBuffer\r
1019) \r
1020{\r
1021 if (DhBuffer != NULL) {\r
1022 if (DhBuffer->GxBuffer != NULL) {\r
1023 FreePool (DhBuffer->GxBuffer);\r
1024 }\r
1025 if (DhBuffer->GyBuffer != NULL) {\r
1026 FreePool (DhBuffer->GyBuffer);\r
1027 }\r
1028 if (DhBuffer->GxyBuffer != NULL) {\r
1029 FreePool (DhBuffer->GxyBuffer);\r
1030 }\r
1031 if (DhBuffer->DhContext != NULL) {\r
1032 IpSecCryptoIoFreeDh (&DhBuffer->DhContext);\r
1033 }\r
1034 FreePool (DhBuffer);\r
1035 }\r
1036}\r
1037\r
1038/**\r
1039 This function is to parse a request IKE packet and return its request type.\r
1040 The request type is one of IKE CHILD SA creation, IKE SA rekeying and \r
1041 IKE CHILD SA rekeying.\r
1042\r
1043 @param[in] IkePacket IKE packet to be prased.\r
1044\r
1045 return the type of the IKE packet.\r
1046\r
1047**/\r
1048IKEV2_CREATE_CHILD_REQUEST_TYPE\r
1049Ikev2ChildExchangeRequestType(\r
1050 IN IKE_PACKET *IkePacket\r
1051 )\r
1052{\r
1053 BOOLEAN Flag;\r
1054 LIST_ENTRY *Entry;\r
1055 IKE_PAYLOAD *IkePayload;\r
1056\r
1057 Flag = FALSE;\r
1058\r
1059 NET_LIST_FOR_EACH (Entry, &(IkePacket)->PayloadList) {\r
1060 IkePayload = IKE_PAYLOAD_BY_PACKET (Entry);\r
1061 if (IkePayload->PayloadType == IKEV2_PAYLOAD_TYPE_TS_INIT) {\r
1062 //\r
1063 // Packet with Ts Payload means it is for either CHILD_SA_CREATE or CHILD_SA_REKEY.\r
1064 //\r
1065 Flag = TRUE;\r
1066 }\r
1067 if (IkePayload->PayloadType == IKEV2_PAYLOAD_TYPE_NOTIFY) { \r
1068 if (((IKEV2_NOTIFY*)IkePayload)->MessageType == IKEV2_NOTIFICATION_REKEY_SA) {\r
1069 //\r
1070 // If notify payload with REKEY_SA message type, the IkePacket is for \r
1071 // rekeying Child SA.\r
1072 //\r
1073 return IkeRequestTypeRekeyChildSa;\r
1074 }\r
1075 }\r
1076 };\r
1077\r
1078 if (!Flag){\r
1079 //\r
1080 // The Create Child Exchange is for IKE SA rekeying.\r
1081 //\r
1082 return IkeRequestTypeRekeyIkeSa;\r
1083 } else {\r
1084 //\r
1085 // If the Notify payloaad with transport mode message type, the IkePacket is \r
1086 // for create Child SA.\r
1087 //\r
1088 return IkeRequestTypeCreateChildSa;\r
1089 }\r
1090}\r
1091\r
1092/**\r
1093 Associate a SPD selector to the Child SA Session.\r
1094\r
1095 This function is called when the Child SA is not the first child SA of its \r
1096 IKE SA. It associate a SPD to this Child SA.\r
1097\r
1098 @param[in, out] ChildSaSession Pointer to the Child SA Session to be associated to \r
1099 a SPD selector.\r
1100\r
1101 @retval EFI_SUCCESS Associate one SPD selector to this Child SA Session successfully.\r
1102 @retval EFI_NOT_FOUND Can't find the related SPD selector.\r
1103\r
1104**/\r
1105EFI_STATUS\r
1106Ikev2ChildSaAssociateSpdEntry (\r
1107 IN OUT IKEV2_CHILD_SA_SESSION *ChildSaSession\r
1108 )\r
1109{\r
1110 IpSecVisitConfigData (IPsecConfigDataTypeSpd, Ikev2MatchSpdEntry, ChildSaSession);\r
1111 if (ChildSaSession->Spd != NULL) {\r
1112 return EFI_SUCCESS;\r
1113 } else {\r
1114 return EFI_NOT_FOUND;\r
1115 }\r
1116}\r
1117\r
1118\r
1119/**\r
1120 This function finds the SPI from Create Child SA Exchange Packet.\r
1121 \r
1122 @param[in] IkePacket Pointer to IKE_PACKET to be searched.\r
1123\r
1124 @retval SPI number or 0 if it is not supported.\r
1125\r
1126**/\r
1127UINT32\r
1128Ikev2ChildExchangeRekeySpi (\r
1129 IN IKE_PACKET *IkePacket\r
1130 )\r
1131{\r
1132 //\r
1133 // Not support yet.\r
1134 // \r
1135 return 0;\r
1136}\r
1137\r
1138/**\r
1139 Validate the IKE header of received IKE packet.\r
1140\r
1141 @param[in] IkeSaSession Pointer to IKEV2_SA_SESSION related to this IKE packet.\r
1142 @param[in] IkeHdr Pointer to IKE header of received IKE packet.\r
1143\r
1144 @retval TRUE If the IKE header is valid.\r
1145 @retval FALSE If the IKE header is invalid.\r
1146\r
1147**/\r
1148BOOLEAN\r
1149Ikev2ValidateHeader (\r
1150 IN IKEV2_SA_SESSION *IkeSaSession,\r
1151 IN IKE_HEADER *IkeHdr\r
1152 )\r
1153{\r
1154\r
1155 IKEV2_SESSION_STATE State;\r
1156\r
1157 State = IkeSaSession->SessionCommon.State;\r
1158 if (State == IkeStateInit) {\r
1159 //\r
1160 // For the IKE Initial Exchange, the MessagId should be zero.\r
1161 //\r
1162 if (IkeHdr->MessageId != 0) {\r
1163 return FALSE;\r
1164 }\r
1165 } else {\r
1166 if (State == IkeStateAuth) {\r
1167 if (IkeHdr->MessageId != 1) {\r
1168 return FALSE;\r
1169 }\r
1170 }\r
1171 if (IkeHdr->InitiatorCookie != IkeSaSession->InitiatorCookie ||\r
1172 IkeHdr->ResponderCookie != IkeSaSession->ResponderCookie\r
1173 ) {\r
1174 //\r
1175 // TODO: send notification INVALID-COOKIE\r
1176 //\r
1177 return FALSE;\r
1178 }\r
1179 }\r
1180\r
1181 //\r
1182 // Information Exchagne and Create Child Exchange can be started from each part.\r
1183 //\r
1184 if (IkeHdr->ExchangeType != IKEV2_EXCHANGE_TYPE_INFO && \r
1185 IkeHdr->ExchangeType != IKEV2_EXCHANGE_TYPE_CREATE_CHILD\r
1186 ) {\r
1187 if (IkeSaSession->SessionCommon.IsInitiator) {\r
1188 if (IkeHdr->InitiatorCookie != IkeSaSession->InitiatorCookie) {\r
1189 //\r
1190 // TODO: send notification INVALID-COOKIE\r
1191 //\r
1192 return FALSE;\r
1193 }\r
1194 if (IkeHdr->Flags != IKE_HEADER_FLAGS_RESPOND) {\r
1195 return FALSE;\r
1196 }\r
1197 } else {\r
1198 if (IkeHdr->Flags != IKE_HEADER_FLAGS_INIT) {\r
1199 return FALSE;\r
1200 }\r
1201 }\r
1202 }\r
1203\r
1204 return TRUE;\r
1205}\r
1206\r
1207/**\r
1208 Create and intialize IKEV2_SA_DATA for speicifed IKEV2_SESSION_COMMON.\r
1209\r
1210 This function will be only called by the initiator. The responder's IKEV2_SA_DATA\r
1211 will be generated during parsed the initiator packet.\r
1212\r
1213 @param[in] SessionCommon Pointer to IKEV2_SESSION_COMMON related to.\r
1214\r
1215 @retval a Pointer to a new IKEV2_SA_DATA or NULL.\r
1216\r
1217**/\r
1218IKEV2_SA_DATA *\r
1219Ikev2InitializeSaData (\r
1220 IN IKEV2_SESSION_COMMON *SessionCommon\r
1221 )\r
1222{\r
1223 IKEV2_CHILD_SA_SESSION *ChildSaSession;\r
1224 IKEV2_SA_DATA *SaData;\r
1225 IKEV2_PROPOSAL_DATA *ProposalData;\r
1226 IKEV2_TRANSFORM_DATA *TransformData;\r
1227 IKE_SA_ATTRIBUTE *Attribute;\r
1228\r
1229 ASSERT (SessionCommon != NULL);\r
1230 //\r
1231 // TODO: Remove the hard code of the support Alogrithm. Those data should be\r
1232 // get from the SPD/PAD data.\r
1233 //\r
1234 if (SessionCommon->IkeSessionType == IkeSessionTypeIkeSa) {\r
1235 SaData = AllocateZeroPool (\r
1236 sizeof (IKEV2_SA_DATA) +\r
1237 sizeof (IKEV2_PROPOSAL_DATA) * 2 +\r
1238 sizeof (IKEV2_TRANSFORM_DATA) * 4 * 2\r
1239 );\r
1240 } else {\r
1241 SaData = AllocateZeroPool (\r
1242 sizeof (IKEV2_SA_DATA) +\r
1243 sizeof (IKEV2_PROPOSAL_DATA) * 2 +\r
1244 sizeof (IKEV2_TRANSFORM_DATA) * 3 * 2\r
1245 );\r
1246 }\r
1247 if (SaData == NULL) {\r
1248 return NULL;\r
1249 }\r
1250\r
1251 //\r
1252 // First proposal payload: 3DES + SHA1 + DH\r
1253 //\r
1254 SaData->NumProposals = 2;\r
1255 ProposalData = (IKEV2_PROPOSAL_DATA *) (SaData + 1);\r
1256 ProposalData->ProposalIndex = 1;\r
1257\r
1258 //\r
1259 // If SA data for IKE_SA_INIT exchage, contains 4 transforms. If SA data for \r
1260 // IKE_AUTH exchange contains 3 transforms.\r
1261 //\r
1262 if (SessionCommon->IkeSessionType == IkeSessionTypeIkeSa) {\r
1263 ProposalData->NumTransforms = 4;\r
1264 } else {\r
1265 ProposalData->NumTransforms = 3;\r
1266 }\r
1267\r
1268\r
1269 if (SessionCommon->IkeSessionType == IkeSessionTypeIkeSa) {\r
1270 ProposalData->ProtocolId = IPSEC_PROTO_ISAKMP;\r
1271 } else {\r
1272 ChildSaSession = IKEV2_CHILD_SA_SESSION_FROM_COMMON (SessionCommon);\r
1273 ProposalData->ProtocolId = IPSEC_PROTO_IPSEC_ESP;\r
1274 ProposalData->Spi = AllocateZeroPool (sizeof (ChildSaSession->LocalPeerSpi));\r
1275 ASSERT (ProposalData->Spi != NULL);\r
1276 CopyMem (\r
1277 ProposalData->Spi,\r
1278 &ChildSaSession->LocalPeerSpi,\r
1279 sizeof(ChildSaSession->LocalPeerSpi)\r
1280 );\r
1281 }\r
1282\r
1283 //\r
1284 // Set transform attribute for Encryption Algorithm - 3DES\r
1285 //\r
1286 TransformData = (IKEV2_TRANSFORM_DATA *) (ProposalData + 1);\r
1287 TransformData->TransformIndex = 0;\r
1288 TransformData->TransformType = IKEV2_TRANSFORM_TYPE_ENCR;\r
1289 TransformData->TransformId = IKEV2_TRANSFORM_ID_ENCR_3DES;\r
1290\r
1291 //\r
1292 // Set transform attribute for Integrity Algorithm - SHA1_96\r
1293 //\r
1294 TransformData = (IKEV2_TRANSFORM_DATA *) (TransformData + 1);\r
1295 TransformData->TransformIndex = 1;\r
1296 TransformData->TransformType = IKEV2_TRANSFORM_TYPE_INTEG;\r
1297 TransformData->TransformId = IKEV2_TRANSFORM_ID_AUTH_HMAC_SHA1_96;\r
1298\r
1299 if (SessionCommon->IkeSessionType == IkeSessionTypeIkeSa) {\r
1300 //\r
1301 // Set transform attribute for Pseduo-Random Function - HAMC_SHA1\r
1302 //\r
1303 TransformData = (IKEV2_TRANSFORM_DATA *) (TransformData + 1);\r
1304 TransformData->TransformIndex = 2;\r
1305 TransformData->TransformType = IKEV2_TRANSFORM_TYPE_PRF;\r
1306 TransformData->TransformId = IKEV2_TRANSFORM_ID_PRF_HMAC_SHA1;\r
1307 }\r
1308\r
1309 if (SessionCommon->IkeSessionType == IkeSessionTypeIkeSa) {\r
1310 //\r
1311 // Set transform attribute for DH Group - DH 1024\r
1312 //\r
1313 TransformData = (IKEV2_TRANSFORM_DATA *) (TransformData + 1);\r
1314 TransformData->TransformIndex = 3;\r
1315 TransformData->TransformType = IKEV2_TRANSFORM_TYPE_DH;\r
1316 TransformData->TransformId = IKEV2_TRANSFORM_ID_DH_1024MODP;\r
1317 } else {\r
1318 //\r
1319 // Transform type for Extended Sequence Numbers. Currently not support Extended\r
1320 // Sequence Number.\r
1321 //\r
1322 TransformData = (IKEV2_TRANSFORM_DATA *) (TransformData + 1);\r
1323 TransformData->TransformIndex = 2;\r
1324 TransformData->TransformType = IKEV2_TRANSFORM_TYPE_ESN;\r
1325 TransformData->TransformId = 0;\r
1326 }\r
1327\r
1328 //\r
1329 // Second proposal payload: 3DES + SHA1 + DH\r
1330 //\r
1331 ProposalData = (IKEV2_PROPOSAL_DATA *) (TransformData + 1);\r
1332 ProposalData->ProposalIndex = 2;\r
1333\r
1334 if (SessionCommon->IkeSessionType == IkeSessionTypeIkeSa) {\r
1335 ProposalData->ProtocolId = IPSEC_PROTO_ISAKMP;\r
1336 ProposalData->NumTransforms = 4;\r
1337 } else {\r
1338\r
1339 ChildSaSession = IKEV2_CHILD_SA_SESSION_FROM_COMMON (SessionCommon);\r
1340 ProposalData->ProtocolId = IPSEC_PROTO_IPSEC_ESP;\r
1341 ProposalData->NumTransforms = 3;\r
1342 ProposalData->Spi = AllocateZeroPool (sizeof (ChildSaSession->LocalPeerSpi));\r
1343 ASSERT (ProposalData->Spi != NULL);\r
1344 CopyMem (\r
1345 ProposalData->Spi,\r
1346 &ChildSaSession->LocalPeerSpi,\r
1347 sizeof(ChildSaSession->LocalPeerSpi)\r
1348 );\r
1349 }\r
1350\r
1351 //\r
1352 // Set transform attribute for Encryption Algorithm - AES-CBC\r
1353 //\r
1354 TransformData = (IKEV2_TRANSFORM_DATA *) (ProposalData + 1);\r
1355 TransformData->TransformIndex = 0;\r
1356 TransformData->TransformType = IKEV2_TRANSFORM_TYPE_ENCR;\r
1357 TransformData->TransformId = IKEV2_TRANSFORM_ID_ENCR_AES_CBC;\r
1358 Attribute = &TransformData->Attribute;\r
1359 Attribute->AttrType = IKEV2_ATTRIBUTE_TYPE_KEYLEN;\r
1360 Attribute->Attr.AttrLength = (UINT16) (8 * IpSecGetEncryptKeyLength (IKEV2_TRANSFORM_ID_ENCR_AES_CBC));\r
1361\r
1362 //\r
1363 // Set transform attribute for Integrity Algorithm - SHA1_96\r
1364 //\r
1365 TransformData = (IKEV2_TRANSFORM_DATA *) (TransformData + 1);\r
1366 TransformData->TransformIndex = 1;\r
1367 TransformData->TransformType = IKEV2_TRANSFORM_TYPE_INTEG;\r
1368 TransformData->TransformId = IKEV2_TRANSFORM_ID_AUTH_HMAC_SHA1_96;\r
1369\r
1370 if (SessionCommon->IkeSessionType == IkeSessionTypeIkeSa) {\r
1371 //\r
1372 // Set transform attribute for Pseduo-Random Function - HAMC_SHA1\r
1373 //\r
1374 TransformData = (IKEV2_TRANSFORM_DATA *) (TransformData + 1);\r
1375 TransformData->TransformIndex = 2;\r
1376 TransformData->TransformType = IKEV2_TRANSFORM_TYPE_PRF;\r
1377 TransformData->TransformId = IKEV2_TRANSFORM_ID_PRF_HMAC_SHA1;\r
1378 }\r
1379\r
1380 if (SessionCommon->IkeSessionType == IkeSessionTypeIkeSa) {\r
1381 //\r
1382 // Set transform attrbiute for DH Group - DH-1024\r
1383 //\r
1384 TransformData = (IKEV2_TRANSFORM_DATA *) (TransformData + 1);\r
1385 TransformData->TransformIndex = 3;\r
1386 TransformData->TransformType = IKEV2_TRANSFORM_TYPE_DH;\r
1387 TransformData->TransformId = IKEV2_TRANSFORM_ID_DH_1024MODP;\r
1388 } else {\r
1389 //\r
1390 // Transform type for Extended Sequence Numbers. Currently not support Extended\r
1391 // Sequence Number.\r
1392 //\r
1393 TransformData = (IKEV2_TRANSFORM_DATA *) (TransformData + 1);\r
1394 TransformData->TransformIndex = 2;\r
1395 TransformData->TransformType = IKEV2_TRANSFORM_TYPE_ESN;\r
1396 TransformData->TransformId = 0;\r
1397 }\r
1398\r
1399 return SaData;\r
1400}\r
1401\r
1402/**\r
1403 Store the SA into SAD.\r
1404\r
1405 @param[in] ChildSaSession Pointer to IKEV2_CHILD_SA_SESSION.\r
1406\r
1407**/\r
1408VOID\r
1409Ikev2StoreSaData (\r
1410 IN IKEV2_CHILD_SA_SESSION *ChildSaSession\r
1411 )\r
1412{\r
1413 EFI_STATUS Status;\r
1414 EFI_IPSEC_SA_ID SaId;\r
1415 EFI_IPSEC_SA_DATA2 SaData;\r
1416 IKEV2_SESSION_COMMON *SessionCommon;\r
1417 IPSEC_PRIVATE_DATA *Private;\r
1418 UINT32 TempAddressCount;\r
1419 EFI_IP_ADDRESS_INFO *TempAddressInfo;\r
1420\r
1421 SessionCommon = &ChildSaSession->SessionCommon;\r
1422 Private = SessionCommon->Private;\r
1423\r
1424 ZeroMem (&SaId, sizeof (EFI_IPSEC_SA_ID));\r
1425 ZeroMem (&SaData, sizeof (EFI_IPSEC_SA_DATA2));\r
1426\r
1427 //\r
1428 // Create a SpdSelector. In this implementation, one SPD represents\r
1429 // 2 direction traffic, so in here, there needs to reverse the local address \r
1430 // and remote address for Remote Peer's SA, then reverse again for the locate\r
1431 // SA. \r
1432 //\r
1433 TempAddressCount = ChildSaSession->SpdSelector->LocalAddressCount;\r
1434 TempAddressInfo = ChildSaSession->SpdSelector->LocalAddress;\r
1435\r
1436 ChildSaSession->SpdSelector->LocalAddressCount = ChildSaSession->SpdSelector->RemoteAddressCount;\r
1437 ChildSaSession->SpdSelector->LocalAddress = ChildSaSession->SpdSelector->RemoteAddress;\r
1438\r
1439 ChildSaSession->SpdSelector->RemoteAddress = TempAddressInfo;\r
1440 ChildSaSession->SpdSelector->RemoteAddressCount= TempAddressCount;\r
1441\r
1442 //\r
1443 // Set the SaId and SaData.\r
1444 //\r
1445 SaId.Spi = ChildSaSession->LocalPeerSpi;\r
1446 SaId.Proto = EfiIPsecESP;\r
1447 SaData.AntiReplayWindows = 16;\r
1448 SaData.SNCount = 0;\r
1449 SaData.Mode = ChildSaSession->Spd->Data->ProcessingPolicy->Mode;\r
1450\r
1451 //\r
1452 // If it is tunnel mode, should add the TunnelDest and TunnelSource for SaData.\r
1453 //\r
1454 if (SaData.Mode == EfiIPsecTunnel) {\r
1455 CopyMem (\r
1456 &SaData.TunnelSourceAddress, \r
1457 &ChildSaSession->Spd->Data->ProcessingPolicy->TunnelOption->RemoteTunnelAddress,\r
1458 sizeof (EFI_IP_ADDRESS)\r
1459 );\r
1460 CopyMem (\r
1461 &SaData.TunnelDestinationAddress,\r
1462 &ChildSaSession->Spd->Data->ProcessingPolicy->TunnelOption->LocalTunnelAddress,\r
1463 sizeof (EFI_IP_ADDRESS)\r
1464 );\r
1465 }\r
1466\r
1467 CopyMem (&SaId.DestAddress, &ChildSaSession->SessionCommon.LocalPeerIp, sizeof (EFI_IP_ADDRESS));\r
1468 CopyMem (&SaData.AlgoInfo, &ChildSaSession->ChildKeymats.LocalPeerInfo, sizeof (EFI_IPSEC_ALGO_INFO));\r
1469 SaData.SpdSelector = ChildSaSession->SpdSelector;\r
1470\r
1471 //\r
1472 // Store the remote SA into SAD.\r
1473 //\r
1474 Status = EfiIpSecConfigSetData (\r
1475 &Private->IpSecConfig,\r
1476 IPsecConfigDataTypeSad,\r
1477 (EFI_IPSEC_CONFIG_SELECTOR *) &SaId,\r
1478 &SaData,\r
1479 NULL\r
1480 );\r
1481 ASSERT_EFI_ERROR (Status);\r
1482\r
1483 //\r
1484 // Store the local SA into SAD.\r
1485 // \r
1486 ChildSaSession->SpdSelector->RemoteAddressCount = ChildSaSession->SpdSelector->LocalAddressCount;\r
1487 ChildSaSession->SpdSelector->RemoteAddress = ChildSaSession->SpdSelector->LocalAddress;\r
1488\r
1489 ChildSaSession->SpdSelector->LocalAddress = TempAddressInfo;\r
1490 ChildSaSession->SpdSelector->LocalAddressCount = TempAddressCount;\r
1491 \r
1492 SaId.Spi = ChildSaSession->RemotePeerSpi;\r
1493\r
1494 CopyMem (&SaId.DestAddress, &ChildSaSession->SessionCommon.RemotePeerIp, sizeof (EFI_IP_ADDRESS));\r
1495 CopyMem (&SaData.AlgoInfo, &ChildSaSession->ChildKeymats.RemotePeerInfo, sizeof (EFI_IPSEC_ALGO_INFO));\r
1496 SaData.SpdSelector = ChildSaSession->SpdSelector;\r
1497\r
1498 //\r
1499 // If it is tunnel mode, should add the TunnelDest and TunnelSource for SaData.\r
1500 //\r
1501 if (SaData.Mode == EfiIPsecTunnel) {\r
1502 CopyMem (\r
1503 &SaData.TunnelSourceAddress,\r
1504 &ChildSaSession->Spd->Data->ProcessingPolicy->TunnelOption->LocalTunnelAddress,\r
1505 sizeof (EFI_IP_ADDRESS)\r
1506 );\r
1507 CopyMem (\r
1508 &SaData.TunnelDestinationAddress,\r
1509 &ChildSaSession->Spd->Data->ProcessingPolicy->TunnelOption->RemoteTunnelAddress,\r
1510 sizeof (EFI_IP_ADDRESS)\r
1511 );\r
1512 }\r
1513\r
1514 Status = EfiIpSecConfigSetData (\r
1515 &Private->IpSecConfig,\r
1516 IPsecConfigDataTypeSad,\r
1517 (EFI_IPSEC_CONFIG_SELECTOR *) &SaId,\r
1518 &SaData,\r
1519 NULL\r
1520 );\r
1521\r
1522 ASSERT_EFI_ERROR (Status);\r
1523}\r
1524\r
1525/**\r
1526 Call back function of the IKE life time is over.\r
1527\r
1528 This function will mark the related IKE SA Session as deleting and trigger a \r
1529 Information negotiation.\r
1530\r
1531 @param[in] Event The signaled Event.\r
1532 @param[in] Context Pointer to data passed by caller.\r
1533 \r
1534**/\r
1535VOID\r
1536EFIAPI\r
1537Ikev2LifetimeNotify (\r
1538 IN EFI_EVENT Event,\r
1539 IN VOID *Context\r
1540 )\r
1541{\r
1542 IKEV2_SA_SESSION *IkeSaSession;\r
1543 IKEV2_CHILD_SA_SESSION *ChildSaSession;\r
1544 IKEV2_SESSION_COMMON *SessionCommon;\r
1545\r
1546 ASSERT (Context != NULL);\r
1547 SessionCommon = (IKEV2_SESSION_COMMON *) Context;\r
1548\r
1549 if (SessionCommon->IkeSessionType == IkeSessionTypeIkeSa) {\r
1550 IkeSaSession = IKEV2_SA_SESSION_FROM_COMMON (SessionCommon);\r
1551 DEBUG ((\r
1552 DEBUG_INFO,\r
1553 "\n---IkeSa Lifetime is out(cookie_i, cookie_r):(0x%lx, 0x%lx)---\n",\r
1554 IkeSaSession->InitiatorCookie,\r
1555 IkeSaSession->ResponderCookie\r
1556 ));\r
1557\r
1558 //\r
1559 // Change the IKE SA Session's State to IKE_STATE_SA_DELETING.\r
1560 //\r
1561 IKEV2_DUMP_STATE (IkeSaSession->SessionCommon.State, IkeStateSaDeleting);\r
1562 IkeSaSession->SessionCommon.State = IkeStateSaDeleting;\r
1563\r
1564 } else {\r
1565 ChildSaSession = IKEV2_CHILD_SA_SESSION_FROM_COMMON (SessionCommon);\r
1566 IkeSaSession = ChildSaSession->IkeSaSession;\r
1567\r
1568 //\r
1569 // Link the timeout child SA to the DeleteSaList.\r
1570 //\r
1571 InsertTailList (&IkeSaSession->DeleteSaList, &ChildSaSession->ByDelete);\r
1572\r
1573 //\r
1574 // Change the Child SA Session's State to IKE_STATE_SA_DELETING.\r
1575 // \r
1576 DEBUG ((\r
1577 DEBUG_INFO,\r
1578 "\n------ChildSa Lifetime is out(SPI):(0x%x)------\n",\r
1579 ChildSaSession->LocalPeerSpi\r
1580 ));\r
1581 }\r
1582\r
1583 //\r
1584 // TODO: Send the delete info packet or delete silently\r
1585 //\r
1586 mIkev2Exchange.NegotiateInfo ((UINT8 *) IkeSaSession, NULL);\r
1587}\r
1588\r
1589/**\r
1590 This function will be called if the TimeOut Event is signaled.\r
1591\r
1592 @param[in] Event The signaled Event.\r
1593 @param[in] Context The data passed by caller.\r
1594\r
1595**/\r
1596VOID\r
1597EFIAPI\r
1598Ikev2ResendNotify (\r
1599 IN EFI_EVENT Event,\r
1600 IN VOID *Context\r
1601 )\r
1602{\r
1603 IPSEC_PRIVATE_DATA *Private;\r
1604 IKEV2_SA_SESSION *IkeSaSession;\r
1605 IKEV2_CHILD_SA_SESSION *ChildSaSession;\r
1606 IKEV2_SESSION_COMMON *SessionCommon;\r
1607 LIST_ENTRY *ChildSaEntry;\r
1608 UINT8 Value;\r
1609 EFI_STATUS Status;\r
1610\r
1611 ASSERT (Context != NULL); \r
1612 IkeSaSession = NULL;\r
1613 ChildSaSession = NULL;\r
1614 SessionCommon = (IKEV2_SESSION_COMMON *) Context;\r
1615 Private = SessionCommon->Private;\r
1616\r
1617 //\r
1618 // Remove the SA session from the processing list if exceed the max retry.\r
1619 //\r
1620 if (SessionCommon->RetryCount > IKE_MAX_RETRY) {\r
1621 if (SessionCommon->IkeSessionType == IkeSessionTypeIkeSa) {\r
1622 IkeSaSession = IKEV2_SA_SESSION_FROM_COMMON (SessionCommon);\r
1623 if (IkeSaSession->SessionCommon.State == IkeStateSaDeleting) {\r
1624\r
1625 //\r
1626 // If the IkeSaSession is initiator, delete all its Child SAs before removing IKE SA.\r
1627 // If the IkesaSession is responder, all ChildSa has been remove in Ikev2HandleInfo();\r
1628 //\r
1629 for (ChildSaEntry = IkeSaSession->ChildSaEstablishSessionList.ForwardLink;\r
1630 ChildSaEntry != &IkeSaSession->ChildSaEstablishSessionList;\r
1631 ) {\r
1632 ChildSaSession = IKEV2_CHILD_SA_SESSION_BY_IKE_SA (ChildSaEntry);\r
1633 //\r
1634 // Move to next ChildSa Entry.\r
1635 //\r
1636 ChildSaEntry = ChildSaEntry->ForwardLink;\r
1637 //\r
1638 // Delete LocalSpi & RemoteSpi and remove the ChildSaSession from the\r
1639 // EstablishedChildSaList.\r
1640 //\r
1641 Ikev2ChildSaSilentDelete (IkeSaSession, ChildSaSession->LocalPeerSpi);\r
1642 }\r
1643\r
1644 //\r
1645 // If the IKE SA Delete Payload wasn't sent out successfully, Delete it from the EstablishedList.\r
1646 //\r
1647 Ikev2SaSessionRemove (&Private->Ikev2EstablishedList, &SessionCommon->RemotePeerIp);\r
1648\r
1649 if (Private != NULL && Private->IsIPsecDisabling) {\r
1650 //\r
1651 // After all IKE SAs were deleted, set the IPSEC_STATUS_DISABLED value in\r
1652 // IPsec status variable.\r
1653 //\r
1654 if (IsListEmpty (&Private->Ikev1EstablishedList) && IsListEmpty (&Private->Ikev2EstablishedList)) {\r
1655 Value = IPSEC_STATUS_DISABLED;\r
1656 Status = gRT->SetVariable (\r
1657 IPSECCONFIG_STATUS_NAME,\r
1658 &gEfiIpSecConfigProtocolGuid,\r
1659 EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
1660 sizeof (Value),\r
1661 &Value\r
1662 );\r
1663 if (!EFI_ERROR (Status)) {\r
1664 //\r
1665 // Set the Disabled Flag in Private data.\r
1666 //\r
1667 Private->IpSec.DisabledFlag = TRUE;\r
1668 Private->IsIPsecDisabling = FALSE;\r
1669 }\r
1670 }\r
1671 }\r
1672 } else {\r
1673 Ikev2SaSessionRemove (&Private->Ikev2SessionList, &SessionCommon->RemotePeerIp);\r
1674 }\r
1675 Ikev2SaSessionFree (IkeSaSession);\r
1676\r
1677 } else {\r
1678\r
1679 //\r
1680 // If the packet sent by Child SA.\r
1681 //\r
1682 ChildSaSession = IKEV2_CHILD_SA_SESSION_FROM_COMMON (SessionCommon);\r
1683 IkeSaSession = ChildSaSession->IkeSaSession;\r
1684 if (ChildSaSession->SessionCommon.State == IkeStateSaDeleting) {\r
1685\r
1686 //\r
1687 // Established Child SA should be remove from the SAD entry and \r
1688 // DeleteList. The function of Ikev2DeleteChildSaSilent() will remove \r
1689 // the childSA from the IkeSaSession->ChildSaEstablishedList. So there \r
1690 // is no need to remove it here.\r
1691 //\r
1692 Ikev2ChildSaSilentDelete (IkeSaSession, ChildSaSession->LocalPeerSpi);\r
1693 Ikev2ChildSaSessionRemove (\r
1694 &IkeSaSession->DeleteSaList,\r
1695 ChildSaSession->LocalPeerSpi,\r
1696 IKEV2_DELET_CHILDSA_LIST\r
1697 );\r
1698 } else {\r
1699 Ikev2ChildSaSessionRemove (\r
1700 &IkeSaSession->ChildSaSessionList,\r
1701 ChildSaSession->LocalPeerSpi,\r
1702 IKEV2_ESTABLISHING_CHILDSA_LIST\r
1703 );\r
1704 }\r
1705\r
1706 Ikev2ChildSaSessionFree (ChildSaSession);\r
1707 }\r
1708 return ;\r
1709 }\r
1710\r
1711 //\r
1712 // Increase the retry count.\r
1713 //\r
1714 SessionCommon->RetryCount++;\r
1715 DEBUG ((DEBUG_INFO, ">>>Resending the last packet ...\n"));\r
1716\r
1717 //\r
1718 // Resend the last packet.\r
1719 //\r
1720 Ikev2SendIkePacket (\r
1721 SessionCommon->UdpService,\r
1722 (UINT8*)SessionCommon,\r
1723 SessionCommon->LastSentPacket,\r
1724 0\r
1725 );\r
1726}\r
1727\r
1728/**\r
1729 Copy ChildSaSession->Spd->Selector to ChildSaSession->SpdSelector.\r
1730\r
1731 ChildSaSession->SpdSelector stores the real Spdselector for its SA. Sometime,\r
1732 the SpdSelector in ChildSaSession is more accurated or the scope is smaller \r
1733 than the one in ChildSaSession->Spd, especially for the tunnel mode.\r
1734 \r
1735 @param[in, out] ChildSaSession Pointer to IKEV2_CHILD_SA_SESSION related to.\r
1736 \r
1737**/\r
1738VOID\r
1739Ikev2ChildSaSessionSpdSelectorCreate (\r
1740 IN OUT IKEV2_CHILD_SA_SESSION *ChildSaSession\r
1741 ) \r
1742{\r
1743 if (ChildSaSession->Spd != NULL && ChildSaSession->Spd->Selector != NULL) {\r
1744 if (ChildSaSession->SpdSelector == NULL) {\r
1745 ChildSaSession->SpdSelector = AllocateZeroPool (sizeof (EFI_IPSEC_SPD_SELECTOR));\r
1746 ASSERT (ChildSaSession->SpdSelector != NULL);\r
1747 }\r
1748 CopyMem (\r
1749 ChildSaSession->SpdSelector, \r
1750 ChildSaSession->Spd->Selector, \r
1751 sizeof (EFI_IPSEC_SPD_SELECTOR)\r
1752 );\r
1753 ChildSaSession->SpdSelector->RemoteAddress = AllocateCopyPool (\r
1754 ChildSaSession->Spd->Selector->RemoteAddressCount * \r
1755 sizeof (EFI_IP_ADDRESS_INFO), \r
1756 ChildSaSession->Spd->Selector->RemoteAddress\r
1757 );\r
1758 ChildSaSession->SpdSelector->LocalAddress = AllocateCopyPool (\r
1759 ChildSaSession->Spd->Selector->LocalAddressCount * \r
1760 sizeof (EFI_IP_ADDRESS_INFO), \r
1761 ChildSaSession->Spd->Selector->LocalAddress\r
1762 );\r
1763\r
1764 ASSERT (ChildSaSession->SpdSelector->LocalAddress != NULL);\r
1765 ASSERT (ChildSaSession->SpdSelector->RemoteAddress != NULL);\r
1766\r
1767 ChildSaSession->SpdSelector->RemoteAddressCount = ChildSaSession->Spd->Selector->RemoteAddressCount;\r
1768 ChildSaSession->SpdSelector->LocalAddressCount = ChildSaSession->Spd->Selector->LocalAddressCount; \r
1769 }\r
1770}\r
1771\r
1772/**\r
1773 Generate a ChildSa Session and insert it into related IkeSaSession.\r
1774\r
1775 @param[in] IkeSaSession Pointer to related IKEV2_SA_SESSION.\r
1776 @param[in] UdpService Pointer to related IKE_UDP_SERVICE.\r
1777\r
1778 @return pointer of IKEV2_CHILD_SA_SESSION.\r
1779\r
1780**/\r
1781IKEV2_CHILD_SA_SESSION *\r
1782Ikev2ChildSaSessionCreate (\r
1783 IN IKEV2_SA_SESSION *IkeSaSession,\r
1784 IN IKE_UDP_SERVICE *UdpService\r
1785 )\r
1786{\r
1787 IKEV2_CHILD_SA_SESSION *ChildSaSession;\r
1788 IKEV2_SESSION_COMMON *ChildSaCommon;\r
1789\r
1790 //\r
1791 // Create a new ChildSaSession.Insert it into processing list and initiate the common parameters.\r
1792 //\r
1793 ChildSaSession = Ikev2ChildSaSessionAlloc (UdpService, IkeSaSession);\r
1794 ASSERT (ChildSaSession != NULL);\r
1795\r
1796 //\r
1797 // Set the specific parameters.\r
1798 // \r
1799 ChildSaSession->Spd = IkeSaSession->Spd;\r
1800 ChildSaCommon = &ChildSaSession->SessionCommon;\r
1801 ChildSaCommon->IsInitiator = IkeSaSession->SessionCommon.IsInitiator;\r
1802 if (IkeSaSession->SessionCommon.State == IkeStateAuth) {\r
1803 ChildSaCommon->State = IkeStateAuth;\r
1804 IKEV2_DUMP_STATE (ChildSaCommon->State, IkeStateAuth);\r
1805 } else {\r
1806 ChildSaCommon->State = IkeStateCreateChild;\r
1807 IKEV2_DUMP_STATE (ChildSaCommon->State, IkeStateCreateChild);\r
1808 }\r
1809\r
1810 //\r
1811 // If SPD->Selector is not NULL, copy it to the ChildSaSession->SpdSelector.\r
1812 // The ChildSaSession->SpdSelector might be changed after the traffic selector\r
1813 // negoniation and it will be copied into the SAData after ChildSA established.\r
1814 //\r
1815 Ikev2ChildSaSessionSpdSelectorCreate (ChildSaSession);\r
1816\r
1817 //\r
1818 // Copy first NiBlock and NrBlock to ChildSa Session\r
1819 //\r
1820 ChildSaSession->NiBlock = AllocateZeroPool (IkeSaSession->NiBlkSize);\r
1821 ASSERT (ChildSaSession->NiBlock != NULL);\r
1822 ChildSaSession->NiBlkSize = IkeSaSession->NiBlkSize;\r
1823 CopyMem (ChildSaSession->NiBlock, IkeSaSession->NiBlock, IkeSaSession->NiBlkSize);\r
1824\r
1825 ChildSaSession->NrBlock = AllocateZeroPool (IkeSaSession->NrBlkSize);\r
1826 ASSERT (ChildSaSession->NrBlock != NULL);\r
1827 ChildSaSession->NrBlkSize = IkeSaSession->NrBlkSize;\r
1828 CopyMem (ChildSaSession->NrBlock, IkeSaSession->NrBlock, IkeSaSession->NrBlkSize);\r
1829\r
1830 //\r
1831 // Only if the Create Child SA is called for the IKE_INIT Exchange and \r
1832 // IkeSaSession is initiator (Only Initiator's SPD is not NULL), Set the \r
1833 // Traffic Selectors related information here.\r
1834 //\r
1835 if (IkeSaSession->SessionCommon.State == IkeStateAuth && IkeSaSession->Spd != NULL) {\r
1836 ChildSaSession->ProtoId = IkeSaSession->Spd->Selector->NextLayerProtocol;\r
1837 ChildSaSession->LocalPort = IkeSaSession->Spd->Selector->LocalPort;\r
1838 ChildSaSession->RemotePort = IkeSaSession->Spd->Selector->RemotePort;\r
1839 }\r
1840\r
1841 //\r
1842 // Insert the new ChildSaSession into processing child SA list.\r
1843 //\r
1844 Ikev2ChildSaSessionInsert (&IkeSaSession->ChildSaSessionList, ChildSaSession);\r
1845 return ChildSaSession;\r
1846}\r
1847\r
1848/**\r
1849 Check if the SPD is related to the input Child SA Session.\r
1850\r
1851 This function is the subfunction of Ikev1AssociateSpdEntry(). It is the call\r
1852 back function of IpSecVisitConfigData(). \r
1853 \r
1854\r
1855 @param[in] Type Type of the input Config Selector.\r
1856 @param[in] Selector Pointer to the Configure Selector to be checked. \r
1857 @param[in] Data Pointer to the Configure Selector's Data passed \r
1858 from the caller.\r
1859 @param[in] SelectorSize The buffer size of Selector.\r
1860 @param[in] DataSize The buffer size of the Data.\r
1861 @param[in] Context The data passed from the caller. It is a Child\r
1862 SA Session in this context.\r
1863\r
1864 @retval EFI_SUCCESS The SPD Selector is not related to the Child SA Session. \r
1865 @retval EFI_ABORTED The SPD Selector is related to the Child SA session and \r
1866 set the ChildSaSession->Spd to point to this SPD Selector.\r
1867\r
1868**/\r
1869EFI_STATUS\r
1870Ikev2MatchSpdEntry (\r
1871 IN EFI_IPSEC_CONFIG_DATA_TYPE Type,\r
1872 IN EFI_IPSEC_CONFIG_SELECTOR *Selector,\r
1873 IN VOID *Data,\r
1874 IN UINTN SelectorSize,\r
1875 IN UINTN DataSize,\r
1876 IN VOID *Context\r
1877 )\r
1878{\r
1879 IKEV2_CHILD_SA_SESSION *ChildSaSession;\r
1880 EFI_IPSEC_SPD_SELECTOR *SpdSelector;\r
1881 EFI_IPSEC_SPD_DATA *SpdData;\r
1882 BOOLEAN IsMatch;\r
1883 UINT8 IpVersion;\r
1884\r
1885 ASSERT (Type == IPsecConfigDataTypeSpd);\r
1886 SpdData = (EFI_IPSEC_SPD_DATA *) Data;\r
1887 //\r
1888 // Bypass all non-protect SPD entry first\r
1889 //\r
1890 if (SpdData->Action != EfiIPsecActionProtect) {\r
1891 return EFI_SUCCESS;\r
1892 }\r
1893\r
1894 ChildSaSession = (IKEV2_CHILD_SA_SESSION *) Context;\r
1895 IpVersion = ChildSaSession->SessionCommon.UdpService->IpVersion;\r
1896 SpdSelector = (EFI_IPSEC_SPD_SELECTOR *) Selector; \r
1897 IsMatch = TRUE;\r
1898\r
1899 if (SpdSelector->NextLayerProtocol == EFI_IP_PROTO_UDP &&\r
1900 SpdSelector->LocalPort == IKE_DEFAULT_PORT &&\r
1901 SpdSelector->LocalPortRange == 0 &&\r
1902 SpdSelector->RemotePort == IKE_DEFAULT_PORT &&\r
1903 SpdSelector->RemotePortRange == 0\r
1904 ) {\r
1905 //\r
1906 // TODO: Skip IKE Policy here or set a SPD entry?\r
1907 //\r
1908 return EFI_SUCCESS;\r
1909 }\r
1910\r
1911 if (SpdSelector->NextLayerProtocol != EFI_IPSEC_ANY_PROTOCOL &&\r
1912 SpdSelector->NextLayerProtocol != ChildSaSession->ProtoId\r
1913 ) {\r
1914 IsMatch = FALSE;\r
1915 }\r
1916\r
1917 if (SpdSelector->LocalPort != EFI_IPSEC_ANY_PORT && SpdSelector->LocalPort != ChildSaSession->LocalPort) {\r
1918 IsMatch = FALSE;\r
1919 }\r
1920\r
1921 if (SpdSelector->RemotePort != EFI_IPSEC_ANY_PORT && SpdSelector->RemotePort != ChildSaSession->RemotePort) {\r
1922 IsMatch = FALSE;\r
1923 }\r
1924\r
1925 IsMatch = (BOOLEAN) (IsMatch && \r
1926 IpSecMatchIpAddress (\r
1927 IpVersion,\r
1928 &ChildSaSession->SessionCommon.LocalPeerIp,\r
1929 SpdSelector->LocalAddress,\r
1930 SpdSelector->LocalAddressCount\r
1931 ));\r
1932\r
1933 IsMatch = (BOOLEAN) (IsMatch && \r
1934 IpSecMatchIpAddress (\r
1935 IpVersion,\r
1936 &ChildSaSession->SessionCommon.RemotePeerIp,\r
1937 SpdSelector->RemoteAddress,\r
1938 SpdSelector->RemoteAddressCount\r
1939 ));\r
1940\r
1941 if (IsMatch) {\r
1942 ChildSaSession->Spd = IkeSearchSpdEntry (SpdSelector);\r
1943 return EFI_ABORTED;\r
1944 } else {\r
1945 return EFI_SUCCESS;\r
1946 }\r
1947}\r
1948\r
1949/**\r
1950 Check if the Algorithm ID is supported.\r
1951\r
1952 @param[in] AlgorithmId The specified Algorithm ID.\r
1953 @param[in] Type The type used to indicate the Algorithm is for Encrypt or\r
1954 Authentication.\r
1955\r
1956 @retval TRUE If the Algorithm ID is supported.\r
1957 @retval FALSE If the Algorithm ID is not supported.\r
1958\r
1959**/\r
1960BOOLEAN\r
1961Ikev2IsSupportAlg (\r
1962 IN UINT16 AlgorithmId,\r
1963 IN UINT8 Type\r
1964 )\r
1965{\r
1966 UINT8 Index;\r
1967 switch (Type) {\r
1968 case IKE_ENCRYPT_TYPE :\r
1969 for (Index = 0; Index < IKEV2_SUPPORT_ENCRYPT_ALGORITHM_NUM; Index++) {\r
1970 if (mIkev2EncryptAlgorithmList[Index] == AlgorithmId) {\r
1971 return TRUE;\r
1972 }\r
1973 }\r
1974 break;\r
1975\r
1976 case IKE_AUTH_TYPE :\r
1977 for (Index = 0; Index < IKEV2_SUPPORT_AUTH_ALGORITHM_NUM; Index++) {\r
1978 if (mIkev2AuthAlgorithmList[Index] == AlgorithmId) {\r
1979 return TRUE;\r
1980 }\r
1981 }\r
1982 break;\r
1983\r
1984 case IKE_DH_TYPE :\r
1985 for (Index = 0; Index < IKEV2_SUPPORT_DH_ALGORITHM_NUM; Index++) {\r
1986 if (mIkev2DhGroupAlgorithmList[Index] == AlgorithmId) {\r
1987 return TRUE;\r
1988 }\r
1989 }\r
1990 break;\r
1991\r
1992 case IKE_PRF_TYPE :\r
1993 for (Index = 0; Index < IKEV2_SUPPORT_PRF_ALGORITHM_NUM; Index++) {\r
1994 if (mIkev2PrfAlgorithmList[Index] == AlgorithmId) {\r
1995 return TRUE;\r
1996 }\r
1997 }\r
1998 }\r
1999 return FALSE;\r
2000}\r
2001\r
2002/**\r
2003 Get the preferred algorithm types from ProposalData.\r
2004\r
2005 @param[in] ProposalData Pointer to related IKEV2_PROPOSAL_DATA.\r
2006 @param[out] PreferEncryptAlgorithm Output of preferred encrypt algorithm.\r
2007 @param[out] PreferIntegrityAlgorithm Output of preferred integrity algorithm. \r
2008 @param[out] PreferPrfAlgorithm Output of preferred PRF algorithm. Only \r
2009 for IKE SA.\r
2010 @param[out] PreferDhGroup Output of preferred DH group. Only for \r
2011 IKE SA.\r
2012 @param[out] PreferEncryptKeylength Output of preferred encrypt key length \r
2013 in bytes.\r
2014 @param[out] IsSupportEsn Output of value about the Extented Sequence\r
2015 Number is support or not. Only for Child SA.\r
2016 @param[in] IsChildSa If it is ture, the ProposalData is for IKE\r
2017 SA. Otherwise the proposalData is for Child SA.\r
2018\r
2019**/\r
2020VOID\r
2021Ikev2ParseProposalData (\r
2022 IN IKEV2_PROPOSAL_DATA *ProposalData, \r
2023 OUT UINT16 *PreferEncryptAlgorithm,\r
2024 OUT UINT16 *PreferIntegrityAlgorithm,\r
2025 OUT UINT16 *PreferPrfAlgorithm,\r
2026 OUT UINT16 *PreferDhGroup,\r
2027 OUT UINTN *PreferEncryptKeylength,\r
2028 OUT BOOLEAN *IsSupportEsn,\r
2029 IN BOOLEAN IsChildSa\r
2030) \r
2031{\r
2032 IKEV2_TRANSFORM_DATA *TransformData;\r
2033 UINT8 TransformIndex;\r
2034\r
2035 //\r
2036 // Check input parameters.\r
2037 //\r
2038 if (ProposalData == NULL ||\r
2039 PreferEncryptAlgorithm == NULL || \r
2040 PreferIntegrityAlgorithm == NULL ||\r
2041 PreferEncryptKeylength == NULL\r
2042 ) {\r
2043 return;\r
2044 }\r
2045\r
2046 if (IsChildSa) {\r
2047 if (IsSupportEsn == NULL) {\r
2048 return;\r
2049 }\r
2050 } else {\r
2051 if (PreferPrfAlgorithm == NULL || PreferDhGroup == NULL) {\r
2052 return;\r
2053 }\r
2054 } \r
2055\r
2056 TransformData = (IKEV2_TRANSFORM_DATA *)(ProposalData + 1);\r
2057 for (TransformIndex = 0; TransformIndex < ProposalData->NumTransforms; TransformIndex++) {\r
2058 switch (TransformData->TransformType) { \r
2059 //\r
2060 // For IKE SA there are four algorithm types. Encryption Algorithm, Pseudo-random Function, \r
2061 // Integrity Algorithm, Diffie-Hellman Group. For Child SA, there are three algorithm types. \r
2062 // Encryption Algorithm, Integrity Algorithm, Extended Sequence Number.\r
2063 //\r
2064 case IKEV2_TRANSFORM_TYPE_ENCR:\r
2065 if (*PreferEncryptAlgorithm == 0 && Ikev2IsSupportAlg (TransformData->TransformId, IKE_ENCRYPT_TYPE)) {\r
2066 //\r
2067 // Check the attribute value. According to RFC, only Keylength is support.\r
2068 //\r
2069 if (TransformData->Attribute.AttrType == IKEV2_ATTRIBUTE_TYPE_KEYLEN) {\r
2070 //\r
2071 // If the Keylength is not support, continue to check the next one.\r
2072 //\r
2073 if (IpSecGetEncryptKeyLength ((UINT8)TransformData->TransformId) != (UINTN)(TransformData->Attribute.Attr.AttrValue >> 3)){\r
2074 break;\r
2075 } else {\r
2076 *PreferEncryptKeylength = TransformData->Attribute.Attr.AttrValue;\r
2077 }\r
2078 }\r
2079 *PreferEncryptAlgorithm = TransformData->TransformId;\r
2080 }\r
2081 break;\r
2082\r
2083 case IKEV2_TRANSFORM_TYPE_PRF :\r
2084 if (!IsChildSa) {\r
2085 if (*PreferPrfAlgorithm == 0 && Ikev2IsSupportAlg (TransformData->TransformId, IKE_PRF_TYPE)) {\r
2086 *PreferPrfAlgorithm = TransformData->TransformId;\r
2087 }\r
2088 } \r
2089 break;\r
2090\r
2091 case IKEV2_TRANSFORM_TYPE_INTEG :\r
2092 if (*PreferIntegrityAlgorithm == 0 && Ikev2IsSupportAlg (TransformData->TransformId, IKE_AUTH_TYPE)) {\r
2093 *PreferIntegrityAlgorithm = TransformData->TransformId;\r
2094 }\r
2095 break;\r
2096 \r
2097 case IKEV2_TRANSFORM_TYPE_DH :\r
2098 if (!IsChildSa) {\r
2099 if (*PreferDhGroup == 0 && Ikev2IsSupportAlg (TransformData->TransformId, IKE_DH_TYPE)) {\r
2100 *PreferDhGroup = TransformData->TransformId;\r
2101 }\r
2102 } \r
2103 break;\r
2104 \r
2105 case IKEV2_TRANSFORM_TYPE_ESN :\r
2106 if (IsChildSa) {\r
2107 if (TransformData->TransformId != 0) {\r
2108 *IsSupportEsn = TRUE;\r
2109 }\r
2110 } \r
2111 break;\r
2112\r
2113 default:\r
2114 break;\r
2115 }\r
2116 TransformData = (IKEV2_TRANSFORM_DATA *)(TransformData + 1);\r
2117 }\r
2118}\r
2119\r
2120/**\r
2121 Parse the received Initial Exchange Packet.\r
2122 \r
2123 This function parse the SA Payload and Key Payload to find out the cryptographic \r
2124 suite for the further IKE negotiation and fill it into the IKE SA Session's \r
2125 CommonSession->SaParams.\r
2126\r
2127 @param[in, out] IkeSaSession Pointer to related IKEV2_SA_SESSION.\r
2128 @param[in] SaPayload The received packet.\r
2129 @param[in] Type The received packet IKE header flag. \r
2130\r
2131 @retval TRUE If the SA proposal in Packet is acceptable.\r
2132 @retval FALSE If the SA proposal in Packet is not acceptable.\r
2133\r
2134**/\r
2135BOOLEAN\r
2136Ikev2SaParseSaPayload (\r
2137 IN OUT IKEV2_SA_SESSION *IkeSaSession,\r
2138 IN IKE_PAYLOAD *SaPayload,\r
2139 IN UINT8 Type\r
2140 )\r
2141{\r
2142 IKEV2_PROPOSAL_DATA *ProposalData;\r
2143 UINT8 ProposalIndex;\r
2144 UINT16 PreferEncryptAlgorithm;\r
2145 UINT16 PreferIntegrityAlgorithm;\r
2146 UINT16 PreferPrfAlgorithm;\r
2147 UINT16 PreferDhGroup;\r
2148 UINTN PreferEncryptKeylength;\r
2149 UINT16 EncryptAlgorithm;\r
2150 UINT16 IntegrityAlgorithm;\r
2151 UINT16 PrfAlgorithm;\r
2152 UINT16 DhGroup;\r
2153 UINTN EncryptKeylength;\r
2154 BOOLEAN IsMatch;\r
2155 UINTN SaDataSize;\r
2156\r
2157 PreferPrfAlgorithm = 0;\r
2158 PreferIntegrityAlgorithm = 0;\r
2159 PreferDhGroup = 0;\r
2160 PreferEncryptAlgorithm = 0;\r
2161 PreferEncryptKeylength = 0;\r
2162 PrfAlgorithm = 0;\r
2163 IntegrityAlgorithm = 0;\r
2164 DhGroup = 0;\r
2165 EncryptAlgorithm = 0;\r
2166 EncryptKeylength = 0;\r
2167 IsMatch = FALSE;\r
2168\r
2169 if (Type == IKE_HEADER_FLAGS_INIT) {\r
2170 ProposalData = (IKEV2_PROPOSAL_DATA *)((IKEV2_SA_DATA *)SaPayload->PayloadBuf + 1);\r
2171 for (ProposalIndex = 0; ProposalIndex < ((IKEV2_SA_DATA *)SaPayload->PayloadBuf)->NumProposals; ProposalIndex++) {\r
2172 //\r
2173 // Iterate each proposal to find the perfered one.\r
2174 //\r
2175 if (ProposalData->ProtocolId == IPSEC_PROTO_ISAKMP && ProposalData->NumTransforms >= 4) {\r
2176 //\r
2177 // Get the preferred algorithms.\r
2178 //\r
2179 Ikev2ParseProposalData (\r
2180 ProposalData, \r
2181 &PreferEncryptAlgorithm,\r
2182 &PreferIntegrityAlgorithm,\r
2183 &PreferPrfAlgorithm,\r
2184 &PreferDhGroup,\r
2185 &PreferEncryptKeylength,\r
2186 NULL,\r
2187 FALSE\r
2188 );\r
2189\r
2190 if (PreferEncryptAlgorithm != 0 &&\r
2191 PreferIntegrityAlgorithm != 0 &&\r
2192 PreferPrfAlgorithm != 0 && \r
2193 PreferDhGroup != 0\r
2194 ) {\r
2195 //\r
2196 // Find the matched one. \r
2197 //\r
2198 IkeSaSession->SessionCommon.SaParams = AllocateZeroPool (sizeof (IKEV2_SA_PARAMS));\r
2199 ASSERT (IkeSaSession->SessionCommon.SaParams != NULL);\r
2200 IkeSaSession->SessionCommon.SaParams->EncAlgId = PreferEncryptAlgorithm;\r
2201 IkeSaSession->SessionCommon.SaParams->EnckeyLen = PreferEncryptKeylength;\r
2202 IkeSaSession->SessionCommon.SaParams->DhGroup = PreferDhGroup;\r
2203 IkeSaSession->SessionCommon.SaParams->Prf = PreferPrfAlgorithm;\r
2204 IkeSaSession->SessionCommon.SaParams->IntegAlgId = PreferIntegrityAlgorithm;\r
2205 IkeSaSession->SessionCommon.PreferDhGroup = PreferDhGroup;\r
2206\r
2207 //\r
2208 // Save the matched one in IKEV2_SA_DATA for furthure calculation.\r
2209 //\r
2210 SaDataSize = sizeof (IKEV2_SA_DATA) +\r
2211 sizeof (IKEV2_PROPOSAL_DATA) +\r
2212 sizeof (IKEV2_TRANSFORM_DATA) * 4;\r
2213 IkeSaSession->SaData = AllocateZeroPool (SaDataSize);\r
2214 ASSERT (IkeSaSession->SaData != NULL);\r
2215\r
2216 IkeSaSession->SaData->NumProposals = 1;\r
2217\r
2218 //\r
2219 // BUGBUG: Suppose the matched proposal only has 4 transforms. If\r
2220 // The matched Proposal has more than 4 transforms means it contains\r
2221 // one than one transform with same type.\r
2222 //\r
2223 CopyMem (\r
2224 (IKEV2_PROPOSAL_DATA *) (IkeSaSession->SaData + 1), \r
2225 ProposalData, \r
2226 SaDataSize - sizeof (IKEV2_SA_DATA)\r
2227 );\r
2228\r
2229 ((IKEV2_PROPOSAL_DATA *) (IkeSaSession->SaData + 1))->ProposalIndex = 1;\r
2230 return TRUE;\r
2231 } else {\r
2232 PreferEncryptAlgorithm = 0;\r
2233 PreferIntegrityAlgorithm = 0;\r
2234 PreferPrfAlgorithm = 0;\r
2235 PreferDhGroup = 0;\r
2236 PreferEncryptKeylength = 0;\r
2237 }\r
2238 }\r
2239 //\r
2240 // Point to next Proposal.\r
2241 //\r
2242 ProposalData = (IKEV2_PROPOSAL_DATA*)((UINT8*)(ProposalData + 1) + \r
2243 ProposalData->NumTransforms * sizeof (IKEV2_TRANSFORM_DATA));\r
2244 }\r
2245 } else if (Type == IKE_HEADER_FLAGS_RESPOND) {\r
2246 //\r
2247 // First check the SA proposal's ProtoctolID and Transform Numbers. Since it is \r
2248 // the responded SA proposal, suppose it only has one proposal and the transform Numbers \r
2249 // is 4. \r
2250 //\r
2251 ProposalData = (IKEV2_PROPOSAL_DATA *)((IKEV2_SA_DATA *) SaPayload->PayloadBuf + 1);\r
2252 if (ProposalData->ProtocolId != IPSEC_PROTO_ISAKMP || ProposalData->NumTransforms != 4) {\r
2253 return FALSE;\r
2254 }\r
2255 //\r
2256 // Get the preferred algorithms. \r
2257 //\r
2258 Ikev2ParseProposalData (\r
2259 ProposalData,\r
2260 &PreferEncryptAlgorithm,\r
2261 &PreferIntegrityAlgorithm,\r
2262 &PreferPrfAlgorithm,\r
2263 &PreferDhGroup,\r
2264 &PreferEncryptKeylength,\r
2265 NULL, \r
2266 FALSE\r
2267 );\r
2268 // \r
2269 // Check if the Sa proposal data from received packet is in the IkeSaSession->SaData.\r
2270 //\r
2271 ProposalData = (IKEV2_PROPOSAL_DATA *) (IkeSaSession->SaData + 1);\r
2272\r
2273 for (ProposalIndex = 0; ProposalIndex < IkeSaSession->SaData->NumProposals && (!IsMatch); ProposalIndex++) {\r
2274 Ikev2ParseProposalData (\r
2275 ProposalData, \r
2276 &EncryptAlgorithm,\r
2277 &IntegrityAlgorithm,\r
2278 &PrfAlgorithm,\r
2279 &DhGroup,\r
2280 &EncryptKeylength,\r
2281 NULL,\r
2282 FALSE\r
2283 );\r
2284 if (EncryptAlgorithm == PreferEncryptAlgorithm &&\r
2285 EncryptKeylength == PreferEncryptKeylength &&\r
2286 IntegrityAlgorithm == PreferIntegrityAlgorithm &&\r
2287 PrfAlgorithm == PreferPrfAlgorithm &&\r
2288 DhGroup == PreferDhGroup\r
2289 ) {\r
2290 IsMatch = TRUE;\r
2291 } else {\r
2292 EncryptAlgorithm = 0;\r
2293 IntegrityAlgorithm = 0;\r
2294 PrfAlgorithm = 0;\r
2295 DhGroup = 0;\r
2296 EncryptKeylength = 0; \r
2297 }\r
2298\r
2299 ProposalData = (IKEV2_PROPOSAL_DATA*)((UINT8*)(ProposalData + 1) + \r
2300 ProposalData->NumTransforms * sizeof (IKEV2_TRANSFORM_DATA)); \r
2301 }\r
2302\r
2303 if (IsMatch) {\r
2304 IkeSaSession->SessionCommon.SaParams = AllocateZeroPool (sizeof (IKEV2_SA_PARAMS));\r
2305 ASSERT (IkeSaSession->SessionCommon.SaParams != NULL);\r
2306 IkeSaSession->SessionCommon.SaParams->EncAlgId = PreferEncryptAlgorithm;\r
2307 IkeSaSession->SessionCommon.SaParams->EnckeyLen = PreferEncryptKeylength;\r
2308 IkeSaSession->SessionCommon.SaParams->DhGroup = PreferDhGroup;\r
2309 IkeSaSession->SessionCommon.SaParams->Prf = PreferPrfAlgorithm;\r
2310 IkeSaSession->SessionCommon.SaParams->IntegAlgId = PreferIntegrityAlgorithm;\r
2311 IkeSaSession->SessionCommon.PreferDhGroup = PreferDhGroup;\r
2312 \r
2313 return TRUE;\r
2314 }\r
2315 }\r
2316 return FALSE;\r
2317}\r
2318\r
2319/**\r
2320 Parse the received Authentication Exchange Packet.\r
2321 \r
2322 This function parse the SA Payload and Key Payload to find out the cryptographic\r
2323 suite for the ESP and fill it into the Child SA Session's CommonSession->SaParams.\r
2324 \r
2325 @param[in, out] ChildSaSession Pointer to IKEV2_CHILD_SA_SESSION related to \r
2326 this Authentication Exchange.\r
2327 @param[in] SaPayload The received packet.\r
2328 @param[in] Type The IKE header's flag of received packet . \r
2329 \r
2330 @retval TRUE If the SA proposal in Packet is acceptable.\r
2331 @retval FALSE If the SA proposal in Packet is not acceptable.\r
2332\r
2333**/\r
2334BOOLEAN\r
2335Ikev2ChildSaParseSaPayload (\r
2336 IN OUT IKEV2_CHILD_SA_SESSION *ChildSaSession,\r
2337 IN IKE_PAYLOAD *SaPayload,\r
2338 IN UINT8 Type\r
2339 )\r
2340{\r
2341 IKEV2_PROPOSAL_DATA *ProposalData;\r
2342 UINT8 ProposalIndex;\r
2343 UINT16 PreferEncryptAlgorithm;\r
2344 UINT16 PreferIntegrityAlgorithm;\r
2345 UINTN PreferEncryptKeylength;\r
2346 BOOLEAN PreferIsSupportEsn;\r
2347 UINT16 EncryptAlgorithm;\r
2348 UINT16 IntegrityAlgorithm;\r
2349 UINTN EncryptKeylength;\r
2350 BOOLEAN IsSupportEsn;\r
2351 BOOLEAN IsMatch;\r
2352 UINTN SaDataSize;\r
2353\r
2354\r
2355 PreferIntegrityAlgorithm = 0;\r
2356 PreferEncryptAlgorithm = 0;\r
2357 PreferEncryptKeylength = 0;\r
2358 IntegrityAlgorithm = 0;\r
2359 EncryptAlgorithm = 0;\r
2360 EncryptKeylength = 0;\r
2361 IsMatch = TRUE;\r
2362 IsSupportEsn = FALSE;\r
2363 PreferIsSupportEsn = FALSE;\r
2364\r
2365 if (Type == IKE_HEADER_FLAGS_INIT) {\r
2366 ProposalData = (IKEV2_PROPOSAL_DATA *)((IKEV2_SA_DATA *) SaPayload->PayloadBuf + 1);\r
2367 for (ProposalIndex = 0; ProposalIndex < ((IKEV2_SA_DATA *) SaPayload->PayloadBuf)->NumProposals; ProposalIndex++) {\r
2368 //\r
2369 // Iterate each proposal to find the preferred one.\r
2370 //\r
2371 if (ProposalData->ProtocolId == IPSEC_PROTO_IPSEC_ESP && ProposalData->NumTransforms >= 3) {\r
2372 //\r
2373 // Get the preferred algorithm.\r
2374 //\r
2375 Ikev2ParseProposalData (\r
2376 ProposalData,\r
2377 &PreferEncryptAlgorithm,\r
2378 &PreferIntegrityAlgorithm,\r
2379 NULL,\r
2380 NULL,\r
2381 &PreferEncryptKeylength,\r
2382 &IsSupportEsn,\r
2383 TRUE\r
2384 );\r
2385 //\r
2386 // Don't support the ESN now.\r
2387 //\r
2388 if (PreferEncryptAlgorithm != 0 && \r
2389 PreferIntegrityAlgorithm != 0 &&\r
2390 !IsSupportEsn\r
2391 ) {\r
2392 //\r
2393 // Find the matched one. \r
2394 //\r
2395 ChildSaSession->SessionCommon.SaParams = AllocateZeroPool (sizeof (IKEV2_SA_PARAMS));\r
2396 ASSERT (ChildSaSession->SessionCommon.SaParams != NULL);\r
2397 ChildSaSession->SessionCommon.SaParams->EncAlgId = PreferEncryptAlgorithm;\r
2398 ChildSaSession->SessionCommon.SaParams->EnckeyLen = PreferEncryptKeylength;\r
2399 ChildSaSession->SessionCommon.SaParams->IntegAlgId = PreferIntegrityAlgorithm;\r
2400 CopyMem (&ChildSaSession->RemotePeerSpi, ProposalData->Spi, sizeof (ChildSaSession->RemotePeerSpi));\r
2401\r
2402 //\r
2403 // Save the matched one in IKEV2_SA_DATA for furthure calculation.\r
2404 //\r
2405 SaDataSize = sizeof (IKEV2_SA_DATA) +\r
2406 sizeof (IKEV2_PROPOSAL_DATA) +\r
2407 sizeof (IKEV2_TRANSFORM_DATA) * 4;\r
2408\r
2409 ChildSaSession->SaData = AllocateZeroPool (SaDataSize);\r
2410 ASSERT (ChildSaSession->SaData != NULL);\r
2411\r
2412 ChildSaSession->SaData->NumProposals = 1;\r
2413\r
2414 //\r
2415 // BUGBUG: Suppose there are 4 transforms in the matched proposal. If\r
2416 // the matched Proposal has more than 4 transforms that means there \r
2417 // are more than one transform with same type.\r
2418 //\r
2419 CopyMem (\r
2420 (IKEV2_PROPOSAL_DATA *) (ChildSaSession->SaData + 1),\r
2421 ProposalData,\r
2422 SaDataSize - sizeof (IKEV2_SA_DATA)\r
2423 );\r
2424\r
2425 ((IKEV2_PROPOSAL_DATA *) (ChildSaSession->SaData + 1))->ProposalIndex = 1;\r
2426\r
2427 ((IKEV2_PROPOSAL_DATA *) (ChildSaSession->SaData + 1))->Spi = AllocateCopyPool (\r
2428 sizeof (ChildSaSession->LocalPeerSpi), \r
2429 &ChildSaSession->LocalPeerSpi\r
2430 );\r
2431 ASSERT (((IKEV2_PROPOSAL_DATA *) (ChildSaSession->SaData + 1))->Spi != NULL);\r
2432 return TRUE;\r
2433\r
2434 } else {\r
2435 PreferEncryptAlgorithm = 0;\r
2436 PreferIntegrityAlgorithm = 0;\r
2437 IsSupportEsn = TRUE;\r
2438 }\r
2439 }\r
2440 //\r
2441 // Point to next Proposal\r
2442 //\r
2443 ProposalData = (IKEV2_PROPOSAL_DATA *)((UINT8 *)(ProposalData + 1) + \r
2444 ProposalData->NumTransforms * sizeof (IKEV2_TRANSFORM_DATA));\r
2445 }\r
2446 } else if (Type == IKE_HEADER_FLAGS_RESPOND) {\r
2447 //\r
2448 // First check the SA proposal's ProtoctolID and Transform Numbers. Since it is \r
2449 // the responded SA proposal, suppose it only has one proposal and the transform Numbers \r
2450 // is 3. \r
2451 //\r
2452 ProposalData = (IKEV2_PROPOSAL_DATA *)((IKEV2_SA_DATA *)SaPayload->PayloadBuf + 1);\r
2453 if (ProposalData->ProtocolId != IPSEC_PROTO_IPSEC_ESP || ProposalData->NumTransforms != 3) {\r
2454 return FALSE;\r
2455 }\r
2456 //\r
2457 // Get the preferred algorithms.\r
2458 //\r
2459 Ikev2ParseProposalData (\r
2460 ProposalData,\r
2461 &PreferEncryptAlgorithm,\r
2462 &PreferIntegrityAlgorithm,\r
2463 NULL,\r
2464 NULL,\r
2465 &PreferEncryptKeylength,\r
2466 &PreferIsSupportEsn,\r
2467 TRUE\r
2468 );\r
2469\r
2470 ProposalData = (IKEV2_PROPOSAL_DATA *) (ChildSaSession->SaData + 1);\r
2471\r
2472 for (ProposalIndex = 0; ProposalIndex < ChildSaSession->SaData->NumProposals && (!IsMatch); ProposalIndex++) {\r
2473 Ikev2ParseProposalData (\r
2474 ProposalData, \r
2475 &EncryptAlgorithm,\r
2476 &IntegrityAlgorithm,\r
2477 NULL,\r
2478 NULL,\r
2479 &EncryptKeylength,\r
2480 &IsSupportEsn,\r
2481 TRUE\r
2482 );\r
2483 if (EncryptAlgorithm == PreferEncryptAlgorithm &&\r
2484 EncryptKeylength == PreferEncryptKeylength &&\r
2485 IntegrityAlgorithm == PreferIntegrityAlgorithm &&\r
2486 IsSupportEsn == PreferIsSupportEsn \r
2487 ) {\r
2488 IsMatch = TRUE;\r
2489 } else {\r
2490 PreferEncryptAlgorithm = 0;\r
2491 PreferIntegrityAlgorithm = 0;\r
2492 IsSupportEsn = TRUE;\r
2493 }\r
2494 ProposalData = (IKEV2_PROPOSAL_DATA*)((UINT8*)(ProposalData + 1) + \r
2495 ProposalData->NumTransforms * sizeof (IKEV2_TRANSFORM_DATA)); \r
2496 }\r
2497 \r
2498 ProposalData = (IKEV2_PROPOSAL_DATA *)((IKEV2_SA_DATA *)SaPayload->PayloadBuf + 1);\r
2499 if (IsMatch) {\r
2500 ChildSaSession->SessionCommon.SaParams = AllocateZeroPool (sizeof (IKEV2_SA_PARAMS));\r
2501 ASSERT (ChildSaSession->SessionCommon.SaParams != NULL);\r
2502 ChildSaSession->SessionCommon.SaParams->EncAlgId = PreferEncryptAlgorithm;\r
2503 ChildSaSession->SessionCommon.SaParams->EnckeyLen = PreferEncryptKeylength;\r
2504 ChildSaSession->SessionCommon.SaParams->IntegAlgId = PreferIntegrityAlgorithm;\r
2505 CopyMem (&ChildSaSession->RemotePeerSpi, ProposalData->Spi, sizeof (ChildSaSession->RemotePeerSpi));\r
2506\r
2507 return TRUE;\r
2508 }\r
2509 }\r
2510 return FALSE;\r
2511}\r
2512\r
2513/**\r
2514 Generate Key buffer from fragments.\r
2515\r
2516 If the digest length of specified HashAlgId is larger than or equal with the \r
2517 required output key length, derive the key directly. Otherwise, Key Material \r
2518 needs to be PRF-based concatenation according to 2.13 of RFC 4306: \r
2519 prf+ (K,S) = T1 | T2 | T3 | T4 | ..., T1 = prf (K, S | 0x01),\r
2520 T2 = prf (K, T1 | S | 0x02), T3 = prf (K, T2 | S | 0x03),T4 = prf (K, T3 | S | 0x04)\r
2521 then derive the key from this key material.\r
2522 \r
2523 @param[in] HashAlgId The Hash Algorithm ID used to generate key.\r
2524 @param[in] HashKey Pointer to a key buffer which contains hash key.\r
2525 @param[in] HashKeyLength The length of HashKey in bytes.\r
2526 @param[in, out] OutputKey Pointer to buffer which is used to receive the \r
2527 output key.\r
2528 @param[in] OutputKeyLength The length of OutPutKey buffer.\r
2529 @param[in] Fragments Pointer to the data to be used to generate key.\r
2530 @param[in] NumFragments The numbers of the Fragement.\r
2531\r
2532 @retval EFI_SUCCESS The operation complete successfully.\r
2533 @retval EFI_INVALID_PARAMETER If NumFragments is zero.\r
2534 @retval EFI_OUT_OF_RESOURCES If the required resource can't be allocated.\r
2535 @retval Others The operation is failed.\r
2536\r
2537**/\r
2538EFI_STATUS\r
2539Ikev2SaGenerateKey (\r
2540 IN UINT8 HashAlgId,\r
2541 IN UINT8 *HashKey,\r
2542 IN UINTN HashKeyLength,\r
2543 IN OUT UINT8 *OutputKey,\r
2544 IN UINTN OutputKeyLength,\r
2545 IN PRF_DATA_FRAGMENT *Fragments,\r
2546 IN UINTN NumFragments\r
2547 )\r
2548{\r
2549 EFI_STATUS Status;\r
2550 PRF_DATA_FRAGMENT LocalFragments[3];\r
2551 UINT8 *Digest;\r
2552 UINTN DigestSize;\r
2553 UINTN Round;\r
2554 UINTN Index;\r
2555 UINTN AuthKeyLength;\r
2556 UINTN FragmentsSize;\r
2557 UINT8 TailData;\r
2558\r
2559 Status = EFI_SUCCESS;\r
2560\r
2561 if (NumFragments == 0) {\r
2562 return EFI_INVALID_PARAMETER;\r
2563 }\r
2564\r
2565 LocalFragments[0].Data = NULL;\r
2566 LocalFragments[1].Data = NULL;\r
2567 LocalFragments[2].Data = NULL;\r
2568\r
2569 AuthKeyLength = IpSecGetHmacDigestLength (HashAlgId);\r
2570 DigestSize = AuthKeyLength;\r
2571 Digest = AllocateZeroPool (AuthKeyLength);\r
2572\r
2573 if (Digest == NULL) {\r
2574 return EFI_OUT_OF_RESOURCES;\r
2575 }\r
2576 //\r
2577 // If the required output key length is less than the digest size,\r
2578 // copy the digest into OutputKey.\r
2579 //\r
2580 if (OutputKeyLength <= DigestSize) {\r
2581 Status = IpSecCryptoIoHmac (\r
2582 HashAlgId,\r
2583 HashKey, \r
2584 HashKeyLength, \r
2585 (HASH_DATA_FRAGMENT *) Fragments, \r
2586 NumFragments, \r
2587 Digest, \r
2588 DigestSize\r
2589 );\r
2590 if (EFI_ERROR (Status)) {\r
2591 goto Exit;\r
2592 }\r
2593\r
2594 CopyMem (OutputKey, Digest, OutputKeyLength);\r
2595 goto Exit;\r
2596 }\r
2597\r
2598 //\r
2599 //Otherwise, Key Material need to be PRF-based concatenation according to 2.13\r
2600 //of RFC 4306: prf+ (K,S) = T1 | T2 | T3 | T4 | ..., T1 = prf (K, S | 0x01),\r
2601 //T2 = prf (K, T1 | S | 0x02), T3 = prf (K, T2 | S | 0x03),T4 = prf (K, T3 | S | 0x04)\r
2602 //then derive the key from this key material.\r
2603 //\r
2604 FragmentsSize = 0;\r
2605 for (Index = 0; Index < NumFragments; Index++) {\r
2606 FragmentsSize = FragmentsSize + Fragments[Index].DataSize;\r
2607 }\r
2608\r
2609 LocalFragments[1].Data = AllocateZeroPool (FragmentsSize);\r
2610 ASSERT (LocalFragments[1].Data != NULL);\r
2611 LocalFragments[1].DataSize = FragmentsSize;\r
2612\r
2613 //\r
2614 // Copy all input fragments into LocalFragments[1];\r
2615 //\r
2616 FragmentsSize = 0;\r
2617 for (Index = 0; Index < NumFragments; Index++) {\r
2618 CopyMem (\r
2619 LocalFragments[1].Data + FragmentsSize, \r
2620 Fragments[Index].Data,\r
2621 Fragments[Index].DataSize\r
2622 );\r
2623 FragmentsSize = FragmentsSize + Fragments[Index].DataSize;\r
2624 }\r
2625\r
2626 //\r
2627 // Prepare 0x01 as the first tail data.\r
2628 //\r
2629 TailData = 0x01;\r
2630 LocalFragments[2].Data = &TailData;\r
2631 LocalFragments[2].DataSize = sizeof (TailData);\r
2632 //\r
2633 // Allocate buffer for the first fragment\r
2634 //\r
2635 LocalFragments[0].Data = AllocateZeroPool (AuthKeyLength);\r
2636 ASSERT (LocalFragments[0].Data != NULL);\r
2637 LocalFragments[0].DataSize = AuthKeyLength;\r
2638\r
2639 Round = (OutputKeyLength - 1) / AuthKeyLength + 1;\r
2640 for (Index = 0; Index < Round; Index++) {\r
2641 Status = IpSecCryptoIoHmac (\r
2642 HashAlgId, \r
2643 HashKey, \r
2644 HashKeyLength, \r
2645 (HASH_DATA_FRAGMENT *)(Index == 0 ? &LocalFragments[1] : LocalFragments),\r
2646 Index == 0 ? 2 : 3, \r
2647 Digest,\r
2648 DigestSize\r
2649 );\r
2650 if (EFI_ERROR(Status)) {\r
2651 goto Exit;\r
2652 }\r
2653 CopyMem (\r
2654 LocalFragments[0].Data, \r
2655 Digest, \r
2656 DigestSize\r
2657 );\r
2658 if (OutputKeyLength > DigestSize * (Index + 1)) {\r
2659 CopyMem (\r
2660 OutputKey + Index * DigestSize, \r
2661 Digest, \r
2662 DigestSize\r
2663 );\r
2664 LocalFragments[0].DataSize = DigestSize;\r
2665 TailData ++;\r
2666 } else {\r
2667 // \r
2668 // The last round\r
2669 //\r
2670 CopyMem (\r
2671 OutputKey + Index * DigestSize, \r
2672 Digest, \r
2673 OutputKeyLength - Index * DigestSize\r
2674 );\r
2675 }\r
2676 }\r
2677\r
2678Exit:\r
2679 //\r
2680 // Only First and second Framgement Data need to be freed.\r
2681 //\r
2682 for (Index = 0 ; Index < 2; Index++) {\r
2683 if (LocalFragments[Index].Data != NULL) {\r
2684 FreePool (LocalFragments[Index].Data);\r
2685 }\r
2686 }\r
2687 if (Digest != NULL) {\r
2688 FreePool (Digest);\r
2689 }\r
2690 return Status;\r
2691}\r
2692\r
EFI Development Kit II mirror for PVE