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

   1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" Escape single quotes in literal strings from groff's Unicode transform.
  52 .ie \n(.g .ds Aq \(aq
  53 .el       .ds Aq '
  54 .\"
  55 .\" If the F register is turned on, we'll generate index entries on stderr for
  56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  58 .\" output yourself in some meaningful fashion.
  59 .ie \nF \{\
  60 .    de IX
  61 .    tm Index:\\$1\t\\n%\t"\\$2"
  62 ..
  63 .    nr % 0
  64 .    rr F
  65 .\}
  66 .el \{\
  67 .    de IX
  68 ..
  69 .\}
  70 .\"
  71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  73 .    \" fudge factors for nroff and troff
  74 .if n \{\
  75 .    ds #H 0
  76 .    ds #V .8m
  77 .    ds #F .3m
  78 .    ds #[ \f1
  79 .    ds #] \fP
  80 .\}
  81 .if t \{\
  82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  83 .    ds #V .6m
  84 .    ds #F 0
  85 .    ds #[ \&
  86 .    ds #] \&
  87 .\}
  88 .    \" simple accents for nroff and troff
  89 .if n \{\
  90 .    ds ' \&
  91 .    ds ` \&
  92 .    ds ^ \&
  93 .    ds , \&
  94 .    ds ~ ~
  95 .    ds /
  96 .\}
  97 .if t \{\
  98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 104 .\}
 105 .    \" troff and (daisy-wheel) nroff accents
 106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 113 .ds ae a\h'-(\w'a'u*4/10)'e
 114 .ds Ae A\h'-(\w'A'u*4/10)'E
 115 .    \" corrections for vroff
 116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 118 .    \" for low resolution devices (crt and lpr)
 119 .if \n(.H>23 .if \n(.V>19 \
 120 \{\
 121 .    ds : e
 122 .    ds 8 ss
 123 .    ds o a
 124 .    ds d- d\h'-1'\(ga
 125 .    ds D- D\h'-1'\(hy
 126 .    ds th \o'bp'
 127 .    ds Th \o'LP'
 128 .    ds ae ae
 129 .    ds Ae AE
 130 .\}
 131 .rm #[ #] #H #V #F C
 132 .\" ========================================================================
 133 .\"
 134 .IX Title "GENRSA 1"
 135 .TH GENRSA 1 "2009-11-06" "0.9.8l" "OpenSSL"
 136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 137 .\" way too many mistakes in technical documents.
 138 .if n .ad l
 139 .nh
 140 .SH "NAME"
 141 genrsa \- generate an RSA private key
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 \&\fBopenssl\fR \fBgenrsa\fR
 145 [\fB\-out filename\fR]
 146 [\fB\-passout arg\fR]
 147 [\fB\-des\fR]
 148 [\fB\-des3\fR]
 149 [\fB\-idea\fR]
 150 [\fB\-f4\fR]
 151 [\fB\-3\fR]
 152 [\fB\-rand file(s)\fR]
 153 [\fB\-engine id\fR]
 154 [\fBnumbits\fR]
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 The \fBgenrsa\fR command generates an \s-1RSA\s0 private key.
 158 .SH "OPTIONS"
 159 .IX Header "OPTIONS"
 160 .IP "\fB\-out filename\fR" 4
 161 .IX Item "-out filename"
 162 the output filename. If this argument is not specified then standard output is
 163 used.
 164 .IP "\fB\-passout arg\fR" 4
 165 .IX Item "-passout arg"
 166 the output file password source. For more information about the format of \fBarg\fR
 167 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
 168 .IP "\fB\-des|\-des3|\-idea\fR" 4
 169 .IX Item "-des|-des3|-idea"
 170 These options encrypt the private key with the \s-1DES\s0, triple \s-1DES\s0, or the
 171 \&\s-1IDEA\s0 ciphers respectively before outputting it. If none of these options is
 172 specified no encryption is used. If encryption is used a pass phrase is prompted
 173 for if it is not supplied via the \fB\-passout\fR argument.
 174 .IP "\fB\-F4|\-3\fR" 4
 175 .IX Item "-F4|-3"
 176 the public exponent to use, either 65537 or 3. The default is 65537.
 177 .IP "\fB\-rand file(s)\fR" 4
 178 .IX Item "-rand file(s)"
 179 a file or files containing random data used to seed the random number
 180 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
 181 Multiple files can be specified separated by a OS-dependent character.
 182 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
 183 all others.
 184 .IP "\fB\-engine id\fR" 4
 185 .IX Item "-engine id"
 186 specifying an engine (by it's unique \fBid\fR string) will cause \fBreq\fR
 187 to attempt to obtain a functional reference to the specified engine,
 188 thus initialising it if needed. The engine will then be set as the default
 189 for all available algorithms.
 190 .IP "\fBnumbits\fR" 4
 191 .IX Item "numbits"
 192 the size of the private key to generate in bits. This must be the last option
 193 specified. The default is 512.
 194 .SH "NOTES"
 195 .IX Header "NOTES"
 196 \&\s-1RSA\s0 private key generation essentially involves the generation of two prime
 197 numbers. When generating a private key various symbols will be output to
 198 indicate the progress of the generation. A \fB.\fR represents each number which
 199 has passed an initial sieve test, \fB+\fR means a number has passed a single
 200 round of the Miller-Rabin primality test. A newline means that the number has
 201 passed all the prime tests (the actual number depends on the key size).
 202 .PP
 203 Because key generation is a random process the time taken to generate a key
 204 may vary somewhat.
 205 .SH "BUGS"
 206 .IX Header "BUGS"
 207 A quirk of the prime generation algorithm is that it cannot generate small
 208 primes. Therefore the number of bits should not be less that 64. For typical
 209 private keys this will not matter because for security reasons they will
 210 be much larger (typically 1024 bits).
 211 .SH "SEE ALSO"
 212 .IX Header "SEE ALSO"
 213 \&\fIgendsa\fR\|(1)