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_name,
  24 EVP_PKEY_CTX_set_rsa_mgf1_md,
  25 EVP_PKEY_CTX_get_rsa_mgf1_md,
  26 EVP_PKEY_CTX_get_rsa_mgf1_md_name,
  27 EVP_PKEY_CTX_set_rsa_oaep_md_name,
  28 EVP_PKEY_CTX_set_rsa_oaep_md,
  29 EVP_PKEY_CTX_get_rsa_oaep_md,
  30 EVP_PKEY_CTX_get_rsa_oaep_md_name,
  31 EVP_PKEY_CTX_set0_rsa_oaep_label,
  32 EVP_PKEY_CTX_get0_rsa_oaep_label,
  33 EVP_PKEY_CTX_set_dsa_paramgen_bits,
  34 EVP_PKEY_CTX_set_dsa_paramgen_q_bits,
  35 EVP_PKEY_CTX_set_dsa_paramgen_md,
  36 EVP_PKEY_CTX_set_dsa_paramgen_md_props,
  37 EVP_PKEY_CTX_set_dsa_paramgen_gindex,
  38 EVP_PKEY_CTX_set_dsa_paramgen_type,
  39 EVP_PKEY_CTX_set_dsa_paramgen_seed,
  40 EVP_PKEY_CTX_set_dh_paramgen_prime_len,
  41 EVP_PKEY_CTX_set_dh_paramgen_subprime_len,
  42 EVP_PKEY_CTX_set_dh_paramgen_generator,
  43 EVP_PKEY_CTX_set_dh_paramgen_type,
  44 EVP_PKEY_CTX_set_dh_paramgen_gindex,
  45 EVP_PKEY_CTX_set_dh_paramgen_seed,
  46 EVP_PKEY_CTX_set_dh_rfc5114,
  47 EVP_PKEY_CTX_set_dhx_rfc5114,
  48 EVP_PKEY_CTX_set_dh_pad,
  49 EVP_PKEY_CTX_set_dh_nid,
  50 EVP_PKEY_CTX_set_dh_kdf_type,
  51 EVP_PKEY_CTX_get_dh_kdf_type,
  52 EVP_PKEY_CTX_set0_dh_kdf_oid,
  53 EVP_PKEY_CTX_get0_dh_kdf_oid,
  54 EVP_PKEY_CTX_set_dh_kdf_md,
  55 EVP_PKEY_CTX_get_dh_kdf_md,
  56 EVP_PKEY_CTX_set_dh_kdf_outlen,
  57 EVP_PKEY_CTX_get_dh_kdf_outlen,
  58 EVP_PKEY_CTX_set0_dh_kdf_ukm,
  59 EVP_PKEY_CTX_get0_dh_kdf_ukm,
  60 EVP_PKEY_CTX_set_ec_paramgen_curve_name,
  61 EVP_PKEY_CTX_get_ec_paramgen_curve_name,
  62 EVP_PKEY_CTX_set_ec_paramgen_curve_nid,
  63 EVP_PKEY_CTX_set_ec_param_enc,
  64 EVP_PKEY_CTX_set_ecdh_cofactor_mode,
  65 EVP_PKEY_CTX_get_ecdh_cofactor_mode,
  66 EVP_PKEY_CTX_set_ecdh_kdf_type,
  67 EVP_PKEY_CTX_get_ecdh_kdf_type,
  68 EVP_PKEY_CTX_set_ecdh_kdf_md,
  69 EVP_PKEY_CTX_get_ecdh_kdf_md,
  70 EVP_PKEY_CTX_set_ecdh_kdf_outlen,
  71 EVP_PKEY_CTX_get_ecdh_kdf_outlen,
  72 EVP_PKEY_CTX_set0_ecdh_kdf_ukm,
  73 EVP_PKEY_CTX_get0_ecdh_kdf_ukm,
  74 EVP_PKEY_CTX_set1_id, EVP_PKEY_CTX_get1_id, EVP_PKEY_CTX_get1_id_len
  75 - algorithm specific control operations
  76
  77 =head1 SYNOPSIS
  78
  79  #include <openssl/evp.h>
  80
  81  int EVP_PKEY_CTX_get_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params);
  82  const OSSL_PARAM *EVP_PKEY_CTX_gettable_params(EVP_PKEY_CTX *ctx);
  83  int EVP_PKEY_CTX_set_params(EVP_PKEY_CTX *ctx, OSSL_PARAM *params);
  84  const OSSL_PARAM *EVP_PKEY_CTX_settable_params(EVP_PKEY_CTX *ctx);
  85
  86  int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype,
  87                        int cmd, int p1, void *p2);
  88  int EVP_PKEY_CTX_ctrl_uint64(EVP_PKEY_CTX *ctx, int keytype, int optype,
  89                               int cmd, uint64_t value);
  90  int EVP_PKEY_CTX_ctrl_str(EVP_PKEY_CTX *ctx, const char *type,
  91                            const char *value);
  92
  93  int EVP_PKEY_CTX_md(EVP_PKEY_CTX *ctx, int optype, int cmd, const char *md);
  94
  95  int EVP_PKEY_CTX_set_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
  96  int EVP_PKEY_CTX_get_signature_md(EVP_PKEY_CTX *ctx, const EVP_MD **pmd);
  97
  98  int EVP_PKEY_CTX_set_mac_key(EVP_PKEY_CTX *ctx, const unsigned char *key,
  99                               int len);
 100
 101  #include <openssl/rsa.h>
 102
 103  int EVP_PKEY_CTX_set_rsa_padding(EVP_PKEY_CTX *ctx, int pad);
 104  int EVP_PKEY_CTX_get_rsa_padding(EVP_PKEY_CTX *ctx, int *pad);
 105  int EVP_PKEY_CTX_set_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, int saltlen);
 106  int EVP_PKEY_CTX_get_rsa_pss_saltlen(EVP_PKEY_CTX *ctx, int *saltlen);
 107  int EVP_PKEY_CTX_set_rsa_keygen_bits(EVP_PKEY_CTX *ctx, int mbits);
 108  int EVP_PKEY_CTX_set_rsa_keygen_pubexp(EVP_PKEY_CTX *ctx, BIGNUM *pubexp);
 109  int EVP_PKEY_CTX_set_rsa_keygen_primes(EVP_PKEY_CTX *ctx, int primes);
 110  int EVP_PKEY_CTX_set_rsa_mgf1_md_name(EVP_PKEY_CTX *ctx, const char *mdname,
 111                                      const char *mdprops);
 112  int EVP_PKEY_CTX_set_rsa_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
 113  int EVP_PKEY_CTX_get_rsa_mgf1_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
 114  int EVP_PKEY_CTX_get_rsa_mgf1_md_name(EVP_PKEY_CTX *ctx, char *name,
 115                                        size_t namelen);
 116  int EVP_PKEY_CTX_set_rsa_oaep_md_name(EVP_PKEY_CTX *ctx, const char *mdname,
 117                                        const char *mdprops);
 118  int EVP_PKEY_CTX_set_rsa_oaep_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
 119  int EVP_PKEY_CTX_get_rsa_oaep_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
 120  int EVP_PKEY_CTX_get_rsa_oaep_md_name(EVP_PKEY_CTX *ctx, char *name,
 121                                        size_t namelen)
 122  int EVP_PKEY_CTX_set0_rsa_oaep_label(EVP_PKEY_CTX *ctx, unsigned char *label, int len);
 123  int EVP_PKEY_CTX_get0_rsa_oaep_label(EVP_PKEY_CTX *ctx, unsigned char **label);
 124
 125  #include <openssl/dsa.h>
 126
 127  int EVP_PKEY_CTX_set_dsa_paramgen_bits(EVP_PKEY_CTX *ctx, int nbits);
 128  int EVP_PKEY_CTX_set_dsa_paramgen_q_bits(EVP_PKEY_CTX *ctx, int qbits);
 129  int EVP_PKEY_CTX_set_dsa_paramgen_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
 130  int EVP_PKEY_CTX_set_dsa_paramgen_md_props(EVP_PKEY_CTX *ctx,
 131                                             const char *md_name,
 132                                             const char *md_properties);
 133  int EVP_PKEY_CTX_set_dsa_paramgen_type(EVP_PKEY_CTX *ctx, const char *name);
 134  int EVP_PKEY_CTX_set_dsa_paramgen_gindex(EVP_PKEY_CTX *ctx, int gindex);
 135  int EVP_PKEY_CTX_set_dsa_paramgen_seed(EVP_PKEY_CTX *ctx,
 136                                         const unsigned char *seed,
 137                                         size_t seedlen);
 138
 139  #include <openssl/dh.h>
 140
 141  int EVP_PKEY_CTX_set_dh_paramgen_prime_len(EVP_PKEY_CTX *ctx, int len);
 142  int EVP_PKEY_CTX_set_dh_paramgen_subprime_len(EVP_PKEY_CTX *ctx, int len);
 143  int EVP_PKEY_CTX_set_dh_paramgen_generator(EVP_PKEY_CTX *ctx, int gen);
 144  int EVP_PKEY_CTX_set_dh_paramgen_type(EVP_PKEY_CTX *ctx, int type);
 145  int EVP_PKEY_CTX_set_dh_pad(EVP_PKEY_CTX *ctx, int pad);
 146  int EVP_PKEY_CTX_set_dh_nid(EVP_PKEY_CTX *ctx, int nid);
 147  int EVP_PKEY_CTX_set_dh_rfc5114(EVP_PKEY_CTX *ctx, int rfc5114);
 148  int EVP_PKEY_CTX_set_dhx_rfc5114(EVP_PKEY_CTX *ctx, int rfc5114);
 149  int EVP_PKEY_CTX_set_dh_paramgen_gindex(EVP_PKEY_CTX *ctx, int gindex);
 150  int EVP_PKEY_CTX_set_dh_paramgen_seed(EVP_PKEY_CTX *ctx,
 151                                         const unsigned char *seed,
 152                                         size_t seedlen);
 153  int EVP_PKEY_CTX_set_dh_kdf_type(EVP_PKEY_CTX *ctx, int kdf);
 154  int EVP_PKEY_CTX_get_dh_kdf_type(EVP_PKEY_CTX *ctx);
 155  int EVP_PKEY_CTX_set0_dh_kdf_oid(EVP_PKEY_CTX *ctx, ASN1_OBJECT *oid);
 156  int EVP_PKEY_CTX_get0_dh_kdf_oid(EVP_PKEY_CTX *ctx, ASN1_OBJECT **oid);
 157  int EVP_PKEY_CTX_set_dh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
 158  int EVP_PKEY_CTX_get_dh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
 159  int EVP_PKEY_CTX_set_dh_kdf_outlen(EVP_PKEY_CTX *ctx, int len);
 160  int EVP_PKEY_CTX_get_dh_kdf_outlen(EVP_PKEY_CTX *ctx, int *len);
 161  int EVP_PKEY_CTX_set0_dh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char *ukm, int len);
 162  int EVP_PKEY_CTX_get0_dh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char **ukm);
 163
 164  #include <openssl/ec.h>
 165
 166  int EVP_PKEY_CTX_set_ec_paramgen_curve_name(EVP_PKEY_CTX *ctx,
 167                                              const char *name);
 168  int EVP_PKEY_CTX_get_ec_paramgen_curve_name(EVP_PKEY_CTX *ctx,
 169                                              char *name, size_t namelen);
 170  int EVP_PKEY_CTX_set_ec_paramgen_curve_nid(EVP_PKEY_CTX *ctx, int nid);
 171  int EVP_PKEY_CTX_set_ec_param_enc(EVP_PKEY_CTX *ctx, int param_enc);
 172  int EVP_PKEY_CTX_set_ecdh_cofactor_mode(EVP_PKEY_CTX *ctx, int cofactor_mode);
 173  int EVP_PKEY_CTX_get_ecdh_cofactor_mode(EVP_PKEY_CTX *ctx);
 174  int EVP_PKEY_CTX_set_ecdh_kdf_type(EVP_PKEY_CTX *ctx, int kdf);
 175  int EVP_PKEY_CTX_get_ecdh_kdf_type(EVP_PKEY_CTX *ctx);
 176  int EVP_PKEY_CTX_set_ecdh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD *md);
 177  int EVP_PKEY_CTX_get_ecdh_kdf_md(EVP_PKEY_CTX *ctx, const EVP_MD **md);
 178  int EVP_PKEY_CTX_set_ecdh_kdf_outlen(EVP_PKEY_CTX *ctx, int len);
 179  int EVP_PKEY_CTX_get_ecdh_kdf_outlen(EVP_PKEY_CTX *ctx, int *len);
 180  int EVP_PKEY_CTX_set0_ecdh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char *ukm, int len);
 181  int EVP_PKEY_CTX_get0_ecdh_kdf_ukm(EVP_PKEY_CTX *ctx, unsigned char **ukm);
 182
 183  int EVP_PKEY_CTX_set1_id(EVP_PKEY_CTX *ctx, void *id, size_t id_len);
 184  int EVP_PKEY_CTX_get1_id(EVP_PKEY_CTX *ctx, void *id);
 185  int EVP_PKEY_CTX_get1_id_len(EVP_PKEY_CTX *ctx, size_t *id_len);
 186
 187 =head1 DESCRIPTION
 188
 189 The EVP_PKEY_CTX_get_params() and EVP_PKEY_CTX_set_params() functions get and
 190 send arbitrary parameters from and to the algorithm implementation respectively.
 191 Not all parameters may be supported by all providers.
 192 See L<OSSL_PROVIDER(3)> for more information on providers.
 193 See L<OSSL_PARAM(3)> for more information on parameters.
 194 These functions must only be called after the EVP_PKEY_CTX has been initialised
 195 for use in an operation.
 196
 197 The parameters currently supported by the default provider are:
 198
 199 =over 4
 200
 201 =item "pad" (B<OSSL_EXCHANGE_PARAM_PAD>) <unsigned integer>
 202
 203 Sets the DH padding mode.
 204 If B<OSSL_EXCHANGE_PARAM_PAD> is 1 then the  shared secret is padded with zeros
 205 up to the size of the DH prime I<p>.
 206 If B<OSSL_EXCHANGE_PARAM_PAD> is zero (the default) then no padding is
 207 performed.
 208
 209 =item "digest" (B<OSSL_SIGNATURE_PARAM_DIGEST>) <UTF8 string>
 210
 211 Gets and sets the name of the digest algorithm used for the input to the
 212 signature functions.
 213
 214 =item "digest-size" (B<OSSL_SIGNATURE_PARAM_DIGEST_SIZE>) <unsigned integer>
 215
 216 Gets and sets the output size of the digest algorithm used for the input to the
 217 signature functions.
 218 The length of the "digest-size" parameter should not exceed that of a B<size_t>.
 219 The internal algorithm that supports this parameter is DSA.
 220
 221 =back
 222
 223 EVP_PKEY_CTX_gettable_params() and EVP_PKEY_CTX_settable_params() gets a
 224 constant B<OSSL_PARAM> array that describes the  gettable and
 225 settable parameters for the current algorithm implementation, i.e. parameters
 226 that can be used with EVP_PKEY_CTX_get_params() and EVP_PKEY_CTX_set_params()
 227 respectively.
 228 See L<OSSL_PARAM(3)> for the use of B<OSSL_PARAM> as parameter descriptor.
 229 These functions must only be called after the EVP_PKEY_CTX has been initialised
 230 for use in an operation.
 231
 232 The function EVP_PKEY_CTX_ctrl() sends a control operation to the context
 233 I<ctx>. The key type used must match I<keytype> if it is not -1. The parameter
 234 I<optype> is a mask indicating which operations the control can be applied to.
 235 The control command is indicated in I<cmd> and any additional arguments in
 236 I<p1> and I<p2>.
 237
 238 For I<cmd> = B<EVP_PKEY_CTRL_SET_MAC_KEY>, I<p1> is the length of the MAC key,
 239 and I<p2> is the MAC key. This is used by Poly1305, SipHash, HMAC and CMAC.
 240
 241 Applications will not normally call EVP_PKEY_CTX_ctrl() directly but will
 242 instead call one of the algorithm specific macros below.
 243
 244 The function EVP_PKEY_CTX_ctrl_uint64() is a wrapper that directly passes a
 245 uint64 value as I<p2> to EVP_PKEY_CTX_ctrl().
 246
 247 The function EVP_PKEY_CTX_ctrl_str() allows an application to send an algorithm
 248 specific control operation to a context I<ctx> in string form. This is
 249 intended to be used for options specified on the command line or in text
 250 files. The commands supported are documented in the openssl utility
 251 command line pages for the option I<-pkeyopt> which is supported by the
 252 I<pkeyutl>, I<genpkey> and I<req> commands.
 253
 254 The function EVP_PKEY_CTX_md() sends a message digest control operation
 255 to the context I<ctx>. The message digest is specified by its name I<md>.
 256
 257 The EVP_PKEY_CTX_set_signature_md() function sets the message digest type used
 258 in a signature. It can be used in the RSA, DSA and ECDSA algorithms.
 259
 260 The EVP_PKEY_CTX_get_signature_md() function gets the message digest type used
 261 in a signature. It can be used in the RSA, DSA and ECDSA algorithms.
 262
 263 All the remaining "functions" are implemented as macros.
 264
 265 Key generation typically involves setting up parameters to be used and
 266 generating the private and public key data. Some algorithm implementations
 267 allow private key data to be set explicitly using the EVP_PKEY_CTX_set_mac_key()
 268 macro. In this case key generation is simply the process of setting up the
 269 parameters for the key and then setting the raw key data to the value explicitly
 270 provided by that macro. Normally applications would call
 271 L<EVP_PKEY_new_raw_private_key(3)> or similar functions instead of this macro.
 272
 273 The EVP_PKEY_CTX_set_mac_key() macro can be used with any of the algorithms
 274 supported by the L<EVP_PKEY_new_raw_private_key(3)> function.
 275
 276 =head2 RSA parameters
 277
 278 The EVP_PKEY_CTX_set_rsa_padding() function sets the RSA padding mode for I<ctx>.
 279 The I<pad> parameter can take the value B<RSA_PKCS1_PADDING> for PKCS#1
 280 padding, B<RSA_SSLV23_PADDING> for SSLv23 padding, B<RSA_NO_PADDING> for
 281 no padding, B<RSA_PKCS1_OAEP_PADDING> for OAEP padding (encrypt and
 282 decrypt only), B<RSA_X931_PADDING> for X9.31 padding (signature operations
 283 only), B<RSA_PKCS1_PSS_PADDING> (sign and verify only) and
 284 B<RSA_PKCS1_WITH_TLS_PADDING> for TLS RSA ClientKeyExchange message padding
 285 (decryption only).
 286
 287 Two RSA padding modes behave differently if EVP_PKEY_CTX_set_signature_md()
 288 is used. If this macro is called for PKCS#1 padding the plaintext buffer is
 289 an actual digest value and is encapsulated in a DigestInfo structure according
 290 to PKCS#1 when signing and this structure is expected (and stripped off) when
 291 verifying. If this control is not used with RSA and PKCS#1 padding then the
 292 supplied data is used directly and not encapsulated. In the case of X9.31
 293 padding for RSA the algorithm identifier byte is added or checked and removed
 294 if this control is called. If it is not called then the first byte of the plaintext
 295 buffer is expected to be the algorithm identifier byte.
 296
 297 The EVP_PKEY_CTX_get_rsa_padding() function gets the RSA padding mode for I<ctx>.
 298
 299 The EVP_PKEY_CTX_set_rsa_pss_saltlen() function sets the RSA PSS salt
 300 length to I<saltlen>. As its name implies it is only supported for PSS
 301 padding. If this function is not called then the maximum salt length
 302 is used when signing and auto detection when verifying. Three special
 303 values are supported:
 304
 305 =over 4
 306
 307 =item B<RSA_PSS_SALTLEN_DIGEST>
 308
 309 sets the salt length to the digest length.
 310
 311 =item B<RSA_PSS_SALTLEN_MAX>
 312
 313 sets the salt length to the maximum permissible value.
 314
 315 =item B<RSA_PSS_SALTLEN_AUTO>
 316
 317 causes the salt length to be automatically determined based on the
 318 B<PSS> block structure when verifying.  When signing, it has the same
 319 meaning as B<RSA_PSS_SALTLEN_MAX>.
 320
 321 =back
 322
 323 The EVP_PKEY_CTX_get_rsa_pss_saltlen() function gets the RSA PSS salt length
 324 for I<ctx>. The padding mode must already have been set to
 325 B<RSA_PKCS1_PSS_PADDING>.
 326
 327 The EVP_PKEY_CTX_set_rsa_keygen_bits() macro sets the RSA key length for
 328 RSA key generation to I<bits>. If not specified 2048 bits is used.
 329
 330 The EVP_PKEY_CTX_set_rsa_keygen_pubexp() macro sets the public exponent value
 331 for RSA key generation to I<pubexp>. Currently it should be an odd integer. The
 332 I<pubexp> pointer is used internally by this function so it should not be
 333 modified or freed after the call. If not specified 65537 is used.
 334
 335 The EVP_PKEY_CTX_set_rsa_keygen_primes() macro sets the number of primes for
 336 RSA key generation to I<primes>. If not specified 2 is used.
 337
 338 The EVP_PKEY_CTX_set_rsa_mgf1_md_name() function sets the MGF1 digest for RSA
 339 padding schemes to the digest named I<mdname>. If the RSA algorithm
 340 implementation for the selected provider supports it then the digest will be
 341 fetched using the properties I<mdprops>. If not explicitly set the signing
 342 digest is used. The padding mode must have been set to B<RSA_PKCS1_OAEP_PADDING>
 343 or B<RSA_PKCS1_PSS_PADDING>.
 344
 345 The EVP_PKEY_CTX_set_rsa_mgf1_md() function does the same as
 346 EVP_PKEY_CTX_set_rsa_mgf1_md_name() except that the name of the digest is
 347 inferred from the supplied I<md> and it is not possible to specify any
 348 properties.
 349
 350 The EVP_PKEY_CTX_get_rsa_mgf1_md_name() function gets the name of the MGF1
 351 digest algorithm for I<ctx>. If not explicitly set the signing digest is used.
 352 The padding mode must have been set to B<RSA_PKCS1_OAEP_PADDING> or
 353 B<RSA_PKCS1_PSS_PADDING>.
 354
 355 The EVP_PKEY_CTX_get_rsa_mgf1_md() function does the same as
 356 EVP_PKEY_CTX_get_rsa_mgf1_md_name() except that it returns a pointer to an
 357 EVP_MD object instead. Note that only known, built-in EVP_MD objects will be
 358 returned. The EVP_MD object may be NULL if the digest is not one of these (such
 359 as a digest only implemented in a third party provider).
 360
 361 The EVP_PKEY_CTX_set_rsa_oaep_md_name() function sets the message digest type
 362 used in RSA OAEP to the digest named I<mdname>.  If the RSA algorithm
 363 implementation for the selected provider supports it then the digest will be
 364 fetched using the properties I<mdprops>. The padding mode must have been set to
 365 B<RSA_PKCS1_OAEP_PADDING>.
 366
 367 The EVP_PKEY_CTX_set_rsa_oaep_md() function does the same as
 368 EVP_PKEY_CTX_set_rsa_oaep_md_name() except that the name of the digest is
 369 inferred from the supplied I<md> and it is not possible to specify any
 370 properties.
 371
 372 The EVP_PKEY_CTX_get_rsa_oaep_md_name() function gets the message digest
 373 algorithm name used in RSA OAEP and stores it in the buffer I<name> which is of
 374 size I<namelen>. The padding mode must have been set to
 375 B<RSA_PKCS1_OAEP_PADDING>. The buffer should be sufficiently large for any
 376 expected digest algorithm names or the function will fail.
 377
 378 The EVP_PKEY_CTX_get_rsa_oaep_md() function does the same as
 379 EVP_PKEY_CTX_get_rsa_oaep_md_name() except that it returns a pointer to an
 380 EVP_MD object instead. Note that only known, built-in EVP_MD objects will be
 381 returned. The EVP_MD object may be NULL if the digest is not one of these (such
 382 as a digest only implemented in a third party provider).
 383
 384 The EVP_PKEY_CTX_set0_rsa_oaep_label() function sets the RSA OAEP label to
 385 I<label> and its length to I<len>. If I<label> is NULL or I<len> is 0,
 386 the label is cleared. The library takes ownership of the label so the
 387 caller should not free the original memory pointed to by I<label>.
 388 The padding mode must have been set to B<RSA_PKCS1_OAEP_PADDING>.
 389
 390 The EVP_PKEY_CTX_get0_rsa_oaep_label() function gets the RSA OAEP label to
 391 I<label>. The return value is the label length. The padding mode
 392 must have been set to B<RSA_PKCS1_OAEP_PADDING>. The resulting pointer is owned
 393 by the library and should not be freed by the caller.
 394
 395 B<RSA_PKCS1_WITH_TLS_PADDING> is used when decrypting an RSA encrypted TLS
 396 pre-master secret in a TLS ClientKeyExchange message. It is the same as
 397 RSA_PKCS1_PADDING except that it additionally verifies that the result is the
 398 correct length and the first two bytes are the protocol version initially
 399 requested by the client. If the encrypted content is publicly invalid then the
 400 decryption will fail. However, if the padding checks fail then decryption will
 401 still appear to succeed but a random TLS premaster secret will be returned
 402 instead. This padding mode accepts two parameters which can be set using the
 403 L<EVP_PKEY_CTX_set_params(3)> function. These are
 404 OSSL_ASYM_CIPHER_PARAM_TLS_CLIENT_VERSION and
 405 OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION, both of which are expected to be
 406 unsigned integers. Normally only the first of these will be set and represents
 407 the TLS protocol version that was first requested by the client (e.g. 0x0303 for
 408 TLSv1.2, 0x0302 for TLSv1.1 etc). Historically some buggy clients would use the
 409 negotiated protocol version instead of the protocol version first requested. If
 410 this behaviour should be tolerated then
 411 OSSL_ASYM_CIPHER_PARAM_TLS_NEGOTIATED_VERSION should be set to the actual
 412 negotiated protocol version. Otherwise it should be left unset.
 413
 414 =head2 DSA parameters
 415
 416 The EVP_PKEY_CTX_set_dsa_paramgen_bits() method sets the number of bits used
 417 for DSA parameter generation to I<nbits>. If not specified, 2048 is used.
 418
 419 The EVP_PKEY_CTX_set_dsa_paramgen_q_bits() method sets the number of bits in the
 420 subprime parameter I<q> for DSA parameter generation to I<qbits>. If not
 421 specified, 224 is used. If a digest function is specified below, this parameter
 422 is ignored and instead, the number of bits in I<q> matches the size of the
 423 digest.
 424
 425 The EVP_PKEY_CTX_set_dsa_paramgen_md() method sets the digest function used for
 426 DSA parameter generation to I<md>. If not specified, one of SHA-1, SHA-224, or
 427 SHA-256 is selected to match the bit length of I<q> above.
 428
 429 The EVP_PKEY_CTX_set_dsa_paramgen_md_props() method sets the digest function
 430 used for DSA parameter generation using I<md_name> and I<md_properties> to
 431 retrieve the digest from a provider.
 432 If not specified, I<md_name> will be set to one of SHA-1, SHA-224, or
 433 SHA-256 depending on the bit length of I<q> above. I<md_properties> is a
 434 property query string that has a default value of '' if not specified.
 435
 436 The EVP_PKEY_CTX_set_dsa_paramgen_gindex() method sets the I<gindex> used by
 437 the generator G. The default value is -1 which uses unverifiable g, otherwise
 438 a positive value uses verifiable g. This value must be saved if key validation
 439 of g is required, since it is not part of a persisted key.
 440
 441 The EVP_PKEY_CTX_set_dsa_paramgen_seed() method sets the I<seed> to use for
 442 generation rather than using a randomly generated value for the seed. This is
 443 useful for testing purposes only and can fail if the seed does not produce
 444 primes for both p & q on its first iteration. This value must be saved if
 445 key validation of p, q, and verifiable g are required, since it is not part of
 446 a persisted key.
 447
 448 The EVP_PKEY_CTX_set_dsa_paramgen_type() method sets the generation type to
 449 use FIPS186-4 generation if I<name> is "fips186_4", or FIPS186-2 generation if
 450 I<name> is "fips186_2". The default value is "fips186_4".
 451
 452 =head2 DH parameters
 453
 454 The EVP_PKEY_CTX_set_dh_paramgen_prime_len() macro sets the length of the DH
 455 prime parameter I<p> for DH parameter generation. If this macro is not called
 456 then 2048 is used. Only accepts lengths greater than or equal to 256.
 457
 458 The EVP_PKEY_CTX_set_dh_paramgen_subprime_len() macro sets the length of the DH
 459 optional subprime parameter I<q> for DH parameter generation. The default is
 460 256 if the prime is at least 2048 bits long or 160 otherwise. The DH
 461 paramgen type must have been set to "fips186_4".
 462
 463 The EVP_PKEY_CTX_set_dh_paramgen_generator() macro sets DH generator to I<gen>
 464 for DH parameter generation. If not specified 2 is used.
 465
 466 The EVP_PKEY_CTX_set_dh_paramgen_type() macro sets the key type for DH
 467 parameter generation. The supported parameters are:
 468
 469 =over 4
 470
 471 =item B<DH_PARAMGEN_TYPE_GROUP>
 472
 473 Use a named group. If only the safe prime parameter I<p> is set this can be
 474 used to select a ffdhe safe prime group of the correct size.
 475
 476 =item B<DH_PARAMGEN_TYPE_FIPS_186_4>
 477
 478 FIPS186-4 FFC parameter generator.
 479
 480 =item B<DH_PARAMGEN_TYPE_FIPS_186_2>
 481
 482 FIPS186-2 FFC parameter generator (X9.42 DH).
 483
 484 =item B<DH_PARAMGEN_TYPE_GENERATOR>
 485
 486 Uses a safe prime generator g (PKCS#3 format).
 487
 488 =back
 489
 490 The default is B<DH_PARAMGEN_TYPE_GENERATOR>.
 491
 492 The EVP_PKEY_CTX_set_dh_paramgen_gindex() method sets the I<gindex> used by
 493 the generator G. The default value is -1 which uses unverifiable g, otherwise
 494 a positive value uses verifiable g. This value must be saved if key validation
 495 of g is required, since it is not part of a persisted key.
 496
 497 The EVP_PKEY_CTX_set_dh_paramgen_seed() method sets the I<seed> to use for
 498 generation rather than using a randomly generated value for the seed. This is
 499 useful for testing purposes only and can fail if the seed does not produce
 500 primes for both p & q on its first iteration. This value must be saved if
 501 key validation of p, q, and verifiable g are required, since it is not part of
 502 a persisted key.
 503
 504 The EVP_PKEY_CTX_set_dh_pad() function sets the DH padding mode.
 505 If I<pad> is 1 the shared secret is padded with zeros up to the size of the DH
 506 prime I<p>.
 507 If I<pad> is zero (the default) then no padding is performed.
 508
 509 EVP_PKEY_CTX_set_dh_nid() sets the DH parameters to values corresponding to
 510 I<nid> as defined in RFC7919 or RFC3526. The I<nid> parameter must be
 511 B<NID_ffdhe2048>, B<NID_ffdhe3072>, B<NID_ffdhe4096>, B<NID_ffdhe6144>,
 512 B<NID_ffdhe8192>, B<NID_modp_1536>, B<NID_modp_2048>, B<NID_modp_3072>,
 513 B<NID_modp_4096>, B<NID_modp_6144>, B<NID_modp_8192> or B<NID_undef> to clear
 514 the stored value. This macro can be called during parameter or key generation.
 515 The nid parameter and the rfc5114 parameter are mutually exclusive.
 516
 517 The EVP_PKEY_CTX_set_dh_rfc5114() and EVP_PKEY_CTX_set_dhx_rfc5114() macros are
 518 synonymous. They set the DH parameters to the values defined in RFC5114. The
 519 I<rfc5114> parameter must be 1, 2 or 3 corresponding to RFC5114 sections
 520 2.1, 2.2 and 2.3. or 0 to clear the stored value. This macro can be called
 521 during parameter generation. The I<ctx> must have a key type of
 522 B<EVP_PKEY_DHX>.
 523 The rfc5114 parameter and the nid parameter are mutually exclusive.
 524
 525 =head2 DH key derivation function parameters
 526
 527 Note that all of the following functions require that the I<ctx> parameter has
 528 a private key type of B<EVP_PKEY_DHX>. When using key derivation, the output of
 529 EVP_PKEY_derive() is the output of the KDF instead of the DH shared secret.
 530 The KDF output is typically used as a Key Encryption Key (KEK) that in turn
 531 encrypts a Content Encryption Key (CEK).
 532
 533 The EVP_PKEY_CTX_set_dh_kdf_type() macro sets the key derivation function type
 534 to I<kdf> for DH key derivation. Possible values are B<EVP_PKEY_DH_KDF_NONE>
 535 and B<EVP_PKEY_DH_KDF_X9_42> which uses the key derivation specified in RFC2631
 536 (based on the keying algorithm described in X9.42). When using key derivation,
 537 the I<kdf_oid>, I<kdf_md> and I<kdf_outlen> parameters must also be specified.
 538
 539 The EVP_PKEY_CTX_get_dh_kdf_type() macro gets the key derivation function type
 540 for I<ctx> used for DH key derivation. Possible values are B<EVP_PKEY_DH_KDF_NONE>
 541 and B<EVP_PKEY_DH_KDF_X9_42>.
 542
 543 The EVP_PKEY_CTX_set0_dh_kdf_oid() macro sets the key derivation function
 544 object identifier to I<oid> for DH key derivation. This OID should identify
 545 the algorithm to be used with the Content Encryption Key.
 546 The library takes ownership of the object identifier so the caller should not
 547 free the original memory pointed to by I<oid>.
 548
 549 The EVP_PKEY_CTX_get0_dh_kdf_oid() macro gets the key derivation function oid
 550 for I<ctx> used for DH key derivation. The resulting pointer is owned by the
 551 library and should not be freed by the caller.
 552
 553 The EVP_PKEY_CTX_set_dh_kdf_md() macro sets the key derivation function
 554 message digest to I<md> for DH key derivation. Note that RFC2631 specifies
 555 that this digest should be SHA1 but OpenSSL tolerates other digests.
 556
 557 The EVP_PKEY_CTX_get_dh_kdf_md() macro gets the key derivation function
 558 message digest for I<ctx> used for DH key derivation.
 559
 560 The EVP_PKEY_CTX_set_dh_kdf_outlen() macro sets the key derivation function
 561 output length to I<len> for DH key derivation.
 562
 563 The EVP_PKEY_CTX_get_dh_kdf_outlen() macro gets the key derivation function
 564 output length for I<ctx> used for DH key derivation.
 565
 566 The EVP_PKEY_CTX_set0_dh_kdf_ukm() macro sets the user key material to
 567 I<ukm> and its length to I<len> for DH key derivation. This parameter is optional
 568 and corresponds to the partyAInfo field in RFC2631 terms. The specification
 569 requires that it is 512 bits long but this is not enforced by OpenSSL.
 570 The library takes ownership of the user key material so the caller should not
 571 free the original memory pointed to by I<ukm>.
 572
 573 The EVP_PKEY_CTX_get0_dh_kdf_ukm() macro gets the user key material for I<ctx>.
 574 The return value is the user key material length. The resulting pointer is owned
 575 by the library and should not be freed by the caller.
 576
 577 =head2 EC parameters
 578
 579 EVP_PKEY_CTX_set_ec_paramgen_curve_name() sets the EC curve to I<name> for EC
 580 parameter generation.
 581
 582 EVP_PKEY_CTX_set_ec_paramgen_curve_nid() does the same as
 583 EVP_PKEY_CTX_set_ec_paramgen_curve_name(), but uses a I<nid> rather than a
 584 name string.
 585
 586 For EC parameter generation, one of EVP_PKEY_CTX_set_ec_paramgen_curve_name()
 587 or EVP_PKEY_CTX_set_ec_paramgen_curve_nid() must be called or an error occurs
 588 because there is no default curve.
 589 These function can also be called to set the curve explicitly when
 590 generating an EC key.
 591
 592 EVP_PKEY_CTX_get_ec_paramgen_curve_name() finds the curve name that's currently
 593 set with I<ctx>, and writes it to the location that I<name> points at, as long
 594 as its size I<namelen> is large enough to store that name, including a
 595 terminating NUL byte.
 596
 597 The EVP_PKEY_CTX_set_ec_param_enc() macro sets the EC parameter encoding to
 598 I<param_enc> when generating EC parameters or an EC key. The encoding can be
 599 B<OPENSSL_EC_EXPLICIT_CURVE> for explicit parameters (the default in versions
 600 of OpenSSL before 1.1.0) or B<OPENSSL_EC_NAMED_CURVE> to use named curve form.
 601 For maximum compatibility the named curve form should be used. Note: the
 602 B<OPENSSL_EC_NAMED_CURVE> value was added in OpenSSL 1.1.0; previous
 603 versions should use 0 instead.
 604
 605 =head2 ECDH parameters
 606
 607 The EVP_PKEY_CTX_set_ecdh_cofactor_mode() macro sets the cofactor mode to
 608 I<cofactor_mode> for ECDH key derivation. Possible values are 1 to enable
 609 cofactor key derivation, 0 to disable it and -1 to clear the stored cofactor
 610 mode and fallback to the private key cofactor mode.
 611
 612 The EVP_PKEY_CTX_get_ecdh_cofactor_mode() macro returns the cofactor mode for
 613 I<ctx> used for ECDH key derivation. Possible values are 1 when cofactor key
 614 derivation is enabled and 0 otherwise.
 615
 616 =head2 ECDH key derivation function parameters
 617
 618 The EVP_PKEY_CTX_set_ecdh_kdf_type() macro sets the key derivation function type
 619 to I<kdf> for ECDH key derivation. Possible values are B<EVP_PKEY_ECDH_KDF_NONE>
 620 and B<EVP_PKEY_ECDH_KDF_X9_63> which uses the key derivation specified in X9.63.
 621 When using key derivation, the I<kdf_md> and I<kdf_outlen> parameters must
 622 also be specified.
 623
 624 The EVP_PKEY_CTX_get_ecdh_kdf_type() macro returns the key derivation function
 625 type for I<ctx> used for ECDH key derivation. Possible values are
 626 B<EVP_PKEY_ECDH_KDF_NONE> and B<EVP_PKEY_ECDH_KDF_X9_63>.
 627
 628 The EVP_PKEY_CTX_set_ecdh_kdf_md() macro sets the key derivation function
 629 message digest to I<md> for ECDH key derivation. Note that X9.63 specifies
 630 that this digest should be SHA1 but OpenSSL tolerates other digests.
 631
 632 The EVP_PKEY_CTX_get_ecdh_kdf_md() macro gets the key derivation function
 633 message digest for I<ctx> used for ECDH key derivation.
 634
 635 The EVP_PKEY_CTX_set_ecdh_kdf_outlen() macro sets the key derivation function
 636 output length to I<len> for ECDH key derivation.
 637
 638 The EVP_PKEY_CTX_get_ecdh_kdf_outlen() macro gets the key derivation function
 639 output length for I<ctx> used for ECDH key derivation.
 640
 641 The EVP_PKEY_CTX_set0_ecdh_kdf_ukm() macro sets the user key material to I<ukm>
 642 for ECDH key derivation. This parameter is optional and corresponds to the
 643 shared info in X9.63 terms. The library takes ownership of the user key material
 644 so the caller should not free the original memory pointed to by I<ukm>.
 645
 646 The EVP_PKEY_CTX_get0_ecdh_kdf_ukm() macro gets the user key material for I<ctx>.
 647 The return value is the user key material length. The resulting pointer is owned
 648 by the library and should not be freed by the caller.
 649
 650 =head2 Other parameters
 651
 652 The EVP_PKEY_CTX_set1_id(), EVP_PKEY_CTX_get1_id() and EVP_PKEY_CTX_get1_id_len()
 653 macros are used to manipulate the special identifier field for specific signature
 654 algorithms such as SM2. The EVP_PKEY_CTX_set1_id() sets an ID pointed by I<id> with
 655 the length I<id_len> to the library. The library takes a copy of the id so that
 656 the caller can safely free the original memory pointed to by I<id>. The
 657 EVP_PKEY_CTX_get1_id_len() macro returns the length of the ID set via a previous
 658 call to EVP_PKEY_CTX_set1_id(). The length is usually used to allocate adequate
 659 memory for further calls to EVP_PKEY_CTX_get1_id(). The EVP_PKEY_CTX_get1_id()
 660 macro returns the previously set ID value to caller in I<id>. The caller should
 661 allocate adequate memory space for the I<id> before calling EVP_PKEY_CTX_get1_id().
 662
 663 =head1 RETURN VALUES
 664
 665 EVP_PKEY_CTX_set_params() returns 1 for success or 0 otherwise.
 666 EVP_PKEY_CTX_settable_params() returns an OSSL_PARAM array on success or NULL on
 667 error.
 668 It may also return NULL if there are no settable parameters available.
 669
 670 All other functions and macros described on this page return a positive value
 671 for success and 0 or a negative value for failure. In particular a return value
 672 of -2 indicates the operation is not supported by the public key algorithm.
 673
 674 =head1 SEE ALSO
 675
 676 L<EVP_PKEY_CTX_new(3)>,
 677 L<EVP_PKEY_encrypt(3)>,
 678 L<EVP_PKEY_decrypt(3)>,
 679 L<EVP_PKEY_sign(3)>,
 680 L<EVP_PKEY_verify(3)>,
 681 L<EVP_PKEY_verify_recover(3)>,
 682 L<EVP_PKEY_derive(3)>,
 683 L<EVP_PKEY_keygen(3)>
 684
 685 =head1 HISTORY
 686
 687 EVP_PKEY_CTX_get_signature_md(), EVP_PKEY_CTX_set_signature_md(),
 688 EVP_PKEY_CTX_set_dh_pad(), EVP_PKEY_CTX_set_rsa_padding(),
 689 EVP_PKEY_CTX_get_rsa_padding(), EVP_PKEY_CTX_get_rsa_mgf1_md(),
 690 EVP_PKEY_CTX_set_rsa_mgf1_md(), EVP_PKEY_CTX_set_rsa_oaep_md(),
 691 EVP_PKEY_CTX_get_rsa_oaep_md(), EVP_PKEY_CTX_set0_rsa_oaep_label(),
 692 EVP_PKEY_CTX_get0_rsa_oaep_label(), EVP_PKEY_CTX_set_rsa_pss_saltlen(),
 693 EVP_PKEY_CTX_get_rsa_pss_saltlen(), EVP_PKEY_CTX_set_dsa_paramgen_bits(),
 694 EVP_PKEY_CTX_set_dsa_paramgen_q_bits() and EVP_PKEY_CTX_set_dsa_paramgen_md()
 695 were macros in OpenSSL 1.1.1 and below.
 696 From OpenSSL 3.0 they are functions.
 697
 698 EVP_PKEY_CTX_get_rsa_oaep_md_name(), EVP_PKEY_CTX_get_rsa_mgf1_md_name(),
 699 EVP_PKEY_CTX_set_rsa_mgf1_md_name(), EVP_PKEY_CTX_set_rsa_oaep_md_name(),
 700 EVP_PKEY_CTX_set_dsa_paramgen_md_props(), EVP_PKEY_CTX_set_dsa_paramgen_gindex(),
 701 EVP_PKEY_CTX_set_dsa_paramgen_type() and EVP_PKEY_CTX_set_dsa_paramgen_seed()
 702 were added in OpenSSL 3.0.
 703
 704 The EVP_PKEY_CTX_set1_id(), EVP_PKEY_CTX_get1_id() and
 705 EVP_PKEY_CTX_get1_id_len() macros were added in 1.1.1, other functions were
 706 added in OpenSSL 1.0.0.
 707
 708 =head1 COPYRIGHT
 709
 710 Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
 711
 712 Licensed under the Apache License 2.0 (the "License").  You may not use
 713 this file except in compliance with the License.  You can obtain a copy
 714 in the file LICENSE in the source distribution or at
 715 L<https://www.openssl.org/source/license.html>.
 716
 717 =cut