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