doc/man3/EVP_KEYEXCH_free.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 EVP_KEYEXCH_fetch, EVP_KEYEXCH_free, EVP_KEYEXCH_up_ref
   6 - Functions to manage EVP_KEYEXCH algorithm objects
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/evp.h>
  11
  12  EVP_KEYEXCH *EVP_KEYEXCH_fetch(OPENSSL_CTX *ctx, const char *algorithm,
  13                                 const char *properties);
  14  void EVP_KEYEXCH_free(EVP_KEYEXCH *exchange);
  15  int EVP_KEYEXCH_up_ref(EVP_KEYEXCH *exchange);
  16
  17 =head1 DESCRIPTION
  18
  19 EVP_KEYEXCH_fetch() fetches the key exchange implementation for the given
  20 B<algorithm> from any provider offering it, within the criteria given
  21 by the B<properties>.
  22 See L<provider(7)/Fetching algorithms> for further information.
  23
  24 The returned value must eventually be freed with EVP_KEYEXCH_free().
  25
  26 EVP_KEYEXCH_free() decrements the reference count for the B<EVP_KEYEXCH>
  27 structure. Typically this structure will have been obtained from an earlier call
  28 to EVP_KEYEXCH_fetch(). If the reference count drops to 0 then the
  29 structure is freed.
  30
  31 EVP_KEYEXCH_up_ref() increments the reference count for an B<EVP_KEYEXCH>
  32 structure.
  33
  34 =head1 RETURN VALUES
  35
  36 EVP_KEYEXCH_fetch() returns a pointer to a B<EVP_KEYEXCH> for success
  37 or B<NULL> for failure.
  38
  39 EVP_KEYEXCH_up_ref() returns 1 for success or 0 otherwise.
  40
  41 =head1 SEE ALSO
  42
  43 L<provider(7)/Fetching algorithms>
  44
  45 =head1 HISTORY
  46
  47 The functions described here were added in OpenSSL 3.0.
  48
  49 =head1 COPYRIGHT
  50
  51 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
  52
  53 Licensed under the Apache License 2.0 (the "License").  You may not use
  54 this file except in compliance with the License.  You can obtain a copy
  55 in the file LICENSE in the source distribution or at
  56 L<https://www.openssl.org/source/license.html>.
  57
  58 =cut