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  EVP_PKEY_CTX *EVP_PKEY_CTX_dup(const EVP_PKEY_CTX *ctx);
  21  void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx);
  22
  23 =head1 DESCRIPTION
  24
  25 The EVP_PKEY_CTX_new() function allocates public key algorithm context using
  26 the I<pkey> key type and ENGINE I<e>.
  27
  28 The EVP_PKEY_CTX_new_id() function allocates public key algorithm context
  29 using the key type specified by I<id> and ENGINE I<e>.
  30
  31 The EVP_PKEY_CTX_new_from_name() function allocates a public key algorithm
  32 context using the library context I<libctx> (see L<OPENSSL_CTX(3)>), the
  33 key type specified by I<name> and the property query I<propquery>.  None
  34 of the arguments are duplicated, so they  must remain unchanged for the
  35 lifetime of the returned B<EVP_PKEY_CTX> or of any of its duplicates.
  36
  37 The EVP_PKEY_CTX_new_from_pkey() function allocates a public key algorithm
  38 context using the library context I<libctx> (see L<OPENSSL_CTX(3)>) and the
  39 algorithm specified by I<pkey> . None of the arguments are duplicated, so they
  40 must remain unchanged for the lifetime of the returned B<EVP_PKEY_CTX> or of
  41 any of its duplicates.
  42
  43 EVP_PKEY_CTX_new_id() and EVP_PKEY_CTX_new_from_name() are normally
  44 used when no B<EVP_PKEY> structure is associated with the operations,
  45 for example during parameter generation or key generation for some
  46 algorithms.
  47
  48 EVP_PKEY_CTX_dup() duplicates the context I<ctx>.
  49
  50 EVP_PKEY_CTX_free() frees up the context I<ctx>.
  51 If I<ctx> is NULL, nothing is done.
  52
  53 =head1 NOTES
  54
  55 =over 4
  56
  57 =item 1.
  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 =item 2.
  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 =back
  73
  74 =head1 RETURN VALUES
  75
  76 EVP_PKEY_CTX_new(), EVP_PKEY_CTX_new_id(), EVP_PKEY_CTX_dup() returns either
  77 the newly allocated B<EVP_PKEY_CTX> structure of B<NULL> if an error occurred.
  78
  79 EVP_PKEY_CTX_free() does not return a value.
  80
  81 =head1 SEE ALSO
  82
  83 L<EVP_PKEY_new(3)>
  84
  85 =head1 HISTORY
  86
  87 The EVP_PKEY_CTX_new(), EVP_PKEY_CTX_new_id(), EVP_PKEY_CTX_dup() and
  88 EVP_PKEY_CTX_free() functions were added in OpenSSL 1.0.0.
  89
  90 The EVP_PKEY_CTX_new_from_name() and EVP_PKEY_CTX_new_from_pkey() functions were
  91 added in OpenSSL 3.0.
  92
  93 =head1 COPYRIGHT
  94
  95 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
  96
  97 Licensed under the Apache License 2.0 (the "License").  You may not use
  98 this file except in compliance with the License.  You can obtain a copy
  99 in the file LICENSE in the source distribution or at
 100 L<https://www.openssl.org/source/license.html>.
 101
 102 =cut