genpkey.pod revision 238384
128219Smsmith=pod 228219Smsmith 328219Smsmith=head1 NAME 428219Smsmith 528219Smsmithgenpkey - generate a private key 628219Smsmith 728219Smsmith=head1 SYNOPSIS 828219Smsmith 928219SmsmithB<openssl> B<genpkey> 1028219Smsmith[B<-out filename>] 1128219Smsmith[B<-outform PEM|DER>] 1228219Smsmith[B<-pass arg>] 1328219Smsmith[B<-cipher>] 1428219Smsmith[B<-engine id>] 1528219Smsmith[B<-paramfile file>] 1628219Smsmith[B<-algorithm alg>] 1728219Smsmith[B<-pkeyopt opt:value>] 1828219Smsmith[B<-genparam>] 1928219Smsmith[B<-text>] 2028219Smsmith 2128219Smsmith=head1 DESCRIPTION 2228219Smsmith 2328219SmsmithThe B<genpkey> command generates a private key. 2428219Smsmith 2528219Smsmith=head1 OPTIONS 2632178Smsmith 2728219Smsmith=over 4 2828219Smsmith 2928219Smsmith=item B<-out filename> 3028219Smsmith 3128219Smsmiththe output filename. If this argument is not specified then standard output is 3232178Smsmithused. 3332178Smsmith 3432178Smsmith=item B<-outform DER|PEM> 3532178Smsmith 3628219SmsmithThis specifies the output format DER or PEM. 3732178Smsmith 3832178Smsmith=item B<-pass arg> 3932178Smsmith 4032178Smsmiththe output file password source. For more information about the format of B<arg> 4132178Smsmithsee the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>. 4232178Smsmith 4328219Smsmith=item B<-cipher> 4432178Smsmith 4532178SmsmithThis option encrypts the private key with the supplied cipher. Any algorithm 4632178Smsmithname accepted by EVP_get_cipherbyname() is acceptable such as B<des3>. 4732178Smsmith 4832178Smsmith=item B<-engine id> 4932178Smsmith 5028219Smsmithspecifying an engine (by its unique B<id> string) will cause B<genpkey> 5128219Smsmithto attempt to obtain a functional reference to the specified engine, 52thus initialising it if needed. The engine will then be set as the default 53for all available algorithms. If used this option should precede all other 54options. 55 56=item B<-algorithm alg> 57 58public key algorithm to use such as RSA, DSA or DH. If used this option must 59precede any B<-pkeyopt> options. The options B<-paramfile> and B<-algorithm> 60are mutually exclusive. 61 62=item B<-pkeyopt opt:value> 63 64set the public key algorithm option B<opt> to B<value>. The precise set of 65options supported depends on the public key algorithm used and its 66implementation. See B<KEY GENERATION OPTIONS> below for more details. 67 68=item B<-genparam> 69 70generate a set of parameters instead of a private key. If used this option must 71precede and B<-algorithm>, B<-paramfile> or B<-pkeyopt> options. 72 73=item B<-paramfile filename> 74 75Some public key algorithms generate a private key based on a set of parameters. 76They can be supplied using this option. If this option is used the public key 77algorithm used is determined by the parameters. If used this option must 78precede and B<-pkeyopt> options. The options B<-paramfile> and B<-algorithm> 79are mutually exclusive. 80 81=item B<-text> 82 83Print an (unencrypted) text representation of private and public keys and 84parameters along with the PEM or DER structure. 85 86=back 87 88=head1 KEY GENERATION OPTIONS 89 90The options supported by each algorith and indeed each implementation of an 91algorithm can vary. The options for the OpenSSL implementations are detailed 92below. 93 94=head1 RSA KEY GENERATION OPTIONS 95 96=over 4 97 98=item B<rsa_keygen_bits:numbits> 99 100The number of bits in the generated key. If not specified 1024 is used. 101 102=item B<rsa_keygen_pubexp:value> 103 104The RSA public exponent value. This can be a large decimal or 105hexadecimal value if preceded by B<0x>. Default value is 65537. 106 107=back 108 109=head1 DSA PARAMETER GENERATION OPTIONS 110 111=over 4 112 113=item B<dsa_paramgen_bits:numbits> 114 115The number of bits in the generated parameters. If not specified 1024 is used. 116 117=back 118 119=head1 DH PARAMETER GENERATION OPTIONS 120 121=over 4 122 123=item B<dh_paramgen_prime_len:numbits> 124 125The number of bits in the prime parameter B<p>. 126 127=item B<dh_paramgen_generator:value> 128 129The value to use for the generator B<g>. 130 131=back 132 133=head1 EC PARAMETER GENERATION OPTIONS 134 135=over 4 136 137=item B<ec_paramgen_curve:curve> 138 139the EC curve to use. 140 141=back 142 143=head1 GOST2001 KEY GENERATION AND PARAMETER OPTIONS 144 145Gost 2001 support is not enabled by default. To enable this algorithm, 146one should load the ccgost engine in the OpenSSL configuration file. 147See README.gost file in the engines/ccgost directiry of the source 148distribution for more details. 149 150Use of a parameter file for the GOST R 34.10 algorithm is optional. 151Parameters can be specified during key generation directly as well as 152during generation of parameter file. 153 154=over 4 155 156=item B<paramset:name> 157 158Specifies GOST R 34.10-2001 parameter set according to RFC 4357. 159Parameter set can be specified using abbreviated name, object short name or 160numeric OID. Following parameter sets are supported: 161 162 paramset OID Usage 163 A 1.2.643.2.2.35.1 Signature 164 B 1.2.643.2.2.35.2 Signature 165 C 1.2.643.2.2.35.3 Signature 166 XA 1.2.643.2.2.36.0 Key exchange 167 XB 1.2.643.2.2.36.1 Key exchange 168 test 1.2.643.2.2.35.0 Test purposes 169 170=back 171 172 173 174=head1 NOTES 175 176The use of the genpkey program is encouraged over the algorithm specific 177utilities because additional algorithm options and ENGINE provided algorithms 178can be used. 179 180=head1 EXAMPLES 181 182Generate an RSA private key using default parameters: 183 184 openssl genpkey -algorithm RSA -out key.pem 185 186Encrypt output private key using 128 bit AES and the passphrase "hello": 187 188 openssl genpkey -algorithm RSA -out key.pem -aes-128-cbc -pass pass:hello 189 190Generate a 2048 bit RSA key using 3 as the public exponent: 191 192 openssl genpkey -algorithm RSA -out key.pem -pkeyopt rsa_keygen_bits:2048 \ 193 -pkeyopt rsa_keygen_pubexp:3 194 195Generate 1024 bit DSA parameters: 196 197 openssl genpkey -genparam -algorithm DSA -out dsap.pem \ 198 -pkeyopt dsa_paramgen_bits:1024 199 200Generate DSA key from parameters: 201 202 openssl genpkey -paramfile dsap.pem -out dsakey.pem 203 204Generate 1024 bit DH parameters: 205 206 openssl genpkey -genparam -algorithm DH -out dhp.pem \ 207 -pkeyopt dh_paramgen_prime_len:1024 208 209Generate DH key from parameters: 210 211 openssl genpkey -paramfile dhp.pem -out dhkey.pem 212 213 214=cut 215 216