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

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