]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/Rsa2048Sha256Sign/Rsa2048Sha256Sign.py
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / BaseTools / Source / Python / Rsa2048Sha256Sign / Rsa2048Sha256Sign.py
index 952583cf4bb00fa2ef67b15d04c7c328df94bccd..df05826282ebb685f14f4dd00a686944780f759c 100644 (file)
@@ -4,23 +4,18 @@
 #   {0xa7717414, 0xc616, 0x4977, {0x94, 0x20, 0x84, 0x47, 0x12, 0xa7, 0x35, 0xbf}}\r
 # This tool has been tested with OpenSSL 1.0.1e 11 Feb 2013\r
 #\r
-# Copyright (c) 2013 - 2017, Intel Corporation. All rights reserved.<BR>\r
-# This program and the accompanying materials\r
-# are licensed and made available under the terms and conditions of the BSD License\r
-# which accompanies this distribution.  The full text of the license may be found at\r
-# http://opensource.org/licenses/bsd-license.php\r
-#\r
-# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+# Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>\r
+# SPDX-License-Identifier: BSD-2-Clause-Patent\r
 #\r
 \r
 '''\r
 Rsa2048Sha256Sign\r
 '''\r
+from __future__ import print_function\r
 \r
 import os\r
 import sys\r
-import argparse \r
+import argparse\r
 import subprocess\r
 import uuid\r
 import struct\r
@@ -32,7 +27,7 @@ from Common.BuildVersion import gBUILD_VERSION
 #\r
 __prog__      = 'Rsa2048Sha256Sign'\r
 __version__   = '%s Version %s' % (__prog__, '0.9 ' + gBUILD_VERSION)\r
-__copyright__ = 'Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved.'\r
+__copyright__ = 'Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.'\r
 __usage__     = '%s -e|-d [options] <input_file>' % (__prog__)\r
 \r
 #\r
@@ -41,7 +36,7 @@ __usage__     = '%s -e|-d [options] <input_file>' % (__prog__)
 EFI_HASH_ALGORITHM_SHA256_GUID = uuid.UUID('{51aa59de-fdf2-4ea3-bc63-875fb7842ee9}')\r
 \r
 #\r
-# Structure defintion to unpack EFI_CERT_BLOCK_RSA_2048_SHA256 from UEFI 2.4 Specification\r
+# Structure definition to unpack EFI_CERT_BLOCK_RSA_2048_SHA256 from UEFI 2.4 Specification\r
 #\r
 #   typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {\r
 #     EFI_GUID HashType;\r
@@ -49,7 +44,7 @@ EFI_HASH_ALGORITHM_SHA256_GUID = uuid.UUID('{51aa59de-fdf2-4ea3-bc63-875fb7842ee
 #     UINT8 Signature[256];\r
 #   } EFI_CERT_BLOCK_RSA_2048_SHA256;\r
 #\r
-EFI_CERT_BLOCK_RSA_2048_SHA256        = collections.namedtuple('EFI_CERT_BLOCK_RSA_2048_SHA256', ['HashType','PublicKey','Signature'])\r
+EFI_CERT_BLOCK_RSA_2048_SHA256        = collections.namedtuple('EFI_CERT_BLOCK_RSA_2048_SHA256', ['HashType', 'PublicKey', 'Signature'])\r
 EFI_CERT_BLOCK_RSA_2048_SHA256_STRUCT = struct.Struct('16s256s256s')\r
 \r
 #\r
@@ -60,22 +55,23 @@ TEST_SIGNING_PRIVATE_KEY_FILENAME = 'TestSigningPrivateKey.pem'
 if __name__ == '__main__':\r
   #\r
   # Create command line argument parser object\r
-  #  \r
-  parser = argparse.ArgumentParser(prog=__prog__, version=__version__, usage=__usage__, description=__copyright__, conflict_handler='resolve')\r
+  #\r
+  parser = argparse.ArgumentParser(prog=__prog__, usage=__usage__, description=__copyright__, conflict_handler='resolve')\r
   group = parser.add_mutually_exclusive_group(required=True)\r
   group.add_argument("-e", action="store_true", dest='Encode', help='encode file')\r
   group.add_argument("-d", action="store_true", dest='Decode', help='decode file')\r
+  group.add_argument("--version", action='version', version=__version__)\r
   parser.add_argument("-o", "--output", dest='OutputFile', type=str, metavar='filename', help="specify the output filename", required=True)\r
   parser.add_argument("--monotonic-count", dest='MonotonicCountStr', type=str, help="specify the MonotonicCount in FMP capsule.")\r
   parser.add_argument("--private-key", dest='PrivateKeyFile', type=argparse.FileType('rb'), help="specify the private key filename.  If not specified, a test signing key is used.")\r
   parser.add_argument("-v", "--verbose", dest='Verbose', action="store_true", help="increase output messages")\r
   parser.add_argument("-q", "--quiet", dest='Quiet', action="store_true", help="reduce output messages")\r
-  parser.add_argument("--debug", dest='Debug', type=int, metavar='[0-9]', choices=range(0,10), default=0, help="set debug level")\r
+  parser.add_argument("--debug", dest='Debug', type=int, metavar='[0-9]', choices=range(0, 10), default=0, help="set debug level")\r
   parser.add_argument(metavar="input_file", dest='InputFile', type=argparse.FileType('rb'), help="specify the input filename")\r
 \r
   #\r
   # Parse command line arguments\r
-  #  \r
+  #\r
   args = parser.parse_args()\r
 \r
   #\r
@@ -85,6 +81,8 @@ if __name__ == '__main__':
   try:\r
     OpenSslPath = os.environ['OPENSSL_PATH']\r
     OpenSslCommand = os.path.join(OpenSslPath, OpenSslCommand)\r
+    if ' ' in OpenSslCommand:\r
+      OpenSslCommand = '"' + OpenSslCommand + '"'\r
   except:\r
     pass\r
 \r
@@ -93,19 +91,19 @@ if __name__ == '__main__':
   #\r
   try:\r
     Process = subprocess.Popen('%s version' % (OpenSslCommand), stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\r
-  except:  \r
-    print 'ERROR: Open SSL command not available.  Please verify PATH or set OPENSSL_PATH'\r
+  except:\r
+    print('ERROR: Open SSL command not available.  Please verify PATH or set OPENSSL_PATH')\r
     sys.exit(1)\r
-    \r
+\r
   Version = Process.communicate()\r
-  if Process.returncode <> 0:\r
-    print 'ERROR: Open SSL command not available.  Please verify PATH or set OPENSSL_PATH'\r
+  if Process.returncode != 0:\r
+    print('ERROR: Open SSL command not available.  Please verify PATH or set OPENSSL_PATH')\r
     sys.exit(Process.returncode)\r
-  print Version[0]\r
-  \r
+  print(Version[0].decode('utf-8'))\r
+\r
   #\r
   # Read input file into a buffer and save input filename\r
-  #  \r
+  #\r
   args.InputFileName   = args.InputFile.name\r
   args.InputFileBuffer = args.InputFile.read()\r
   args.InputFile.close()\r
@@ -115,7 +113,7 @@ if __name__ == '__main__':
   #\r
   OutputDir = os.path.dirname(args.OutputFile)\r
   if not os.path.exists(OutputDir):\r
-    print 'ERROR: The output path does not exist: %s' % OutputDir\r
+    print('ERROR: The output path does not exist: %s' % OutputDir)\r
     sys.exit(1)\r
   args.OutputFileName = args.OutputFile\r
 \r
@@ -142,27 +140,28 @@ if __name__ == '__main__':
       args.PrivateKeyFile = open(args.PrivateKeyFileName, 'rb')\r
       args.PrivateKeyFile.close()\r
     except:\r
-      print 'ERROR: test signing private key file %s missing' % (args.PrivateKeyFileName)\r
+      print('ERROR: test signing private key file %s missing' % (args.PrivateKeyFileName))\r
       sys.exit(1)\r
 \r
   #\r
   # Extract public key from private key into STDOUT\r
   #\r
-  Process = subprocess.Popen('%s rsa -in "%s" -modulus -noout' % (OpenSslCommand, args.PrivateKeyFileName), stdout=subprocess.PIPE, stderr=subprocess.PIPE)\r
-  PublicKeyHexString = Process.communicate()[0].split('=')[1].strip()\r
+  Process = subprocess.Popen('%s rsa -in "%s" -modulus -noout' % (OpenSslCommand, args.PrivateKeyFileName), stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\r
+  PublicKeyHexString = Process.communicate()[0].split(b'=')[1].strip()\r
+  PublicKeyHexString = PublicKeyHexString.decode('utf-8')\r
   PublicKey = ''\r
   while len(PublicKeyHexString) > 0:\r
-    PublicKey = PublicKey + chr(int(PublicKeyHexString[0:2],16))\r
+    PublicKey = PublicKey + PublicKeyHexString[0:2]\r
     PublicKeyHexString=PublicKeyHexString[2:]\r
-  if Process.returncode <> 0:\r
+  if Process.returncode != 0:\r
     sys.exit(Process.returncode)\r
 \r
   if args.MonotonicCountStr:\r
     try:\r
       if args.MonotonicCountStr.upper().startswith('0X'):\r
-        args.MonotonicCountValue = (long)(args.MonotonicCountStr, 16)\r
+        args.MonotonicCountValue = int(args.MonotonicCountStr, 16)\r
       else:\r
-        args.MonotonicCountValue = (long)(args.MonotonicCountStr)\r
+        args.MonotonicCountValue = int(args.MonotonicCountStr)\r
     except:\r
         pass\r
 \r
@@ -171,20 +170,20 @@ if __name__ == '__main__':
     if args.MonotonicCountStr:\r
       format = "%dsQ" % len(args.InputFileBuffer)\r
       FullInputFileBuffer = struct.pack(format, args.InputFileBuffer, args.MonotonicCountValue)\r
-    # \r
+    #\r
     # Sign the input file using the specified private key and capture signature from STDOUT\r
     #\r
-    Process = subprocess.Popen('%s sha256 -sign "%s"' % (OpenSslCommand, args.PrivateKeyFileName), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)\r
+    Process = subprocess.Popen('%s dgst -sha256 -sign "%s"' % (OpenSslCommand, args.PrivateKeyFileName), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\r
     Signature = Process.communicate(input=FullInputFileBuffer)[0]\r
-    if Process.returncode <> 0:\r
+    if Process.returncode != 0:\r
       sys.exit(Process.returncode)\r
-      \r
+\r
     #\r
     # Write output file that contains hash GUID, Public Key, Signature, and Input data\r
-    #    \r
+    #\r
     args.OutputFile = open(args.OutputFileName, 'wb')\r
-    args.OutputFile.write(EFI_HASH_ALGORITHM_SHA256_GUID.get_bytes_le())\r
-    args.OutputFile.write(PublicKey)\r
+    args.OutputFile.write(EFI_HASH_ALGORITHM_SHA256_GUID.bytes_le)\r
+    args.OutputFile.write(bytearray.fromhex(str(PublicKey)))\r
     args.OutputFile.write(Signature)\r
     args.OutputFile.write(args.InputFileBuffer)\r
     args.OutputFile.close()\r
@@ -195,19 +194,19 @@ if __name__ == '__main__':
     #\r
     Header = EFI_CERT_BLOCK_RSA_2048_SHA256._make(EFI_CERT_BLOCK_RSA_2048_SHA256_STRUCT.unpack_from(args.InputFileBuffer))\r
     args.InputFileBuffer = args.InputFileBuffer[EFI_CERT_BLOCK_RSA_2048_SHA256_STRUCT.size:]\r
-    \r
+\r
     #\r
     # Verify that the Hash Type matches the expected SHA256 type\r
     #\r
-    if uuid.UUID(bytes_le = Header.HashType) <> EFI_HASH_ALGORITHM_SHA256_GUID:\r
-      print 'ERROR: unsupport hash GUID'\r
+    if uuid.UUID(bytes_le = Header.HashType) != EFI_HASH_ALGORITHM_SHA256_GUID:\r
+      print('ERROR: unsupport hash GUID')\r
       sys.exit(1)\r
 \r
     #\r
     # Verify the public key\r
     #\r
-    if Header.PublicKey <> PublicKey:\r
-      print 'ERROR: Public key in input file does not match public key from private key file'\r
+    if Header.PublicKey != bytearray.fromhex(PublicKey):\r
+      print('ERROR: Public key in input file does not match public key from private key file')\r
       sys.exit(1)\r
 \r
     FullInputFileBuffer = args.InputFileBuffer\r
@@ -219,18 +218,18 @@ if __name__ == '__main__':
     # Write Signature to output file\r
     #\r
     open(args.OutputFileName, 'wb').write(Header.Signature)\r
-      \r
+\r
     #\r
     # Verify signature\r
-    #    \r
-    Process = subprocess.Popen('%s sha256 -prverify "%s" -signature %s' % (OpenSslCommand, args.PrivateKeyFileName, args.OutputFileName), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)\r
+    #\r
+    Process = subprocess.Popen('%s dgst -sha256 -prverify "%s" -signature %s' % (OpenSslCommand, args.PrivateKeyFileName, args.OutputFileName), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)\r
     Process.communicate(input=FullInputFileBuffer)\r
-    if Process.returncode <> 0:\r
-      print 'ERROR: Verification failed'\r
+    if Process.returncode != 0:\r
+      print('ERROR: Verification failed')\r
       os.remove (args.OutputFileName)\r
       sys.exit(Process.returncode)\r
 \r
     #\r
-    # Save output file contents from input file \r
-    #    \r
+    # Save output file contents from input file\r
+    #\r
     open(args.OutputFileName, 'wb').write(args.InputFileBuffer)\r