]> git.proxmox.com Git - mirror_edk2.git/blobdiff - NetworkPkg/HttpDxe/HttpsSupport.c
NetworkPkg/HttpDxe: drop misleading comment / status code in cert config
[mirror_edk2.git] / NetworkPkg / HttpDxe / HttpsSupport.c
index e4d9a37bee2db1528e16c242aba0ac256313f7b2..baab77225fdfedf0570e7e6180469fd148cd158f 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Miscellaneous routines specific to Https for HttpDxe driver.\r
 \r
-Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>\r
 (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
@@ -67,11 +67,11 @@ AsciiStrCaseStr (
       Dst = *SearchStringTmp;\r
 \r
       if ((Src >= 'A') && (Src <= 'Z')) {\r
-        Src -= ('A' - 'a');\r
+        Src += ('a' - 'A');\r
       }\r
 \r
       if ((Dst >= 'A') && (Dst <= 'Z')) {\r
-        Dst -= ('A' - 'a');\r
+        Dst += ('a' - 'A');\r
       }\r
 \r
       if (Src != Dst) {\r
@@ -140,6 +140,7 @@ IsHttpsUrl (
   Creates a Tls child handle, open EFI_TLS_PROTOCOL and EFI_TLS_CONFIGURATION_PROTOCOL.\r
 \r
   @param[in]  ImageHandle           The firmware allocated handle for the UEFI image.\r
+  @param[out] TlsSb                 Pointer to the TLS SERVICE_BINDING_PROTOCOL.\r
   @param[out] TlsProto              Pointer to the EFI_TLS_PROTOCOL instance.\r
   @param[out] TlsConfiguration      Pointer to the EFI_TLS_CONFIGURATION_PROTOCOL instance.\r
 \r
@@ -150,15 +151,14 @@ EFI_HANDLE
 EFIAPI\r
 TlsCreateChild (\r
   IN  EFI_HANDLE                     ImageHandle,\r
+  OUT EFI_SERVICE_BINDING_PROTOCOL   **TlsSb,\r
   OUT EFI_TLS_PROTOCOL               **TlsProto,\r
   OUT EFI_TLS_CONFIGURATION_PROTOCOL **TlsConfiguration\r
   )\r
 {\r
   EFI_STATUS                    Status;\r
-  EFI_SERVICE_BINDING_PROTOCOL  *TlsSb;\r
   EFI_HANDLE                    TlsChildHandle;\r
 \r
-  TlsSb          = NULL;\r
   TlsChildHandle = 0;\r
 \r
   //\r
@@ -167,13 +167,13 @@ TlsCreateChild (
   gBS->LocateProtocol (\r
      &gEfiTlsServiceBindingProtocolGuid,\r
      NULL,\r
-     (VOID **) &TlsSb\r
+     (VOID **) TlsSb\r
      );\r
-  if (TlsSb == NULL) {\r
+  if (*TlsSb == NULL) {\r
     return NULL;\r
   }\r
 \r
-  Status = TlsSb->CreateChild (TlsSb, &TlsChildHandle);\r
+  Status = (*TlsSb)->CreateChild (*TlsSb, &TlsChildHandle);\r
   if (EFI_ERROR (Status)) {\r
     return NULL;\r
   }\r
@@ -187,7 +187,7 @@ TlsCreateChild (
                   EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                   );\r
   if (EFI_ERROR (Status)) {\r
-    TlsSb->DestroyChild (TlsSb, TlsChildHandle);\r
+    (*TlsSb)->DestroyChild (*TlsSb, TlsChildHandle);\r
     return NULL;\r
   }\r
 \r
@@ -200,7 +200,7 @@ TlsCreateChild (
                   EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                   );\r
   if (EFI_ERROR (Status)) {\r
-    TlsSb->DestroyChild (TlsSb, TlsChildHandle);\r
+    (*TlsSb)->DestroyChild (*TlsSb, TlsChildHandle);\r
     return NULL;\r
   }\r
 \r
@@ -423,11 +423,8 @@ TlsConfigCertificate (
   if (EFI_ERROR (Status)) {\r
     //\r
     // GetVariable still error or the variable is corrupted.\r
-    // Fall back to the default value.\r
     //\r
-    FreePool (CACert);\r
-\r
-    return EFI_NOT_FOUND;\r
+    goto FreeCACert;\r
   }\r
 \r
   ASSERT (CACert != NULL);\r
@@ -451,8 +448,7 @@ TlsConfigCertificate (
                                                  CertList->SignatureSize - sizeof (Cert->SignatureOwner)\r
                                                  );\r
       if (EFI_ERROR (Status)) {\r
-        FreePool (CACert);\r
-        return Status;\r
+        goto FreeCACert;\r
       }\r
 \r
       Cert = (EFI_SIGNATURE_DATA *) ((UINT8 *) Cert + CertList->SignatureSize);\r
@@ -462,10 +458,92 @@ TlsConfigCertificate (
     CertList = (EFI_SIGNATURE_LIST *) ((UINT8 *) CertList + CertList->SignatureListSize);\r
   }\r
 \r
+FreeCACert:\r
   FreePool (CACert);\r
   return Status;\r
 }\r
 \r
+/**\r
+  Read the HttpTlsCipherList variable and configure it for HTTPS session.\r
+\r
+  @param[in, out]  HttpInstance  The HTTP instance private data.\r
+\r
+  @retval EFI_SUCCESS            The prefered HTTP TLS CipherList is configured.\r
+  @retval EFI_NOT_FOUND          Fail to get 'HttpTlsCipherList' variable.\r
+  @retval EFI_INVALID_PARAMETER  The contents of variable are invalid.\r
+  @retval EFI_OUT_OF_RESOURCES   Can't allocate memory resources.\r
+\r
+  @retval Others                 Other error as indicated.\r
+\r
+**/\r
+EFI_STATUS\r
+TlsConfigCipherList (\r
+  IN OUT HTTP_PROTOCOL      *HttpInstance\r
+  )\r
+{\r
+  EFI_STATUS          Status;\r
+  UINT8               *CipherList;\r
+  UINTN               CipherListSize;\r
+\r
+  CipherList     = NULL;\r
+  CipherListSize = 0;\r
+\r
+  //\r
+  // Try to read the HttpTlsCipherList variable.\r
+  //\r
+  Status  = gRT->GetVariable (\r
+                   EDKII_HTTP_TLS_CIPHER_LIST_VARIABLE,\r
+                   &gEdkiiHttpTlsCipherListGuid,\r
+                   NULL,\r
+                   &CipherListSize,\r
+                   NULL\r
+                   );\r
+  ASSERT (EFI_ERROR (Status));\r
+  if (Status != EFI_BUFFER_TOO_SMALL) {\r
+    return Status;\r
+  }\r
+\r
+  if (CipherListSize % sizeof (EFI_TLS_CIPHER) != 0) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // Allocate buffer and read the config variable.\r
+  //\r
+  CipherList = AllocatePool (CipherListSize);\r
+  if (CipherList == NULL) {\r
+    return EFI_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  Status = gRT->GetVariable (\r
+                  EDKII_HTTP_TLS_CIPHER_LIST_VARIABLE,\r
+                  &gEdkiiHttpTlsCipherListGuid,\r
+                  NULL,\r
+                  &CipherListSize,\r
+                  CipherList\r
+                  );\r
+  if (EFI_ERROR (Status)) {\r
+    //\r
+    // GetVariable still error or the variable is corrupted.\r
+    //\r
+    goto ON_EXIT;\r
+  }\r
+\r
+  ASSERT (CipherList != NULL);\r
+\r
+  Status = HttpInstance->Tls->SetSessionData (\r
+                                HttpInstance->Tls,\r
+                                EfiTlsCipherList,\r
+                                CipherList,\r
+                                CipherListSize\r
+                                );\r
+\r
+ON_EXIT:  \r
+  FreePool (CipherList);\r
+  \r
+  return Status;\r
+}\r
+\r
 /**\r
   Configure TLS session data.\r
 \r
@@ -525,6 +603,15 @@ TlsConfigureSession (
     return Status;\r
   }\r
 \r
+  //\r
+  // Tls Cipher List\r
+  //\r
+  Status = TlsConfigCipherList (HttpInstance);\r
+  if (EFI_ERROR (Status) && Status != EFI_NOT_FOUND) {\r
+    DEBUG ((EFI_D_ERROR, "TlsConfigCipherList: return %r error.\n", Status));\r
+    return Status;\r
+  }\r
+\r
   //\r
   // Tls Config Certificate\r
   //\r
@@ -861,7 +948,7 @@ TlsReceiveOnePdu (
   //\r
   // Allocate buffer to receive one TLS header.\r
   //\r
-  Len     = sizeof (TLS_RECORD_HEADER);\r
+  Len     = TLS_RECORD_HEADER_LENGTH;\r
   PduHdr  = NetbufAlloc (Len);\r
   if (PduHdr == NULL) {\r
     Status = EFI_OUT_OF_RESOURCES;\r
@@ -1301,11 +1388,19 @@ TlsCloseSession (
   Process one message according to the CryptMode.\r
 \r
   @param[in]           HttpInstance    Pointer to HTTP_PROTOCOL structure.\r
-  @param[in]           Message         Pointer to the message buffer needed to processed.\r
+  @param[in]           Message         Pointer to the message buffer needed to processed. \r
+                                       If ProcessMode is EfiTlsEncrypt, the message contain the TLS\r
+                                       header and plain text TLS APP payload.\r
+                                       If ProcessMode is EfiTlsDecrypt, the message contain the TLS \r
+                                       header and cipher text TLS APP payload.\r
   @param[in]           MessageSize     Pointer to the message buffer size.\r
   @param[in]           ProcessMode     Process mode.\r
   @param[in, out]      Fragment        Only one Fragment returned after the Message is\r
                                        processed successfully.\r
+                                       If ProcessMode is EfiTlsEncrypt, the fragment contain the TLS \r
+                                       header and cipher text TLS APP payload.\r
+                                       If ProcessMode is EfiTlsDecrypt, the fragment contain the TLS \r
+                                       header and plain text TLS APP payload.\r
 \r
   @retval EFI_SUCCESS          Message is processed successfully.\r
   @retval EFI_OUT_OF_RESOURCES   Can't allocate memory resources.\r
@@ -1408,6 +1503,9 @@ TlsProcessMessage (
 ON_EXIT:\r
 \r
   if (OriginalFragmentTable != NULL) {\r
+    if( FragmentTable == OriginalFragmentTable) {\r
+      FragmentTable = NULL;\r
+    }\r
     FreePool (OriginalFragmentTable);\r
     OriginalFragmentTable = NULL;\r
   }\r
@@ -1592,7 +1690,7 @@ HttpsReceive (
       return Status;\r
     }\r
 \r
-    CopyMem (BufferIn, TempFragment.Bulk + sizeof (TLS_RECORD_HEADER), BufferInSize);\r
+    CopyMem (BufferIn, TempFragment.Bulk + TLS_RECORD_HEADER_LENGTH, BufferInSize);\r
 \r
     //\r
     // Free the buffer in TempFragment.\r