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 (int 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 =back
 165
 166 The function EVP_PKEY_CTX_ctrl() sends a control operation to the context
 167 B<ctx>. The key type used must match B<keytype> if it is not -1. The parameter
 168 B<optype> is a mask indicating which operations the control can be applied to.
 169 The control command is indicated in B<cmd> and any additional arguments in
 170 B<p1> and B<p2>.
 171
 172 For B<cmd> = B<EVP_PKEY_CTRL_SET_MAC_KEY>, B<p1> is the length of the MAC key,
 173 and B<p2> is MAC key. This is used by Poly1305, SipHash, HMAC and CMAC.
 174
 175 Applications will not normally call EVP_PKEY_CTX_ctrl() directly but will
 176 instead call one of the algorithm specific macros below.
 177
 178 The function EVP_PKEY_CTX_ctrl_uint64() is a wrapper that directly passes a
 179 uint64 value as B<p2> to EVP_PKEY_CTX_ctrl().
 180
 181 The function EVP_PKEY_CTX_ctrl_str() allows an application to send an algorithm
 182 specific control operation to a context B<ctx> in string form. This is
 183 intended to be used for options specified on the command line or in text
 184 files. The commands supported are documented in the openssl utility
 185 command line pages for the option B<-pkeyopt> which is supported by the
 186 B<pkeyutl>, B<genpkey> and B<req> commands.
 187
 188 The function EVP_PKEY_CTX_md() sends a message digest control operation
 189 to the context B<ctx>. The message digest is specified by its name B<md>.
 190
 191 All the remaining "functions" are implemented as macros.
 192
 193 The EVP_PKEY_CTX_set_signature_md() macro sets the message digest type used
 194 in a signature. It can be used in the RSA, DSA and ECDSA algorithms.
 195
 196 The EVP_PKEY_CTX_get_signature_md() macro gets the message digest type used in a
 197 signature. It can be used in the RSA, DSA and ECDSA algorithms.
 198
 199 Key generation typically involves setting up parameters to be used and
 200 generating the private and public key data. Some algorithm implementations
 201 allow private key data to be set explicitly using the EVP_PKEY_CTX_set_mac_key()
 202 macro. In this case key generation is simply the process of setting up the
 203 parameters for the key and then setting the raw key data to the value explicitly
 204 provided by that macro. Normally applications would call
 205 L<EVP_PKEY_new_raw_private_key(3)> or similar functions instead of this macro.
 206
 207 The EVP_PKEY_CTX_set_mac_key() macro can be used with any of the algorithms
 208 supported by the L<EVP_PKEY_new_raw_private_key(3)> function.
 209
 210 =head2 RSA parameters
 211
 212 The EVP_PKEY_CTX_set_rsa_padding() macro sets the RSA padding mode for B<ctx>.
 213 The B<pad> parameter can take the value B<RSA_PKCS1_PADDING> for PKCS#1
 214 padding, B<RSA_SSLV23_PADDING> for SSLv23 padding, B<RSA_NO_PADDING> for
 215 no padding, B<RSA_PKCS1_OAEP_PADDING> for OAEP padding (encrypt and
 216 decrypt only), B<RSA_X931_PADDING> for X9.31 padding (signature operations
 217 only) and B<RSA_PKCS1_PSS_PADDING> (sign and verify only).
 218
 219 Two RSA padding modes behave differently if EVP_PKEY_CTX_set_signature_md()
 220 is used. If this macro is called for PKCS#1 padding the plaintext buffer is
 221 an actual digest value and is encapsulated in a DigestInfo structure according
 222 to PKCS#1 when signing and this structure is expected (and stripped off) when
 223 verifying. If this control is not used with RSA and PKCS#1 padding then the
 224 supplied data is used directly and not encapsulated. In the case of X9.31
 225 padding for RSA the algorithm identifier byte is added or checked and removed
 226 if this control is called. If it is not called then the first byte of the plaintext
 227 buffer is expected to be the algorithm identifier byte.
 228
 229 The EVP_PKEY_CTX_get_rsa_padding() macro gets the RSA padding mode for B<ctx>.
 230
 231 The EVP_PKEY_CTX_set_rsa_pss_saltlen() macro sets the RSA PSS salt length to
 232 B<len>. As its name implies it is only supported for PSS padding. Three special
 233 values are supported: B<RSA_PSS_SALTLEN_DIGEST> sets the salt length to the
 234 digest length, B<RSA_PSS_SALTLEN_MAX> sets the salt length to the maximum
 235 permissible value. When verifying B<RSA_PSS_SALTLEN_AUTO> causes the salt length
 236 to be automatically determined based on the B<PSS> block structure. If this
 237 macro is not called maximum salt length is used when signing and auto detection
 238 when verifying is used by default.
 239
 240 The EVP_PKEY_CTX_get_rsa_pss_saltlen() macro gets the RSA PSS salt length
 241 for B<ctx>. The padding mode must have been set to B<RSA_PKCS1_PSS_PADDING>.
 242
 243 The EVP_PKEY_CTX_set_rsa_keygen_bits() macro sets the RSA key length for
 244 RSA key generation to B<bits>. If not specified 1024 bits is used.
 245
 246 The EVP_PKEY_CTX_set_rsa_keygen_pubexp() macro sets the public exponent value
 247 for RSA key generation to B<pubexp>. Currently it should be an odd integer. The
 248 B<pubexp> pointer is used internally by this function so it should not be
 249 modified or freed after the call. If not specified 65537 is used.
 250
 251 The EVP_PKEY_CTX_set_rsa_keygen_primes() macro sets the number of primes for
 252 RSA key generation to B<primes>. If not specified 2 is used.
 253
 254 The EVP_PKEY_CTX_set_rsa_mgf1_md() macro sets the MGF1 digest for RSA padding
 255 schemes to B<md>. If not explicitly set the signing digest is used. The
 256 padding mode must have been set to B<RSA_PKCS1_OAEP_PADDING>
 257 or B<RSA_PKCS1_PSS_PADDING>.
 258
 259 The EVP_PKEY_CTX_get_rsa_mgf1_md() macro gets the MGF1 digest for B<ctx>.
 260 If not explicitly set the signing digest is used. The padding mode must have
 261 been set to B<RSA_PKCS1_OAEP_PADDING> or B<RSA_PKCS1_PSS_PADDING>.
 262
 263 The EVP_PKEY_CTX_set_rsa_oaep_md() macro sets the message digest type used
 264 in RSA OAEP to B<md>. The padding mode must have been set to
 265 B<RSA_PKCS1_OAEP_PADDING>.
 266
 267 The EVP_PKEY_CTX_get_rsa_oaep_md() macro gets the message digest type used
 268 in RSA OAEP to B<md>. The padding mode must have been set to
 269 B<RSA_PKCS1_OAEP_PADDING>.
 270
 271 The EVP_PKEY_CTX_set0_rsa_oaep_label() macro sets the RSA OAEP label to
 272 B<label> and its length to B<len>. If B<label> is NULL or B<len> is 0,
 273 the label is cleared. The library takes ownership of the label so the
 274 caller should not free the original memory pointed to by B<label>.
 275 The padding mode must have been set to B<RSA_PKCS1_OAEP_PADDING>.
 276
 277 The EVP_PKEY_CTX_get0_rsa_oaep_label() macro gets the RSA OAEP label to
 278 B<label>. The return value is the label length. The padding mode
 279 must have been set to B<RSA_PKCS1_OAEP_PADDING>. The resulting pointer is owned
 280 by the library and should not be freed by the caller.
 281
 282 =head2 DSA parameters
 283
 284 The EVP_PKEY_CTX_set_dsa_paramgen_bits() macro sets the number of bits used
 285 for DSA parameter generation to B<nbits>. If not specified, 1024 is used.
 286
 287 The EVP_PKEY_CTX_set_dsa_paramgen_q_bits() macro sets the number of bits in the
 288 subprime parameter B<q> for DSA parameter generation to B<qbits>. If not
 289 specified, 160 is used. If a digest function is specified below, this parameter
 290 is ignored and instead, the number of bits in B<q> matches the size of the
 291 digest.
 292
 293 The EVP_PKEY_CTX_set_dsa_paramgen_md() macro sets the digest function used for
 294 DSA parameter generation to B<md>. If not specified, one of SHA-1, SHA-224, or
 295 SHA-256 is selected to match the bit length of B<q> above.
 296
 297 =head2 DH parameters
 298
 299 The EVP_PKEY_CTX_set_dh_paramgen_prime_len() macro sets the length of the DH
 300 prime parameter B<p> for DH parameter generation. If this macro is not called
 301 then 1024 is used. Only accepts lengths greater than or equal to 256.
 302
 303 The EVP_PKEY_CTX_set_dh_paramgen_subprime_len() macro sets the length of the DH
 304 optional subprime parameter B<q> for DH parameter generation. The default is
 305 256 if the prime is at least 2048 bits long or 160 otherwise. The DH
 306 paramgen type must have been set to x9.42.
 307
 308 The EVP_PKEY_CTX_set_dh_paramgen_generator() macro sets DH generator to B<gen>
 309 for DH parameter generation. If not specified 2 is used.
 310
 311 The EVP_PKEY_CTX_set_dh_paramgen_type() macro sets the key type for DH
 312 parameter generation. Use 0 for PKCS#3 DH and 1 for X9.42 DH.
 313 The default is 0.
 314
 315 The EVP_PKEY_CTX_set_dh_pad() function sets the DH padding mode.
 316 If B<pad> is 1 the shared secret is padded with zeroes up to the size of the DH
 317 prime B<p>.
 318 If B<pad> is zero (the default) then no padding is performed.
 319
 320 EVP_PKEY_CTX_set_dh_nid() sets the DH parameters to values corresponding to
 321 B<nid> as defined in RFC7919. The B<nid> parameter must be B<NID_ffdhe2048>,
 322 B<NID_ffdhe3072>, B<NID_ffdhe4096>, B<NID_ffdhe6144>, B<NID_ffdhe8192>
 323 or B<NID_undef> to clear the stored value. This macro can be called during
 324 parameter or key generation.
 325 The nid parameter and the rfc5114 parameter are mutually exclusive.
 326
 327 The EVP_PKEY_CTX_set_dh_rfc5114() and EVP_PKEY_CTX_set_dhx_rfc5114() macros are
 328 synonymous. They set the DH parameters to the values defined in RFC5114. The
 329 B<rfc5114> parameter must be 1, 2 or 3 corresponding to RFC5114 sections
 330 2.1, 2.2 and 2.3. or 0 to clear the stored value. This macro can be called
 331 during parameter generation. The B<ctx> must have a key type of
 332 B<EVP_PKEY_DHX>.
 333 The rfc5114 parameter and the nid parameter are mutually exclusive.
 334
 335 =head2 DH key derivation function parameters
 336
 337 Note that all of the following functions require that the B<ctx> parameter has
 338 a private key type of B<EVP_PKEY_DHX>. When using key derivation, the output of
 339 EVP_PKEY_derive() is the output of the KDF instead of the DH shared secret.
 340 The KDF output is typically used as a Key Encryption Key (KEK) that in turn
 341 encrypts a Content Encryption Key (CEK).
 342
 343 The EVP_PKEY_CTX_set_dh_kdf_type() macro sets the key derivation function type
 344 to B<kdf> for DH key derivation. Possible values are B<EVP_PKEY_DH_KDF_NONE>
 345 and B<EVP_PKEY_DH_KDF_X9_42> which uses the key derivation specified in RFC2631
 346 (based on the keying algorithm described in X9.42). When using key derivation,
 347 the B<kdf_oid>, B<kdf_md> and B<kdf_outlen> parameters must also be specified.
 348
 349 The EVP_PKEY_CTX_get_dh_kdf_type() macro gets the key derivation function type
 350 for B<ctx> used for DH key derivation. Possible values are B<EVP_PKEY_DH_KDF_NONE>
 351 and B<EVP_PKEY_DH_KDF_X9_42>.
 352
 353 The EVP_PKEY_CTX_set0_dh_kdf_oid() macro sets the key derivation function
 354 object identifier to B<oid> for DH key derivation. This OID should identify
 355 the algorithm to be used with the Content Encryption Key.
 356 The library takes ownership of the object identifier so the caller should not
 357 free the original memory pointed to by B<oid>.
 358
 359 The EVP_PKEY_CTX_get0_dh_kdf_oid() macro gets the key derivation function oid
 360 for B<ctx> used for DH key derivation. The resulting pointer is owned by the
 361 library and should not be freed by the caller.
 362
 363 The EVP_PKEY_CTX_set_dh_kdf_md() macro sets the key derivation function
 364 message digest to B<md> for DH key derivation. Note that RFC2631 specifies
 365 that this digest should be SHA1 but OpenSSL tolerates other digests.
 366
 367 The EVP_PKEY_CTX_get_dh_kdf_md() macro gets the key derivation function
 368 message digest for B<ctx> used for DH key derivation.
 369
 370 The EVP_PKEY_CTX_set_dh_kdf_outlen() macro sets the key derivation function
 371 output length to B<len> for DH key derivation.
 372
 373 The EVP_PKEY_CTX_get_dh_kdf_outlen() macro gets the key derivation function
 374 output length for B<ctx> used for DH key derivation.
 375
 376 The EVP_PKEY_CTX_set0_dh_kdf_ukm() macro sets the user key material to
 377 B<ukm> and its length to B<len> for DH key derivation. This parameter is optional
 378 and corresponds to the partyAInfo field in RFC2631 terms. The specification
 379 requires that it is 512 bits long but this is not enforced by OpenSSL.
 380 The library takes ownership of the user key material so the caller should not
 381 free the original memory pointed to by B<ukm>.
 382
 383 The EVP_PKEY_CTX_get0_dh_kdf_ukm() macro gets the user key material for B<ctx>.
 384 The return value is the user key material length. The resulting pointer is owned
 385 by the library and should not be freed by the caller.
 386
 387 =head2 EC parameters
 388
 389 The EVP_PKEY_CTX_set_ec_paramgen_curve_nid() sets the EC curve for EC parameter
 390 generation to B<nid>. For EC parameter generation this macro must be called
 391 or an error occurs because there is no default curve.
 392 This function can also be called to set the curve explicitly when
 393 generating an EC key.
 394
 395 The EVP_PKEY_CTX_set_ec_param_enc() macro sets the EC parameter encoding to
 396 B<param_enc> when generating EC parameters or an EC key. The encoding can be
 397 B<OPENSSL_EC_EXPLICIT_CURVE> for explicit parameters (the default in versions
 398 of OpenSSL before 1.1.0) or B<OPENSSL_EC_NAMED_CURVE> to use named curve form.
 399 For maximum compatibility the named curve form should be used. Note: the
 400 B<OPENSSL_EC_NAMED_CURVE> value was added in OpenSSL 1.1.0; previous
 401 versions should use 0 instead.
 402
 403 =head2 ECDH parameters
 404
 405 The EVP_PKEY_CTX_set_ecdh_cofactor_mode() macro sets the cofactor mode to
 406 B<cofactor_mode> for ECDH key derivation. Possible values are 1 to enable
 407 cofactor key derivation, 0 to disable it and -1 to clear the stored cofactor
 408 mode and fallback to the private key cofactor mode.
 409
 410 The EVP_PKEY_CTX_get_ecdh_cofactor_mode() macro returns the cofactor mode for
 411 B<ctx> used for ECDH key derivation. Possible values are 1 when cofactor key
 412 derivation is enabled and 0 otherwise.
 413
 414 =head2 ECDH key derivation function parameters
 415
 416 The EVP_PKEY_CTX_set_ecdh_kdf_type() macro sets the key derivation function type
 417 to B<kdf> for ECDH key derivation. Possible values are B<EVP_PKEY_ECDH_KDF_NONE>
 418 and B<EVP_PKEY_ECDH_KDF_X9_63> which uses the key derivation specified in X9.63.
 419 When using key derivation, the B<kdf_md> and B<kdf_outlen> parameters must
 420 also be specified.
 421
 422 The EVP_PKEY_CTX_get_ecdh_kdf_type() macro returns the key derivation function
 423 type for B<ctx> used for ECDH key derivation. Possible values are
 424 B<EVP_PKEY_ECDH_KDF_NONE> and B<EVP_PKEY_ECDH_KDF_X9_63>.
 425
 426 The EVP_PKEY_CTX_set_ecdh_kdf_md() macro sets the key derivation function
 427 message digest to B<md> for ECDH key derivation. Note that X9.63 specifies
 428 that this digest should be SHA1 but OpenSSL tolerates other digests.
 429
 430 The EVP_PKEY_CTX_get_ecdh_kdf_md() macro gets the key derivation function
 431 message digest for B<ctx> used for ECDH key derivation.
 432
 433 The EVP_PKEY_CTX_set_ecdh_kdf_outlen() macro sets the key derivation function
 434 output length to B<len> for ECDH key derivation.
 435
 436 The EVP_PKEY_CTX_get_ecdh_kdf_outlen() macro gets the key derivation function
 437 output length for B<ctx> used for ECDH key derivation.
 438
 439 The EVP_PKEY_CTX_set0_ecdh_kdf_ukm() macro sets the user key material to B<ukm>
 440 for ECDH key derivation. This parameter is optional and corresponds to the
 441 shared info in X9.63 terms. The library takes ownership of the user key material
 442 so the caller should not free the original memory pointed to by B<ukm>.
 443
 444 The EVP_PKEY_CTX_get0_ecdh_kdf_ukm() macro gets the user key material for B<ctx>.
 445 The return value is the user key material length. The resulting pointer is owned
 446 by the library and should not be freed by the caller.
 447
 448 =head2 Other parameters
 449
 450 The EVP_PKEY_CTX_set1_id(), EVP_PKEY_CTX_get1_id() and EVP_PKEY_CTX_get1_id_len()
 451 macros are used to manipulate the special identifier field for specific signature
 452 algorithms such as SM2. The EVP_PKEY_CTX_set1_id() sets an ID pointed by B<id> with
 453 the length B<id_len> to the library. The library takes a copy of the id so that
 454 the caller can safely free the original memory pointed to by B<id>. The
 455 EVP_PKEY_CTX_get1_id_len() macro returns the length of the ID set via a previous
 456 call to EVP_PKEY_CTX_set1_id(). The length is usually used to allocate adequate
 457 memory for further calls to EVP_PKEY_CTX_get1_id(). The EVP_PKEY_CTX_get1_id()
 458 macro returns the previously set ID value to caller in B<id>. The caller should
 459 allocate adequate memory space for the B<id> before calling EVP_PKEY_CTX_get1_id().
 460
 461 =head1 RETURN VALUES
 462
 463 EVP_PKEY_CTX_ctrl() and its macros return a positive value for success and 0
 464 or a negative value for failure. In particular a return value of -2
 465 indicates the operation is not supported by the public key algorithm.
 466
 467 =head1 SEE ALSO
 468
 469 L<EVP_PKEY_CTX_new(3)>,
 470 L<EVP_PKEY_encrypt(3)>,
 471 L<EVP_PKEY_decrypt(3)>,
 472 L<EVP_PKEY_sign(3)>,
 473 L<EVP_PKEY_verify(3)>,
 474 L<EVP_PKEY_verify_recover(3)>,
 475 L<EVP_PKEY_derive(3)>,
 476 L<EVP_PKEY_keygen(3)>
 477
 478 =head1 HISTORY
 479
 480 The
 481 EVP_PKEY_CTX_set1_id(), EVP_PKEY_CTX_get1_id() and EVP_PKEY_CTX_get1_id_len()
 482 macros were added in 1.1.1, other functions were added in OpenSSL 1.0.0.
 483
 484 EVP_PKEY_CTX_set_dh_pad() was a macro in OpenSSL 1.1.1 and below.
 485 From OpenSSL 3.0 it is a function.
 486
 487 =head1 COPYRIGHT
 488
 489 Copyright 2006-2018 The OpenSSL Project Authors. All Rights Reserved.
 490
 491 Licensed under the Apache License 2.0 (the "License").  You may not use
 492 this file except in compliance with the License.  You can obtain a copy
 493 in the file LICENSE in the source distribution or at
 494 L<https://www.openssl.org/source/license.html>.
 495
 496 =cut