BaseTools/Source/Python/Pkcs7Sign/Pkcs7Sign.py

   1 ## @file
   2 # This tool adds EFI_FIRMWARE_IMAGE_AUTHENTICATION for a binary.
   3 #
   4 # This tool only support CertType - EFI_CERT_TYPE_PKCS7_GUID
   5 #   {0x4aafd29d, 0x68df, 0x49ee, {0x8a, 0xa9, 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7}}
   6 #
   7 # This tool has been tested with OpenSSL.
   8 #
   9 # Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>
  10 # This program and the accompanying materials
  11 # are licensed and made available under the terms and conditions of the BSD License
  12 # which accompanies this distribution.  The full text of the license may be found at
  13 # http://opensource.org/licenses/bsd-license.php
  14 #
  15 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  16 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  17 #
  18
  19 '''
  20 Pkcs7Sign
  21 '''
  22
  23 import os
  24 import sys
  25 import argparse
  26 import subprocess
  27 import uuid
  28 import struct
  29 import collections
  30 from Common.BuildVersion import gBUILD_VERSION
  31
  32 #
  33 # Globals for help information
  34 #
  35 __prog__      = 'Pkcs7Sign'
  36 __version__   = '%s Version %s' % (__prog__, '0.9 ' + gBUILD_VERSION)
  37 __copyright__ = 'Copyright (c) 2016, Intel Corporation. All rights reserved.'
  38 __usage__     = '%s -e|-d [options] <input_file>' % (__prog__)
  39
  40 #
  41 # GUID for PKCS7 from UEFI Specification
  42 #
  43 WIN_CERT_REVISION      = 0x0200
  44 WIN_CERT_TYPE_EFI_GUID = 0x0EF1
  45 EFI_CERT_TYPE_PKCS7_GUID = uuid.UUID('{4aafd29d-68df-49ee-8aa9-347d375665a7}')
  46
  47 #
  48 # typedef struct _WIN_CERTIFICATE {
  49 #   UINT32 dwLength;
  50 #   UINT16 wRevision;
  51 #   UINT16 wCertificateType;
  52 # //UINT8 bCertificate[ANYSIZE_ARRAY];
  53 # } WIN_CERTIFICATE;
  54 #
  55 # typedef struct _WIN_CERTIFICATE_UEFI_GUID {
  56 #   WIN_CERTIFICATE Hdr;
  57 #   EFI_GUID        CertType;
  58 # //UINT8 CertData[ANYSIZE_ARRAY];
  59 # } WIN_CERTIFICATE_UEFI_GUID;
  60 #
  61 # typedef struct {
  62 #   UINT64                    MonotonicCount;
  63 #   WIN_CERTIFICATE_UEFI_GUID AuthInfo;
  64 # } EFI_FIRMWARE_IMAGE_AUTHENTICATION;
  65 #
  66
  67 #
  68 # Filename of test signing private cert that is stored in same directory as this tool
  69 #
  70 TEST_SIGNER_PRIVATE_CERT_FILENAME = 'TestCert.pem'
  71 TEST_OTHER_PUBLIC_CERT_FILENAME = 'TestSub.pub.pem'
  72 TEST_TRUSTED_PUBLIC_CERT_FILENAME = 'TestRoot.pub.pem'
  73
  74 if __name__ == '__main__':
  75   #
  76   # Create command line argument parser object
  77   #
  78   parser = argparse.ArgumentParser(prog=__prog__, version=__version__, usage=__usage__, description=__copyright__, conflict_handler='resolve')
  79   group = parser.add_mutually_exclusive_group(required=True)
  80   group.add_argument("-e", action="store_true", dest='Encode', help='encode file')
  81   group.add_argument("-d", action="store_true", dest='Decode', help='decode file')
  82   parser.add_argument("-o", "--output", dest='OutputFile', type=str, metavar='filename', help="specify the output filename", required=True)
  83   parser.add_argument("--signer-private-cert", dest='SignerPrivateCertFile', type=argparse.FileType('rb'), help="specify the signer private cert filename.  If not specified, a test signer private cert is used.")
  84   parser.add_argument("--other-public-cert", dest='OtherPublicCertFile', type=argparse.FileType('rb'), help="specify the other public cert filename.  If not specified, a test other public cert is used.")
  85   parser.add_argument("--trusted-public-cert", dest='TrustedPublicCertFile', type=argparse.FileType('rb'), help="specify the trusted public cert filename.  If not specified, a test trusted public cert is used.")
  86   parser.add_argument("--monotonic-count", dest='MonotonicCountStr', type=str, help="specify the MonotonicCount in FMP capsule.  If not specified, 0 is used.")
  87   parser.add_argument("--signature-size", dest='SignatureSizeStr', type=str, help="specify the signature size for decode process.")
  88   parser.add_argument("-v", "--verbose", dest='Verbose', action="store_true", help="increase output messages")
  89   parser.add_argument("-q", "--quiet", dest='Quiet', action="store_true", help="reduce output messages")
  90   parser.add_argument("--debug", dest='Debug', type=int, metavar='[0-9]', choices=range(0,10), default=0, help="set debug level")
  91   parser.add_argument(metavar="input_file", dest='InputFile', type=argparse.FileType('rb'), help="specify the input filename")
  92
  93   #
  94   # Parse command line arguments
  95   #
  96   args = parser.parse_args()
  97
  98   #
  99   # Generate file path to Open SSL command
 100   #
 101   OpenSslCommand = 'openssl'
 102   try:
 103     OpenSslPath = os.environ['OPENSSL_PATH']
 104     OpenSslCommand = os.path.join(OpenSslPath, OpenSslCommand)
 105     if ' ' in OpenSslCommand:
 106       OpenSslCommand = '"' + OpenSslCommand + '"'
 107   except:
 108     pass
 109
 110   #
 111   # Verify that Open SSL command is available
 112   #
 113   try:
 114     Process = subprocess.Popen('%s version' % (OpenSslCommand), stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
 115   except:
 116     print 'ERROR: Open SSL command not available.  Please verify PATH or set OPENSSL_PATH'
 117     sys.exit(1)
 118
 119   Version = Process.communicate()
 120   if Process.returncode <> 0:
 121     print 'ERROR: Open SSL command not available.  Please verify PATH or set OPENSSL_PATH'
 122     sys.exit(Process.returncode)
 123   print Version[0]
 124
 125   #
 126   # Read input file into a buffer and save input filename
 127   #
 128   args.InputFileName   = args.InputFile.name
 129   args.InputFileBuffer = args.InputFile.read()
 130   args.InputFile.close()
 131
 132   #
 133   # Save output filename and check if path exists
 134   #
 135   OutputDir = os.path.dirname(args.OutputFile)
 136   if not os.path.exists(OutputDir):
 137     print 'ERROR: The output path does not exist: %s' % OutputDir
 138     sys.exit(1)
 139   args.OutputFileName = args.OutputFile
 140
 141   try:
 142     if args.MonotonicCountStr.upper().startswith('0X'):
 143       args.MonotonicCountValue = (long)(args.MonotonicCountStr, 16)
 144     else:
 145       args.MonotonicCountValue = (long)(args.MonotonicCountStr)
 146   except:
 147     args.MonotonicCountValue = (long)(0)
 148
 149   if args.Encode:
 150     #
 151     # Save signer private cert filename and close private cert file
 152     #
 153     try:
 154       args.SignerPrivateCertFileName = args.SignerPrivateCertFile.name
 155       args.SignerPrivateCertFile.close()
 156     except:
 157       try:
 158         #
 159         # Get path to currently executing script or executable
 160         #
 161         if hasattr(sys, 'frozen'):
 162             Pkcs7ToolPath = sys.executable
 163         else:
 164             Pkcs7ToolPath = sys.argv[0]
 165         if Pkcs7ToolPath.startswith('"'):
 166             Pkcs7ToolPath = Pkcs7ToolPath[1:]
 167         if Pkcs7ToolPath.endswith('"'):
 168             Pkcs7ToolPath = RsaToolPath[:-1]
 169         args.SignerPrivateCertFileName = os.path.join(os.path.dirname(os.path.realpath(Pkcs7ToolPath)), TEST_SIGNER_PRIVATE_CERT_FILENAME)
 170         args.SignerPrivateCertFile = open(args.SignerPrivateCertFileName, 'rb')
 171         args.SignerPrivateCertFile.close()
 172       except:
 173         print 'ERROR: test signer private cert file %s missing' % (args.SignerPrivateCertFileName)
 174         sys.exit(1)
 175
 176     #
 177     # Save other public cert filename and close public cert file
 178     #
 179     try:
 180       args.OtherPublicCertFileName = args.OtherPublicCertFile.name
 181       args.OtherPublicCertFile.close()
 182     except:
 183       try:
 184         #
 185         # Get path to currently executing script or executable
 186         #
 187         if hasattr(sys, 'frozen'):
 188             Pkcs7ToolPath = sys.executable
 189         else:
 190             Pkcs7ToolPath = sys.argv[0]
 191         if Pkcs7ToolPath.startswith('"'):
 192             Pkcs7ToolPath = Pkcs7ToolPath[1:]
 193         if Pkcs7ToolPath.endswith('"'):
 194             Pkcs7ToolPath = RsaToolPath[:-1]
 195         args.OtherPublicCertFileName = os.path.join(os.path.dirname(os.path.realpath(Pkcs7ToolPath)), TEST_OTHER_PUBLIC_CERT_FILENAME)
 196         args.OtherPublicCertFile = open(args.OtherPublicCertFileName, 'rb')
 197         args.OtherPublicCertFile.close()
 198       except:
 199         print 'ERROR: test other public cert file %s missing' % (args.OtherPublicCertFileName)
 200         sys.exit(1)
 201
 202     format = "%dsQ" % len(args.InputFileBuffer)
 203     FullInputFileBuffer = struct.pack(format, args.InputFileBuffer, args.MonotonicCountValue)
 204
 205     #
 206     # Sign the input file using the specified private key and capture signature from STDOUT
 207     #
 208     Process = subprocess.Popen('%s smime -sign -binary -signer "%s" -outform DER -md sha256 -certfile "%s"' % (OpenSslCommand, args.SignerPrivateCertFileName, args.OtherPublicCertFileName), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
 209     Signature = Process.communicate(input=FullInputFileBuffer)[0]
 210     if Process.returncode <> 0:
 211       sys.exit(Process.returncode)
 212
 213     #
 214     # Write output file that contains Signature, and Input data
 215     #
 216     args.OutputFile = open(args.OutputFileName, 'wb')
 217     args.OutputFile.write(Signature)
 218     args.OutputFile.write(args.InputFileBuffer)
 219     args.OutputFile.close()
 220
 221   if args.Decode:
 222     #
 223     # Save trusted public cert filename and close public cert file
 224     #
 225     try:
 226       args.TrustedPublicCertFileName = args.TrustedPublicCertFile.name
 227       args.TrustedPublicCertFile.close()
 228     except:
 229       try:
 230         #
 231         # Get path to currently executing script or executable
 232         #
 233         if hasattr(sys, 'frozen'):
 234             Pkcs7ToolPath = sys.executable
 235         else:
 236             Pkcs7ToolPath = sys.argv[0]
 237         if Pkcs7ToolPath.startswith('"'):
 238             Pkcs7ToolPath = Pkcs7ToolPath[1:]
 239         if Pkcs7ToolPath.endswith('"'):
 240             Pkcs7ToolPath = RsaToolPath[:-1]
 241         args.TrustedPublicCertFileName = os.path.join(os.path.dirname(os.path.realpath(Pkcs7ToolPath)), TEST_TRUSTED_PUBLIC_CERT_FILENAME)
 242         args.TrustedPublicCertFile = open(args.TrustedPublicCertFileName, 'rb')
 243         args.TrustedPublicCertFile.close()
 244       except:
 245         print 'ERROR: test trusted public cert file %s missing' % (args.TrustedPublicCertFileName)
 246         sys.exit(1)
 247
 248     if not args.SignatureSizeStr:
 249       print "ERROR: please use the option --signature-size to specify the size of the signature data!"
 250       sys.exit(1)
 251     else:
 252       if args.SignatureSizeStr.upper().startswith('0X'):
 253         SignatureSize = (long)(args.SignatureSizeStr, 16)
 254       else:
 255         SignatureSize = (long)(args.SignatureSizeStr)
 256     if SignatureSize < 0:
 257         print "ERROR: The value of option --signature-size can't be set to negative value!"
 258         sys.exit(1)
 259     elif SignatureSize > len(args.InputFileBuffer):
 260         print "ERROR: The value of option --signature-size is exceed the size of the input file !"
 261         sys.exit(1)
 262
 263     args.SignatureBuffer = args.InputFileBuffer[0:SignatureSize]
 264     args.InputFileBuffer = args.InputFileBuffer[SignatureSize:]
 265
 266     format = "%dsQ" % len(args.InputFileBuffer)
 267     FullInputFileBuffer = struct.pack(format, args.InputFileBuffer, args.MonotonicCountValue)
 268
 269     #
 270     # Save output file contents from input file
 271     #
 272     open(args.OutputFileName, 'wb').write(FullInputFileBuffer)
 273
 274     #
 275     # Verify signature
 276     #
 277     Process = subprocess.Popen('%s smime -verify -inform DER -content %s -CAfile %s' % (OpenSslCommand, args.OutputFileName, args.TrustedPublicCertFileName), stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
 278     Process.communicate(input=args.SignatureBuffer)[0]
 279     if Process.returncode <> 0:
 280       print 'ERROR: Verification failed'
 281       os.remove (args.OutputFileName)
 282       sys.exit(Process.returncode)
 283
 284     open(args.OutputFileName, 'wb').write(args.InputFileBuffer)