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