BaseTools/Pkcs7Sign: Update the test certificates & Readme.md

[mirror_edk2.git] / BaseTools / Source / Python / Pkcs7Sign / Pkcs7Sign.py

## @file\r
# This tool adds EFI_FIRMWARE_IMAGE_AUTHENTICATION for a binary.\r
#\r
# This tool only support CertType - EFI_CERT_TYPE_PKCS7_GUID\r
#   {0x4aafd29d, 0x68df, 0x49ee, {0x8a, 0xa9, 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7}}\r
#\r
# This tool has been tested with OpenSSL.\r
#\r
# Copyright (c) 2016 - 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
#\r
\r
'''\r
Pkcs7Sign\r
'''\r
\r
import os\r
import sys\r
import argparse\r
import subprocess\r
import uuid\r
import struct\r
import collections\r
from Common.BuildVersion import gBUILD_VERSION\r
\r
#\r
# Globals for help information\r
#\r
__prog__      = 'Pkcs7Sign'\r
__version__   = '%s Version %s' % (__prog__, '0.9 ' + gBUILD_VERSION)\r
__copyright__ = 'Copyright (c) 2016, Intel Corporation. All rights reserved.'\r
__usage__     = '%s -e|-d [options] <input_file>' % (__prog__)\r
\r
#\r
# GUID for PKCS7 from UEFI Specification\r
#\r
WIN_CERT_REVISION      = 0x0200\r
WIN_CERT_TYPE_EFI_GUID = 0x0EF1\r
EFI_CERT_TYPE_PKCS7_GUID = uuid.UUID('{4aafd29d-68df-49ee-8aa9-347d375665a7}')\r
\r
#\r
# typedef struct _WIN_CERTIFICATE {\r
#   UINT32 dwLength;\r
#   UINT16 wRevision;\r
#   UINT16 wCertificateType;\r
# //UINT8 bCertificate[ANYSIZE_ARRAY];\r
# } WIN_CERTIFICATE;\r
#\r
# typedef struct _WIN_CERTIFICATE_UEFI_GUID {\r
#   WIN_CERTIFICATE Hdr;\r
#   EFI_GUID        CertType;\r
# //UINT8 CertData[ANYSIZE_ARRAY];\r
# } WIN_CERTIFICATE_UEFI_GUID;\r
#\r
# typedef struct {\r
#   UINT64                    MonotonicCount;\r
#   WIN_CERTIFICATE_UEFI_GUID AuthInfo;\r
# } EFI_FIRMWARE_IMAGE_AUTHENTICATION;\r
#\r
\r
#\r
# Filename of test signing private cert that is stored in same directory as this tool\r
#\r
TEST_SIGNER_PRIVATE_CERT_FILENAME = 'TestCert.pem'\r
TEST_OTHER_PUBLIC_CERT_FILENAME = 'TestSub.pub.pem'\r
TEST_TRUSTED_PUBLIC_CERT_FILENAME = 'TestRoot.pub.pem'\r
\r
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
  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
  parser.add_argument("-o", "--output", dest='OutputFile', type=str, metavar='filename', help="specify the output filename", required=True)\r
  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.")\r
  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.")\r
  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.")\r
  parser.add_argument("--monotonic-count", dest='MonotonicCountStr', type=str, help="specify the MonotonicCount in FMP capsule.  If not specified, 0 is used.")\r
  parser.add_argument("--signature-size", dest='SignatureSizeStr', type=str, help="specify the signature size for decode process.")\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(metavar="input_file", dest='InputFile', type=argparse.FileType('rb'), help="specify the input filename")\r
\r
  #\r
  # Parse command line arguments\r
  #\r
  args = parser.parse_args()\r
\r
  #\r
  # Generate file path to Open SSL command\r
  #\r
  OpenSslCommand = 'openssl'\r
  try:\r
    OpenSslPath = os.environ['OPENSSL_PATH']\r
    OpenSslCommand = os.path.join(OpenSslPath, OpenSslCommand)\r
  except:\r
    pass\r
\r
  #\r
  # Verify that Open SSL command is available\r
  #\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
    sys.exit(1)\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
    sys.exit(Process.returncode)\r
  print Version[0]\r
\r
  #\r
  # Read input file into a buffer and save input filename\r
  #\r
  args.InputFileName   = args.InputFile.name\r
  args.InputFileBuffer = args.InputFile.read()\r
  args.InputFile.close()\r
\r
  #\r
  # Save output filename and check if path exists\r
  #\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
    sys.exit(1)\r
  args.OutputFileName = args.OutputFile\r
\r
  try:\r
    if args.MonotonicCountStr.upper().startswith('0X'):\r
      args.MonotonicCountValue = (long)(args.MonotonicCountStr, 16)\r
    else:\r
      args.MonotonicCountValue = (long)(args.MonotonicCountStr)\r
  except:\r
    args.MonotonicCountValue = (long)(0)\r
\r
  if args.Encode:\r
    #\r
    # Save signer private cert filename and close private cert file\r
    #\r
    try:\r
      args.SignerPrivateCertFileName = args.SignerPrivateCertFile.name\r
      args.SignerPrivateCertFile.close()\r
    except:\r
      try:\r
        #\r
        # Get path to currently executing script or executable\r
        #\r
        if hasattr(sys, 'frozen'):\r
            Pkcs7ToolPath = sys.executable\r
        else:\r
            Pkcs7ToolPath = sys.argv[0]\r
        if Pkcs7ToolPath.startswith('"'):\r
            Pkcs7ToolPath = Pkcs7ToolPath[1:]\r
        if Pkcs7ToolPath.endswith('"'):\r
            Pkcs7ToolPath = RsaToolPath[:-1]\r
        args.SignerPrivateCertFileName = os.path.join(os.path.dirname(os.path.realpath(Pkcs7ToolPath)), TEST_SIGNER_PRIVATE_CERT_FILENAME)\r
        args.SignerPrivateCertFile = open(args.SignerPrivateCertFileName, 'rb')\r
        args.SignerPrivateCertFile.close()\r
      except:\r
        print 'ERROR: test signer private cert file %s missing' % (args.SignerPrivateCertFileName)\r
        sys.exit(1)\r
\r
    #\r
    # Save other public cert filename and close public cert file\r
    #\r
    try:\r
      args.OtherPublicCertFileName = args.OtherPublicCertFile.name\r
      args.OtherPublicCertFile.close()\r
    except:\r
      try:\r
        #\r
        # Get path to currently executing script or executable\r
        #\r
        if hasattr(sys, 'frozen'):\r
            Pkcs7ToolPath = sys.executable\r
        else:\r
            Pkcs7ToolPath = sys.argv[0]\r
        if Pkcs7ToolPath.startswith('"'):\r
            Pkcs7ToolPath = Pkcs7ToolPath[1:]\r
        if Pkcs7ToolPath.endswith('"'):\r
            Pkcs7ToolPath = RsaToolPath[:-1]\r
        args.OtherPublicCertFileName = os.path.join(os.path.dirname(os.path.realpath(Pkcs7ToolPath)), TEST_OTHER_PUBLIC_CERT_FILENAME)\r
        args.OtherPublicCertFile = open(args.OtherPublicCertFileName, 'rb')\r
        args.OtherPublicCertFile.close()\r
      except:\r
        print 'ERROR: test other public cert file %s missing' % (args.OtherPublicCertFileName)\r
        sys.exit(1)\r
\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 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)\r
    Signature = Process.communicate(input=FullInputFileBuffer)[0]\r
    if Process.returncode <> 0:\r
      sys.exit(Process.returncode)\r
\r
    #\r
    # Write output file that contains Signature, and Input data\r
    #\r
    args.OutputFile = open(args.OutputFileName, 'wb')\r
    args.OutputFile.write(Signature)\r
    args.OutputFile.write(args.InputFileBuffer)\r
    args.OutputFile.close()\r
\r
  if args.Decode:\r
    #\r
    # Save trusted public cert filename and close public cert file\r
    #\r
    try:\r
      args.TrustedPublicCertFileName = args.TrustedPublicCertFile.name\r
      args.TrustedPublicCertFile.close()\r
    except:\r
      try:\r
        #\r
        # Get path to currently executing script or executable\r
        #\r
        if hasattr(sys, 'frozen'):\r
            Pkcs7ToolPath = sys.executable\r
        else:\r
            Pkcs7ToolPath = sys.argv[0]\r
        if Pkcs7ToolPath.startswith('"'):\r
            Pkcs7ToolPath = Pkcs7ToolPath[1:]\r
        if Pkcs7ToolPath.endswith('"'):\r
            Pkcs7ToolPath = RsaToolPath[:-1]\r
        args.TrustedPublicCertFileName = os.path.join(os.path.dirname(os.path.realpath(Pkcs7ToolPath)), TEST_TRUSTED_PUBLIC_CERT_FILENAME)\r
        args.TrustedPublicCertFile = open(args.TrustedPublicCertFileName, 'rb')\r
        args.TrustedPublicCertFile.close()\r
      except:\r
        print 'ERROR: test trusted public cert file %s missing' % (args.TrustedPublicCertFileName)\r
        sys.exit(1)\r
\r
    if not args.SignatureSizeStr:\r
      print "ERROR: please use the option --signature-size to specify the size of the signature data!"\r
      sys.exit(1)\r
    else:\r
      if args.SignatureSizeStr.upper().startswith('0X'):\r
        SignatureSize = (long)(args.SignatureSizeStr, 16)\r
      else:\r
        SignatureSize = (long)(args.SignatureSizeStr)\r
    if SignatureSize < 0:\r
        print "ERROR: The value of option --signature-size can't be set to negative value!"\r
        sys.exit(1)\r
    elif SignatureSize > len(args.InputFileBuffer):\r
        print "ERROR: The value of option --signature-size is exceed the size of the input file !"\r
        sys.exit(1)\r
\r
    args.SignatureBuffer = args.InputFileBuffer[0:SignatureSize]\r
    args.InputFileBuffer = args.InputFileBuffer[SignatureSize:]\r
\r
    format = "%dsQ" % len(args.InputFileBuffer)\r
    FullInputFileBuffer = struct.pack(format, args.InputFileBuffer, args.MonotonicCountValue)\r
\r
    #\r
    # Save output file contents from input file\r
    #\r
    open(args.OutputFileName, 'wb').write(FullInputFileBuffer)\r
\r
    #\r
    # Verify signature\r
    #\r
    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)\r
    Process.communicate(input=args.SignatureBuffer)[0]\r
    if Process.returncode <> 0:\r
      print 'ERROR: Verification failed'\r
      os.remove (args.OutputFileName)\r
      sys.exit(Process.returncode)\r
\r
    open(args.OutputFileName, 'wb').write(args.InputFileBuffer)\r