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

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   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 turned on, 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 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "GENRSA 1"
 136 .TH GENRSA 1 "2015-07-09" "1.0.1p" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 genrsa \- generate an RSA private key
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBopenssl\fR \fBgenrsa\fR
 146 [\fB\-out filename\fR]
 147 [\fB\-passout arg\fR]
 148 [\fB\-aes128\fR]
 149 [\fB\-aes128\fR]
 150 [\fB\-aes192\fR]
 151 [\fB\-aes256\fR]
 152 [\fB\-camellia128\fR]
 153 [\fB\-camellia192\fR]
 154 [\fB\-camellia256\fR]
 155 [\fB\-aes192\fR]
 156 [\fB\-aes256\fR]
 157 [\fB\-camellia128\fR]
 158 [\fB\-camellia192\fR]
 159 [\fB\-camellia256\fR]
 160 [\fB\-des\fR]
 161 [\fB\-des3\fR]
 162 [\fB\-idea\fR]
 163 [\fB\-f4\fR]
 164 [\fB\-3\fR]
 165 [\fB\-rand file(s)\fR]
 166 [\fB\-engine id\fR]
 167 [\fBnumbits\fR]
 168 .SH "DESCRIPTION"
 169 .IX Header "DESCRIPTION"
 170 The \fBgenrsa\fR command generates an \s-1RSA\s0 private key.
 171 .SH "OPTIONS"
 172 .IX Header "OPTIONS"
 173 .IP "\fB\-out filename\fR" 4
 174 .IX Item "-out filename"
 175 the output filename. If this argument is not specified then standard output is
 176 used.
 177 .IP "\fB\-passout arg\fR" 4
 178 .IX Item "-passout arg"
 179 the output file password source. For more information about the format of \fBarg\fR
 180 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 181 .IP "\fB\-aes128|\-aes192|\-aes256|\-camellia128|\-camellia192|\-camellia256|\-des|\-des3|\-idea\fR" 4
 182 .IX Item "-aes128|-aes192|-aes256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea"
 183 These options encrypt the private key with specified
 184 cipher before outputting it. If none of these options is
 185 specified no encryption is used. If encryption is used a pass phrase is prompted
 186 for if it is not supplied via the \fB\-passout\fR argument.
 187 .IP "\fB\-F4|\-3\fR" 4
 188 .IX Item "-F4|-3"
 189 the public exponent to use, either 65537 or 3. The default is 65537.
 190 .IP "\fB\-rand file(s)\fR" 4
 191 .IX Item "-rand file(s)"
 192 a file or files containing random data used to seed the random number
 193 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 194 Multiple files can be specified separated by a OS-dependent character.
 195 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 196 all others.
 197 .IP "\fB\-engine id\fR" 4
 198 .IX Item "-engine id"
 199 specifying an engine (by its unique \fBid\fR string) will cause \fBgenrsa\fR
 200 to attempt to obtain a functional reference to the specified engine,
 201 thus initialising it if needed. The engine will then be set as the default
 202 for all available algorithms.
 203 .IP "\fBnumbits\fR" 4
 204 .IX Item "numbits"
 205 the size of the private key to generate in bits. This must be the last option
 206 specified. The default is 512.
 207 .SH "NOTES"
 208 .IX Header "NOTES"
 209 \&\s-1RSA\s0 private key generation essentially involves the generation of two prime
 210 numbers. When generating a private key various symbols will be output to
 211 indicate the progress of the generation. A \fB.\fR represents each number which
 212 has passed an initial sieve test, \fB+\fR means a number has passed a single
 213 round of the Miller-Rabin primality test. A newline means that the number has
 214 passed all the prime tests (the actual number depends on the key size).
 215 .PP
 216 Because key generation is a random process the time taken to generate a key
 217 may vary somewhat.
 218 .SH "BUGS"
 219 .IX Header "BUGS"
 220 A quirk of the prime generation algorithm is that it cannot generate small
 221 primes. Therefore the number of bits should not be less that 64. For typical
 222 private keys this will not matter because for security reasons they will
 223 be much larger (typically 1024 bits).
 224 .SH "SEE ALSO"
 225 .IX Header "SEE ALSO"
 226 \&\fIgendsa\fR\|(1)