FmpDevicePkg/FmpDxe: Improve function parameter validation

REF:https://bugzilla.tianocore.org/show_bug.cgi?id=2869

Makes some minor improvements to function parameter validation
in FmpDxe, in particular to externally exposed functions such
as those that back EFI_FIRMWARE_MANAGEMENT_PROTOCOL.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Guomin Jiang <guomin.jiang@intel.com>
Cc: Wei6 Xu <wei6.xu@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Guomin Jiang <guomin.jiang@intel.com>
Reviewed-by: Wei6 Xu <wei6.xu@intel.com>

diff --git a/FmpDevicePkg/FmpDxe/FmpDxe.c b/FmpDevicePkg/FmpDxe/FmpDxe.c
index a3e34259193679f548a6f6b933449c41e41d2210..854feec0a162b1fce7a6af0f886a60331b543037 100644 (file)
--- a/FmpDevicePkg/FmpDxe/FmpDxe.c
+++ b/FmpDevicePkg/FmpDxe/FmpDxe.c
@@ -278,6 +278,11 @@ PopulateDescriptor (
   EFI_STATUS  Status;\r
   UINT32      DependenciesSize;\r
 \r
+  if (Private == NULL) {\r
+    DEBUG ((DEBUG_ERROR, "FmpDxe(%s): PopulateDescriptor() - Private is NULL.\n", mImageIdName));\r
+    return;\r
+  }\r
+\r
   if (Private->DescriptorPopulated) {\r
     return;\r
   }\r
@@ -451,6 +456,12 @@ GetTheImageInfo (
 \r
   Status = EFI_SUCCESS;\r
 \r
+  if (This == NULL) {\r
+    DEBUG ((DEBUG_ERROR, "FmpDxe(%s): GetImageInfo() - This is NULL.\n", mImageIdName));\r
+    Status = EFI_INVALID_PARAMETER;\r
+    goto cleanup;\r
+  }\r
+\r
   //\r
   // Retrieve the private context structure\r
   //\r
@@ -561,6 +572,12 @@ GetTheImage (
 \r
   Status = EFI_SUCCESS;\r
 \r
+  if (This == NULL) {\r
+    DEBUG ((DEBUG_ERROR, "FmpDxe(%s): GetImage() - This is NULL.\n", mImageIdName));\r
+    Status = EFI_INVALID_PARAMETER;\r
+    goto cleanup;\r
+  }\r
+\r
   //\r
   // Retrieve the private context structure\r
   //\r
@@ -615,7 +632,8 @@ cleanup:
   @param[in]   Image                 Pointer to the image.\r
   @param[in]   ImageSize             Size of the image.\r
   @param[in]   AdditionalHeaderSize  Size of any headers that cannot be calculated by this function.\r
-  @param[out]  PayloadSize\r
+  @param[out]  PayloadSize           An optional pointer to a UINTN that holds the size of the payload\r
+                                     (image size minus headers)\r
 \r
   @retval  !NULL  Valid pointer to the header.\r
   @retval  NULL   Structure is bad and pointer cannot be found.\r
@@ -626,7 +644,7 @@ GetFmpHeader (
   IN  CONST EFI_FIRMWARE_IMAGE_AUTHENTICATION  *Image,\r
   IN  CONST UINTN                              ImageSize,\r
   IN  CONST UINTN                              AdditionalHeaderSize,\r
-  OUT UINTN                                    *PayloadSize\r
+  OUT UINTN                                    *PayloadSize OPTIONAL\r
   )\r
 {\r
   //\r
@@ -640,7 +658,10 @@ GetFmpHeader (
     return NULL;\r
   }\r
 \r
-  *PayloadSize = ImageSize - (sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength + AdditionalHeaderSize);\r
+  if (PayloadSize != NULL) {\r
+    *PayloadSize = ImageSize - (sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength + AdditionalHeaderSize);\r
+  }\r
+\r
   return (VOID *)((UINT8 *)Image + sizeof (Image->MonotonicCount) + Image->AuthInfo.Hdr.dwLength  + AdditionalHeaderSize);\r
 }\r
 \r
@@ -663,6 +684,11 @@ GetAllHeaderSize (
 {\r
   UINT32  CalculatedSize;\r
 \r
+  if (Image == NULL) {\r
+    DEBUG ((DEBUG_ERROR, "FmpDxe(%s): GetAllHeaderSize() - Image is NULL.\n", mImageIdName));\r
+    return 0;\r
+  }\r
+\r
   CalculatedSize = sizeof (Image->MonotonicCount) +\r
                    AdditionalHeaderSize +\r
                    Image->AuthInfo.Hdr.dwLength;\r
@@ -743,6 +769,12 @@ CheckTheImage (
     return EFI_UNSUPPORTED;\r
   }\r
 \r
+  if (This == NULL) {\r
+    DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckImage() - This is NULL.\n", mImageIdName));\r
+    Status = EFI_INVALID_PARAMETER;\r
+    goto cleanup;\r
+  }\r
+\r
   //\r
   // Retrieve the private context structure\r
   //\r
@@ -851,7 +883,7 @@ CheckTheImage (
   if (ImageIndex != 1) {\r
     DEBUG ((DEBUG_ERROR, "FmpDxe(%s): CheckImage() - Image Index Invalid.\n", mImageIdName));\r
     *ImageUpdatable = IMAGE_UPDATABLE_INVALID_TYPE;\r
-    Status = EFI_SUCCESS;\r
+    Status = EFI_INVALID_PARAMETER;\r
     goto cleanup;\r
   }\r
 \r
@@ -1026,6 +1058,12 @@ SetTheImage (
     return EFI_UNSUPPORTED;\r
   }\r
 \r
+  if (This == NULL) {\r
+    DEBUG ((DEBUG_ERROR, "FmpDxe(%s): SetTheImage() - This is NULL.\n", mImageIdName));\r
+    Status = EFI_INVALID_PARAMETER;\r
+    goto cleanup;\r
+  }\r
+\r
   //\r
   // Retrieve the private context structure\r
   //\r
@@ -1382,6 +1420,11 @@ FmpDxeLockEventNotify (
   EFI_STATUS                        Status;\r
   FIRMWARE_MANAGEMENT_PRIVATE_DATA  *Private;\r
 \r
+  if (Context == NULL) {\r
+    ASSERT (Context != NULL);\r
+    return;\r
+  }\r
+\r
   Private = (FIRMWARE_MANAGEMENT_PRIVATE_DATA *)Context;\r
 \r
   if (!Private->FmpDeviceLocked) {\r