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_provided,
   6 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_provided(OPENSSL_CTX *libctx,
  16                                          const char *name,
  17                                          const char *propquery);
  18  EVP_PKEY_CTX *EVP_PKEY_CTX_dup(const EVP_PKEY_CTX *ctx);
  19  void EVP_PKEY_CTX_free(EVP_PKEY_CTX *ctx);
  20
  21 =head1 DESCRIPTION
  22
  23 The EVP_PKEY_CTX_new() function allocates public key algorithm context using
  24 the algorithm specified in I<pkey> and ENGINE I<e>.
  25
  26 The EVP_PKEY_CTX_new_id() function allocates public key algorithm context
  27 using the algorithm specified by I<id> and ENGINE I<e>.
  28
  29 The EVP_PKEY_CTX_new_provided() function allocates a public key algorithm
  30 context using the library context I<libctx> (see L<OPENSSL_CTX(3)>), the
  31 algorithm specified by I<name> and the property query I<propquery>.  None
  32 of the arguments are duplicated, so they  must remain unchanged for the
  33 lifetime of the returned B<EVP_PKEY_CTX> or of any of its duplicates.
  34
  35 EVP_PKEY_CTX_new_id() and EVP_PKEY_CTX_new_provided() are normally
  36 used when no B<EVP_PKEY> structure is associated with the operations,
  37 for example during parameter generation or key generation for some
  38 algorithms.
  39
  40 EVP_PKEY_CTX_dup() duplicates the context I<ctx>.
  41
  42 EVP_PKEY_CTX_free() frees up the context I<ctx>.
  43 If I<ctx> is NULL, nothing is done.
  44
  45 =head1 NOTES
  46
  47 The B<EVP_PKEY_CTX> structure is an opaque public key algorithm context used
  48 by the OpenSSL high level public key API. Contexts B<MUST NOT> be shared between
  49 threads: that is it is not permissible to use the same context simultaneously
  50 in two threads.
  51
  52 =head1 RETURN VALUES
  53
  54 EVP_PKEY_CTX_new(), EVP_PKEY_CTX_new_id(), EVP_PKEY_CTX_dup() returns either
  55 the newly allocated B<EVP_PKEY_CTX> structure of B<NULL> if an error occurred.
  56
  57 EVP_PKEY_CTX_free() does not return a value.
  58
  59 =head1 SEE ALSO
  60
  61 L<EVP_PKEY_new(3)>
  62
  63 =head1 HISTORY
  64
  65 These functions were added in OpenSSL 1.0.0.
  66
  67 =head1 COPYRIGHT
  68
  69 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
  70
  71 Licensed under the Apache License 2.0 (the "License").  You may not use
  72 this file except in compliance with the License.  You can obtain a copy
  73 in the file LICENSE in the source distribution or at
  74 L<https://www.openssl.org/source/license.html>.
  75
  76 =cut