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

   1 .\" Automatically generated by Pod::Man 4.07 (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 "2017-05-25" "1.0.2l" "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 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(s)\fR]
 160 [\fB\-engine id\fR]
 161 [\fBnumbits\fR]
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 The \fBgenrsa\fR command generates an \s-1RSA\s0 private key.
 165 .SH "OPTIONS"
 166 .IX Header "OPTIONS"
 167 .IP "\fB\-help\fR" 4
 168 .IX Item "-help"
 169 Print out a usage message.
 170 .IP "\fB\-out filename\fR" 4
 171 .IX Item "-out filename"
 172 Output the key to the specified file. If this argument is not specified then
 173 standard output is used.
 174 .IP "\fB\-passout arg\fR" 4
 175 .IX Item "-passout arg"
 176 the output file password source. For more information about the format of \fBarg\fR
 177 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 178 .IP "\fB\-aes128|\-aes192|\-aes256|\-aria128|\-aria192|\-aria256|\-camellia128|\-camellia192|\-camellia256|\-des|\-des3|\-idea\fR" 4
 179 .IX Item "-aes128|-aes192|-aes256|-aria128|-aria192|-aria256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea"
 180 These options encrypt the private key with specified
 181 cipher before outputting it. If none of these options is
 182 specified no encryption is used. If encryption is used a pass phrase is prompted
 183 for if it is not supplied via the \fB\-passout\fR argument.
 184 .IP "\fB\-F4|\-3\fR" 4
 185 .IX Item "-F4|-3"
 186 the public exponent to use, either 65537 or 3. The default is 65537.
 187 .IP "\fB\-rand file(s)\fR" 4
 188 .IX Item "-rand file(s)"
 189 a file or files containing random data used to seed the random number
 190 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 191 Multiple files can be specified separated by an OS-dependent character.
 192 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 193 all others.
 194 .IP "\fB\-engine id\fR" 4
 195 .IX Item "-engine id"
 196 specifying an engine (by its unique \fBid\fR string) will cause \fBgenrsa\fR
 197 to attempt to obtain a functional reference to the specified engine,
 198 thus initialising it if needed. The engine will then be set as the default
 199 for all available algorithms.
 200 .IP "\fBnumbits\fR" 4
 201 .IX Item "numbits"
 202 the size of the private key to generate in bits. This must be the last option
 203 specified. The default is 2048.
 204 .SH "NOTES"
 205 .IX Header "NOTES"
 206 \&\s-1RSA\s0 private key generation essentially involves the generation of two prime
 207 numbers. When generating a private key various symbols will be output to
 208 indicate the progress of the generation. A \fB.\fR represents each number which
 209 has passed an initial sieve test, \fB+\fR means a number has passed a single
 210 round of the Miller-Rabin primality test. A newline means that the number has
 211 passed all the prime tests (the actual number depends on the key size).
 212 .PP
 213 Because key generation is a random process the time taken to generate a key
 214 may vary somewhat.
 215 .SH "BUGS"
 216 .IX Header "BUGS"
 217 A quirk of the prime generation algorithm is that it cannot generate small
 218 primes. Therefore the number of bits should not be less that 64. For typical
 219 private keys this will not matter because for security reasons they will
 220 be much larger (typically 1024 bits).
 221 .SH "SEE ALSO"
 222 .IX Header "SEE ALSO"
 223 \&\fIgendsa\fR\|(1)
 224 .SH "COPYRIGHT"
 225 .IX Header "COPYRIGHT"
 226 Copyright 2000\-2017 The OpenSSL Project Authors. All Rights Reserved.
 227 .PP
 228 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 229 this file except in compliance with the License.  You can obtain a copy
 230 in the file \s-1LICENSE\s0 in the source distribution or at
 231 <https://www.openssl.org/source/license.html>.