doc/man3/EVP_PKEY_CTX_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_PKEY_CTX_new, EVP_PKEY_CTX_new_id, EVP_PKEY_CTX_new_from_name,
   6 EVP_PKEY_CTX_new_from_pkey, EVP_PKEY_CTX_dup, EVP_PKEY_CTX_free
   7 - public key algorithm context functions
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/evp.h>
  12
  13  EVP_PKEY_CTX *EVP_PKEY_CTX_new(EVP_PKEY *pkey, ENGINE *e);
  14  EVP_PKEY_CTX *EVP_PKEY_CTX_new_id(int id, ENGINE *e);
  15  EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_name(OPENSSL_CTX *libctx,
  16                                           const char *name,
  17                                           const char *propquery);
  18  EVP_PKEY_CTX *EVP_PKEY_CTX_new_from_pkey(OPENSSL_CTX *libctx,
  19                                           EVP_PKEY *pkey,
  20                                           const char *propquery);
  21  EVP_PKEY_CTX *EVP_PKEY_CTX_dup(const EVP_PKEY_CTX *ctx);
  22  void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx);
  23
  24 =head1 DESCRIPTION
  25
  26 The EVP_PKEY_CTX_new() function allocates public key algorithm context using
  27 the I<pkey> key type and ENGINE I<e>.
  28
  29 The EVP_PKEY_CTX_new_id() function allocates public key algorithm context
  30 using the key type specified by I<id> and ENGINE I<e>.
  31
  32 The EVP_PKEY_CTX_new_from_name() function allocates a public key algorithm
  33 context using the library context I<libctx> (see L<OPENSSL_CTX(3)>), the
  34 key type specified by I<name> and the property query I<propquery>.  None
  35 of the arguments are duplicated, so they  must remain unchanged for the
  36 lifetime of the returned B<EVP_PKEY_CTX> or of any of its duplicates.  Read
  37 further about the possible names in L</NOTES> below.
  38
  39 The EVP_PKEY_CTX_new_from_pkey() function allocates a public key algorithm
  40 context using the library context I<libctx> (see L<OPENSSL_CTX(3)>) and the
  41 algorithm specified by I<pkey> and the property query I<propquery>. None of the
  42 arguments are duplicated, so they must remain unchanged for the lifetime of the
  43 returned B<EVP_PKEY_CTX> or any of its duplicates.
  44
  45 EVP_PKEY_CTX_new_id() and EVP_PKEY_CTX_new_from_name() are normally
  46 used when no B<EVP_PKEY> structure is associated with the operations,
  47 for example during parameter generation or key generation for some
  48 algorithms.
  49
  50 EVP_PKEY_CTX_dup() duplicates the context I<ctx>.
  51
  52 EVP_PKEY_CTX_free() frees up the context I<ctx>.
  53 If I<ctx> is NULL, nothing is done.
  54
  55 =head1 NOTES
  56
  57 =head2 On B<EVP_PKEY_CTX>
  58
  59 The B<EVP_PKEY_CTX> structure is an opaque public key algorithm context used
  60 by the OpenSSL high level public key API. Contexts B<MUST NOT> be shared between
  61 threads: that is it is not permissible to use the same context simultaneously
  62 in two threads.
  63
  64 =head2 On Key Types
  65
  66 We mention "key type" in this manual, which is the same
  67 as "algorithm" in most cases, allowing either term to be used
  68 interchangeably.  There are algorithms where the I<key type> and the
  69 I<algorithm> of the operations that use the keys are not the same,
  70 such as EC keys being used for ECDSA and ECDH operations.
  71
  72 Key types are given in two different manners:
  73
  74 =over 4
  75
  76 =item Legacy NID or EVP_PKEY type
  77
  78 This is the I<id> used with EVP_PKEY_CTX_new_id().
  79
  80 These are B<EVP_PKEY_RSA>, B<EVP_PKEY_RSA_PSS>, B<EVP_PKEY_DSA>,
  81 B<EVP_PKEY_DH>, B<EVP_PKEY_EC>, B<EVP_PKEY_SM2>, B<EVP_PKEY_X25519>,
  82 B<EVP_PKEY_X448>, and are used by legacy methods.
  83
  84 =item Name strings
  85
  86 This is the I<name> used with EVP_PKEY_CTX_new_from_name().
  87
  88 These are names like "RSA", "DSA", and what's available depends on what
  89 providers are currently accessible.
  90
  91 The OpenSSL providers offer a set of key types available this way, please
  92 see L<OSSL_PROVIDER-FIPS(7)> and L<OSSL_PROVIDER-default(7)> and related
  93 documentation for more information.
  94
  95 =back
  96
  97 =head1 RETURN VALUES
  98
  99 EVP_PKEY_CTX_new(), EVP_PKEY_CTX_new_id(), EVP_PKEY_CTX_dup() returns either
 100 the newly allocated B<EVP_PKEY_CTX> structure of B<NULL> if an error occurred.
 101
 102 EVP_PKEY_CTX_free() does not return a value.
 103
 104 =head1 SEE ALSO
 105
 106 L<EVP_PKEY_new(3)>
 107
 108 =head1 HISTORY
 109
 110 The EVP_PKEY_CTX_new(), EVP_PKEY_CTX_new_id(), EVP_PKEY_CTX_dup() and
 111 EVP_PKEY_CTX_free() functions were added in OpenSSL 1.0.0.
 112
 113 The EVP_PKEY_CTX_new_from_name() and EVP_PKEY_CTX_new_from_pkey() functions were
 114 added in OpenSSL 3.0.
 115
 116 =head1 COPYRIGHT
 117
 118 Copyright 2006-2020 The OpenSSL Project Authors. All Rights Reserved.
 119
 120 Licensed under the Apache License 2.0 (the "License").  You may not use
 121 this file except in compliance with the License.  You can obtain a copy
 122 in the file LICENSE in the source distribution or at
 123 L<https://www.openssl.org/source/license.html>.
 124
 125 =cut