doc/man3/EVP_PKEY_CTX_ctrl.pod

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