4d805f94329d03706f221996b1e52aba9cb195fc
[dragonfly.git] / secure / lib / libcrypto / man / EVP_PKEY_keygen.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
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 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
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"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
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
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
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'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
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
116 .    \" corrections for vroff
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'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
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
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "EVP_PKEY_keygen 3"
136 .TH EVP_PKEY_keygen 3 "2015-03-19" "1.0.1m" "OpenSSL"
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
141 .SH "NAME"
142 EVP_PKEY_keygen_init, EVP_PKEY_keygen, EVP_PKEY_paramgen_init, EVP_PKEY_paramgen, EVP_PKEY_CTX_set_cb, EVP_PKEY_CTX_get_cb, EVP_PKEY_CTX_get_keygen_info, EVP_PKEVP_PKEY_CTX_set_app_data, EVP_PKEY_CTX_get_app_data \- key and parameter generation functions
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/evp.h>
147 \&
148 \& int EVP_PKEY_keygen_init(EVP_PKEY_CTX *ctx);
149 \& int EVP_PKEY_keygen(EVP_PKEY_CTX *ctx, EVP_PKEY **ppkey);
150 \& int EVP_PKEY_paramgen_init(EVP_PKEY_CTX *ctx);
151 \& int EVP_PKEY_paramgen(EVP_PKEY_CTX *ctx, EVP_PKEY **ppkey);
152 \&
153 \& typedef int EVP_PKEY_gen_cb(EVP_PKEY_CTX *ctx);
154 \&
155 \& void EVP_PKEY_CTX_set_cb(EVP_PKEY_CTX *ctx, EVP_PKEY_gen_cb *cb);
156 \& EVP_PKEY_gen_cb *EVP_PKEY_CTX_get_cb(EVP_PKEY_CTX *ctx);
157 \&
158 \& int EVP_PKEY_CTX_get_keygen_info(EVP_PKEY_CTX *ctx, int idx);
159 \&
160 \& void EVP_PKEY_CTX_set_app_data(EVP_PKEY_CTX *ctx, void *data);
161 \& void *EVP_PKEY_CTX_get_app_data(EVP_PKEY_CTX *ctx);
162 .Ve
163 .SH "DESCRIPTION"
164 .IX Header "DESCRIPTION"
165 The \fIEVP_PKEY_keygen_init()\fR function initializes a public key algorithm
166 context using key \fBpkey\fR for a key genration operation.
167 .PP
168 The \fIEVP_PKEY_keygen()\fR function performs a key generation operation, the 
169 generated key is written to \fBppkey\fR.
170 .PP
171 The functions \fIEVP_PKEY_paramgen_init()\fR and \fIEVP_PKEY_paramgen()\fR are similar
172 except parameters are generated.
173 .PP
174 The function \fIEVP_PKEY_set_cb()\fR sets the key or parameter generation callback
175 to \fBcb\fR. The function \fIEVP_PKEY_CTX_get_cb()\fR returns the key or parameter
176 generation callback.
177 .PP
178 The function \fIEVP_PKEY_CTX_get_keygen_info()\fR returns parameters associated
179 with the generation operation. If \fBidx\fR is \-1 the total number of
180 parameters available is returned. Any non negative value returns the value of
181 that parameter. \fIEVP_PKEY_CTX_gen_keygen_info()\fR with a non-negative value for
182 \&\fBidx\fR should only be called within the generation callback.
183 .PP
184 If the callback returns 0 then the key genration operation is aborted and an
185 error occurs. This might occur during a time consuming operation where
186 a user clicks on a \*(L"cancel\*(R" button.
187 .PP
188 The functions \fIEVP_PKEY_CTX_set_app_data()\fR and \fIEVP_PKEY_CTX_get_app_data()\fR set
189 and retrieve an opaque pointer. This can be used to set some application
190 defined value which can be retrieved in the callback: for example a handle
191 which is used to update a \*(L"progress dialog\*(R".
192 .SH "NOTES"
193 .IX Header "NOTES"
194 After the call to \fIEVP_PKEY_keygen_init()\fR or \fIEVP_PKEY_paramgen_init()\fR algorithm
195 specific control operations can be performed to set any appropriate parameters
196 for the operation.
197 .PP
198 The functions \fIEVP_PKEY_keygen()\fR and \fIEVP_PKEY_paramgen()\fR can be called more than
199 once on the same context if several operations are performed using the same
200 parameters.
201 .PP
202 The meaning of the parameters passed to the callback will depend on the
203 algorithm and the specifiic implementation of the algorithm. Some might not
204 give any useful information at all during key or parameter generation. Others
205 might not even call the callback.
206 .PP
207 The operation performed by key or parameter generation depends on the algorithm
208 used. In some cases (e.g. \s-1EC\s0 with a supplied named curve) the \*(L"generation\*(R"
209 option merely sets the appropriate fields in an \s-1EVP_PKEY\s0 structure.
210 .PP
211 In OpenSSL an \s-1EVP_PKEY\s0 structure containing a private key also contains the
212 public key components and parameters (if any). An OpenSSL private key is
213 equivalent to what some libraries call a \*(L"key pair\*(R". A private key can be used
214 in functions which require the use of a public key or parameters.
215 .SH "RETURN VALUES"
216 .IX Header "RETURN VALUES"
217 \&\fIEVP_PKEY_keygen_init()\fR, \fIEVP_PKEY_paramgen_init()\fR, \fIEVP_PKEY_keygen()\fR and
218 \&\fIEVP_PKEY_paramgen()\fR return 1 for success and 0 or a negative value for failure.
219 In particular a return value of \-2 indicates the operation is not supported by
220 the public key algorithm.
221 .SH "EXAMPLES"
222 .IX Header "EXAMPLES"
223 Generate a 2048 bit \s-1RSA\s0 key:
224 .PP
225 .Vb 2
226 \& #include <openssl/evp.h>
227 \& #include <openssl/rsa.h>
228 \&
229 \& EVP_PKEY_CTX *ctx;
230 \& EVP_PKEY *pkey = NULL;
231 \& ctx = EVP_PKEY_CTX_new_id(EVP_PKEY_RSA, NULL);
232 \& if (!ctx)
233 \&        /* Error occurred */
234 \& if (EVP_PKEY_keygen_init(ctx) <= 0)
235 \&        /* Error */
236 \& if (EVP_PKEY_CTX_set_rsa_keygen_bits(ctx, 2048) <= 0)
237 \&        /* Error */
238 \&
239 \& /* Generate key */
240 \& if (EVP_PKEY_keygen(ctx, &pkey) <= 0)
241 \&        /* Error */
242 .Ve
243 .PP
244 Generate a key from a set of parameters:
245 .PP
246 .Vb 2
247 \& #include <openssl/evp.h>
248 \& #include <openssl/rsa.h>
249 \&
250 \& EVP_PKEY_CTX *ctx;
251 \& EVP_PKEY *pkey = NULL, *param;
252 \& /* Assumed param is set up already */
253 \& ctx = EVP_PKEY_CTX_new(param);
254 \& if (!ctx)
255 \&        /* Error occurred */
256 \& if (EVP_PKEY_keygen_init(ctx) <= 0)
257 \&        /* Error */
258 \&
259 \& /* Generate key */
260 \& if (EVP_PKEY_keygen(ctx, &pkey) <= 0)
261 \&        /* Error */
262 .Ve
263 .PP
264 Example of generation callback for OpenSSL public key implementations:
265 .PP
266 .Vb 1
267 \& /* Application data is a BIO to output status to */
268 \&
269 \& EVP_PKEY_CTX_set_app_data(ctx, status_bio);
270 \&
271 \& static int genpkey_cb(EVP_PKEY_CTX *ctx)
272 \&        {
273 \&        char c=\*(Aq*\*(Aq;
274 \&        BIO *b = EVP_PKEY_CTX_get_app_data(ctx);
275 \&        int p;
276 \&        p = EVP_PKEY_CTX_get_keygen_info(ctx, 0);
277 \&        if (p == 0) c=\*(Aq.\*(Aq;
278 \&        if (p == 1) c=\*(Aq+\*(Aq;
279 \&        if (p == 2) c=\*(Aq*\*(Aq;
280 \&        if (p == 3) c=\*(Aq\en\*(Aq;
281 \&        BIO_write(b,&c,1);
282 \&        (void)BIO_flush(b);
283 \&        return 1;
284 \&        }
285 .Ve
286 .SH "SEE ALSO"
287 .IX Header "SEE ALSO"
288 \&\fIEVP_PKEY_CTX_new\fR\|(3),
289 \&\fIEVP_PKEY_encrypt\fR\|(3),
290 \&\fIEVP_PKEY_decrypt\fR\|(3),
291 \&\fIEVP_PKEY_sign\fR\|(3),
292 \&\fIEVP_PKEY_verify\fR\|(3),
293 \&\fIEVP_PKEY_verify_recover\fR\|(3),
294 \&\fIEVP_PKEY_derive\fR\|(3)
295 .SH "HISTORY"
296 .IX Header "HISTORY"
297 These functions were first added to OpenSSL 1.0.0.