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_is_a, EVP_SIGNATURE_provider, EVP_SIGNATURE_do_all_provided,
   7 EVP_SIGNATURE_names_do_all
   8 - Functions to manage EVP_SIGNATURE algorithm objects
   9
  10 =head1 SYNOPSIS
  11
  12  #include <openssl/evp.h>
  13
  14  EVP_SIGNATURE *EVP_SIGNATURE_fetch(OPENSSL_CTX *ctx, const char *algorithm,
  15                                     const char *properties);
  16  void EVP_SIGNATURE_free(EVP_SIGNATURE *signature);
  17  int EVP_SIGNATURE_up_ref(EVP_SIGNATURE *signature);
  18  int EVP_SIGNATURE_is_a(const EVP_SIGNATURE *signature, const char *name);
  19  OSSL_PROVIDER *EVP_SIGNATURE_provider(const EVP_SIGNATURE *signature);
  20  void EVP_SIGNATURE_do_all_provided(OPENSSL_CTX *libctx,
  21                                     void (*fn)(EVP_SIGNATURE *signature,
  22                                                void *arg),
  23                                     void *arg);
  24  void EVP_SIGNATURE_names_do_all(const EVP_SIGNATURE *signature,
  25                                  void (*fn)(const char *name, void *data),
  26                                  void *data);
  27
  28 =head1 DESCRIPTION
  29
  30 EVP_SIGNATURE_fetch() fetches the implementation for the given
  31 B<algorithm> from any provider offering it, within the criteria given
  32 by the B<properties>.
  33 The algorithm will be one offering functions for performing signature related
  34 tasks such as signing and verifying.
  35 See L<provider(7)/Fetching algorithms> for further information.
  36
  37 The returned value must eventually be freed with EVP_SIGNATURE_free().
  38
  39 EVP_SIGNATURE_free() decrements the reference count for the B<EVP_SIGNATURE>
  40 structure. Typically this structure will have been obtained from an earlier call
  41 to EVP_SIGNATURE_fetch(). If the reference count drops to 0 then the
  42 structure is freed.
  43
  44 EVP_SIGNATURE_up_ref() increments the reference count for an B<EVP_SIGNATURE>
  45 structure.
  46
  47 EVP_SIGNATURE_is_a() returns 1 if I<signature> is an implementation of an
  48 algorithm that's identifiable with I<name>, otherwise 0.
  49
  50 EVP_SIGNATURE_provider() returns the provider that I<signature> was fetched from.
  51
  52 EVP_SIGNATURE_do_all_provided() traverses all SIGNATURE implemented by all
  53 activated roviders in the given library context I<libctx>, and for each of the
  54 implementations, calls the given function I<fn> with the implementation method
  55 and the given I<arg> as argument.
  56
  57 EVP_SIGNATURE_names_do_all() traverses all names for I<signature>, and calls
  58 I<fn> with each name and I<data>.
  59
  60 =head1 RETURN VALUES
  61
  62 EVP_SIGNATURE_fetch() returns a pointer to an B<EVP_SIGNATURE> for success
  63 or B<NULL> for failure.
  64
  65 EVP_SIGNATURE_up_ref() returns 1 for success or 0 otherwise.
  66
  67 =head1 SEE ALSO
  68
  69 L<provider(7)/Fetching algorithms>, L<OSSL_PROVIDER(3)>
  70
  71 =head1 HISTORY
  72
  73 The functions described here were added in OpenSSL 3.0.
  74
  75 =head1 COPYRIGHT
  76
  77 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
  78
  79 Licensed under the Apache License 2.0 (the "License").  You may not use
  80 this file except in compliance with the License.  You can obtain a copy
  81 in the file LICENSE in the source distribution or at
  82 L<https://www.openssl.org/source/license.html>.
  83
  84 =cut