5 EVP_SIGNATURE_fetch, EVP_SIGNATURE_free, EVP_SIGNATURE_up_ref,
6 EVP_SIGNATURE_number, EVP_SIGNATURE_is_a, EVP_SIGNATURE_provider,
7 EVP_SIGNATURE_do_all_provided, EVP_SIGNATURE_names_do_all
8 - Functions to manage EVP_SIGNATURE algorithm objects
12 #include <openssl/evp.h>
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_number(const EVP_SIGNATURE *signature);
19 int EVP_SIGNATURE_is_a(const EVP_SIGNATURE *signature, const char *name);
20 OSSL_PROVIDER *EVP_SIGNATURE_provider(const EVP_SIGNATURE *signature);
21 void EVP_SIGNATURE_do_all_provided(OPENSSL_CTX *libctx,
22 void (*fn)(EVP_SIGNATURE *signature,
25 void EVP_SIGNATURE_names_do_all(const EVP_SIGNATURE *signature,
26 void (*fn)(const char *name, void *data),
31 EVP_SIGNATURE_fetch() fetches the implementation for the given
32 B<algorithm> from any provider offering it, within the criteria given
34 The algorithm will be one offering functions for performing signature related
35 tasks such as signing and verifying.
36 See L<provider(7)/Fetching algorithms> for further information.
38 The returned value must eventually be freed with EVP_SIGNATURE_free().
40 EVP_SIGNATURE_free() decrements the reference count for the B<EVP_SIGNATURE>
41 structure. Typically this structure will have been obtained from an earlier call
42 to EVP_SIGNATURE_fetch(). If the reference count drops to 0 then the
45 EVP_SIGNATURE_up_ref() increments the reference count for an B<EVP_SIGNATURE>
48 EVP_SIGNATURE_is_a() returns 1 if I<signature> is an implementation of an
49 algorithm that's identifiable with I<name>, otherwise 0.
51 EVP_SIGNATURE_provider() returns the provider that I<signature> was fetched from.
53 EVP_SIGNATURE_do_all_provided() traverses all SIGNATURE implemented by all
54 activated roviders in the given library context I<libctx>, and for each of the
55 implementations, calls the given function I<fn> with the implementation method
56 and the given I<arg> as argument.
58 EVP_SIGNATURE_number() returns the internal dynamic number assigned to
61 EVP_SIGNATURE_names_do_all() traverses all names for I<signature>, and calls
62 I<fn> with each name and I<data>.
66 EVP_SIGNATURE_fetch() returns a pointer to an B<EVP_SIGNATURE> for success
67 or B<NULL> for failure.
69 EVP_SIGNATURE_up_ref() returns 1 for success or 0 otherwise.
73 L<provider(7)/Fetching algorithms>, L<OSSL_PROVIDER(3)>
77 The functions described here were added in OpenSSL 3.0.
81 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
83 Licensed under the Apache License 2.0 (the "License"). You may not use
84 this file except in compliance with the License. You can obtain a copy
85 in the file LICENSE in the source distribution or at
86 L<https://www.openssl.org/source/license.html>.