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

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