]>
git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/Rsa2048Sha256Sign/Rsa2048Sha256GenerateKeys.py
2 # This tool can be used to generate new RSA 2048 bit private/public key pairs
3 # in a PEM file format using OpenSSL command line utilities that are installed
4 # on the path specified by the system environment variable OPENSSL_PATH.
5 # This tool can also optionally write one or more SHA 256 hashes of 2048 bit
6 # public keys to a binary file, write one or more SHA 256 hashes of 2048 bit
7 # public keys to a file in a C structure format, and in verbose mode display
8 # one or more SHA 256 hashes of 2048 bit public keys in a C structure format
10 # This tool has been tested with OpenSSL 1.0.1e 11 Feb 2013
12 # Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>
13 # This program and the accompanying materials
14 # are licensed and made available under the terms and conditions of the BSD License
15 # which accompanies this distribution. The full text of the license may be found at
16 # http://opensource.org/licenses/bsd-license.php
18 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
19 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
23 Rsa2048Sha256GenerateKeys
31 if __name__
== '__main__' :
33 # Save name of the program
35 ProgramName
= sys
. argv
[ 0 ]
40 print ' %s - Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.' % ( ProgramName
)
43 # Create command line argument parser object
45 parser
= argparse
. ArgumentParser ( prog
= ProgramName
, usage
= ' %(prog)s [options]' , add_help
= False )
46 group
= parser
. add_mutually_exclusive_group ( required
= True )
47 group
. add_argument ( "-o" , "--output" , dest
= 'OutputFile' , type = argparse
. FileType ( 'wb' ), metavar
= 'filename' , nargs
= '*' , help = "specify the output private key filename in PEM format" )
48 group
. add_argument ( "-i" , "--input" , dest
= 'InputFile' , type = argparse
. FileType ( 'rb' ), metavar
= 'filename' , nargs
= '*' , help = "specify the input private key filename in PEM format" )
49 parser
. add_argument ( "--public-key-hash" , dest
= 'PublicKeyHashFile' , type = argparse
. FileType ( 'wb' ), help = "specify the public key hash filename that is SHA 256 hash of 2048 bit RSA public key in binary format" )
50 parser
. add_argument ( "--public-key-hash-c" , dest
= 'PublicKeyHashCFile' , type = argparse
. FileType ( 'wb' ), help = "specify the public key hash filename that is SHA 256 hash of 2048 bit RSA public key in C structure format" )
51 parser
. add_argument ( "-v" , "--verbose" , dest
= 'Verbose' , action
= "store_true" , help = "increase output messages" )
52 parser
. add_argument ( "-q" , "--quiet" , dest
= 'Quiet' , action
= "store_true" , help = "reduce output messages" )
53 parser
. add_argument ( "--debug" , dest
= 'Debug' , type = int , metavar
= '[0-9]' , choices
= range ( 0 , 10 ), default
= 0 , help = "set debug level" )
54 parser
. add_argument ( "--version" , dest
= 'Version' , action
= "store_true" , help = "display the program version and exit" )
55 parser
. add_argument ( "-h" , "--help" , dest
= 'Help' , action
= "help" , help = "display this help text" )
58 # Parse command line arguments
60 args
= parser
. parse_args ()
63 # Generate file path to Open SSL command
65 OpenSslCommand
= 'openssl'
67 OpenSslPath
= os
. environ
[ 'OPENSSL_PATH' ]
68 OpenSslCommand
= os
. path
. join ( OpenSslPath
, OpenSslCommand
)
73 # Verify that Open SSL command is available
76 Process
= subprocess
. Popen ( ' %s version' % ( OpenSslCommand
), stdout
= subprocess
. PIPE
, stderr
= subprocess
. PIPE
)
78 print 'ERROR: Open SSL command not available. Please verify PATH or set OPENSSL_PATH'
81 Version
= Process
. communicate ()
82 if Process
. returncode
<> 0 :
83 print 'ERROR: Open SSL command not available. Please verify PATH or set OPENSSL_PATH'
84 sys
. exit ( Process
. returncode
)
90 # Check for output file argument
92 if args
. OutputFile
<> None :
93 for Item
in args
. OutputFile
:
95 # Save PEM filename and close output file
97 args
. PemFileName
. append ( Item
. name
)
101 # Generate private key and save it to output file in a PEM file format
103 Process
= subprocess
. Popen ( ' %s genrsa -out %s 2048' % ( OpenSslCommand
, Item
. name
), stdout
= subprocess
. PIPE
, stderr
= subprocess
. PIPE
)
104 Process
. communicate ()
105 if Process
. returncode
<> 0 :
106 print 'ERROR: RSA 2048 key generation failed'
107 sys
. exit ( Process
. returncode
)
110 # Check for input file argument
112 if args
. InputFile
<> None :
113 for Item
in args
. InputFile
:
115 # Save PEM filename and close input file
117 args
. PemFileName
. append ( Item
. name
)
121 for Item
in args
. PemFileName
:
123 # Extract public key from private key into STDOUT
125 Process
= subprocess
. Popen ( ' %s rsa -in %s -modulus -noout' % ( OpenSslCommand
, Item
), stdout
= subprocess
. PIPE
, stderr
= subprocess
. PIPE
)
126 PublicKeyHexString
= Process
. communicate ()[ 0 ]. split ( '=' )[ 1 ]. strip ()
127 if Process
. returncode
<> 0 :
128 print 'ERROR: Unable to extract public key from private key'
129 sys
. exit ( Process
. returncode
)
131 for Index
in range ( 0 , len ( PublicKeyHexString
), 2 ):
132 PublicKey
= PublicKey
+ chr ( int ( PublicKeyHexString
[ Index
: Index
+ 2 ], 16 ))
135 # Generate SHA 256 hash of RSA 2048 bit public key into STDOUT
137 Process
= subprocess
. Popen ( ' %s dgst -sha256 -binary' % ( OpenSslCommand
), stdin
= subprocess
. PIPE
, stdout
= subprocess
. PIPE
, stderr
= subprocess
. PIPE
)
138 Process
. stdin
. write ( PublicKey
)
139 PublicKeyHash
= PublicKeyHash
+ Process
. communicate ()[ 0 ]
140 if Process
. returncode
<> 0 :
141 print 'ERROR: Unable to extract SHA 256 hash of public key'
142 sys
. exit ( Process
. returncode
)
145 # Write SHA 256 hash of 2048 bit binary public key to public key hash file
148 args
. PublicKeyHashFile
. write ( PublicKeyHash
)
149 args
. PublicKeyHashFile
. close ()
154 # Convert public key hash to a C structure string
157 for Item
in PublicKeyHash
:
158 PublicKeyHashC
= PublicKeyHashC
+ '0x %0 2x, ' % ( ord ( Item
))
159 PublicKeyHashC
= PublicKeyHashC
[:- 2 ] + '}'
162 # Write SHA 256 of 2048 bit binary public key to public key hash C structure file
165 args
. PublicKeyHashCFile
. write ( PublicKeyHashC
)
166 args
. PublicKeyHashCFile
. close ()
171 # If verbose is enabled display the public key in C structure format
174 print 'PublicKeySha256 = ' + PublicKeyHashC