BaseTools: FMP capsule add the support to generate auth info

[mirror_edk2.git] / BaseTools / Source / Python / GenFds / FdfParser.py

diff --git a/BaseTools/Source/Python/GenFds/FdfParser.py b/BaseTools/Source/Python/GenFds/FdfParser.py
index 8709cfc0917860a0391cd5ab73a005a94b2953a7..02ae7c9f9c6bc6bfa4a078c4c84107b27a2e7734 100644 (file)
--- a/BaseTools/Source/Python/GenFds/FdfParser.py
+++ b/BaseTools/Source/Python/GenFds/FdfParser.py
@@ -52,11 +52,13 @@ import Common.GlobalData as GlobalData
 from Common.Expression import *\r
 from Common import GlobalData\r
 from Common.String import ReplaceMacro\r
-\r
+import uuid\r
 from Common.Misc import tdict\r
 \r
 import Common.LongFilePathOs as os\r
 from Common.LongFilePathSupport import OpenLongFilePath as open\r
+from Capsule import EFI_CERT_TYPE_PKCS7_GUID\r
+from Capsule import EFI_CERT_TYPE_RSA2048_SHA256_GUID\r
 \r
 ##define T_CHAR_SPACE                ' '\r
 ##define T_CHAR_NULL                 '\0'\r
@@ -1124,6 +1126,26 @@ class FdfParser:
             self.__UndoToken()\r
             return False\r
 \r
+    def __Verify(self, Name, Value, Scope):\r
+        if Scope in ['UINT64', 'UINT8']:\r
+            ValueNumber = 0\r
+            try:\r
+                if Value.upper().startswith('0X'):\r
+                    ValueNumber = int (Value, 16)\r
+                else:\r
+                    ValueNumber = int (Value)\r
+            except:\r
+                EdkLogger.error("FdfParser", FORMAT_INVALID, "The value is not valid dec or hex number for %s." % Name)\r
+            if ValueNumber < 0:\r
+                EdkLogger.error("FdfParser", FORMAT_INVALID, "The value can't be set to negative value for %s." % Name)\r
+            if Scope == 'UINT64':\r
+                if ValueNumber >= 0x10000000000000000:\r
+                    EdkLogger.error("FdfParser", FORMAT_INVALID, "Too large value for %s." % Name)\r
+            if Scope == 'UINT8':\r
+                if ValueNumber >= 0x100:\r
+                    EdkLogger.error("FdfParser", FORMAT_INVALID, "Too large value for %s." % Name)\r
+            return True\r
+\r
     ## __UndoToken() method\r
     #\r
     #   Go back one token unit in file buffer\r
@@ -3187,7 +3209,7 @@ class FdfParser:
 \r
         if not self.__GetNextToken():\r
             raise Warning("The FMP payload section is empty!", self.FileName, self.CurrentLineNumber)\r
-        FmpKeyList = ['IMAGE_HEADER_INIT_VERSION', 'IMAGE_TYPE_ID', 'IMAGE_INDEX', 'HARDWARE_INSTANCE']\r
+        FmpKeyList = ['IMAGE_HEADER_INIT_VERSION', 'IMAGE_TYPE_ID', 'IMAGE_INDEX', 'HARDWARE_INSTANCE', 'CERTIFICATE_GUID', 'MONOTONIC_COUNT']\r
         while self.__Token in FmpKeyList:\r
             Name = self.__Token\r
             FmpKeyList.remove(Name)\r
@@ -3195,32 +3217,58 @@ class FdfParser:
                 raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
             if Name == 'IMAGE_TYPE_ID':\r
                 if not self.__GetNextGuid():\r
-                    raise Warning("expected GUID value for IMAGE_TYPE_ID", self.FileName, self.CurrentLineNumber)\r
+                    raise Warning("expected GUID value for IMAGE_TYPE_ID.", self.FileName, self.CurrentLineNumber)\r
                 FmpData.ImageTypeId = self.__Token\r
+            elif Name == 'CERTIFICATE_GUID':\r
+                if not self.__GetNextGuid():\r
+                    raise Warning("expected GUID value for CERTIFICATE_GUID.", self.FileName, self.CurrentLineNumber)\r
+                FmpData.Certificate_Guid = self.__Token\r
+                if uuid.UUID(FmpData.Certificate_Guid) != EFI_CERT_TYPE_RSA2048_SHA256_GUID and uuid.UUID(FmpData.Certificate_Guid) != EFI_CERT_TYPE_PKCS7_GUID:\r
+                    raise Warning("Only support EFI_CERT_TYPE_RSA2048_SHA256_GUID or EFI_CERT_TYPE_PKCS7_GUID for CERTIFICATE_GUID.", self.FileName, self.CurrentLineNumber)\r
             else:\r
                 if not self.__GetNextToken():\r
                     raise Warning("expected value of %s" % Name, self.FileName, self.CurrentLineNumber)\r
                 Value = self.__Token\r
                 if Name == 'IMAGE_HEADER_INIT_VERSION':\r
-                    FmpData.Version = Value\r
+                    if self.__Verify(Name, Value, 'UINT8'):\r
+                        FmpData.Version = Value\r
                 elif Name == 'IMAGE_INDEX':\r
-                    FmpData.ImageIndex = Value\r
+                    if self.__Verify(Name, Value, 'UINT8'):\r
+                        FmpData.ImageIndex = Value\r
                 elif Name == 'HARDWARE_INSTANCE':\r
-                    FmpData.HardwareInstance = Value\r
+                    if self.__Verify(Name, Value, 'UINT8'):\r
+                        FmpData.HardwareInstance = Value\r
+                elif Name == 'MONOTONIC_COUNT':\r
+                    if self.__Verify(Name, Value, 'UINT64'):\r
+                        FmpData.MonotonicCount = Value\r
+                        if FmpData.MonotonicCount.upper().startswith('0X'):\r
+                            FmpData.MonotonicCount = (long)(FmpData.MonotonicCount, 16)\r
+                        else:\r
+                            FmpData.MonotonicCount = (long)(FmpData.MonotonicCount)\r
             if not self.__GetNextToken():\r
                 break\r
         else:\r
             self.__UndoToken()\r
 \r
+        if (FmpData.MonotonicCount and not FmpData.Certificate_Guid) or (not FmpData.MonotonicCount and FmpData.Certificate_Guid):\r
+            EdkLogger.error("FdfParser", FORMAT_INVALID, "CERTIFICATE_GUID and MONOTONIC_COUNT must be work as a pair.")\r
+        # remove CERTIFICATE_GUID and MONOTONIC_COUNT from FmpKeyList, since these keys are optional\r
+        if 'CERTIFICATE_GUID' in FmpKeyList:\r
+            FmpKeyList.remove('CERTIFICATE_GUID')\r
+        if 'MONOTONIC_COUNT' in FmpKeyList:\r
+            FmpKeyList.remove('MONOTONIC_COUNT')\r
         if FmpKeyList:\r
-            raise Warning("Missing keywords %s in FMP payload section" % ', '.join(FmpKeyList), self.FileName, self.CurrentLineNumber)\r
+            raise Warning("Missing keywords %s in FMP payload section." % ', '.join(FmpKeyList), self.FileName, self.CurrentLineNumber)\r
         ImageFile = self.__ParseRawFileStatement()\r
         if not ImageFile:\r
-            raise Warning("Missing image file in FMP payload section", self.FileName, self.CurrentLineNumber)\r
+            raise Warning("Missing image file in FMP payload section.", self.FileName, self.CurrentLineNumber)\r
         FmpData.ImageFile = ImageFile\r
         VendorCodeFile = self.__ParseRawFileStatement()\r
         if VendorCodeFile:\r
             FmpData.VendorCodeFile = VendorCodeFile\r
+        AdditionalFile = self.__ParseRawFileStatement()\r
+        if AdditionalFile:\r
+            raise Warning("At most one Image file and one Vendor code file are allowed in FMP payload section.", self.FileName, self.CurrentLineNumber)\r
         self.Profile.FmpPayloadDict[FmpUiName] = FmpData\r
         return True\r
 \r