doc/man3/EVP_SIGNATURE_free.pod

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