secure/usr.bin/openssl/man/genpkey.1

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   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 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "GENPKEY 1"
 132 .TH GENPKEY 1 "2018-11-20" "1.0.2q" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 openssl\-genpkey,
 139 genpkey \- generate a private key
 140 .SH "SYNOPSIS"
 141 .IX Header "SYNOPSIS"
 142 \&\fBopenssl\fR \fBgenpkey\fR
 143 [\fB\-out filename\fR]
 144 [\fB\-outform PEM|DER\fR]
 145 [\fB\-pass arg\fR]
 146 [\fB\-\f(BIcipher\fB\fR]
 147 [\fB\-engine id\fR]
 148 [\fB\-paramfile file\fR]
 149 [\fB\-algorithm alg\fR]
 150 [\fB\-pkeyopt opt:value\fR]
 151 [\fB\-genparam\fR]
 152 [\fB\-text\fR]
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 The \fBgenpkey\fR command generates a private key.
 156 .SH "OPTIONS"
 157 .IX Header "OPTIONS"
 158 .IP "\fB\-out filename\fR" 4
 159 .IX Item "-out filename"
 160 the output filename. If this argument is not specified then standard output is
 161 used.
 162 .IP "\fB\-outform DER|PEM\fR" 4
 163 .IX Item "-outform DER|PEM"
 164 This specifies the output format \s-1DER\s0 or \s-1PEM.\s0 The default format is \s-1PEM.\s0
 165 .IP "\fB\-pass arg\fR" 4
 166 .IX Item "-pass arg"
 167 The output file password source. For more information about the format of \fBarg\fR
 168 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 169 .IP "\fB\-\f(BIcipher\fB\fR" 4
 170 .IX Item "-cipher"
 171 This option encrypts the private key with the supplied cipher. Any algorithm
 172 name accepted by \fIEVP_get_cipherbyname()\fR is acceptable such as \fBdes3\fR.
 173 .IP "\fB\-engine id\fR" 4
 174 .IX Item "-engine id"
 175 Specifying an engine (by its unique \fBid\fR string) will cause \fBgenpkey\fR
 176 to attempt to obtain a functional reference to the specified engine,
 177 thus initialising it if needed. The engine will then be set as the default
 178 for all available algorithms. If used this option should precede all other
 179 options.
 180 .IP "\fB\-algorithm alg\fR" 4
 181 .IX Item "-algorithm alg"
 182 Public key algorithm to use such as \s-1RSA, DSA\s0 or \s-1DH.\s0 If used this option must
 183 precede any \fB\-pkeyopt\fR options. The options \fB\-paramfile\fR and \fB\-algorithm\fR
 184 are mutually exclusive. Engines may add algorithms in addition to the standard
 185 built-in ones.
 186 .Sp
 187 Valid built-in algorithm names for private key generation are \s-1RSA\s0 and \s-1EC.\s0
 188 .Sp
 189 Valid built-in algorithm names for parameter generation (see the \fB\-genparam\fR
 190 option) are \s-1DH, DSA\s0 and \s-1EC.\s0
 191 .Sp
 192 Note that the algorithm name X9.42 \s-1DH\s0 may be used as a synonym for the \s-1DH\s0
 193 algorithm. These are identical and do not indicate the type of parameters that
 194 will be generated. Use the \fBdh_paramgen_type\fR option to indicate whether PKCS#3
 195 or X9.42 \s-1DH\s0 parameters are required. See \*(L"\s-1DH\s0 Parameter Generation Options\*(R"
 196 below for more details.
 197 .IP "\fB\-pkeyopt opt:value\fR" 4
 198 .IX Item "-pkeyopt opt:value"
 199 Set the public key algorithm option \fBopt\fR to \fBvalue\fR. The precise set of
 200 options supported depends on the public key algorithm used and its
 201 implementation. See \*(L"\s-1KEY GENERATION OPTIONS\*(R"\s0 and
 202 \&\*(L"\s-1PARAMETER GENERATION OPTIONS\*(R"\s0 below for more details.
 203 .IP "\fB\-genparam\fR" 4
 204 .IX Item "-genparam"
 205 Generate a set of parameters instead of a private key. If used this option must
 206 precede any \fB\-algorithm\fR, \fB\-paramfile\fR or \fB\-pkeyopt\fR options.
 207 .IP "\fB\-paramfile filename\fR" 4
 208 .IX Item "-paramfile filename"
 209 Some public key algorithms generate a private key based on a set of parameters.
 210 They can be supplied using this option. If this option is used the public key
 211 algorithm used is determined by the parameters. If used this option must
 212 precede and \fB\-pkeyopt\fR options. The options \fB\-paramfile\fR and \fB\-algorithm\fR
 213 are mutually exclusive.
 214 .IP "\fB\-text\fR" 4
 215 .IX Item "-text"
 216 Print an (unencrypted) text representation of private and public keys and
 217 parameters along with the \s-1PEM\s0 or \s-1DER\s0 structure.
 218 .SH "KEY GENERATION OPTIONS"
 219 .IX Header "KEY GENERATION OPTIONS"
 220 The options supported by each algorith and indeed each implementation of an
 221 algorithm can vary. The options for the OpenSSL implementations are detailed
 222 below.
 223 .SS "\s-1RSA\s0 Key Generation Options"
 224 .IX Subsection "RSA Key Generation Options"
 225 .IP "\fBrsa_keygen_bits:numbits\fR" 4
 226 .IX Item "rsa_keygen_bits:numbits"
 227 The number of bits in the generated key. If not specified 1024 is used.
 228 .IP "\fBrsa_keygen_pubexp:value\fR" 4
 229 .IX Item "rsa_keygen_pubexp:value"
 230 The \s-1RSA\s0 public exponent value. This can be a large decimal or
 231 hexadecimal value if preceded by \fB0x\fR. Default value is 65537.
 232 .SS "\s-1EC\s0 Key Generation Options"
 233 .IX Subsection "EC Key Generation Options"
 234 The \s-1EC\s0 key generation options can also be used for parameter generation.
 235 .IP "\fBec_paramgen_curve:curve\fR" 4
 236 .IX Item "ec_paramgen_curve:curve"
 237 The \s-1EC\s0 curve to use. OpenSSL supports \s-1NIST\s0 curve names such as \*(L"P\-256\*(R".
 238 .IP "\fBec_param_enc:encoding\fR" 4
 239 .IX Item "ec_param_enc:encoding"
 240 The encoding to use for parameters. The \*(L"encoding\*(R" parameter must be either
 241 \&\*(L"named_curve\*(R" or \*(L"explicit\*(R". The default value is \*(L"named_curve\*(R".
 242 .SH "PARAMETER GENERATION OPTIONS"
 243 .IX Header "PARAMETER GENERATION OPTIONS"
 244 The options supported by each algorithm and indeed each implementation of an
 245 algorithm can vary. The options for the OpenSSL implementations are detailed
 246 below.
 247 .SS "\s-1DSA\s0 Parameter Generation Options"
 248 .IX Subsection "DSA Parameter Generation Options"
 249 .IP "\fBdsa_paramgen_bits:numbits\fR" 4
 250 .IX Item "dsa_paramgen_bits:numbits"
 251 The number of bits in the generated prime. If not specified 1024 is used.
 252 .IP "\fBdsa_paramgen_q_bits:numbits\fR" 4
 253 .IX Item "dsa_paramgen_q_bits:numbits"
 254 The number of bits in the q parameter. Must be one of 160, 224 or 256. If not
 255 specified 160 is used.
 256 .IP "\fBdsa_paramgen_md:digest\fR" 4
 257 .IX Item "dsa_paramgen_md:digest"
 258 The digest to use during parameter generation. Must be one of \fBsha1\fR, \fBsha224\fR
 259 or \fBsha256\fR. If set, then the number of bits in \fBq\fR will match the output size
 260 of the specified digest and the \fBdsa_paramgen_q_bits\fR parameter will be
 261 ignored. If not set, then a digest will be used that gives an output matching
 262 the number of bits in \fBq\fR, i.e. \fBsha1\fR if q length is 160, \fBsha224\fR if it 224
 263 or \fBsha256\fR if it is 256.
 264 .SS "\s-1DH\s0 Parameter Generation Options"
 265 .IX Subsection "DH Parameter Generation Options"
 266 .IP "\fBdh_paramgen_prime_len:numbits\fR" 4
 267 .IX Item "dh_paramgen_prime_len:numbits"
 268 The number of bits in the prime parameter \fBp\fR. The default is 1024.
 269 .IP "\fBdh_paramgen_subprime_len:numbits\fR" 4
 270 .IX Item "dh_paramgen_subprime_len:numbits"
 271 The number of bits in the sub prime parameter \fBq\fR. The default is 256 if the
 272 prime is at least 2048 bits long or 160 otherwise. Only relevant if used in
 273 conjunction with the \fBdh_paramgen_type\fR option to generate X9.42 \s-1DH\s0 parameters.
 274 .IP "\fBdh_paramgen_generator:value\fR" 4
 275 .IX Item "dh_paramgen_generator:value"
 276 The value to use for the generator \fBg\fR. The default is 2.
 277 .IP "\fBdh_paramgen_type:value\fR" 4
 278 .IX Item "dh_paramgen_type:value"
 279 The type of \s-1DH\s0 parameters to generate. Use 0 for PKCS#3 \s-1DH\s0 and 1 for X9.42 \s-1DH.\s0
 280 The default is 0.
 281 .IP "\fBdh_rfc5114:num\fR" 4
 282 .IX Item "dh_rfc5114:num"
 283 If this option is set, then the appropriate \s-1RFC5114\s0 parameters are used
 284 instead of generating new parameters. The value \fBnum\fR can take the
 285 values 1, 2 or 3 corresponding to \s-1RFC5114 DH\s0 parameters consisting of
 286 1024 bit group with 160 bit subgroup, 2048 bit group with 224 bit subgroup
 287 and 2048 bit group with 256 bit subgroup as mentioned in \s-1RFC5114\s0 sections
 288 2.1, 2.2 and 2.3 respectively. If present this overrides all other \s-1DH\s0 parameter
 289 options.
 290 .SS "\s-1EC\s0 Parameter Generation Options"
 291 .IX Subsection "EC Parameter Generation Options"
 292 The \s-1EC\s0 parameter generation options are the same as for key generation. See
 293 \&\*(L"\s-1EC\s0 Key Generation Options\*(R" above.
 294 .SH "GOST2001 KEY GENERATION AND PARAMETER OPTIONS"
 295 .IX Header "GOST2001 KEY GENERATION AND PARAMETER OPTIONS"
 296 Gost 2001 support is not enabled by default. To enable this algorithm,
 297 one should load the ccgost engine in the OpenSSL configuration file.
 298 See \s-1README\s0.gost file in the engines/ccgost directiry of the source
 299 distribution for more details.
 300 .PP
 301 Use of a parameter file for the \s-1GOST R 34.10\s0 algorithm is optional.
 302 Parameters can be specified during key generation directly as well as
 303 during generation of parameter file.
 304 .IP "\fBparamset:name\fR" 4
 305 .IX Item "paramset:name"
 306 Specifies \s-1GOST R 34.10\-2001\s0 parameter set according to \s-1RFC 4357.\s0
 307 Parameter set can be specified using abbreviated name, object short name or
 308 numeric \s-1OID.\s0 Following parameter sets are supported:
 309 .Sp
 310 .Vb 7
 311 \&  paramset   OID               Usage
 312 \&  A          1.2.643.2.2.35.1  Signature
 313 \&  B          1.2.643.2.2.35.2  Signature
 314 \&  C          1.2.643.2.2.35.3  Signature
 315 \&  XA         1.2.643.2.2.36.0  Key exchange
 316 \&  XB         1.2.643.2.2.36.1  Key exchange
 317 \&  test       1.2.643.2.2.35.0  Test purposes
 318 .Ve
 319 .SH "NOTES"
 320 .IX Header "NOTES"
 321 The use of the genpkey program is encouraged over the algorithm specific
 322 utilities because additional algorithm options and \s-1ENGINE\s0 provided algorithms
 323 can be used.
 324 .SH "EXAMPLES"
 325 .IX Header "EXAMPLES"
 326 Generate an \s-1RSA\s0 private key using default parameters:
 327 .PP
 328 .Vb 1
 329 \& openssl genpkey \-algorithm RSA \-out key.pem
 330 .Ve
 331 .PP
 332 Encrypt output private key using 128 bit \s-1AES\s0 and the passphrase \*(L"hello\*(R":
 333 .PP
 334 .Vb 1
 335 \& openssl genpkey \-algorithm RSA \-out key.pem \-aes\-128\-cbc \-pass pass:hello
 336 .Ve
 337 .PP
 338 Generate a 2048 bit \s-1RSA\s0 key using 3 as the public exponent:
 339 .PP
 340 .Vb 2
 341 \& openssl genpkey \-algorithm RSA \-out key.pem \-pkeyopt rsa_keygen_bits:2048 \e
 342 \&                                                \-pkeyopt rsa_keygen_pubexp:3
 343 .Ve
 344 .PP
 345 Generate 2048 bit \s-1DSA\s0 parameters:
 346 .PP
 347 .Vb 2
 348 \& openssl genpkey \-genparam \-algorithm DSA \-out dsap.pem \e
 349 \&                                                \-pkeyopt dsa_paramgen_bits:2048
 350 .Ve
 351 .PP
 352 Generate \s-1DSA\s0 key from parameters:
 353 .PP
 354 .Vb 1
 355 \& openssl genpkey \-paramfile dsap.pem \-out dsakey.pem
 356 .Ve
 357 .PP
 358 Generate 2048 bit \s-1DH\s0 parameters:
 359 .PP
 360 .Vb 2
 361 \& openssl genpkey \-genparam \-algorithm DH \-out dhp.pem \e
 362 \&                                        \-pkeyopt dh_paramgen_prime_len:2048
 363 .Ve
 364 .PP
 365 Generate 2048 bit X9.42 \s-1DH\s0 parameters:
 366 .PP
 367 .Vb 3
 368 \& openssl genpkey \-genparam \-algorithm DH \-out dhpx.pem \e
 369 \&                                        \-pkeyopt dh_paramgen_prime_len:2048 \e
 370 \&                                        \-pkeyopt dh_paramgen_type:1
 371 .Ve
 372 .PP
 373 Output \s-1RFC5114 2048\s0 bit \s-1DH\s0 parameters with 224 bit subgroup:
 374 .PP
 375 .Vb 1
 376 \& openssl genpkey \-genparam \-algorithm DH \-out dhp.pem \-pkeyopt dh_rfc5114:2
 377 .Ve
 378 .PP
 379 Generate \s-1DH\s0 key from parameters:
 380 .PP
 381 .Vb 1
 382 \& openssl genpkey \-paramfile dhp.pem \-out dhkey.pem
 383 .Ve
 384 .PP
 385 Generate \s-1EC\s0 key directly:
 386 .PP
 387 .Vb 3
 388 \& openssl genpkey \-algorithm EC \-out eckey.pem \e
 389 \&        \-pkeyopt ec_paramgen_curve:P\-384 \e
 390 \&        \-pkeyopt ec_param_enc:named_curve
 391 .Ve
 392 .SH "HISTORY"
 393 .IX Header "HISTORY"
 394 The ability to use \s-1NIST\s0 curve names, and to generate an \s-1EC\s0 key directly,
 395 were added in OpenSSL 1.0.2.