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