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