Correct PPTP server firewall rules chain.
[tomato/davidwu.git] / release / src / router / openssl / doc / apps / genpkey.pod
blobc74d097fb3d830c4edf476e36fa84ea01933b262
1 =pod
3 =head1 NAME
5 genpkey - generate a private key
7 =head1 SYNOPSIS
9 B<openssl> B<genpkey>
10 [B<-out filename>]
11 [B<-outform PEM|DER>]
12 [B<-pass arg>]
13 [B<-cipher>]
14 [B<-engine id>]
15 [B<-paramfile file>]
16 [B<-algorithm alg>]
17 [B<-pkeyopt opt:value>]
18 [B<-genparam>]
19 [B<-text>]
21 =head1 DESCRIPTION
23 The B<genpkey> command generates a private key.
25 =head1 OPTIONS
27 =over 4
29 =item B<-out filename>
31 the output filename. If this argument is not specified then standard output is
32 used.  
34 =item B<-outform DER|PEM>
36 This specifies the output format DER or PEM.
38 =item B<-pass arg>
40 the output file password source. For more information about the format of B<arg>
41 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
43 =item B<-cipher>
45 This option encrypts the private key with the supplied cipher. Any algorithm
46 name accepted by EVP_get_cipherbyname() is acceptable such as B<des3>.
48 =item B<-engine id>
50 specifying an engine (by its unique B<id> string) will cause B<genpkey>
51 to attempt to obtain a functional reference to the specified engine,
52 thus initialising it if needed. The engine will then be set as the default
53 for all available algorithms. If used this option should precede all other
54 options.
56 =item B<-algorithm alg>
58 public key algorithm to use such as RSA, DSA or DH. If used this option must
59 precede any B<-pkeyopt> options. The options B<-paramfile> and B<-algorithm>
60 are mutually exclusive.
62 =item B<-pkeyopt opt:value>
64 set the public key algorithm option B<opt> to B<value>. The precise set of
65 options supported depends on the public key algorithm used and its
66 implementation. See B<KEY GENERATION OPTIONS> below for more details.
68 =item B<-genparam>
70 generate a set of parameters instead of a private key. If used this option must
71 precede and B<-algorithm>, B<-paramfile> or B<-pkeyopt> options.
73 =item B<-paramfile filename>
75 Some public key algorithms generate a private key based on a set of parameters.
76 They can be supplied using this option. If this option is used the public key
77 algorithm used is determined by the parameters. If used this option must
78 precede and B<-pkeyopt> options. The options B<-paramfile> and B<-algorithm>
79 are mutually exclusive.
81 =item B<-text>
83 Print an (unencrypted) text representation of private and public keys and
84 parameters along with the PEM or DER structure.
86 =back
88 =head1 KEY GENERATION OPTIONS
90 The options supported by each algorith and indeed each implementation of an
91 algorithm can vary. The options for the OpenSSL implementations are detailed
92 below.
94 =head1 RSA KEY GENERATION OPTIONS
96 =over 4
98 =item B<rsa_keygen_bits:numbits>
100 The number of bits in the generated key. If not specified 1024 is used.
102 =item B<rsa_keygen_pubexp:value>
104 The RSA public exponent value. This can be a large decimal or
105 hexadecimal value if preceded by B<0x>. Default value is 65537.
107 =back
109 =head1 DSA PARAMETER GENERATION OPTIONS
111 =over 4
113 =item B<dsa_paramgen_bits:numbits>
115 The number of bits in the generated parameters. If not specified 1024 is used.
117 =back
119 =head1 DH PARAMETER GENERATION OPTIONS
121 =over 4
123 =item B<dh_paramgen_prime_len:numbits>
125 The number of bits in the prime parameter B<p>.
127 =item B<dh_paramgen_generator:value>
129 The value to use for the generator B<g>.
131 =back
133 =head1 EC PARAMETER GENERATION OPTIONS
135 =over 4
137 =item B<ec_paramgen_curve:curve>
139 the EC curve to use.
141 =back
143 =head1 GOST2001 KEY GENERATION AND PARAMETER OPTIONS
145 Gost 2001 support is not enabled by default. To enable this algorithm,
146 one should load the ccgost engine in the OpenSSL configuration file.
147 See README.gost file in the engines/ccgost directiry of the source
148 distribution for more details.
150 Use of a parameter file for the GOST R 34.10 algorithm is optional.
151 Parameters can be specified during key generation directly as well as
152 during generation of parameter file.
154 =over 4
156 =item B<paramset:name>
158 Specifies GOST R 34.10-2001 parameter set according to RFC 4357.
159 Parameter set can be specified using abbreviated name, object short name or
160 numeric OID. Following parameter sets are supported:
162   paramset   OID               Usage
163   A          1.2.643.2.2.35.1  Signature
164   B          1.2.643.2.2.35.2  Signature
165   C          1.2.643.2.2.35.3  Signature
166   XA         1.2.643.2.2.36.0  Key exchange
167   XB         1.2.643.2.2.36.1  Key exchange
168   test       1.2.643.2.2.35.0  Test purposes
170 =back
174 =head1 NOTES
176 The use of the genpkey program is encouraged over the algorithm specific
177 utilities because additional algorithm options and ENGINE provided algorithms
178 can be used.
180 =head1 EXAMPLES
182 Generate an RSA private key using default parameters:
184  openssl genpkey -algorithm RSA -out key.pem 
186 Encrypt output private key using 128 bit AES and the passphrase "hello":
188  openssl genpkey -algorithm RSA -out key.pem -aes-128-cbc -pass pass:hello
190 Generate a 2048 bit RSA key using 3 as the public exponent:
192  openssl genpkey -algorithm RSA -out key.pem -pkeyopt rsa_keygen_bits:2048 \
193                                                 -pkeyopt rsa_keygen_pubexp:3
195 Generate 1024 bit DSA parameters:
197  openssl genpkey -genparam -algorithm DSA -out dsap.pem \
198                                                 -pkeyopt dsa_paramgen_bits:1024
200 Generate DSA key from parameters:
202  openssl genpkey -paramfile dsap.pem -out dsakey.pem 
204 Generate 1024 bit DH parameters:
206  openssl genpkey -genparam -algorithm DH -out dhp.pem \
207                                         -pkeyopt dh_paramgen_prime_len:1024
209 Generate DH key from parameters:
211  openssl genpkey -paramfile dhp.pem -out dhkey.pem 
214 =cut