BaseTools/Source/Python/Rsa2048Sha256Sign/Rsa2048Sha256Sign.py

   1 ## @file
   2 # This tool encodes and decodes GUIDed FFS sections or FMP capsule for a GUID type of
   3 # EFI_CERT_TYPE_RSA2048_SHA256_GUID defined in the UEFI 2.4 Specification as
   4 #   {0xa7717414, 0xc616, 0x4977, {0x94, 0x20, 0x84, 0x47, 0x12, 0xa7, 0x35, 0xbf}}
   5 # This tool has been tested with OpenSSL 1.0.1e 11 Feb 2013
   6 #
   7 # Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
   8 # This program and the accompanying materials
   9 # are licensed and made available under the terms and conditions of the BSD License
  10 # which accompanies this distribution.  The full text of the license may be found at
  11 # http://opensource.org/licenses/bsd-license.php
  12 #
  13 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15 #
  16
  17 '''
  18 Rsa2048Sha256Sign
  19 '''
  20 from __future__ import print_function
  21
  22 import os
  23 import sys
  24 import argparse
  25 import subprocess
  26 import uuid
  27 import struct
  28 import collections
  29 from Common.BuildVersion import gBUILD_VERSION
  30
  31 #
  32 # Globals for help information
  33 #
  34 __prog__      = 'Rsa2048Sha256Sign'
  35 __version__   = '%s Version %s' % (__prog__, '0.9 ' + gBUILD_VERSION)
  36 __copyright__ = 'Copyright (c) 2013 - 2016, Intel Corporation. All rights reserved.'
  37 __usage__     = '%s -e|-d [options] <input_file>' % (__prog__)
  38
  39 #
  40 # GUID for SHA 256 Hash Algorithm from UEFI Specification
  41 #
  42 EFI_HASH_ALGORITHM_SHA256_GUID = uuid.UUID('{51aa59de-fdf2-4ea3-bc63-875fb7842ee9}')
  43
  44 #
  45 # Structure defintion to unpack EFI_CERT_BLOCK_RSA_2048_SHA256 from UEFI 2.4 Specification
  46 #
  47 #   typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {
  48 #     EFI_GUID HashType;
  49 #     UINT8 PublicKey[256];
  50 #     UINT8 Signature[256];
  51 #   } EFI_CERT_BLOCK_RSA_2048_SHA256;
  52 #
  53 EFI_CERT_BLOCK_RSA_2048_SHA256        = collections.namedtuple('EFI_CERT_BLOCK_RSA_2048_SHA256', ['HashType', 'PublicKey', 'Signature'])
  54 EFI_CERT_BLOCK_RSA_2048_SHA256_STRUCT = struct.Struct('16s256s256s')
  55
  56 #
  57 # Filename of test signing private key that is stored in same directory as this tool
  58 #
  59 TEST_SIGNING_PRIVATE_KEY_FILENAME = 'TestSigningPrivateKey.pem'
  60
  61 if __name__ == '__main__':
  62   #
  63   # Create command line argument parser object
  64   #
  65   parser = argparse.ArgumentParser(prog=__prog__, version=__version__, usage=__usage__, description=__copyright__, conflict_handler='resolve')
  66   group = parser.add_mutually_exclusive_group(required=True)
  67   group.add_argument("-e", action="store_true", dest='Encode', help='encode file')
  68   group.add_argument("-d", action="store_true", dest='Decode', help='decode file')
  69   parser.add_argument("-o", "--output", dest='OutputFile', type=str, metavar='filename', help="specify the output filename", required=True)
  70   parser.add_argument("--monotonic-count", dest='MonotonicCountStr', type=str, help="specify the MonotonicCount in FMP capsule.")
  71   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.")
  72   parser.add_argument("-v", "--verbose", dest='Verbose', action="store_true", help="increase output messages")
  73   parser.add_argument("-q", "--quiet", dest='Quiet', action="store_true", help="reduce output messages")
  74   parser.add_argument("--debug", dest='Debug', type=int, metavar='[0-9]', choices=range(0, 10), default=0, help="set debug level")
  75   parser.add_argument(metavar="input_file", dest='InputFile', type=argparse.FileType('rb'), help="specify the input filename")
  76
  77   #
  78   # Parse command line arguments
  79   #
  80   args = parser.parse_args()
  81
  82   #
  83   # Generate file path to Open SSL command
  84   #
  85   OpenSslCommand = 'openssl'
  86   try:
  87     OpenSslPath = os.environ['OPENSSL_PATH']
  88     OpenSslCommand = os.path.join(OpenSslPath, OpenSslCommand)
  89     if ' ' in OpenSslCommand:
  90       OpenSslCommand = '"' + OpenSslCommand + '"'
  91   except:
  92     pass
  93
  94   #
  95   # Verify that Open SSL command is available
  96   #
  97   try:
  98     Process = subprocess.Popen('%s version' % (OpenSslCommand), stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
  99   except:
 100     print('ERROR: Open SSL command not available.  Please verify PATH or set OPENSSL_PATH')
 101     sys.exit(1)
 102
 103   Version = Process.communicate()
 104   if Process.returncode != 0:
 105     print('ERROR: Open SSL command not available.  Please verify PATH or set OPENSSL_PATH')
 106     sys.exit(Process.returncode)
 107   print(Version[0])
 108
 109   #
 110   # Read input file into a buffer and save input filename
 111   #
 112   args.InputFileName   = args.InputFile.name
 113   args.InputFileBuffer = args.InputFile.read()
 114   args.InputFile.close()
 115
 116   #
 117   # Save output filename and check if path exists
 118   #
 119   OutputDir = os.path.dirname(args.OutputFile)
 120   if not os.path.exists(OutputDir):
 121     print('ERROR: The output path does not exist: %s' % OutputDir)
 122     sys.exit(1)
 123   args.OutputFileName = args.OutputFile
 124
 125   #
 126   # Save private key filename and close private key file
 127   #
 128   try:
 129     args.PrivateKeyFileName = args.PrivateKeyFile.name
 130     args.PrivateKeyFile.close()
 131   except:
 132     try:
 133       #
 134       # Get path to currently executing script or executable
 135       #
 136       if hasattr(sys, 'frozen'):
 137           RsaToolPath = sys.executable
 138       else:
 139           RsaToolPath = sys.argv[0]
 140       if RsaToolPath.startswith('"'):
 141           RsaToolPath = RsaToolPath[1:]
 142       if RsaToolPath.endswith('"'):
 143           RsaToolPath = RsaToolPath[:-1]
 144       args.PrivateKeyFileName = os.path.join(os.path.dirname(os.path.realpath(RsaToolPath)), TEST_SIGNING_PRIVATE_KEY_FILENAME)
 145       args.PrivateKeyFile = open(args.PrivateKeyFileName, 'rb')
 146       args.PrivateKeyFile.close()
 147     except:
 148       print('ERROR: test signing private key file %s missing' % (args.PrivateKeyFileName))
 149       sys.exit(1)
 150
 151   #
 152   # Extract public key from private key into STDOUT
 153   #
 154   Process = subprocess.Popen('%s rsa -in "%s" -modulus -noout' % (OpenSslCommand, args.PrivateKeyFileName), stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
 155   PublicKeyHexString = Process.communicate()[0].split('=')[1].strip()
 156   PublicKey = ''
 157   while len(PublicKeyHexString) > 0:
 158     PublicKey = PublicKey + chr(int(PublicKeyHexString[0:2], 16))
 159     PublicKeyHexString=PublicKeyHexString[2:]
 160   if Process.returncode != 0:
 161     sys.exit(Process.returncode)
 162
 163   if args.MonotonicCountStr:
 164     try:
 165       if args.MonotonicCountStr.upper().startswith('0X'):
 166         args.MonotonicCountValue = (long)(args.MonotonicCountStr, 16)
 167       else:
 168         args.MonotonicCountValue = (long)(args.MonotonicCountStr)
 169     except:
 170         pass
 171
 172   if args.Encode:
 173     FullInputFileBuffer = args.InputFileBuffer
 174     if args.MonotonicCountStr:
 175       format = "%dsQ" % len(args.InputFileBuffer)
 176       FullInputFileBuffer = struct.pack(format, args.InputFileBuffer, args.MonotonicCountValue)
 177     #
 178     # Sign the input file using the specified private key and capture signature from STDOUT
 179     #
 180     Process = subprocess.Popen('%s dgst -sha256 -sign "%s"' % (OpenSslCommand, args.PrivateKeyFileName), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
 181     Signature = Process.communicate(input=FullInputFileBuffer)[0]
 182     if Process.returncode != 0:
 183       sys.exit(Process.returncode)
 184
 185     #
 186     # Write output file that contains hash GUID, Public Key, Signature, and Input data
 187     #
 188     args.OutputFile = open(args.OutputFileName, 'wb')
 189     args.OutputFile.write(EFI_HASH_ALGORITHM_SHA256_GUID.get_bytes_le())
 190     args.OutputFile.write(PublicKey)
 191     args.OutputFile.write(Signature)
 192     args.OutputFile.write(args.InputFileBuffer)
 193     args.OutputFile.close()
 194
 195   if args.Decode:
 196     #
 197     # Parse Hash Type, Public Key, and Signature from the section header
 198     #
 199     Header = EFI_CERT_BLOCK_RSA_2048_SHA256._make(EFI_CERT_BLOCK_RSA_2048_SHA256_STRUCT.unpack_from(args.InputFileBuffer))
 200     args.InputFileBuffer = args.InputFileBuffer[EFI_CERT_BLOCK_RSA_2048_SHA256_STRUCT.size:]
 201
 202     #
 203     # Verify that the Hash Type matches the expected SHA256 type
 204     #
 205     if uuid.UUID(bytes_le = Header.HashType) != EFI_HASH_ALGORITHM_SHA256_GUID:
 206       print('ERROR: unsupport hash GUID')
 207       sys.exit(1)
 208
 209     #
 210     # Verify the public key
 211     #
 212     if Header.PublicKey != PublicKey:
 213       print('ERROR: Public key in input file does not match public key from private key file')
 214       sys.exit(1)
 215
 216     FullInputFileBuffer = args.InputFileBuffer
 217     if args.MonotonicCountStr:
 218       format = "%dsQ" % len(args.InputFileBuffer)
 219       FullInputFileBuffer = struct.pack(format, args.InputFileBuffer, args.MonotonicCountValue)
 220
 221     #
 222     # Write Signature to output file
 223     #
 224     open(args.OutputFileName, 'wb').write(Header.Signature)
 225
 226     #
 227     # Verify signature
 228     #
 229     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)
 230     Process.communicate(input=FullInputFileBuffer)
 231     if Process.returncode != 0:
 232       print('ERROR: Verification failed')
 233       os.remove (args.OutputFileName)
 234       sys.exit(Process.returncode)
 235
 236     #
 237     # Save output file contents from input file
 238     #
 239     open(args.OutputFileName, 'wb').write(args.InputFileBuffer)