BaseTools/Capsule: Support Different Hash Algorithm for Payload Digest

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

- The capsule payload digest got hardcoded inside the GenerateCapsule
  script as "sha256".

- It would be hard for the caller to change the supported hash algorithm
  which supported on OpenSSL or Windows signtool program and platform.

- Capsule payload digest signed data is followed by the PKCS#7 standard,
  in EDK-II CryptoPkg "Pkcs7Verify ()" is supported to validate with
  several hash algorithms naturally.
  (md5, sha1, sha256, sha384, and sha512)

- Deliver below changes within this patch,
  (1) Introduce an optional argument "--hash-algorithm" to assign
      the caller expected one and leave the default value "sha256"
      to support the backward compatibility.

  (2) Add the double quotes to put the string of certificate's
      subject name inside it.

  (3) Set "Open" argument of "SignToolSubjectName" into "False".

  (4) Set "Convert" argument of "SignToolSubjectName: into "str".

  (5) Correct the actual name of the "--subject-name" flag.

  (6) Add back correct number of arguments for PayloadDescriptor
      class object initializing.

Note:
- Platform needs to support the correspond hash algorithm to validate
  the digital signature or the failure would be observed.

- Set the md5 and sha1 algorithm as EOL based on the CryptoPkg supported
  table and reject the capsule creation.

Signed-off-by: Jason1 Lin <jason1.lin@intel.com>

1 files changed, 103 insertions, 14 deletions

diff --git a/BaseTools/Source/Python/Capsule/GenerateCapsule.py b/BaseTools/Source/Python/Capsule/GenerateCapsule.py
index a773cfb2b3..fd3ee4a614 100644
--- a/BaseTools/Source/Python/Capsule/GenerateCapsule.py
+++ b/BaseTools/Source/Python/Capsule/GenerateCapsule.py
@@ -10,7 +10,7 @@
 # keep the tool as simple as possible, it has the following limitations:

 #   * Do not support vendor code bytes in a capsule.

 #

-# Copyright (c) 2018 - 2022, Intel Corporation. All rights reserved.<BR>

+# Copyright (c) 2018 - 2024, Intel Corporation. All rights reserved.<BR>

 # SPDX-License-Identifier: BSD-2-Clause-Patent

 #

 

@@ -38,11 +38,68 @@ from Common.Edk2.Capsule.FmpPayloadHeader  import FmpPayloadHeaderClass
 # Globals for help information

 #

 __prog__        = 'GenerateCapsule'

-__version__     = '0.10'

-__copyright__   = 'Copyright (c) 2022, Intel Corporation. All rights reserved.'

+__version__     = '0.11'

+__copyright__   = 'Copyright (c) 2024, Intel Corporation. All rights reserved.'

 __description__ = 'Generate a capsule.\n'

 

-def SignPayloadSignTool (Payload, ToolPath, PfxFile, SubjectName, Verbose = False):

+#

+# Globals definitions

+#

+HASH_ALG_MD5           = 'md5'

+HASH_ALG_SHA1          = 'sha1'

+HASH_ALG_SHA256        = 'sha256'

+HASH_ALG_SHA384        = 'sha384'

+HASH_ALG_SHA512        = 'sha512'

+DEFAULT_HASH_ALGORITHM = HASH_ALG_SHA256

+

+TOOL_SIGN_TOOL = 0x0

+TOOL_OPENSSL   = 0x1

+

+SIGN_TOOL_HASH_ALG_EOL_LIST = [

+    HASH_ALG_MD5,

+    HASH_ALG_SHA1,

+    ]

+

+SIGN_TOOL_HASH_ALG_SUPPORT_LIST = [

+    HASH_ALG_SHA256,

+    HASH_ALG_SHA384,

+    HASH_ALG_SHA512,

+    ]

+

+OPENSSL_HASH_ALG_EOL_LIST = [

+    HASH_ALG_MD5,

+    HASH_ALG_SHA1,

+    ]

+

+OPENSSL_HASH_ALG_SUPPORT_LIST = [

+    HASH_ALG_SHA256,

+    HASH_ALG_SHA384,

+    HASH_ALG_SHA512,

+    ]

+

+def CheckHashAlgorithmSupported (ToolType, HashAlgorithm):

+    if ToolType == TOOL_SIGN_TOOL:

+        EolList     = SIGN_TOOL_HASH_ALG_EOL_LIST

+        SupportList = SIGN_TOOL_HASH_ALG_SUPPORT_LIST

+    elif ToolType == TOOL_OPENSSL:

+        EolList     = OPENSSL_HASH_ALG_EOL_LIST

+        SupportList = OPENSSL_HASH_ALG_SUPPORT_LIST

+    else:

+        raise ValueError ('GenerateCapsule: error: unsupported type of tool.')

+

+    if HashAlgorithm.lower () in EolList:

+        raise ValueError ('GenerateCapsule: error: hash algorithm [{HashAlgorithm}] had been EOL.'.format (HashAlgorithm = HashAlgorithm))

+    elif HashAlgorithm.lower () not in SupportList:

+        raise ValueError ('GenerateCapsule: error: hash algorithm [{HashAlgorithm}] is not supported.'.format (HashAlgorithm = HashAlgorithm))

+

+    return

+

+def SignPayloadSignTool (Payload, ToolPath, PfxFile, SubjectName, HashAlgorithm = DEFAULT_HASH_ALGORITHM, Verbose = False):

+    #

+    # Check the hash algorithm is supported

+    #

+    CheckHashAlgorithmSupported (TOOL_SIGN_TOOL, HashAlgorithm)

+

     #

     # Create a temporary directory

     #

@@ -70,12 +127,12 @@ def SignPayloadSignTool (Payload, ToolPath, PfxFile, SubjectName, Verbose = Fals
         ToolPath = ''

     Command = ''

     Command = Command + '"{Path}" '.format (Path = os.path.join (ToolPath, 'signtool.exe'))

-    Command = Command + 'sign /fd sha256 /p7ce DetachedSignedData /p7co 1.2.840.113549.1.7.2 '

+    Command = Command + 'sign /fd {HashAlgorithm} /p7ce DetachedSignedData /p7co 1.2.840.113549.1.7.2 '.format (HashAlgorithm = HashAlgorithm)

     Command = Command + '/p7 {TempDir} '.format (TempDir = TempDirectoryName)

     if PfxFile is not None:

         Command = Command + '/f {PfxFile} '.format (PfxFile = PfxFile)

     if SubjectName is not None:

-        Command = Command + '/n {SubjectName} '.format (SubjectName = SubjectName)

+        Command = Command + '/n "{SubjectName}" '.format (SubjectName = SubjectName)

     Command = Command + TempFileName

     if Verbose:

         print (Command)

@@ -108,11 +165,16 @@ def SignPayloadSignTool (Payload, ToolPath, PfxFile, SubjectName, Verbose = Fals
     shutil.rmtree (TempDirectoryName)

     return Signature

 

-def VerifyPayloadSignTool (Payload, CertData, ToolPath, PfxFile, SubjectName, Verbose = False):

+def VerifyPayloadSignTool (Payload, CertData, ToolPath, PfxFile, SubjectName, HashAlgorithm = DEFAULT_HASH_ALGORITHM, Verbose = False):

     print ('signtool verify is not supported.')

     raise ValueError ('GenerateCapsule: error: signtool verify is not supported.')

 

-def SignPayloadOpenSsl (Payload, ToolPath, SignerPrivateCertFile, OtherPublicCertFile, TrustedPublicCertFile, Verbose = False):

+def SignPayloadOpenSsl (Payload, ToolPath, SignerPrivateCertFile, OtherPublicCertFile, TrustedPublicCertFile, HashAlgorithm = DEFAULT_HASH_ALGORITHM, Verbose = False):

+    #

+    # Check the hash algorithm is supported

+    #

+    CheckHashAlgorithmSupported (TOOL_OPENSSL, HashAlgorithm)

+

     #

     # Build openssl command

     #

@@ -120,7 +182,7 @@ def SignPayloadOpenSsl (Payload, ToolPath, SignerPrivateCertFile, OtherPublicCer
         ToolPath = ''

     Command = ''

     Command = Command + '"{Path}" '.format (Path = os.path.join (ToolPath, 'openssl'))

-    Command = Command + 'smime -sign -binary -outform DER -md sha256 '

+    Command = Command + 'smime -sign -binary -outform DER -md {HashAlgorithm} '.format (HashAlgorithm = HashAlgorithm)

     Command = Command + '-signer "{Private}" -certfile "{Public}"'.format (Private = SignerPrivateCertFile, Public = OtherPublicCertFile)

     if Verbose:

         print (Command)

@@ -141,7 +203,7 @@ def SignPayloadOpenSsl (Payload, ToolPath, SignerPrivateCertFile, OtherPublicCer
 

     return Signature

 

-def VerifyPayloadOpenSsl (Payload, CertData, ToolPath, SignerPrivateCertFile, OtherPublicCertFile, TrustedPublicCertFile, Verbose = False):

+def VerifyPayloadOpenSsl (Payload, CertData, ToolPath, SignerPrivateCertFile, OtherPublicCertFile, TrustedPublicCertFile, HashAlgorithm = DEFAULT_HASH_ALGORITHM, Verbose = False):

     #

     # Create a temporary directory

     #

@@ -251,8 +313,9 @@ if __name__ == '__main__':
             LowestSupportedVersion       = ConvertJsonValue (Config, 'LowestSupportedVersion', ValidateUnsignedInteger, Required = False)

             HardwareInstance             = ConvertJsonValue (Config, 'HardwareInstance', ValidateUnsignedInteger, Required = False, Default = 0)

             MonotonicCount               = ConvertJsonValue (Config, 'MonotonicCount', ValidateUnsignedInteger, Required = False, Default = 0)

+            HashAlgorithm                = ConvertJsonValue (Config, 'HashAlgorithm', str, Required = False, Default = DEFAULT_HASH_ALGORITHM)

             SignToolPfxFile              = ConvertJsonValue (Config, 'SignToolPfxFile', os.path.expandvars, Required = False, Default = None, Open = True)

-            SignToolSubjectName          = ConvertJsonValue (Config, 'SignToolSubjectName', os.path.expandvars, Required = False, Default = None, Open = True)

+            SignToolSubjectName          = ConvertJsonValue (Config, 'SignToolSubjectName', str, Required = False, Default = None, Open = False)

             OpenSslSignerPrivateCertFile = ConvertJsonValue (Config, 'OpenSslSignerPrivateCertFile', os.path.expandvars, Required = False, Default = None, Open = True)

             OpenSslOtherPublicCertFile   = ConvertJsonValue (Config, 'OpenSslOtherPublicCertFile', os.path.expandvars, Required = False, Default = None, Open = True)

             OpenSslTrustedPublicCertFile = ConvertJsonValue (Config, 'OpenSslTrustedPublicCertFile', os.path.expandvars, Required = False, Default = None, Open = True)

@@ -267,6 +330,7 @@ if __name__ == '__main__':
                                             MonotonicCount,

                                             HardwareInstance,

                                             UpdateImageIndex,

+                                            HashAlgorithm,

                                             SignToolPfxFile,

                                             SignToolSubjectName,

                                             OpenSslSignerPrivateCertFile,

@@ -307,8 +371,9 @@ if __name__ == '__main__':
             HardwareInstance             = ConvertJsonValue (Config, 'HardwareInstance', ValidateUnsignedInteger, Required = False, Default = 0)

             UpdateImageIndex             = ConvertJsonValue (Config, 'UpdateImageIndex', ValidateUnsignedInteger, Required = False, Default = 1)

             MonotonicCount               = ConvertJsonValue (Config, 'MonotonicCount', ValidateUnsignedInteger, Required = False, Default = 0)

+            HashAlgorithm                = ConvertJsonValue (Config, 'HashAlgorithm', str, Required = False, Default = DEFAULT_HASH_ALGORITHM)

             SignToolPfxFile              = ConvertJsonValue (Config, 'SignToolPfxFile', os.path.expandvars, Required = False, Default = None, Open = True)

-            SignToolSubjectName          = ConvertJsonValue (Config, 'SignToolSubjectName', os.path.expandvars, Required = False, Default = None, Open = True)

+            SignToolSubjectName          = ConvertJsonValue (Config, 'SignToolSubjectName', str, Required = False, Default = None, Open = False)

             OpenSslSignerPrivateCertFile = ConvertJsonValue (Config, 'OpenSslSignerPrivateCertFile', os.path.expandvars, Required = False, Default = None, Open = True)

             OpenSslOtherPublicCertFile   = ConvertJsonValue (Config, 'OpenSslOtherPublicCertFile', os.path.expandvars, Required = False, Default = None, Open = True)

             OpenSslTrustedPublicCertFile = ConvertJsonValue (Config, 'OpenSslTrustedPublicCertFile', os.path.expandvars, Required = False, Default = None, Open = True)

@@ -334,6 +399,7 @@ if __name__ == '__main__':
                                             MonotonicCount,

                                             HardwareInstance,

                                             UpdateImageIndex,

+                                            HashAlgorithm,

                                             SignToolPfxFile,

                                             SignToolSubjectName,

                                             OpenSslSignerPrivateCertFile,

@@ -354,6 +420,7 @@ if __name__ == '__main__':
                                   "Payload": PayloadDescriptor.Payload,

                                   "HardwareInstance": str(PayloadDescriptor.HardwareInstance),

                                   "UpdateImageIndex": str(PayloadDescriptor.UpdateImageIndex),

+                                  "HashAlgorithm": str(PayloadDescriptor.HashAlgorithm),

                                   "SignToolPfxFile": str(PayloadDescriptor.SignToolPfxFile),

                                   "SignToolSubjectName": str(PayloadDescriptor.SignToolSubjectName),

                                   "OpenSslSignerPrivateCertFile": str(PayloadDescriptor.OpenSslSignerPrivateCertFile),

@@ -409,11 +476,14 @@ if __name__ == '__main__':
         if args.HardwareInstance:

             print ('GenerateCapsule: error: Argument --hardware-instance conflicts with Argument -j')

             sys.exit (1)

+        if args.HashAlgorithm:

+            print ('GenerateCapsule: error: Argument --hash-algorithm conflicts with Argument -j')

+            sys.exit (1)

         if args.SignToolPfxFile:

             print ('GenerateCapsule: error: Argument --pfx-file conflicts with Argument -j')

             sys.exit (1)

         if args.SignToolSubjectName:

-            print ('GenerateCapsule: error: Argument --SubjectName conflicts with Argument -j')

+            print ('GenerateCapsule: error: Argument --subject-name conflicts with Argument -j')

             sys.exit (1)

         if args.OpenSslSignerPrivateCertFile:

             print ('GenerateCapsule: error: Argument --signer-private-cert conflicts with Argument -j')

@@ -437,6 +507,7 @@ if __name__ == '__main__':
                      MonotonicCount               = 0,

                      HardwareInstance             = 0,

                      UpdateImageIndex             = 1,

+                     HashAlgorithm                = None,

                      SignToolPfxFile              = None,

                      SignToolSubjectName          = None,

                      OpenSslSignerPrivateCertFile = None,

@@ -452,6 +523,7 @@ if __name__ == '__main__':
             self.MonotonicCount               = MonotonicCount

             self.HardwareInstance             = HardwareInstance

             self.UpdateImageIndex             = UpdateImageIndex

+            self.HashAlgorithm                = HashAlgorithm

             self.SignToolPfxFile              = SignToolPfxFile

             self.SignToolSubjectName          = SignToolSubjectName

             self.OpenSslSignerPrivateCertFile = OpenSslSignerPrivateCertFile

@@ -523,6 +595,9 @@ if __name__ == '__main__':
                 if args.OutputFile is None:

                     raise argparse.ArgumentTypeError ('--decode requires --output')

 

+            if self.HashAlgorithm is None:

+                self.HashAlgorithm = DEFAULT_HASH_ALGORITHM

+

             if self.UseSignTool:

                 if self.SignToolPfxFile is not None:

                     self.SignToolPfxFile.close()

@@ -568,6 +643,7 @@ if __name__ == '__main__':
                                             args.MonotonicCount,

                                             args.HardwareInstance,

                                             args.UpdateImageIndex,

+                                            args.HashAlgorithm,

                                             args.SignToolPfxFile,

                                             args.SignToolSubjectName,

                                             args.OpenSslSignerPrivateCertFile,

@@ -613,6 +689,7 @@ if __name__ == '__main__':
                             SinglePayloadDescriptor.SigningToolPath,

                             SinglePayloadDescriptor.SignToolPfxFile,

                             SinglePayloadDescriptor.SignToolSubjectName,

+                            HashAlgorithm = SinglePayloadDescriptor.HashAlgorithm,

                             Verbose = args.Verbose

                         )

                     else:

@@ -622,6 +699,7 @@ if __name__ == '__main__':
                             SinglePayloadDescriptor.OpenSslSignerPrivateCertFile,

                             SinglePayloadDescriptor.OpenSslOtherPublicCertFile,

                             SinglePayloadDescriptor.OpenSslTrustedPublicCertFile,

+                            HashAlgorithm = SinglePayloadDescriptor.HashAlgorithm,

                             Verbose = args.Verbose

                         )

                 except Exception as Msg:

@@ -693,6 +771,7 @@ if __name__ == '__main__':
                                             args.MonotonicCount,

                                             args.HardwareInstance,

                                             args.UpdateImageIndex,

+                                            args.HashAlgorithm,

                                             args.SignToolPfxFile,

                                             args.SignToolSubjectName,

                                             args.OpenSslSignerPrivateCertFile,

@@ -738,6 +817,7 @@ if __name__ == '__main__':
                                                                 None,

                                                                 HardwareInstance,

                                                                 UpdateImageIndex,

+                                                                PayloadDescriptorList[Index].HashAlgorithm,

                                                                 PayloadDescriptorList[Index].SignToolPfxFile,

                                                                 PayloadDescriptorList[Index].SignToolSubjectName,

                                                                 PayloadDescriptorList[Index].OpenSslSignerPrivateCertFile,

@@ -751,7 +831,10 @@ if __name__ == '__main__':
                     for Index in range (0, FmpCapsuleHeader.PayloadItemCount):

                         if Index > 0:

                             PayloadDecodeFile = FmpCapsuleHeader.GetFmpCapsuleImageHeader (Index).Payload

-                            PayloadDescriptorList.append (PayloadDescriptor (PayloadDecodeFile,

+                            PayloadDescriptorList.append (PayloadDescriptor (

+                                                            PayloadDecodeFile,

+                                                            None,

+                                                            None,

                                                             None,

                                                             None,

                                                             None,

@@ -777,6 +860,7 @@ if __name__ == '__main__':
                                                             None,

                                                             HardwareInstance,

                                                             UpdateImageIndex,

+                                                            PayloadDescriptorList[Index].HashAlgorithm,

                                                             PayloadDescriptorList[Index].SignToolPfxFile,

                                                             PayloadDescriptorList[Index].SignToolSubjectName,

                                                             PayloadDescriptorList[Index].OpenSslSignerPrivateCertFile,

@@ -812,6 +896,7 @@ if __name__ == '__main__':
                                            SinglePayloadDescriptor.SigningToolPath,

                                            SinglePayloadDescriptor.SignToolPfxFile,

                                            SinglePayloadDescriptor.SignToolSubjectName,

+                                           HashAlgorithm = SinglePayloadDescriptor.HashAlgorithm,

                                            Verbose = args.Verbose

                                            )

                           else:

@@ -822,6 +907,7 @@ if __name__ == '__main__':
                                            SinglePayloadDescriptor.OpenSslSignerPrivateCertFile,

                                            SinglePayloadDescriptor.OpenSslOtherPublicCertFile,

                                            SinglePayloadDescriptor.OpenSslTrustedPublicCertFile,

+                                           HashAlgorithm = SinglePayloadDescriptor.HashAlgorithm,

                                            Verbose = args.Verbose

                                            )

                         except Exception as Msg:

@@ -993,6 +1079,9 @@ if __name__ == '__main__':
     parser.add_argument ("--lsv", dest = 'LowestSupportedVersion', type = ValidateUnsignedInteger,

                          help = "The 32-bit lowest supported version of the binary payload (e.g. 0x11223344 or 5678).  Required for encode operations.")

 

+    parser.add_argument ("--hash-algorithm", dest = 'HashAlgorithm', type = str,

+                         help = "Hash algorithm for the payload digest.")

+

     parser.add_argument ("--pfx-file", dest='SignToolPfxFile', type=argparse.FileType('rb'),

                          help="signtool PFX certificate filename.")

     parser.add_argument ("--subject-name", dest='SignToolSubjectName',