NetworkPkg/IpSecDxe/Ikev2/ChildSa.c

   1 /** @file
   2   The operations for Child SA.
   3
   4   Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
   5
   6   SPDX-License-Identifier: BSD-2-Clause-Patent
   7
   8 **/
   9
  10 #include "Utility.h"
  11
  12 /**
  13   Generate IKE Packet for CREATE_CHILD_SA exchange.
  14
  15   This IKE Packet would be the packet for creating new CHILD SA, or the packet for
  16   rekeying existing IKE SA, or the packet for existing CHILD SA.
  17
  18   @param[in] SaSession   Pointer to related SA session.
  19   @param[in] Context     The data passed by the caller.
  20
  21   return a pointer of IKE packet.
  22
  23 **/
  24 IKE_PACKET *
  25 Ikev2CreateChildGenerator (
  26   IN UINT8               *SaSession,
  27   IN VOID                *Context
  28   )
  29 {
  30
  31   IKEV2_CHILD_SA_SESSION  *ChildSaSession;
  32   IKEV2_SA_SESSION        *IkeSaSession;
  33   IKE_PACKET              *IkePacket;
  34   IKE_PAYLOAD             *NotifyPayload;
  35   UINT32                  *MessageId;
  36
  37   NotifyPayload   = NULL;
  38   MessageId       = NULL;
  39
  40   ChildSaSession  = (IKEV2_CHILD_SA_SESSION *) SaSession;
  41   if (ChildSaSession == NULL) {
  42     return NULL;
  43   }
  44
  45   IkePacket       = IkePacketAlloc();
  46   if (IkePacket == NULL) {
  47     return NULL;
  48   }
  49
  50
  51   if (Context != NULL) {
  52     MessageId = (UINT32 *) Context;
  53   }
  54
  55   IkePacket->Header->Version      = (UINT8) (2 << 4);
  56   IkePacket->Header->NextPayload  = IKEV2_PAYLOAD_TYPE_NOTIFY;
  57   IkePacket->Header->ExchangeType = IKE_XCG_TYPE_CREATE_CHILD_SA;
  58
  59   if (ChildSaSession->SessionCommon.IkeSessionType == IkeSessionTypeChildSa) {
  60     //
  61     // 1.a Fill the IkePacket->Hdr
  62     //
  63     IkePacket->Header->InitiatorCookie = ChildSaSession->IkeSaSession->InitiatorCookie;
  64     IkePacket->Header->ResponderCookie = ChildSaSession->IkeSaSession->ResponderCookie;
  65
  66     if (MessageId != NULL) {
  67       IkePacket->Header->MessageId     = *MessageId;
  68     } else {
  69       IkePacket->Header->MessageId     = ChildSaSession->MessageId;
  70     }
  71
  72     if (ChildSaSession->SessionCommon.IsInitiator) {
  73       IkePacket->Header->Flags = IKE_HEADER_FLAGS_INIT;
  74     }
  75
  76   } else {
  77     IkeSaSession  = (IKEV2_SA_SESSION *) SaSession;
  78     //
  79     // 1.a Fill the IkePacket->Hdr
  80     //
  81     IkePacket->Header->InitiatorCookie = IkeSaSession->InitiatorCookie;
  82     IkePacket->Header->ResponderCookie = IkeSaSession->ResponderCookie;
  83
  84     if (MessageId != NULL) {
  85       IkePacket->Header->MessageId     = *MessageId;
  86     } else {
  87       IkePacket->Header->MessageId     = IkeSaSession->MessageId;
  88     }
  89
  90     if (IkeSaSession->SessionCommon.IsInitiator) {
  91       IkePacket->Header->Flags = IKE_HEADER_FLAGS_INIT;
  92     }
  93   }
  94
  95   if (MessageId != NULL) {
  96     IkePacket->Header->Flags |= IKE_HEADER_FLAGS_RESPOND;
  97   }
  98
  99   //
 100   // According to RFC4306, Chapter 4.
 101   // A minimal implementation may support the CREATE_CHILD_SA exchange only to
 102   // recognize requests and reject them with a Notify payload of type NO_ADDITIONAL_SAS.
 103   //
 104   NotifyPayload = Ikev2GenerateNotifyPayload (
 105                     0,
 106                     IKEV2_PAYLOAD_TYPE_NONE,
 107                     0,
 108                     IKEV2_NOTIFICATION_NO_ADDITIONAL_SAS,
 109                     NULL,
 110                     NULL,
 111                     0
 112                     );
 113   if (NotifyPayload == NULL) {
 114     IkePacketFree (IkePacket);
 115     return NULL;
 116   }
 117
 118   IKE_PACKET_APPEND_PAYLOAD (IkePacket, NotifyPayload);
 119   //
 120   // TODO: Support the CREATE_CHILD_SA exchange.
 121   //
 122   return IkePacket;
 123 }
 124
 125 /**
 126   Parse the IKE packet of CREATE_CHILD_SA exchange.
 127
 128   This function parse the IKE packet and save the related information to further
 129   calculation.
 130
 131   @param[in] SaSession   Pointer to IKEv2_CHILD_SA_SESSION related to this Exchange.
 132   @param[in] IkePacket   Received packet to be parsed.
 133
 134
 135   @retval EFI_SUCCESS       The IKE Packet is acceptable.
 136   @retval EFI_UNSUPPORTED   Not support the CREATE_CHILD_SA request.
 137
 138 **/
 139 EFI_STATUS
 140 Ikev2CreateChildParser (
 141   IN UINT8                        *SaSession,
 142   IN IKE_PACKET                   *IkePacket
 143   )
 144 {
 145   return EFI_UNSUPPORTED;
 146 }
 147
 148 /**
 149   Routine process before the payload decoding.
 150
 151   @param[in] SessionCommon  Pointer to ChildSa SessionCommon.
 152   @param[in] PayloadBuf     Pointer to the payload.
 153   @param[in] PayloadSize    Size of PayloadBuf in byte.
 154   @param[in] PayloadType    Type of Payload.
 155
 156 **/
 157 VOID
 158 Ikev2ChildSaBeforeDecodePayload (
 159   IN UINT8              *SessionCommon,
 160   IN UINT8              *PayloadBuf,
 161   IN UINTN              PayloadSize,
 162   IN UINT8              PayloadType
 163   )
 164 {
 165
 166 }
 167
 168 /**
 169   Routine Process after the payload encoding.
 170
 171   @param[in] SessionCommon  Pointer to ChildSa SessionCommon.
 172   @param[in] PayloadBuf     Pointer to the payload.
 173   @param[in] PayloadSize    Size of PayloadBuf in byte.
 174   @param[in] PayloadType    Type of Payload.
 175
 176 **/
 177 VOID
 178 Ikev2ChildSaAfterEncodePayload (
 179   IN UINT8              *SessionCommon,
 180   IN UINT8              *PayloadBuf,
 181   IN UINTN              PayloadSize,
 182   IN UINT8              PayloadType
 183   )
 184 {
 185 }
 186
 187 IKEV2_PACKET_HANDLER  mIkev2CreateChild = {
 188   //
 189   // Create Child
 190   //
 191   Ikev2CreateChildParser,
 192   Ikev2CreateChildGenerator
 193 };