5 EVP_ASYM_CIPHER_fetch, EVP_ASYM_CIPHER_free, EVP_ASYM_CIPHER_up_ref,
6 EVP_ASYM_CIPHER_number, EVP_ASYM_CIPHER_is_a, EVP_ASYM_CIPHER_provider,
7 EVP_ASYM_CIPHER_do_all_provided, EVP_ASYM_CIPHER_names_do_all
8 - Functions to manage EVP_ASYM_CIPHER algorithm objects
12 #include <openssl/evp.h>
14 EVP_ASYM_CIPHER *EVP_ASYM_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
15 const char *properties);
16 void EVP_ASYM_CIPHER_free(EVP_ASYM_CIPHER *cipher);
17 int EVP_ASYM_CIPHER_up_ref(EVP_ASYM_CIPHER *cipher);
18 int EVP_ASYM_CIPHER_number(const EVP_ASYM_CIPHER *cipher);
19 int EVP_ASYM_CIPHER_is_a(const EVP_ASYM_CIPHER *cipher, const char *name);
20 OSSL_PROVIDER *EVP_ASYM_CIPHER_provider(const EVP_ASYM_CIPHER *cipher);
21 void EVP_ASYM_CIPHER_do_all_provided(OPENSSL_CTX *libctx,
22 void (*fn)(EVP_ASYM_CIPHER *cipher,
25 void EVP_ASYM_CIPHER_names_do_all(const EVP_ASYM_CIPHER *cipher,
26 void (*fn)(const char *name, void *data),
31 EVP_ASYM_CIPHER_fetch() fetches the implementation for the given
32 B<algorithm> from any provider offering it, within the criteria given
33 by the B<properties> and in the scope of the given library context B<ctx> (see
34 L<OPENSSL_CTX(3)>). The algorithm will be one offering functions for performing
35 asymmetric cipher related tasks such as asymmetric encryption and decryption.
36 See L<provider(7)/Fetching algorithms> for further information.
38 The returned value must eventually be freed with EVP_ASYM_CIPHER_free().
40 EVP_ASYM_CIPHER_free() decrements the reference count for the B<EVP_ASYM_CIPHER>
41 structure. Typically this structure will have been obtained from an earlier call
42 to EVP_ASYM_CIPHER_fetch(). If the reference count drops to 0 then the
45 EVP_ASYM_CIPHER_up_ref() increments the reference count for an
46 B<EVP_ASYM_CIPHER> structure.
48 EVP_ASYM_CIPHER_is_a() returns 1 if I<cipher> is an implementation of an
49 algorithm that's identifiable with I<name>, otherwise 0.
51 EVP_ASYM_CIPHER_provider() returns the provider that I<cipher> was fetched from.
53 EVP_ASYM_CIPHER_do_all_provided() traverses all EVP_ASYM_CIPHERs implemented by
54 all activated providers in the given library context I<libctx>, and for each of
55 the implementations, calls the given function I<fn> with the implementation
56 method and the given I<arg> as argument.
58 EVP_ASYM_CIPHER_number() returns the internal dynamic number assigned to
61 EVP_ASYM_CIPHER_names_do_all() traverses all names for I<cipher>, and calls
62 I<fn> with each name and I<data>.
66 EVP_ASYM_CIPHER_fetch() returns a pointer to an B<EVP_ASYM_CIPHER> for success
67 or B<NULL> for failure.
69 EVP_ASYM_CIPHER_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>.