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
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
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.
20 from __future__
import print_function
29 from Common
.BuildVersion
import gBUILD_VERSION
32 # Globals for help information
34 __prog__
= 'Rsa2048Sha256Sign'
35 __version__
= '%s Version %s' % (__prog__
, '0.9 ' + gBUILD_VERSION
)
36 __copyright__
= 'Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.'
37 __usage__
= '%s -e|-d [options] <input_file>' % (__prog__
)
40 # GUID for SHA 256 Hash Algorithm from UEFI Specification
42 EFI_HASH_ALGORITHM_SHA256_GUID
= uuid
.UUID('{51aa59de-fdf2-4ea3-bc63-875fb7842ee9}')
45 # Structure definition to unpack EFI_CERT_BLOCK_RSA_2048_SHA256 from UEFI 2.4 Specification
47 # typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {
49 # UINT8 PublicKey[256];
50 # UINT8 Signature[256];
51 # } EFI_CERT_BLOCK_RSA_2048_SHA256;
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')
57 # Filename of test signing private key that is stored in same directory as this tool
59 TEST_SIGNING_PRIVATE_KEY_FILENAME
= 'TestSigningPrivateKey.pem'
61 if __name__
== '__main__':
63 # Create command line argument parser object
65 parser
= argparse
.ArgumentParser(prog
=__prog__
, 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 group
.add_argument("--version", action
='version', version
=__version__
)
70 parser
.add_argument("-o", "--output", dest
='OutputFile', type=str, metavar
='filename', help="specify the output filename", required
=True)
71 parser
.add_argument("--monotonic-count", dest
='MonotonicCountStr', type=str, help="specify the MonotonicCount in FMP capsule.")
72 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.")
73 parser
.add_argument("-v", "--verbose", dest
='Verbose', action
="store_true", help="increase output messages")
74 parser
.add_argument("-q", "--quiet", dest
='Quiet', action
="store_true", help="reduce output messages")
75 parser
.add_argument("--debug", dest
='Debug', type=int, metavar
='[0-9]', choices
=range(0, 10), default
=0, help="set debug level")
76 parser
.add_argument(metavar
="input_file", dest
='InputFile', type=argparse
.FileType('rb'), help="specify the input filename")
79 # Parse command line arguments
81 args
= parser
.parse_args()
84 # Generate file path to Open SSL command
86 OpenSslCommand
= 'openssl'
88 OpenSslPath
= os
.environ
['OPENSSL_PATH']
89 OpenSslCommand
= os
.path
.join(OpenSslPath
, OpenSslCommand
)
90 if ' ' in OpenSslCommand
:
91 OpenSslCommand
= '"' + OpenSslCommand
+ '"'
96 # Verify that Open SSL command is available
99 Process
= subprocess
.Popen('%s version' % (OpenSslCommand
), stdout
=subprocess
.PIPE
, stderr
=subprocess
.PIPE
, shell
=True)
101 print('ERROR: Open SSL command not available. Please verify PATH or set OPENSSL_PATH')
104 Version
= Process
.communicate()
105 if Process
.returncode
!= 0:
106 print('ERROR: Open SSL command not available. Please verify PATH or set OPENSSL_PATH')
107 sys
.exit(Process
.returncode
)
108 print(Version
[0].decode('utf-8'))
111 # Read input file into a buffer and save input filename
113 args
.InputFileName
= args
.InputFile
.name
114 args
.InputFileBuffer
= args
.InputFile
.read()
115 args
.InputFile
.close()
118 # Save output filename and check if path exists
120 OutputDir
= os
.path
.dirname(args
.OutputFile
)
121 if not os
.path
.exists(OutputDir
):
122 print('ERROR: The output path does not exist: %s' % OutputDir
)
124 args
.OutputFileName
= args
.OutputFile
127 # Save private key filename and close private key file
130 args
.PrivateKeyFileName
= args
.PrivateKeyFile
.name
131 args
.PrivateKeyFile
.close()
135 # Get path to currently executing script or executable
137 if hasattr(sys
, 'frozen'):
138 RsaToolPath
= sys
.executable
140 RsaToolPath
= sys
.argv
[0]
141 if RsaToolPath
.startswith('"'):
142 RsaToolPath
= RsaToolPath
[1:]
143 if RsaToolPath
.endswith('"'):
144 RsaToolPath
= RsaToolPath
[:-1]
145 args
.PrivateKeyFileName
= os
.path
.join(os
.path
.dirname(os
.path
.realpath(RsaToolPath
)), TEST_SIGNING_PRIVATE_KEY_FILENAME
)
146 args
.PrivateKeyFile
= open(args
.PrivateKeyFileName
, 'rb')
147 args
.PrivateKeyFile
.close()
149 print('ERROR: test signing private key file %s missing' % (args
.PrivateKeyFileName
))
153 # Extract public key from private key into STDOUT
155 Process
= subprocess
.Popen('%s rsa -in "%s" -modulus -noout' % (OpenSslCommand
, args
.PrivateKeyFileName
), stdout
=subprocess
.PIPE
, stderr
=subprocess
.PIPE
, shell
=True)
156 PublicKeyHexString
= Process
.communicate()[0].split(b
'=')[1].strip()
157 PublicKeyHexString
= PublicKeyHexString
.decode('utf-8')
159 while len(PublicKeyHexString
) > 0:
160 PublicKey
= PublicKey
+ PublicKeyHexString
[0:2]
161 PublicKeyHexString
=PublicKeyHexString
[2:]
162 if Process
.returncode
!= 0:
163 sys
.exit(Process
.returncode
)
165 if args
.MonotonicCountStr
:
167 if args
.MonotonicCountStr
.upper().startswith('0X'):
168 args
.MonotonicCountValue
= int(args
.MonotonicCountStr
, 16)
170 args
.MonotonicCountValue
= int(args
.MonotonicCountStr
)
175 FullInputFileBuffer
= args
.InputFileBuffer
176 if args
.MonotonicCountStr
:
177 format
= "%dsQ" % len(args
.InputFileBuffer
)
178 FullInputFileBuffer
= struct
.pack(format
, args
.InputFileBuffer
, args
.MonotonicCountValue
)
180 # Sign the input file using the specified private key and capture signature from STDOUT
182 Process
= subprocess
.Popen('%s dgst -sha256 -sign "%s"' % (OpenSslCommand
, args
.PrivateKeyFileName
), stdin
=subprocess
.PIPE
, stdout
=subprocess
.PIPE
, stderr
=subprocess
.PIPE
, shell
=True)
183 Signature
= Process
.communicate(input=FullInputFileBuffer
)[0]
184 if Process
.returncode
!= 0:
185 sys
.exit(Process
.returncode
)
188 # Write output file that contains hash GUID, Public Key, Signature, and Input data
190 args
.OutputFile
= open(args
.OutputFileName
, 'wb')
191 args
.OutputFile
.write(EFI_HASH_ALGORITHM_SHA256_GUID
.bytes_le
)
192 args
.OutputFile
.write(bytearray
.fromhex(str(PublicKey
)))
193 args
.OutputFile
.write(Signature
)
194 args
.OutputFile
.write(args
.InputFileBuffer
)
195 args
.OutputFile
.close()
199 # Parse Hash Type, Public Key, and Signature from the section header
201 Header
= EFI_CERT_BLOCK_RSA_2048_SHA256
._make(EFI_CERT_BLOCK_RSA_2048_SHA256_STRUCT
.unpack_from(args
.InputFileBuffer
))
202 args
.InputFileBuffer
= args
.InputFileBuffer
[EFI_CERT_BLOCK_RSA_2048_SHA256_STRUCT
.size
:]
205 # Verify that the Hash Type matches the expected SHA256 type
207 if uuid
.UUID(bytes_le
= Header
.HashType
) != EFI_HASH_ALGORITHM_SHA256_GUID
:
208 print('ERROR: unsupport hash GUID')
212 # Verify the public key
214 if Header
.PublicKey
!= bytearray
.fromhex(PublicKey
):
215 print('ERROR: Public key in input file does not match public key from private key file')
218 FullInputFileBuffer
= args
.InputFileBuffer
219 if args
.MonotonicCountStr
:
220 format
= "%dsQ" % len(args
.InputFileBuffer
)
221 FullInputFileBuffer
= struct
.pack(format
, args
.InputFileBuffer
, args
.MonotonicCountValue
)
224 # Write Signature to output file
226 open(args
.OutputFileName
, 'wb').write(Header
.Signature
)
231 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)
232 Process
.communicate(input=FullInputFileBuffer
)
233 if Process
.returncode
!= 0:
234 print('ERROR: Verification failed')
235 os
.remove (args
.OutputFileName
)
236 sys
.exit(Process
.returncode
)
239 # Save output file contents from input file
241 open(args
.OutputFileName
, 'wb').write(args
.InputFileBuffer
)