Add public API docs for newly added EVP_SIGNATURE related functions
[openssl.git] / doc / man3 / EVP_PKEY_CTX_ctrl.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_PKEY_CTX_set_params,
6 EVP_PKEY_CTX_ctrl,
7 EVP_PKEY_CTX_ctrl_str,
8 EVP_PKEY_CTX_ctrl_uint64,
9 EVP_PKEY_CTX_md,
10 EVP_PKEY_CTX_set_signature_md,
11 EVP_PKEY_CTX_get_signature_md,
12 EVP_PKEY_CTX_set_mac_key,
13 EVP_PKEY_CTX_set_rsa_padding,
14 EVP_PKEY_CTX_get_rsa_padding,
15 EVP_PKEY_CTX_set_rsa_pss_saltlen,
16 EVP_PKEY_CTX_get_rsa_pss_saltlen,
17 EVP_PKEY_CTX_set_rsa_keygen_bits,
18 EVP_PKEY_CTX_set_rsa_keygen_pubexp,
19 EVP_PKEY_CTX_set_rsa_keygen_primes,
20 EVP_PKEY_CTX_set_rsa_mgf1_md,
21 EVP_PKEY_CTX_get_rsa_mgf1_md,
22 EVP_PKEY_CTX_set_rsa_oaep_md,
23 EVP_PKEY_CTX_get_rsa_oaep_md,
24 EVP_PKEY_CTX_set0_rsa_oaep_label,
25 EVP_PKEY_CTX_get0_rsa_oaep_label,
26 EVP_PKEY_CTX_set_dsa_paramgen_bits,
27 EVP_PKEY_CTX_set_dsa_paramgen_q_bits,
28 EVP_PKEY_CTX_set_dsa_paramgen_md,
29 EVP_PKEY_CTX_set_dh_paramgen_prime_len,
30 EVP_PKEY_CTX_set_dh_paramgen_subprime_len,
31 EVP_PKEY_CTX_set_dh_paramgen_generator,
32 EVP_PKEY_CTX_set_dh_paramgen_type,
33 EVP_PKEY_CTX_set_dh_rfc5114,
34 EVP_PKEY_CTX_set_dhx_rfc5114,
35 EVP_PKEY_CTX_set_dh_pad,
36 EVP_PKEY_CTX_set_dh_nid,
37 EVP_PKEY_CTX_set_dh_kdf_type,
38 EVP_PKEY_CTX_get_dh_kdf_type,
39 EVP_PKEY_CTX_set0_dh_kdf_oid,
40 EVP_PKEY_CTX_get0_dh_kdf_oid,
41 EVP_PKEY_CTX_set_dh_kdf_md,
42 EVP_PKEY_CTX_get_dh_kdf_md,
43 EVP_PKEY_CTX_set_dh_kdf_outlen,
44 EVP_PKEY_CTX_get_dh_kdf_outlen,
45 EVP_PKEY_CTX_set0_dh_kdf_ukm,
46 EVP_PKEY_CTX_get0_dh_kdf_ukm,
47 EVP_PKEY_CTX_set_ec_paramgen_curve_nid,
48 EVP_PKEY_CTX_set_ec_param_enc,
49 EVP_PKEY_CTX_set_ecdh_cofactor_mode,
50 EVP_PKEY_CTX_get_ecdh_cofactor_mode,
51 EVP_PKEY_CTX_set_ecdh_kdf_type,
52 EVP_PKEY_CTX_get_ecdh_kdf_type,
53 EVP_PKEY_CTX_set_ecdh_kdf_md,
54 EVP_PKEY_CTX_get_ecdh_kdf_md,
55 EVP_PKEY_CTX_set_ecdh_kdf_outlen,
56 EVP_PKEY_CTX_get_ecdh_kdf_outlen,
57 EVP_PKEY_CTX_set0_ecdh_kdf_ukm,
58 EVP_PKEY_CTX_get0_ecdh_kdf_ukm,
59 EVP_PKEY_CTX_set1_id, EVP_PKEY_CTX_get1_id, EVP_PKEY_CTX_get1_id_len
60 - algorithm specific control operations
61
62 =head1 SYNOPSIS
63
64  #include <openssl/evp.h>
65
66  int EVP_PKEY_CTX_set_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params);
67
68  int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
69                        int cmd, int p1, void *p2);
70  int EVP_PKEY_CTX_ctrl_uint64(EVP_PKEY_CTX *ctx, int keytype, int optype,
71                               int cmd, uint64_t value);
72  int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx, const char *type,
73                            const char *value);
74
75  int EVP_PKEY_CTX_md(EVP_PKEY_CTX *ctx, int optype, int cmd, const char *md);
76
77  int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
78  int EVP_PKEY_CTX_get_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD **pmd);
79
80  int EVP_PKEY_CTX_set_mac_key(EVP_PKEY_CTX *ctx, const unsigned char *key,
81                               int len);
82
83  #include <openssl/rsa.h>
84
85  int EVP_PKEY_CTX_set_rsa_padding(EVP_PKEY_CTX *ctx, int pad);
86  int EVP_PKEY_CTX_get_rsa_padding(EVP_PKEY_CTX *ctx, int *pad);
87  int EVP_PKEY_CTX_set_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, int len);
88  int EVP_PKEY_CTX_get_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, int *len);
89  int EVP_PKEY_CTX_set_rsa_keygen_bits(EVP_PKEY_CTX *ctx, int mbits);
90  int EVP_PKEY_CTX_set_rsa_keygen_pubexp(EVP_PKEY_CTX *ctx, BIGNUM *pubexp);
91  int EVP_PKEY_CTX_set_rsa_keygen_primes(EVP_PKEY_CTX *ctx, int primes);
92  int EVP_PKEY_CTX_set_rsa_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
93  int EVP_PKEY_CTX_get_rsa_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
94  int EVP_PKEY_CTX_set_rsa_oaep_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
95  int EVP_PKEY_CTX_get_rsa_oaep_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
96  int EVP_PKEY_CTX_set0_rsa_oaep_label(EVP_PKEY_CTX *ctx, unsigned char *label, int len);
97  int EVP_PKEY_CTX_get0_rsa_oaep_label(EVP_PKEY_CTX *ctx, unsigned char **label);
98
99  #include <openssl/dsa.h>
100
101  int EVP_PKEY_CTX_set_dsa_paramgen_bits(EVP_PKEY_CTX *ctx, int nbits);
102  int EVP_PKEY_CTX_set_dsa_paramgen_q_bits(EVP_PKEY_CTX *ctx, int qbits);
103  int EVP_PKEY_CTX_set_dsa_paramgen_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
104
105  #include <openssl/dh.h>
106
107  int EVP_PKEY_CTX_set_dh_paramgen_prime_len(EVP_PKEY_CTX *ctx, int len);
108  int EVP_PKEY_CTX_set_dh_paramgen_subprime_len(EVP_PKEY_CTX *ctx, int len);
109  int EVP_PKEY_CTX_set_dh_paramgen_generator(EVP_PKEY_CTX *ctx, int gen);
110  int EVP_PKEY_CTX_set_dh_paramgen_type(EVP_PKEY_CTX *ctx, int type);
111  int EVP_PKEY_CTX_set_dh_pad(EVP_PKEY_CTX *ctx, int pad);
112  int EVP_PKEY_CTX_set_dh_nid(EVP_PKEY_CTX *ctx, int nid);
113  int EVP_PKEY_CTX_set_dh_rfc5114(EVP_PKEY_CTX *ctx, int rfc5114);
114  int EVP_PKEY_CTX_set_dhx_rfc5114(EVP_PKEY_CTX *ctx, int rfc5114);
115  int EVP_PKEY_CTX_set_dh_kdf_type(EVP_PKEY_CTX *ctx, int kdf);
116  int EVP_PKEY_CTX_get_dh_kdf_type(EVP_PKEY_CTX *ctx);
117  int EVP_PKEY_CTX_set0_dh_kdf_oid(EVP_PKEY_CTX *ctx, ASN1_OBJECT *oid);
118  int EVP_PKEY_CTX_get0_dh_kdf_oid(EVP_PKEY_CTX *ctx, ASN1_OBJECT **oid);
119  int EVP_PKEY_CTX_set_dh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
120  int EVP_PKEY_CTX_get_dh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
121  int EVP_PKEY_CTX_set_dh_kdf_outlen(EVP_PKEY_CTX *ctx, int len);
122  int EVP_PKEY_CTX_get_dh_kdf_outlen(EVP_PKEY_CTX *ctx, int *len);
123  int EVP_PKEY_CTX_set0_dh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char *ukm, int len);
124  int EVP_PKEY_CTX_get0_dh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char **ukm);
125
126  #include <openssl/ec.h>
127
128  int EVP_PKEY_CTX_set_ec_paramgen_curve_nid(EVP_PKEY_CTX *ctx, int nid);
129  int EVP_PKEY_CTX_set_ec_param_enc(EVP_PKEY_CTX *ctx, int param_enc);
130  int EVP_PKEY_CTX_set_ecdh_cofactor_mode(EVP_PKEY_CTX *ctx, int cofactor_mode);
131  int EVP_PKEY_CTX_get_ecdh_cofactor_mode(EVP_PKEY_CTX *ctx);
132  int EVP_PKEY_CTX_set_ecdh_kdf_type(EVP_PKEY_CTX *ctx, int kdf);
133  int EVP_PKEY_CTX_get_ecdh_kdf_type(EVP_PKEY_CTX *ctx);
134  int EVP_PKEY_CTX_set_ecdh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
135  int EVP_PKEY_CTX_get_ecdh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
136  int EVP_PKEY_CTX_set_ecdh_kdf_outlen(EVP_PKEY_CTX *ctx, int len);
137  int EVP_PKEY_CTX_get_ecdh_kdf_outlen(EVP_PKEY_CTX *ctx, int *len);
138  int EVP_PKEY_CTX_set0_ecdh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char *ukm, int len);
139  int EVP_PKEY_CTX_get0_ecdh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char **ukm);
140
141  int EVP_PKEY_CTX_set1_id(EVP_PKEY_CTX *ctx, void *id, size_t id_len);
142  int EVP_PKEY_CTX_get1_id(EVP_PKEY_CTX *ctx, void *id);
143  int EVP_PKEY_CTX_get1_id_len(EVP_PKEY_CTX *ctx, size_t *id_len);
144
145 =head1 DESCRIPTION
146
147 The EVP_PKEY_CTX_set_params() function sends arbitrary parameters to the
148 algorithm implementation.
149 Not all parameters may be supported by all providers.
150 See L<OSSL_PROVIDER(3)> for more information on providers.
151 See L<OSSL_PARAM(3)> for more information on parameters.
152 The parameters currently supported by the default provider are:
153
154 =over 4
155
156 =item OSSL_EXCHANGE_PARAM_PAD (uint type)
157
158 Sets the DH padding mode.
159 If B<OSSL_EXCHANGE_PARAM_PAD> is 1 then the  shared secret is padded with zeroes
160 up to the size of the DH prime B<p>.
161 If B<OSSL_EXCHANGE_PARAM_PAD> is zero (the default) then no padding is
162 performed.
163
164 =item OSSL_SIGNATURE_PARAM_DIGEST (UTF8 string type)
165
166 Sets the name of the digest algorithm used for the input to the signature
167 functions.
168
169 =item OSSL_SIGNATURE_PARAM_DIGEST_SIZE (size_t type)
170
171 Sets the output size of the digest algorithm used for the input to the signature
172 functions.
173 The internal algorithm that supports this parameter is DSA.
174
175 =back
176
177 The function EVP_PKEY_CTX_ctrl() sends a control operation to the context
178 B<ctx>. The key type used must match B<keytype> if it is not -1. The parameter
179 B<optype> is a mask indicating which operations the control can be applied to.
180 The control command is indicated in B<cmd> and any additional arguments in
181 B<p1> and B<p2>.
182
183 For B<cmd> = B<EVP_PKEY_CTRL_SET_MAC_KEY>, B<p1> is the length of the MAC key,
184 and B<p2> is MAC key. This is used by Poly1305, SipHash, HMAC and CMAC.
185
186 Applications will not normally call EVP_PKEY_CTX_ctrl() directly but will
187 instead call one of the algorithm specific macros below.
188
189 The function EVP_PKEY_CTX_ctrl_uint64() is a wrapper that directly passes a
190 uint64 value as B<p2> to EVP_PKEY_CTX_ctrl().
191
192 The function EVP_PKEY_CTX_ctrl_str() allows an application to send an algorithm
193 specific control operation to a context B<ctx> in string form. This is
194 intended to be used for options specified on the command line or in text
195 files. The commands supported are documented in the openssl utility
196 command line pages for the option B<-pkeyopt> which is supported by the
197 B<pkeyutl>, B<genpkey> and B<req> commands.
198
199 The function EVP_PKEY_CTX_md() sends a message digest control operation
200 to the context B<ctx>. The message digest is specified by its name B<md>.
201
202 All the remaining "functions" are implemented as macros.
203
204 The EVP_PKEY_CTX_set_signature_md() macro sets the message digest type used
205 in a signature. It can be used in the RSA, DSA and ECDSA algorithms.
206
207 The EVP_PKEY_CTX_get_signature_md() macro gets the message digest type used in a
208 signature. It can be used in the RSA, DSA and ECDSA algorithms.
209
210 Key generation typically involves setting up parameters to be used and
211 generating the private and public key data. Some algorithm implementations
212 allow private key data to be set explicitly using the EVP_PKEY_CTX_set_mac_key()
213 macro. In this case key generation is simply the process of setting up the
214 parameters for the key and then setting the raw key data to the value explicitly
215 provided by that macro. Normally applications would call
216 L<EVP_PKEY_new_raw_private_key(3)> or similar functions instead of this macro.
217
218 The EVP_PKEY_CTX_set_mac_key() macro can be used with any of the algorithms
219 supported by the L<EVP_PKEY_new_raw_private_key(3)> function.
220
221 =head2 RSA parameters
222
223 The EVP_PKEY_CTX_set_rsa_padding() macro sets the RSA padding mode for B<ctx>.
224 The B<pad> parameter can take the value B<RSA_PKCS1_PADDING> for PKCS#1
225 padding, B<RSA_SSLV23_PADDING> for SSLv23 padding, B<RSA_NO_PADDING> for
226 no padding, B<RSA_PKCS1_OAEP_PADDING> for OAEP padding (encrypt and
227 decrypt only), B<RSA_X931_PADDING> for X9.31 padding (signature operations
228 only) and B<RSA_PKCS1_PSS_PADDING> (sign and verify only).
229
230 Two RSA padding modes behave differently if EVP_PKEY_CTX_set_signature_md()
231 is used. If this macro is called for PKCS#1 padding the plaintext buffer is
232 an actual digest value and is encapsulated in a DigestInfo structure according
233 to PKCS#1 when signing and this structure is expected (and stripped off) when
234 verifying. If this control is not used with RSA and PKCS#1 padding then the
235 supplied data is used directly and not encapsulated. In the case of X9.31
236 padding for RSA the algorithm identifier byte is added or checked and removed
237 if this control is called. If it is not called then the first byte of the plaintext
238 buffer is expected to be the algorithm identifier byte.
239
240 The EVP_PKEY_CTX_get_rsa_padding() macro gets the RSA padding mode for B<ctx>.
241
242 The EVP_PKEY_CTX_set_rsa_pss_saltlen() macro sets the RSA PSS salt length to
243 B<len>. As its name implies it is only supported for PSS padding. Three special
244 values are supported: B<RSA_PSS_SALTLEN_DIGEST> sets the salt length to the
245 digest length, B<RSA_PSS_SALTLEN_MAX> sets the salt length to the maximum
246 permissible value. When verifying B<RSA_PSS_SALTLEN_AUTO> causes the salt length
247 to be automatically determined based on the B<PSS> block structure. If this
248 macro is not called maximum salt length is used when signing and auto detection
249 when verifying is used by default.
250
251 The EVP_PKEY_CTX_get_rsa_pss_saltlen() macro gets the RSA PSS salt length
252 for B<ctx>. The padding mode must have been set to B<RSA_PKCS1_PSS_PADDING>.
253
254 The EVP_PKEY_CTX_set_rsa_keygen_bits() macro sets the RSA key length for
255 RSA key generation to B<bits>. If not specified 1024 bits is used.
256
257 The EVP_PKEY_CTX_set_rsa_keygen_pubexp() macro sets the public exponent value
258 for RSA key generation to B<pubexp>. Currently it should be an odd integer. The
259 B<pubexp> pointer is used internally by this function so it should not be
260 modified or freed after the call. If not specified 65537 is used.
261
262 The EVP_PKEY_CTX_set_rsa_keygen_primes() macro sets the number of primes for
263 RSA key generation to B<primes>. If not specified 2 is used.
264
265 The EVP_PKEY_CTX_set_rsa_mgf1_md() macro sets the MGF1 digest for RSA padding
266 schemes to B<md>. If not explicitly set the signing digest is used. The
267 padding mode must have been set to B<RSA_PKCS1_OAEP_PADDING>
268 or B<RSA_PKCS1_PSS_PADDING>.
269
270 The EVP_PKEY_CTX_get_rsa_mgf1_md() macro gets the MGF1 digest for B<ctx>.
271 If not explicitly set the signing digest is used. The padding mode must have
272 been set to B<RSA_PKCS1_OAEP_PADDING> or B<RSA_PKCS1_PSS_PADDING>.
273
274 The EVP_PKEY_CTX_set_rsa_oaep_md() macro sets the message digest type used
275 in RSA OAEP to B<md>. The padding mode must have been set to
276 B<RSA_PKCS1_OAEP_PADDING>.
277
278 The EVP_PKEY_CTX_get_rsa_oaep_md() macro gets the message digest type used
279 in RSA OAEP to B<md>. The padding mode must have been set to
280 B<RSA_PKCS1_OAEP_PADDING>.
281
282 The EVP_PKEY_CTX_set0_rsa_oaep_label() macro sets the RSA OAEP label to
283 B<label> and its length to B<len>. If B<label> is NULL or B<len> is 0,
284 the label is cleared. The library takes ownership of the label so the
285 caller should not free the original memory pointed to by B<label>.
286 The padding mode must have been set to B<RSA_PKCS1_OAEP_PADDING>.
287
288 The EVP_PKEY_CTX_get0_rsa_oaep_label() macro gets the RSA OAEP label to
289 B<label>. The return value is the label length. The padding mode
290 must have been set to B<RSA_PKCS1_OAEP_PADDING>. The resulting pointer is owned
291 by the library and should not be freed by the caller.
292
293 =head2 DSA parameters
294
295 The EVP_PKEY_CTX_set_dsa_paramgen_bits() macro sets the number of bits used
296 for DSA parameter generation to B<nbits>. If not specified, 1024 is used.
297
298 The EVP_PKEY_CTX_set_dsa_paramgen_q_bits() macro sets the number of bits in the
299 subprime parameter B<q> for DSA parameter generation to B<qbits>. If not
300 specified, 160 is used. If a digest function is specified below, this parameter
301 is ignored and instead, the number of bits in B<q> matches the size of the
302 digest.
303
304 The EVP_PKEY_CTX_set_dsa_paramgen_md() macro sets the digest function used for
305 DSA parameter generation to B<md>. If not specified, one of SHA-1, SHA-224, or
306 SHA-256 is selected to match the bit length of B<q> above.
307
308 =head2 DH parameters
309
310 The EVP_PKEY_CTX_set_dh_paramgen_prime_len() macro sets the length of the DH
311 prime parameter B<p> for DH parameter generation. If this macro is not called
312 then 1024 is used. Only accepts lengths greater than or equal to 256.
313
314 The EVP_PKEY_CTX_set_dh_paramgen_subprime_len() macro sets the length of the DH
315 optional subprime parameter B<q> for DH parameter generation. The default is
316 256 if the prime is at least 2048 bits long or 160 otherwise. The DH
317 paramgen type must have been set to x9.42.
318
319 The EVP_PKEY_CTX_set_dh_paramgen_generator() macro sets DH generator to B<gen>
320 for DH parameter generation. If not specified 2 is used.
321
322 The EVP_PKEY_CTX_set_dh_paramgen_type() macro sets the key type for DH
323 parameter generation. Use 0 for PKCS#3 DH and 1 for X9.42 DH.
324 The default is 0.
325
326 The EVP_PKEY_CTX_set_dh_pad() function sets the DH padding mode.
327 If B<pad> is 1 the shared secret is padded with zeroes up to the size of the DH
328 prime B<p>.
329 If B<pad> is zero (the default) then no padding is performed.
330
331 EVP_PKEY_CTX_set_dh_nid() sets the DH parameters to values corresponding to
332 B<nid> as defined in RFC7919. The B<nid> parameter must be B<NID_ffdhe2048>,
333 B<NID_ffdhe3072>, B<NID_ffdhe4096>, B<NID_ffdhe6144>, B<NID_ffdhe8192>
334 or B<NID_undef> to clear the stored value. This macro can be called during
335 parameter or key generation.
336 The nid parameter and the rfc5114 parameter are mutually exclusive.
337
338 The EVP_PKEY_CTX_set_dh_rfc5114() and EVP_PKEY_CTX_set_dhx_rfc5114() macros are
339 synonymous. They set the DH parameters to the values defined in RFC5114. The
340 B<rfc5114> parameter must be 1, 2 or 3 corresponding to RFC5114 sections
341 2.1, 2.2 and 2.3. or 0 to clear the stored value. This macro can be called
342 during parameter generation. The B<ctx> must have a key type of
343 B<EVP_PKEY_DHX>.
344 The rfc5114 parameter and the nid parameter are mutually exclusive.
345
346 =head2 DH key derivation function parameters
347
348 Note that all of the following functions require that the B<ctx> parameter has
349 a private key type of B<EVP_PKEY_DHX>. When using key derivation, the output of
350 EVP_PKEY_derive() is the output of the KDF instead of the DH shared secret.
351 The KDF output is typically used as a Key Encryption Key (KEK) that in turn
352 encrypts a Content Encryption Key (CEK).
353
354 The EVP_PKEY_CTX_set_dh_kdf_type() macro sets the key derivation function type
355 to B<kdf> for DH key derivation. Possible values are B<EVP_PKEY_DH_KDF_NONE>
356 and B<EVP_PKEY_DH_KDF_X9_42> which uses the key derivation specified in RFC2631
357 (based on the keying algorithm described in X9.42). When using key derivation,
358 the B<kdf_oid>, B<kdf_md> and B<kdf_outlen> parameters must also be specified.
359
360 The EVP_PKEY_CTX_get_dh_kdf_type() macro gets the key derivation function type
361 for B<ctx> used for DH key derivation. Possible values are B<EVP_PKEY_DH_KDF_NONE>
362 and B<EVP_PKEY_DH_KDF_X9_42>.
363
364 The EVP_PKEY_CTX_set0_dh_kdf_oid() macro sets the key derivation function
365 object identifier to B<oid> for DH key derivation. This OID should identify
366 the algorithm to be used with the Content Encryption Key.
367 The library takes ownership of the object identifier so the caller should not
368 free the original memory pointed to by B<oid>.
369
370 The EVP_PKEY_CTX_get0_dh_kdf_oid() macro gets the key derivation function oid
371 for B<ctx> used for DH key derivation. The resulting pointer is owned by the
372 library and should not be freed by the caller.
373
374 The EVP_PKEY_CTX_set_dh_kdf_md() macro sets the key derivation function
375 message digest to B<md> for DH key derivation. Note that RFC2631 specifies
376 that this digest should be SHA1 but OpenSSL tolerates other digests.
377
378 The EVP_PKEY_CTX_get_dh_kdf_md() macro gets the key derivation function
379 message digest for B<ctx> used for DH key derivation.
380
381 The EVP_PKEY_CTX_set_dh_kdf_outlen() macro sets the key derivation function
382 output length to B<len> for DH key derivation.
383
384 The EVP_PKEY_CTX_get_dh_kdf_outlen() macro gets the key derivation function
385 output length for B<ctx> used for DH key derivation.
386
387 The EVP_PKEY_CTX_set0_dh_kdf_ukm() macro sets the user key material to
388 B<ukm> and its length to B<len> for DH key derivation. This parameter is optional
389 and corresponds to the partyAInfo field in RFC2631 terms. The specification
390 requires that it is 512 bits long but this is not enforced by OpenSSL.
391 The library takes ownership of the user key material so the caller should not
392 free the original memory pointed to by B<ukm>.
393
394 The EVP_PKEY_CTX_get0_dh_kdf_ukm() macro gets the user key material for B<ctx>.
395 The return value is the user key material length. The resulting pointer is owned
396 by the library and should not be freed by the caller.
397
398 =head2 EC parameters
399
400 The EVP_PKEY_CTX_set_ec_paramgen_curve_nid() sets the EC curve for EC parameter
401 generation to B<nid>. For EC parameter generation this macro must be called
402 or an error occurs because there is no default curve.
403 This function can also be called to set the curve explicitly when
404 generating an EC key.
405
406 The EVP_PKEY_CTX_set_ec_param_enc() macro sets the EC parameter encoding to
407 B<param_enc> when generating EC parameters or an EC key. The encoding can be
408 B<OPENSSL_EC_EXPLICIT_CURVE> for explicit parameters (the default in versions
409 of OpenSSL before 1.1.0) or B<OPENSSL_EC_NAMED_CURVE> to use named curve form.
410 For maximum compatibility the named curve form should be used. Note: the
411 B<OPENSSL_EC_NAMED_CURVE> value was added in OpenSSL 1.1.0; previous
412 versions should use 0 instead.
413
414 =head2 ECDH parameters
415
416 The EVP_PKEY_CTX_set_ecdh_cofactor_mode() macro sets the cofactor mode to
417 B<cofactor_mode> for ECDH key derivation. Possible values are 1 to enable
418 cofactor key derivation, 0 to disable it and -1 to clear the stored cofactor
419 mode and fallback to the private key cofactor mode.
420
421 The EVP_PKEY_CTX_get_ecdh_cofactor_mode() macro returns the cofactor mode for
422 B<ctx> used for ECDH key derivation. Possible values are 1 when cofactor key
423 derivation is enabled and 0 otherwise.
424
425 =head2 ECDH key derivation function parameters
426
427 The EVP_PKEY_CTX_set_ecdh_kdf_type() macro sets the key derivation function type
428 to B<kdf> for ECDH key derivation. Possible values are B<EVP_PKEY_ECDH_KDF_NONE>
429 and B<EVP_PKEY_ECDH_KDF_X9_63> which uses the key derivation specified in X9.63.
430 When using key derivation, the B<kdf_md> and B<kdf_outlen> parameters must
431 also be specified.
432
433 The EVP_PKEY_CTX_get_ecdh_kdf_type() macro returns the key derivation function
434 type for B<ctx> used for ECDH key derivation. Possible values are
435 B<EVP_PKEY_ECDH_KDF_NONE> and B<EVP_PKEY_ECDH_KDF_X9_63>.
436
437 The EVP_PKEY_CTX_set_ecdh_kdf_md() macro sets the key derivation function
438 message digest to B<md> for ECDH key derivation. Note that X9.63 specifies
439 that this digest should be SHA1 but OpenSSL tolerates other digests.
440
441 The EVP_PKEY_CTX_get_ecdh_kdf_md() macro gets the key derivation function
442 message digest for B<ctx> used for ECDH key derivation.
443
444 The EVP_PKEY_CTX_set_ecdh_kdf_outlen() macro sets the key derivation function
445 output length to B<len> for ECDH key derivation.
446
447 The EVP_PKEY_CTX_get_ecdh_kdf_outlen() macro gets the key derivation function
448 output length for B<ctx> used for ECDH key derivation.
449
450 The EVP_PKEY_CTX_set0_ecdh_kdf_ukm() macro sets the user key material to B<ukm>
451 for ECDH key derivation. This parameter is optional and corresponds to the
452 shared info in X9.63 terms. The library takes ownership of the user key material
453 so the caller should not free the original memory pointed to by B<ukm>.
454
455 The EVP_PKEY_CTX_get0_ecdh_kdf_ukm() macro gets the user key material for B<ctx>.
456 The return value is the user key material length. The resulting pointer is owned
457 by the library and should not be freed by the caller.
458
459 =head2 Other parameters
460
461 The EVP_PKEY_CTX_set1_id(), EVP_PKEY_CTX_get1_id() and EVP_PKEY_CTX_get1_id_len()
462 macros are used to manipulate the special identifier field for specific signature
463 algorithms such as SM2. The EVP_PKEY_CTX_set1_id() sets an ID pointed by B<id> with
464 the length B<id_len> to the library. The library takes a copy of the id so that
465 the caller can safely free the original memory pointed to by B<id>. The
466 EVP_PKEY_CTX_get1_id_len() macro returns the length of the ID set via a previous
467 call to EVP_PKEY_CTX_set1_id(). The length is usually used to allocate adequate
468 memory for further calls to EVP_PKEY_CTX_get1_id(). The EVP_PKEY_CTX_get1_id()
469 macro returns the previously set ID value to caller in B<id>. The caller should
470 allocate adequate memory space for the B<id> before calling EVP_PKEY_CTX_get1_id().
471
472 =head1 RETURN VALUES
473
474 EVP_PKEY_CTX_ctrl() and its macros return a positive value for success and 0
475 or a negative value for failure. In particular a return value of -2
476 indicates the operation is not supported by the public key algorithm.
477
478 =head1 SEE ALSO
479
480 L<EVP_PKEY_CTX_new(3)>,
481 L<EVP_PKEY_encrypt(3)>,
482 L<EVP_PKEY_decrypt(3)>,
483 L<EVP_PKEY_sign(3)>,
484 L<EVP_PKEY_verify(3)>,
485 L<EVP_PKEY_verify_recover(3)>,
486 L<EVP_PKEY_derive(3)>,
487 L<EVP_PKEY_keygen(3)>
488
489 =head1 HISTORY
490
491 The
492 EVP_PKEY_CTX_set1_id(), EVP_PKEY_CTX_get1_id() and EVP_PKEY_CTX_get1_id_len()
493 macros were added in 1.1.1, other functions were added in OpenSSL 1.0.0.
494
495 EVP_PKEY_CTX_set_dh_pad() was a macro in OpenSSL 1.1.1 and below.
496 From OpenSSL 3.0 it is a function.
497
498 =head1 COPYRIGHT
499
500 Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved.
501
502 Licensed under the Apache License 2.0 (the "License").  You may not use
503 this file except in compliance with the License.  You can obtain a copy
504 in the file LICENSE in the source distribution or at
505 L<https://www.openssl.org/source/license.html>.
506
507 =cut