doc/man3/EVP_PKEY_CTX_ctrl.pod

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