MdeModulePkg CapsuleApp: Check capsule header for -D and -N options

Then meaningful error message can be shown when the input image is
unexpected.

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Yonghong Zhu <yonghong.zhu@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>

diff --git a/MdeModulePkg/Application/CapsuleApp/CapsuleApp.c b/MdeModulePkg/Application/CapsuleApp/CapsuleApp.c
index 2967b0d1dd18a6dca6747577cada975e3977c1c4..894da2f2d9d59d0ccf2a0a8ab24a41bac81d2cf5 100644 (file)
--- a/MdeModulePkg/Application/CapsuleApp/CapsuleApp.c
+++ b/MdeModulePkg/Application/CapsuleApp/CapsuleApp.c
@@ -362,6 +362,60 @@ GetEsrtFwType (
   return ESRT_FW_TYPE_UNKNOWN;\r
 }\r
 \r
   return ESRT_FW_TYPE_UNKNOWN;\r
 }\r
 \r

+/**\r
+  Validate if it is valid capsule header\r
+\r
+  This function assumes the caller provided correct CapsuleHeader pointer\r
+  and CapsuleSize.\r
+\r
+  This function validates the fields in EFI_CAPSULE_HEADER.\r
+\r
+  @param[in] CapsuleHeader  Points to a capsule header.\r
+  @param[in] CapsuleSize    Size of the whole capsule image.\r
+\r
+**/\r
+BOOLEAN\r
+IsValidCapsuleHeader (\r
+  IN EFI_CAPSULE_HEADER     *CapsuleHeader,\r
+  IN UINT64                 CapsuleSize\r
+  )\r
+{\r
+  if (CapsuleSize < sizeof (EFI_CAPSULE_HEADER)) {\r
+    return FALSE;\r
+  }\r
+  if (CapsuleHeader->CapsuleImageSize != CapsuleSize) {\r
+    return FALSE;\r
+  }\r
+  if (CapsuleHeader->HeaderSize > CapsuleHeader->CapsuleImageSize) {\r
+    return FALSE;\r
+  }\r
+  if (CapsuleHeader->HeaderSize < sizeof (EFI_CAPSULE_HEADER)) {\r
+    return FALSE;\r
+  }\r
+\r
+  return TRUE;\r
+}\r
+\r
+/**\r
+  Return if this CapsuleGuid is a FMP capsule GUID or not.\r
+\r
+  @param[in] CapsuleGuid A pointer to EFI_GUID\r
+\r
+  @retval TRUE  It is a FMP capsule GUID.\r
+  @retval FALSE It is not a FMP capsule GUID.\r
+**/\r
+BOOLEAN\r
+IsFmpCapsuleGuid (\r
+  IN EFI_GUID  *CapsuleGuid\r
+  )\r
+{\r
+  if (CompareGuid(&gEfiFmpCapsuleGuid, CapsuleGuid)) {\r
+    return TRUE;\r
+  }\r
+\r
+  return FALSE;\r
+}\r
+\r

 /**\r
   Append a capsule header on top of current image.\r
   This function follows Windows UEFI Firmware Update Platform document.\r
 /**\r
   Append a capsule header on top of current image.\r
   This function follows Windows UEFI Firmware Update Platform document.\r


@@ -407,15 +461,28 @@ CreateNestedFmp (
     Print(L"CapsuleApp: Capsule image (%s) is not found.\n", CapsuleName);\r
     goto Done;\r
   }\r
     Print(L"CapsuleApp: Capsule image (%s) is not found.\n", CapsuleName);\r
     goto Done;\r
   }\r

+  if (!IsValidCapsuleHeader (CapsuleBuffer, FileSize)) {\r
+    Print(L"CapsuleApp: Capsule image (%s) is not a valid capsule.\n", CapsuleName);\r
+    Status = EFI_INVALID_PARAMETER;\r
+    goto Done;\r
+  }\r
+\r
+  if (!IsFmpCapsuleGuid (&((EFI_CAPSULE_HEADER *) CapsuleBuffer)->CapsuleGuid)) {\r
+    Print(L"CapsuleApp: Capsule image (%s) is not a FMP capsule.\n", CapsuleName);\r
+    Status = EFI_INVALID_PARAMETER;\r
+    goto Done;\r
+  }\r

 \r
   ImageTypeId = GetCapsuleImageTypeId(CapsuleBuffer);\r
   if (ImageTypeId == NULL) {\r
     Print(L"CapsuleApp: Capsule ImageTypeId is not found.\n");\r
 \r
   ImageTypeId = GetCapsuleImageTypeId(CapsuleBuffer);\r
   if (ImageTypeId == NULL) {\r
     Print(L"CapsuleApp: Capsule ImageTypeId is not found.\n");\r

+    Status = EFI_INVALID_PARAMETER;\r

     goto Done;\r
   }\r
   FwType = GetEsrtFwType(ImageTypeId);\r
   if ((FwType != ESRT_FW_TYPE_SYSTEMFIRMWARE) && (FwType != ESRT_FW_TYPE_DEVICEFIRMWARE)) {\r
     Print(L"CapsuleApp: Capsule FwType is invalid.\n");\r
     goto Done;\r
   }\r
   FwType = GetEsrtFwType(ImageTypeId);\r
   if ((FwType != ESRT_FW_TYPE_SYSTEMFIRMWARE) && (FwType != ESRT_FW_TYPE_DEVICEFIRMWARE)) {\r
     Print(L"CapsuleApp: Capsule FwType is invalid.\n");\r

+    Status = EFI_INVALID_PARAMETER;\r

     goto Done;\r
   }\r
 \r
     goto Done;\r
   }\r
 \r


@@ -724,40 +791,6 @@ CleanGatherList (
   }\r
 }\r
 \r
   }\r
 }\r
 \r

-/**\r
-  Validate if it is valid capsule header\r
-\r
-  This function assumes the caller provided correct CapsuleHeader pointer\r
-  and CapsuleSize.\r
-\r
-  This function validates the fields in EFI_CAPSULE_HEADER.\r
-\r
-  @param[in] CapsuleHeader  Points to a capsule header.\r
-  @param[in] CapsuleSize    Size of the whole capsule image.\r
-\r
-**/\r
-BOOLEAN\r
-IsValidCapsuleHeader (\r
-  IN EFI_CAPSULE_HEADER     *CapsuleHeader,\r
-  IN UINT64                 CapsuleSize\r
-  )\r
-{\r
-  if (CapsuleSize < sizeof (EFI_CAPSULE_HEADER)) {\r
-    return FALSE;\r
-  }\r
-  if (CapsuleHeader->CapsuleImageSize != CapsuleSize) {\r
-    return FALSE;\r
-  }\r
-  if (CapsuleHeader->HeaderSize > CapsuleHeader->CapsuleImageSize) {\r
-    return FALSE;\r
-  }\r
-  if (CapsuleHeader->HeaderSize < sizeof (EFI_CAPSULE_HEADER)) {\r
-    return FALSE;\r
-  }\r
-\r
-  return TRUE;\r
-}\r
-\r

 /**\r
   Print APP usage.\r
 **/\r
 /**\r
   Print APP usage.\r
 **/\r

diff --git a/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c b/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
index 11bf2e1d4530ae23627f5a007962b552b6f59bd6..45c3ecd050ab18a6b5702680ee9fdff7b39706dd 100644 (file)
--- a/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
+++ b/MdeModulePkg/Application/CapsuleApp/CapsuleDump.c
@@ -61,6 +61,24 @@ WriteFileFromBuffer (
   IN  VOID                                 *Buffer\r
   );\r
 \r
   IN  VOID                                 *Buffer\r
   );\r
 \r

+/**\r
+  Validate if it is valid capsule header\r
+\r
+  This function assumes the caller provided correct CapsuleHeader pointer\r
+  and CapsuleSize.\r
+\r
+  This function validates the fields in EFI_CAPSULE_HEADER.\r
+\r
+  @param[in] CapsuleHeader  Points to a capsule header.\r
+  @param[in] CapsuleSize    Size of the whole capsule image.\r
+\r
+**/\r
+BOOLEAN\r
+IsValidCapsuleHeader (\r
+  IN EFI_CAPSULE_HEADER     *CapsuleHeader,\r
+  IN UINT64                 CapsuleSize\r
+  );\r
+\r

 /**\r
   Dump UX capsule information.\r
 \r
 /**\r
   Dump UX capsule information.\r
 \r


@@ -248,6 +266,11 @@ DumpCapsule (
     Print(L"CapsuleApp: Capsule (%s) is not found.\n", CapsuleName);\r
     goto Done;\r
   }\r
     Print(L"CapsuleApp: Capsule (%s) is not found.\n", CapsuleName);\r
     goto Done;\r
   }\r

+  if (!IsValidCapsuleHeader (Buffer, FileSize)) {\r
+    Print(L"CapsuleApp: Capsule image (%s) is not a valid capsule.\n", CapsuleName);\r
+    Status = EFI_INVALID_PARAMETER;\r
+    goto Done;\r
+  }\r

 \r
   CapsuleHeader = Buffer;\r
   if (CompareGuid(&CapsuleHeader->CapsuleGuid, &gWindowsUxCapsuleGuid)) {\r
 \r
   CapsuleHeader = Buffer;\r
   if (CompareGuid(&CapsuleHeader->CapsuleGuid, &gWindowsUxCapsuleGuid)) {\r