openssl: Adjust manual pages for 1.0.1n.
[dragonfly.git] / secure / usr.bin / openssl / man / genrsa.1
CommitLineData
5a44c043 1.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
8b0cefbb 5.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
6.if t .sp .5v
7.if n .sp
8..
8b0cefbb 9.de Vb \" Begin verbatim text
984263bc
MD
10.ft CW
11.nf
12.ne \\$1
13..
8b0cefbb 14.de Ve \" End verbatim text
984263bc 15.ft R
984263bc
MD
16.fi
17..
8b0cefbb
JR
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
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-
8b0cefbb 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 26.ie n \{\
8b0cefbb
JR
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' ""
984263bc
MD
35'br\}
36.el\{\
8b0cefbb
JR
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
5a44c043
SW
41. ds C`
42. ds C'
984263bc 43'br\}
8b0cefbb 44.\"
e257b235
PA
45.\" Escape single quotes in literal strings from groff's Unicode transform.
46.ie \n(.g .ds Aq \(aq
47.el .ds Aq '
48.\"
8b0cefbb 49.\" If the F register is turned on, we'll generate index entries on stderr for
01185282 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
8b0cefbb
JR
51.\" entries marked with X<> in POD. Of course, you'll have to process the
52.\" output yourself in some meaningful fashion.
5a44c043
SW
53.\"
54.\" Avoid warning from groff about undefined register 'F'.
55.de IX
984263bc 56..
5a44c043
SW
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"
e257b235 63..
5a44c043
SW
64. if !\nF==2 \{
65. nr % 0
66. nr F 2
67. \}
68. \}
e257b235 69.\}
5a44c043 70.rr rF
aac4ff6f 71.\"
8b0cefbb
JR
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
984263bc 75.if n \{\
8b0cefbb
JR
76. ds #H 0
77. ds #V .8m
78. ds #F .3m
79. ds #[ \f1
80. ds #] \fP
984263bc
MD
81.\}
82.if t \{\
8b0cefbb
JR
83. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84. ds #V .6m
85. ds #F 0
86. ds #[ \&
87. ds #] \&
984263bc 88.\}
8b0cefbb 89. \" simple accents for nroff and troff
984263bc 90.if n \{\
8b0cefbb
JR
91. ds ' \&
92. ds ` \&
93. ds ^ \&
94. ds , \&
95. ds ~ ~
96. ds /
984263bc
MD
97.\}
98.if t \{\
8b0cefbb
JR
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'
984263bc 105.\}
8b0cefbb 106. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 116. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 119. \" for low resolution devices (crt and lpr)
984263bc
MD
120.if \n(.H>23 .if \n(.V>19 \
121\{\
8b0cefbb
JR
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
984263bc
MD
131.\}
132.rm #[ #] #H #V #F C
8b0cefbb
JR
133.\" ========================================================================
134.\"
135.IX Title "GENRSA 1"
60096f03 136.TH GENRSA 1 "2015-06-11" "1.0.1n" "OpenSSL"
e257b235
PA
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
984263bc 141.SH "NAME"
e3cdf75b 142genrsa \- generate an RSA private key
984263bc 143.SH "SYNOPSIS"
8b0cefbb
JR
144.IX Header "SYNOPSIS"
145\&\fBopenssl\fR \fBgenrsa\fR
984263bc
MD
146[\fB\-out filename\fR]
147[\fB\-passout arg\fR]
ecf90583
SW
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]
984263bc
MD
160[\fB\-des\fR]
161[\fB\-des3\fR]
162[\fB\-idea\fR]
163[\fB\-f4\fR]
164[\fB\-3\fR]
e3cdf75b 165[\fB\-rand file(s)\fR]
984263bc
MD
166[\fB\-engine id\fR]
167[\fBnumbits\fR]
168.SH "DESCRIPTION"
8b0cefbb
JR
169.IX Header "DESCRIPTION"
170The \fBgenrsa\fR command generates an \s-1RSA\s0 private key.
984263bc 171.SH "OPTIONS"
8b0cefbb
JR
172.IX Header "OPTIONS"
173.IP "\fB\-out filename\fR" 4
174.IX Item "-out filename"
984263bc 175the output filename. If this argument is not specified then standard output is
e257b235 176used.
8b0cefbb
JR
177.IP "\fB\-passout arg\fR" 4
178.IX Item "-passout arg"
984263bc 179the output file password source. For more information about the format of \fBarg\fR
5a44c043 180see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
ecf90583
SW
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"
183These options encrypt the private key with specified
184cipher before outputting it. If none of these options is
984263bc
MD
185specified no encryption is used. If encryption is used a pass phrase is prompted
186for if it is not supplied via the \fB\-passout\fR argument.
8b0cefbb
JR
187.IP "\fB\-F4|\-3\fR" 4
188.IX Item "-F4|-3"
984263bc 189the public exponent to use, either 65537 or 3. The default is 65537.
8b0cefbb
JR
190.IP "\fB\-rand file(s)\fR" 4
191.IX Item "-rand file(s)"
984263bc 192a file or files containing random data used to seed the random number
8b0cefbb
JR
193generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
194Multiple files can be specified separated by a OS-dependent character.
e257b235 195The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
984263bc 196all others.
8b0cefbb
JR
197.IP "\fB\-engine id\fR" 4
198.IX Item "-engine id"
01185282 199specifying an engine (by its unique \fBid\fR string) will cause \fBgenrsa\fR
984263bc
MD
200to attempt to obtain a functional reference to the specified engine,
201thus initialising it if needed. The engine will then be set as the default
202for all available algorithms.
8b0cefbb
JR
203.IP "\fBnumbits\fR" 4
204.IX Item "numbits"
984263bc
MD
205the size of the private key to generate in bits. This must be the last option
206specified. The default is 512.
207.SH "NOTES"
8b0cefbb
JR
208.IX Header "NOTES"
209\&\s-1RSA\s0 private key generation essentially involves the generation of two prime
984263bc
MD
210numbers. When generating a private key various symbols will be output to
211indicate the progress of the generation. A \fB.\fR represents each number which
212has passed an initial sieve test, \fB+\fR means a number has passed a single
213round of the Miller-Rabin primality test. A newline means that the number has
214passed all the prime tests (the actual number depends on the key size).
215.PP
216Because key generation is a random process the time taken to generate a key
217may vary somewhat.
218.SH "BUGS"
8b0cefbb 219.IX Header "BUGS"
984263bc
MD
220A quirk of the prime generation algorithm is that it cannot generate small
221primes. Therefore the number of bits should not be less that 64. For typical
222private keys this will not matter because for security reasons they will
223be much larger (typically 1024 bits).
224.SH "SEE ALSO"
e3cdf75b 225.IX Header "SEE ALSO"
8b0cefbb 226\&\fIgendsa\fR\|(1)