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_get_number, EVP_SIGNATURE_is_a, EVP_SIGNATURE_get0_provider,
   7 EVP_SIGNATURE_do_all_provided, EVP_SIGNATURE_names_do_all,
   8 EVP_SIGNATURE_get0_name, EVP_SIGNATURE_get0_description,
   9 EVP_SIGNATURE_gettable_ctx_params, EVP_SIGNATURE_settable_ctx_params
  10 - Functions to manage EVP_SIGNATURE algorithm objects
  11
  12 =head1 SYNOPSIS
  13
  14  #include <openssl/evp.h>
  15
  16  EVP_SIGNATURE *EVP_SIGNATURE_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
  17                                     const char *properties);
  18  void EVP_SIGNATURE_free(EVP_SIGNATURE *signature);
  19  int EVP_SIGNATURE_up_ref(EVP_SIGNATURE *signature);
  20  int EVP_SIGNATURE_get_number(const EVP_SIGNATURE *signature);
  21  const char *EVP_SIGNATURE_get0_name(const EVP_SIGNATURE *signature);
  22  int EVP_SIGNATURE_is_a(const EVP_SIGNATURE *signature, const char *name);
  23  OSSL_PROVIDER *EVP_SIGNATURE_get0_provider(const EVP_SIGNATURE *signature);
  24  void EVP_SIGNATURE_do_all_provided(OSSL_LIB_CTX *libctx,
  25                                     void (*fn)(EVP_SIGNATURE *signature,
  26                                                void *arg),
  27                                     void *arg);
  28  int EVP_SIGNATURE_names_do_all(const EVP_SIGNATURE *signature,
  29                                 void (*fn)(const char *name, void *data),
  30                                 void *data);
  31  const char *EVP_SIGNATURE_get0_name(const EVP_SIGNATURE *signature);
  32  const char *EVP_SIGNATURE_get0_description(const EVP_SIGNATURE *signature);
  33  const OSSL_PARAM *EVP_SIGNATURE_gettable_ctx_params(const EVP_SIGNATURE *sig);
  34  const OSSL_PARAM *EVP_SIGNATURE_settable_ctx_params(const EVP_SIGNATURE *sig);
  35
  36 =head1 DESCRIPTION
  37
  38 EVP_SIGNATURE_fetch() fetches the implementation for the given
  39 B<algorithm> from any provider offering it, within the criteria given
  40 by the B<properties>.
  41 The algorithm will be one offering functions for performing signature related
  42 tasks such as signing and verifying.
  43 See L<crypto(7)/ALGORITHM FETCHING> for further information.
  44
  45 The returned value must eventually be freed with EVP_SIGNATURE_free().
  46
  47 EVP_SIGNATURE_free() decrements the reference count for the B<EVP_SIGNATURE>
  48 structure. Typically this structure will have been obtained from an earlier call
  49 to EVP_SIGNATURE_fetch(). If the reference count drops to 0 then the
  50 structure is freed.
  51
  52 EVP_SIGNATURE_up_ref() increments the reference count for an B<EVP_SIGNATURE>
  53 structure.
  54
  55 EVP_SIGNATURE_is_a() returns 1 if I<signature> is an implementation of an
  56 algorithm that's identifiable with I<name>, otherwise 0.
  57
  58 EVP_SIGNATURE_get0_provider() returns the provider that I<signature> was
  59 fetched from.
  60
  61 EVP_SIGNATURE_do_all_provided() traverses all SIGNATURE implemented by all
  62 activated roviders in the given library context I<libctx>, and for each of the
  63 implementations, calls the given function I<fn> with the implementation method
  64 and the given I<arg> as argument.
  65
  66 EVP_SIGNATURE_get_number() returns the internal dynamic number assigned to
  67 I<signature>.
  68
  69 EVP_SIGNATURE_get0_name() returns the algorithm name from the provided
  70 implementation for the given I<signature>. Note that the I<signature> may have
  71 multiple synonyms associated with it. In this case the first name from the
  72 algorithm definition is returned. Ownership of the returned string is retained
  73 by the I<signature> object and should not be freed by the caller.
  74
  75 EVP_SIGNATURE_names_do_all() traverses all names for I<signature>, and calls
  76 I<fn> with each name and I<data>.
  77
  78 EVP_SIGNATURE_get0_description() returns a description of the I<signature>,
  79 meant for display and human consumption.  The description is at the
  80 discretion of the I<signature> implementation.
  81
  82 EVP_SIGNATURE_gettable_ctx_params() and EVP_SIGNATURE_settable_ctx_params()
  83 return a constant B<OSSL_PARAM> array that describes the names and types of key
  84 parameters that can be retrieved or set by a signature algorithm using
  85 L<EVP_PKEY_CTX_get_params(3)> and L<EVP_PKEY_CTX_set_params(3)>.
  86
  87 =head1 RETURN VALUES
  88
  89 EVP_SIGNATURE_fetch() returns a pointer to an B<EVP_SIGNATURE> for success
  90 or B<NULL> for failure.
  91
  92 EVP_SIGNATURE_up_ref() returns 1 for success or 0 otherwise.
  93
  94 EVP_SIGNATURE_names_do_all() returns 1 if the callback was called for all names.
  95 A return value of 0 means that the callback was not called for any names.
  96
  97 EVP_SIGNATURE_gettable_ctx_params() and EVP_SIGNATURE_settable_ctx_params()
  98 return a constant B<OSSL_PARAM> array or NULL on error.
  99
 100 =head1 SEE ALSO
 101
 102 L<crypto(7)/ALGORITHM FETCHING>, L<OSSL_PROVIDER(3)>
 103
 104 =head1 HISTORY
 105
 106 The functions described here were added in OpenSSL 3.0.
 107
 108 =head1 COPYRIGHT
 109
 110 Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
 111
 112 Licensed under the Apache License 2.0 (the "License").  You may not use
 113 this file except in compliance with the License.  You can obtain a copy
 114 in the file LICENSE in the source distribution or at
 115 L<https://www.openssl.org/source/license.html>.
 116
 117 =cut