secure/usr.bin/openssl/man/genrsa.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 "GENRSA 1"
 132 .TH GENRSA 1 "2018-11-20" "1.1.1a" "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\-genrsa, genrsa \- generate an RSA private key
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 \&\fBopenssl\fR \fBgenrsa\fR
 142 [\fB\-help\fR]
 143 [\fB\-out filename\fR]
 144 [\fB\-passout arg\fR]
 145 [\fB\-aes128\fR]
 146 [\fB\-aes192\fR]
 147 [\fB\-aes256\fR]
 148 [\fB\-aria128\fR]
 149 [\fB\-aria192\fR]
 150 [\fB\-aria256\fR]
 151 [\fB\-camellia128\fR]
 152 [\fB\-camellia192\fR]
 153 [\fB\-camellia256\fR]
 154 [\fB\-des\fR]
 155 [\fB\-des3\fR]
 156 [\fB\-idea\fR]
 157 [\fB\-f4\fR]
 158 [\fB\-3\fR]
 159 [\fB\-rand file...\fR]
 160 [\fB\-writerand file\fR]
 161 [\fB\-engine id\fR]
 162 [\fB\-primes num\fR]
 163 [\fBnumbits\fR]
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 The \fBgenrsa\fR command generates an \s-1RSA\s0 private key.
 167 .SH "OPTIONS"
 168 .IX Header "OPTIONS"
 169 .IP "\fB\-help\fR" 4
 170 .IX Item "-help"
 171 Print out a usage message.
 172 .IP "\fB\-out filename\fR" 4
 173 .IX Item "-out filename"
 174 Output the key to the specified file. If this argument is not specified then
 175 standard output is used.
 176 .IP "\fB\-passout arg\fR" 4
 177 .IX Item "-passout arg"
 178 The output file password source. For more information about the format
 179 of \fBarg\fR see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 180 .IP "\fB\-aes128\fR, \fB\-aes192\fR, \fB\-aes256\fR, \fB\-aria128\fR, \fB\-aria192\fR, \fB\-aria256\fR, \fB\-camellia128\fR, \fB\-camellia192\fR, \fB\-camellia256\fR, \fB\-des\fR, \fB\-des3\fR, \fB\-idea\fR" 4
 181 .IX Item "-aes128, -aes192, -aes256, -aria128, -aria192, -aria256, -camellia128, -camellia192, -camellia256, -des, -des3, -idea"
 182 These options encrypt the private key with specified
 183 cipher before outputting it. If none of these options is
 184 specified no encryption is used. If encryption is used a pass phrase is prompted
 185 for if it is not supplied via the \fB\-passout\fR argument.
 186 .IP "\fB\-F4|\-3\fR" 4
 187 .IX Item "-F4|-3"
 188 The public exponent to use, either 65537 or 3. The default is 65537.
 189 .IP "\fB\-rand file...\fR" 4
 190 .IX Item "-rand file..."
 191 A file or files containing random data used to seed the random number
 192 generator.
 193 Multiple files can be specified separated by an OS-dependent character.
 194 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 195 all others.
 196 .IP "[\fB\-writerand file\fR]" 4
 197 .IX Item "[-writerand file]"
 198 Writes random data to the specified \fIfile\fR upon exit.
 199 This can be used with a subsequent \fB\-rand\fR flag.
 200 .IP "\fB\-engine id\fR" 4
 201 .IX Item "-engine id"
 202 Specifying an engine (by its unique \fBid\fR string) will cause \fBgenrsa\fR
 203 to attempt to obtain a functional reference to the specified engine,
 204 thus initialising it if needed. The engine will then be set as the default
 205 for all available algorithms.
 206 .IP "\fB\-primes num\fR" 4
 207 .IX Item "-primes num"
 208 Specify the number of primes to use while generating the \s-1RSA\s0 key. The \fBnum\fR
 209 parameter must be a positive integer that is greater than 1 and less than 16.
 210 If \fBnum\fR is greater than 2, then the generated key is called a 'multi\-prime'
 211 \&\s-1RSA\s0 key, which is defined in \s-1RFC 8017.\s0
 212 .IP "\fBnumbits\fR" 4
 213 .IX Item "numbits"
 214 The size of the private key to generate in bits. This must be the last option
 215 specified. The default is 2048 and values less than 512 are not allowed.
 216 .SH "NOTES"
 217 .IX Header "NOTES"
 218 \&\s-1RSA\s0 private key generation essentially involves the generation of two or more
 219 prime numbers. When generating a private key various symbols will be output to
 220 indicate the progress of the generation. A \fB.\fR represents each number which
 221 has passed an initial sieve test, \fB+\fR means a number has passed a single
 222 round of the Miller-Rabin primality test, \fB*\fR means the current prime starts
 223 a regenerating progress due to some failed tests. A newline means that the number
 224 has passed all the prime tests (the actual number depends on the key size).
 225 .PP
 226 Because key generation is a random process the time taken to generate a key
 227 may vary somewhat. But in general, more primes lead to less generation time
 228 of a key.
 229 .SH "SEE ALSO"
 230 .IX Header "SEE ALSO"
 231 \&\fIgendsa\fR\|(1)
 232 .SH "COPYRIGHT"
 233 .IX Header "COPYRIGHT"
 234 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 235 .PP
 236 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 237 this file except in compliance with the License.  You can obtain a copy
 238 in the file \s-1LICENSE\s0 in the source distribution or at
 239 <https://www.openssl.org/source/license.html>.