Merge from 1.0.0-stable branch.
[openssl.git] / doc / apps / genpkey.pod
1 =pod
2
3 =head1 NAME
4
5 genpkey - generate a private key
6
7 =head1 SYNOPSIS
8
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>]
20
21 =head1 DESCRIPTION
22
23 The B<genpkey> command generates a private key.
24
25 =head1 OPTIONS
26
27 =over 4
28
29 =item B<-out filename>
30
31 the output filename. If this argument is not specified then standard output is
32 used.  
33
34 =item B<-outform DER|PEM>
35
36 This specifies the output format DER or PEM.
37
38 =item B<-pass arg>
39
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)>.
42
43 =item B<-cipher>
44
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>.
47
48 =item B<-engine id>
49
50 specifying an engine (by it's unique B<id> string) will cause B<req>
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.
55
56 =item B<-algorithm alg>
57
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.
61
62 =item B<-pkeyopt opt:value>
63
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.
67
68 =item B<-genparam>
69
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.
72
73 =item B<-paramfile filename>
74
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.
80
81 =item B<-text>
82
83 Print an (unencrypted) text representation of private and public keys and
84 parameters along with the PEM or DER structure.
85
86 =back
87
88 =head1 KEY GENERATION OPTIONS
89
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.
93
94 =head1 RSA KEY GENERATION OPTIONS
95
96 =over 4
97
98 =item B<rsa_keygen_bits:numbits>
99
100 The number of bits in the generated key. If not specified 1024 is used.
101
102 =item B<rsa_keygen_pubexp:value>
103
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.
106
107 =back
108
109 =head1 DSA PARAMETER GENERATION OPTIONS
110
111 =over 4
112
113 =item B<dsa_paramgen_bits:numbits>
114
115 The number of bits in the generated parameters. If not specified 1024 is used.
116
117 =head1 DH PARAMETER GENERATION OPTIONS
118
119 =over 4
120
121 =item B<dh_paramgen_prime_len:numbits>
122
123 The number of bits in the prime parameter B<p>.
124
125 =item B<dh_paramgen_generator:value>
126
127 The value to use for the generator B<g>.
128
129 =back
130
131 =head1 EC PARAMETER GENERATION OPTIONS
132
133 =over 4
134
135 =item B<ec_paramgen_curve:curve>
136
137 the EC curve to use.
138
139 =back
140
141 =head1 NOTES
142
143 The use of the genpkey program is encouraged over the algorithm specific
144 utilities because additional algorithm options and ENGINE provided algorithms
145 can be used.
146
147 =head1 EXAMPLES
148
149 Generate an RSA private key using default parameters:
150
151  openssl genpkey -algoritm RSA -out key.pem 
152
153 Encrypt output private key using 128 bit AES and the passphrase "hello":
154
155  openssl genpkey -algoritm RSA -out key.pem -aes-128-cbc -pass pass:hello
156
157 Generate a 2048 bit RSA key using 3 as the public exponent:
158
159  openssl genpkey -algoritm RSA -out key.pem -pkeyopt rsa_keygen_bits:2048 \
160                                                 -pkeyopt rsa_keygen_pubexp:3
161
162 Generate 1024 bit DSA parameters:
163
164  openssl genpkey -genparam -algorithm DSA -out dsap.pem \
165                                                 -pkeyopt dsa_paramgen_bits:1024
166
167 Generate DSA key from parameters:
168
169  openssl genpkey -paramfile dsap.pem -out dsakey.pem 
170
171 Generate 1024 bit DH parameters:
172
173  openssl genpkey -genparam -algorithm DH -out dhp.pem \
174                                         -pkeyopt dh_paramgen_prime_len:1024
175
176 Generate DH key from parameters:
177
178  openssl genpkey -paramfile dhp.pem -out dhkey.pem 
179
180
181 =cut
182