| 1 | .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sp \" Vertical space (when we can't use .PP) |
| 6 | .if t .sp .5v |
| 7 | .if n .sp |
| 8 | .. |
| 9 | .de Vb \" Begin verbatim text |
| 10 | .ft CW |
| 11 | .nf |
| 12 | .ne \\$1 |
| 13 | .. |
| 14 | .de Ve \" End verbatim text |
| 15 | .ft R |
| 16 | .fi |
| 17 | .. |
| 18 | .\" Set up some character translations and predefined strings. \*(-- will |
| 19 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 20 | .\" double quote, and \*(R" will give a right double quote. \*(C+ will |
| 21 | .\" give a nicer C++. Capital omega is used to do unbreakable dashes and |
| 22 | .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, |
| 23 | .\" nothing in troff, for use with C<>. |
| 24 | .tr \(*W- |
| 25 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 26 | .ie n \{\ |
| 27 | . ds -- \(*W- |
| 28 | . ds PI pi |
| 29 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 30 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 31 | . ds L" "" |
| 32 | . ds R" "" |
| 33 | . ds C` "" |
| 34 | . ds C' "" |
| 35 | 'br\} |
| 36 | .el\{\ |
| 37 | . ds -- \|\(em\| |
| 38 | . ds PI \(*p |
| 39 | . ds L" `` |
| 40 | . ds R" '' |
| 41 | 'br\} |
| 42 | .\" |
| 43 | .\" Escape single quotes in literal strings from groff's Unicode transform. |
| 44 | .ie \n(.g .ds Aq \(aq |
| 45 | .el .ds Aq ' |
| 46 | .\" |
| 47 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 48 | .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 49 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 50 | .\" output yourself in some meaningful fashion. |
| 51 | .ie \nF \{\ |
| 52 | . de IX |
| 53 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 54 | .. |
| 55 | . nr % 0 |
| 56 | . rr F |
| 57 | .\} |
| 58 | .el \{\ |
| 59 | . de IX |
| 60 | .. |
| 61 | .\} |
| 62 | .\" |
| 63 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 64 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| 65 | . \" fudge factors for nroff and troff |
| 66 | .if n \{\ |
| 67 | . ds #H 0 |
| 68 | . ds #V .8m |
| 69 | . ds #F .3m |
| 70 | . ds #[ \f1 |
| 71 | . ds #] \fP |
| 72 | .\} |
| 73 | .if t \{\ |
| 74 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 75 | . ds #V .6m |
| 76 | . ds #F 0 |
| 77 | . ds #[ \& |
| 78 | . ds #] \& |
| 79 | .\} |
| 80 | . \" simple accents for nroff and troff |
| 81 | .if n \{\ |
| 82 | . ds ' \& |
| 83 | . ds ` \& |
| 84 | . ds ^ \& |
| 85 | . ds , \& |
| 86 | . ds ~ ~ |
| 87 | . ds / |
| 88 | .\} |
| 89 | .if t \{\ |
| 90 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 91 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 92 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 93 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 94 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 95 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 96 | .\} |
| 97 | . \" troff and (daisy-wheel) nroff accents |
| 98 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 99 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 100 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 101 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 102 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 103 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 104 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 105 | .ds ae a\h'-(\w'a'u*4/10)'e |
| 106 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| 107 | . \" corrections for vroff |
| 108 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 109 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 110 | . \" for low resolution devices (crt and lpr) |
| 111 | .if \n(.H>23 .if \n(.V>19 \ |
| 112 | \{\ |
| 113 | . ds : e |
| 114 | . ds 8 ss |
| 115 | . ds o a |
| 116 | . ds d- d\h'-1'\(ga |
| 117 | . ds D- D\h'-1'\(hy |
| 118 | . ds th \o'bp' |
| 119 | . ds Th \o'LP' |
| 120 | . ds ae ae |
| 121 | . ds Ae AE |
| 122 | .\} |
| 123 | .rm #[ #] #H #V #F C |
| 124 | .\" ======================================================================== |
| 125 | .\" |
| 126 | .IX Title "GENPKEY 1" |
| 127 | .TH GENPKEY 1 "2011-02-08" "1.0.0d" "OpenSSL" |
| 128 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 129 | .\" way too many mistakes in technical documents. |
| 130 | .if n .ad l |
| 131 | .nh |
| 132 | .SH "NAME" |
| 133 | genpkey \- generate a private key |
| 134 | .SH "SYNOPSIS" |
| 135 | .IX Header "SYNOPSIS" |
| 136 | \&\fBopenssl\fR \fBgenpkey\fR |
| 137 | [\fB\-out filename\fR] |
| 138 | [\fB\-outform PEM|DER\fR] |
| 139 | [\fB\-pass arg\fR] |
| 140 | [\fB\-cipher\fR] |
| 141 | [\fB\-engine id\fR] |
| 142 | [\fB\-paramfile file\fR] |
| 143 | [\fB\-algorithm alg\fR] |
| 144 | [\fB\-pkeyopt opt:value\fR] |
| 145 | [\fB\-genparam\fR] |
| 146 | [\fB\-text\fR] |
| 147 | .SH "DESCRIPTION" |
| 148 | .IX Header "DESCRIPTION" |
| 149 | The \fBgenpkey\fR command generates a private key. |
| 150 | .SH "OPTIONS" |
| 151 | .IX Header "OPTIONS" |
| 152 | .IP "\fB\-out filename\fR" 4 |
| 153 | .IX Item "-out filename" |
| 154 | the output filename. If this argument is not specified then standard output is |
| 155 | used. |
| 156 | .IP "\fB\-outform DER|PEM\fR" 4 |
| 157 | .IX Item "-outform DER|PEM" |
| 158 | This specifies the output format \s-1DER\s0 or \s-1PEM\s0. |
| 159 | .IP "\fB\-pass arg\fR" 4 |
| 160 | .IX Item "-pass arg" |
| 161 | the output file password source. For more information about the format of \fBarg\fR |
| 162 | see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1). |
| 163 | .IP "\fB\-cipher\fR" 4 |
| 164 | .IX Item "-cipher" |
| 165 | This option encrypts the private key with the supplied cipher. Any algorithm |
| 166 | name accepted by \fIEVP_get_cipherbyname()\fR is acceptable such as \fBdes3\fR. |
| 167 | .IP "\fB\-engine id\fR" 4 |
| 168 | .IX Item "-engine id" |
| 169 | specifying an engine (by its unique \fBid\fR string) will cause \fBgenpkey\fR |
| 170 | to attempt to obtain a functional reference to the specified engine, |
| 171 | thus initialising it if needed. The engine will then be set as the default |
| 172 | for all available algorithms. If used this option should precede all other |
| 173 | options. |
| 174 | .IP "\fB\-algorithm alg\fR" 4 |
| 175 | .IX Item "-algorithm alg" |
| 176 | public key algorithm to use such as \s-1RSA\s0, \s-1DSA\s0 or \s-1DH\s0. If used this option must |
| 177 | precede any \fB\-pkeyopt\fR options. The options \fB\-paramfile\fR and \fB\-algorithm\fR |
| 178 | are mutually exclusive. |
| 179 | .IP "\fB\-pkeyopt opt:value\fR" 4 |
| 180 | .IX Item "-pkeyopt opt:value" |
| 181 | set the public key algorithm option \fBopt\fR to \fBvalue\fR. The precise set of |
| 182 | options supported depends on the public key algorithm used and its |
| 183 | implementation. See \fB\s-1KEY\s0 \s-1GENERATION\s0 \s-1OPTIONS\s0\fR below for more details. |
| 184 | .IP "\fB\-genparam\fR" 4 |
| 185 | .IX Item "-genparam" |
| 186 | generate a set of parameters instead of a private key. If used this option must |
| 187 | precede and \fB\-algorithm\fR, \fB\-paramfile\fR or \fB\-pkeyopt\fR options. |
| 188 | .IP "\fB\-paramfile filename\fR" 4 |
| 189 | .IX Item "-paramfile filename" |
| 190 | Some public key algorithms generate a private key based on a set of parameters. |
| 191 | They can be supplied using this option. If this option is used the public key |
| 192 | algorithm used is determined by the parameters. If used this option must |
| 193 | precede and \fB\-pkeyopt\fR options. The options \fB\-paramfile\fR and \fB\-algorithm\fR |
| 194 | are mutually exclusive. |
| 195 | .IP "\fB\-text\fR" 4 |
| 196 | .IX Item "-text" |
| 197 | Print an (unencrypted) text representation of private and public keys and |
| 198 | parameters along with the \s-1PEM\s0 or \s-1DER\s0 structure. |
| 199 | .SH "KEY GENERATION OPTIONS" |
| 200 | .IX Header "KEY GENERATION OPTIONS" |
| 201 | The options supported by each algorith and indeed each implementation of an |
| 202 | algorithm can vary. The options for the OpenSSL implementations are detailed |
| 203 | below. |
| 204 | .SH "RSA KEY GENERATION OPTIONS" |
| 205 | .IX Header "RSA KEY GENERATION OPTIONS" |
| 206 | .IP "\fBrsa_keygen_bits:numbits\fR" 4 |
| 207 | .IX Item "rsa_keygen_bits:numbits" |
| 208 | The number of bits in the generated key. If not specified 1024 is used. |
| 209 | .IP "\fBrsa_keygen_pubexp:value\fR" 4 |
| 210 | .IX Item "rsa_keygen_pubexp:value" |
| 211 | The \s-1RSA\s0 public exponent value. This can be a large decimal or |
| 212 | hexadecimal value if preceded by \fB0x\fR. Default value is 65537. |
| 213 | .SH "DSA PARAMETER GENERATION OPTIONS" |
| 214 | .IX Header "DSA PARAMETER GENERATION OPTIONS" |
| 215 | .IP "\fBdsa_paramgen_bits:numbits\fR" 4 |
| 216 | .IX Item "dsa_paramgen_bits:numbits" |
| 217 | The number of bits in the generated parameters. If not specified 1024 is used. |
| 218 | .SH "DH PARAMETER GENERATION OPTIONS" |
| 219 | .IX Header "DH PARAMETER GENERATION OPTIONS" |
| 220 | .IP "\fBdh_paramgen_prime_len:numbits\fR" 4 |
| 221 | .IX Item "dh_paramgen_prime_len:numbits" |
| 222 | The number of bits in the prime parameter \fBp\fR. |
| 223 | .IP "\fBdh_paramgen_generator:value\fR" 4 |
| 224 | .IX Item "dh_paramgen_generator:value" |
| 225 | The value to use for the generator \fBg\fR. |
| 226 | .SH "EC PARAMETER GENERATION OPTIONS" |
| 227 | .IX Header "EC PARAMETER GENERATION OPTIONS" |
| 228 | .IP "\fBec_paramgen_curve:curve\fR" 4 |
| 229 | .IX Item "ec_paramgen_curve:curve" |
| 230 | the \s-1EC\s0 curve to use. |
| 231 | .SH "GOST2001 KEY GENERATION AND PARAMETER OPTIONS" |
| 232 | .IX Header "GOST2001 KEY GENERATION AND PARAMETER OPTIONS" |
| 233 | Gost 2001 support is not enabled by default. To enable this algorithm, |
| 234 | one should load the ccgost engine in the OpenSSL configuration file. |
| 235 | See \s-1README\s0.gost file in the engines/ccgost directiry of the source |
| 236 | distribution for more details. |
| 237 | .PP |
| 238 | Use of a parameter file for the \s-1GOST\s0 R 34.10 algorithm is optional. |
| 239 | Parameters can be specified during key generation directly as well as |
| 240 | during generation of parameter file. |
| 241 | .IP "\fBparamset:name\fR" 4 |
| 242 | .IX Item "paramset:name" |
| 243 | Specifies \s-1GOST\s0 R 34.10\-2001 parameter set according to \s-1RFC\s0 4357. |
| 244 | Parameter set can be specified using abbreviated name, object short name or |
| 245 | numeric \s-1OID\s0. Following parameter sets are supported: |
| 246 | .Sp |
| 247 | .Vb 7 |
| 248 | \& paramset OID Usage |
| 249 | \& A 1.2.643.2.2.35.1 Signature |
| 250 | \& B 1.2.643.2.2.35.2 Signature |
| 251 | \& C 1.2.643.2.2.35.3 Signature |
| 252 | \& XA 1.2.643.2.2.36.0 Key exchange |
| 253 | \& XB 1.2.643.2.2.36.1 Key exchange |
| 254 | \& test 1.2.643.2.2.35.0 Test purposes |
| 255 | .Ve |
| 256 | .SH "NOTES" |
| 257 | .IX Header "NOTES" |
| 258 | The use of the genpkey program is encouraged over the algorithm specific |
| 259 | utilities because additional algorithm options and \s-1ENGINE\s0 provided algorithms |
| 260 | can be used. |
| 261 | .SH "EXAMPLES" |
| 262 | .IX Header "EXAMPLES" |
| 263 | Generate an \s-1RSA\s0 private key using default parameters: |
| 264 | .PP |
| 265 | .Vb 1 |
| 266 | \& openssl genpkey \-algorithm RSA \-out key.pem |
| 267 | .Ve |
| 268 | .PP |
| 269 | Encrypt output private key using 128 bit \s-1AES\s0 and the passphrase \*(L"hello\*(R": |
| 270 | .PP |
| 271 | .Vb 1 |
| 272 | \& openssl genpkey \-algorithm RSA \-out key.pem \-aes\-128\-cbc \-pass pass:hello |
| 273 | .Ve |
| 274 | .PP |
| 275 | Generate a 2048 bit \s-1RSA\s0 key using 3 as the public exponent: |
| 276 | .PP |
| 277 | .Vb 2 |
| 278 | \& openssl genpkey \-algorithm RSA \-out key.pem \-pkeyopt rsa_keygen_bits:2048 \e |
| 279 | \& \-pkeyopt rsa_keygen_pubexp:3 |
| 280 | .Ve |
| 281 | .PP |
| 282 | Generate 1024 bit \s-1DSA\s0 parameters: |
| 283 | .PP |
| 284 | .Vb 2 |
| 285 | \& openssl genpkey \-genparam \-algorithm DSA \-out dsap.pem \e |
| 286 | \& \-pkeyopt dsa_paramgen_bits:1024 |
| 287 | .Ve |
| 288 | .PP |
| 289 | Generate \s-1DSA\s0 key from parameters: |
| 290 | .PP |
| 291 | .Vb 1 |
| 292 | \& openssl genpkey \-paramfile dsap.pem \-out dsakey.pem |
| 293 | .Ve |
| 294 | .PP |
| 295 | Generate 1024 bit \s-1DH\s0 parameters: |
| 296 | .PP |
| 297 | .Vb 2 |
| 298 | \& openssl genpkey \-genparam \-algorithm DH \-out dhp.pem \e |
| 299 | \& \-pkeyopt dh_paramgen_prime_len:1024 |
| 300 | .Ve |
| 301 | .PP |
| 302 | Generate \s-1DH\s0 key from parameters: |
| 303 | .PP |
| 304 | .Vb 1 |
| 305 | \& openssl genpkey \-paramfile dhp.pem \-out dhkey.pem |
| 306 | .Ve |
| 307 | .SH "POD ERRORS" |
| 308 | .IX Header "POD ERRORS" |
| 309 | Hey! \fBThe above document had some coding errors, which are explained below:\fR |
| 310 | .IP "Around line 117:" 4 |
| 311 | .IX Item "Around line 117:" |
| 312 | You forgot a '=back' before '=head1' |