1EVP_KEM_FREE(3ossl)                 OpenSSL                EVP_KEM_FREE(3ossl)
2
3
4

NAME

6       EVP_KEM_fetch, EVP_KEM_free, EVP_KEM_up_ref, EVP_KEM_get0_name,
7       EVP_KEM_is_a, EVP_KEM_get0_provider, EVP_KEM_do_all_provided,
8       EVP_KEM_names_do_all, EVP_KEM_get0_description,
9       EVP_KEM_gettable_ctx_params, EVP_KEM_settable_ctx_params - Functions to
10       manage EVP_KEM algorithm objects
11

SYNOPSIS

13        #include <openssl/evp.h>
14
15        EVP_KEM *EVP_KEM_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
16                               const char *properties);
17        void EVP_KEM_free(EVP_KEM *kem);
18        int EVP_KEM_up_ref(EVP_KEM *kem);
19        const char *EVP_KEM_get0_name(const EVP_KEM *kem);
20        int EVP_KEM_is_a(const EVP_KEM *kem, const char *name);
21        OSSL_PROVIDER *EVP_KEM_get0_provider(const EVP_KEM *kem);
22        void EVP_KEM_do_all_provided(OSSL_LIB_CTX *libctx,
23                                     void (*fn)(EVP_KEM *kem, void *arg), void *arg);
24        int EVP_KEM_names_do_all(const EVP_KEM *kem,
25                                 void (*fn)(const char *name, void *data), void *data);
26        const char *EVP_KEM_get0_description(const EVP_KEM *kem);
27        const OSSL_PARAM *EVP_KEM_gettable_ctx_params(const EVP_KEM *kem);
28        const OSSL_PARAM *EVP_KEM_settable_ctx_params(const EVP_KEM *kem);
29

DESCRIPTION

31       EVP_KEM_fetch() fetches the implementation for the given algorithm from
32       any provider offering it, within the criteria given by the properties
33       and in the scope of the given library context ctx (see
34       OSSL_LIB_CTX(3)). The algorithm will be one offering functions for
35       performing asymmetric kem related tasks such as key encapsulation and
36       decapsulation.  See "ALGORITHM FETCHING" in crypto(7) for further
37       information.
38
39       The returned value must eventually be freed with EVP_KEM_free().
40
41       EVP_KEM_free() decrements the reference count for the EVP_KEM
42       structure.  Typically this structure will have been obtained from an
43       earlier call to EVP_KEM_fetch(). If the reference count drops to 0 then
44       the structure is freed.
45
46       EVP_KEM_up_ref() increments the reference count for an EVP_KEM
47       structure.
48
49       EVP_KEM_is_a() returns 1 if kem is an implementation of an algorithm
50       that's identifiable with name, otherwise 0.
51
52       EVP_KEM_get0_provider() returns the provider that kem was fetched from.
53
54       EVP_KEM_do_all_provided() traverses all EVP_KEMs implemented by all
55       activated providers in the given library context libctx, and for each
56       of the implementations, calls the given function fn with the
57       implementation method and the given arg as argument.
58
59       EVP_KEM_get0_name() returns the algorithm name from the provided
60       implementation for the given kem. Note that the kem may have multiple
61       synonyms associated with it. In this case the first name from the
62       algorithm definition is returned. Ownership of the returned string is
63       retained by the kem object and should not be freed by the caller.
64
65       EVP_KEM_names_do_all() traverses all names for kem, and calls fn with
66       each name and data.
67
68       EVP_KEM_get0_description() returns a description of the kem, meant for
69       display and human consumption.  The description is at the discretion of
70       the kem implementation.
71
72       EVP_KEM_gettable_ctx_params() and EVP_KEM_settable_ctx_params() return
73       a constant OSSL_PARAM(3) array that describes the names and types of
74       key parameters that can be retrieved or set by a key encapsulation
75       algorithm using EVP_PKEY_CTX_get_params(3) and
76       EVP_PKEY_CTX_set_params(3).
77

RETURN VALUES

79       EVP_KEM_fetch() returns a pointer to an EVP_KEM for success or NULL for
80       failure.
81
82       EVP_KEM_up_ref() returns 1 for success or 0 otherwise.
83
84       EVP_KEM_names_do_all() returns 1 if the callback was called for all
85       names. A return value of 0 means that the callback was not called for
86       any names.
87
88       EVP_KEM_gettable_ctx_params() and EVP_KEM_settable_ctx_params() return
89       a constant OSSL_PARAM(3) array or NULL on error.
90

SEE ALSO

92       "ALGORITHM FETCHING" in crypto(7), OSSL_PROVIDER(3)
93

HISTORY

95       The functions described here were added in OpenSSL 3.0.
96

98       Copyright 2020-2022 The OpenSSL Project Authors. All Rights Reserved.
99
100       Licensed under the Apache License 2.0 (the "License").  You may not use
101       this file except in compliance with the License.  You can obtain a copy
102       in the file LICENSE in the source distribution or at
103       <https://www.openssl.org/source/license.html>.
104
105
106
1073.1.1                             2023-08-31               EVP_KEM_FREE(3ossl)
Impressum