mirror of https://github.com/openssl/openssl.git
107 lines
4.2 KiB
Plaintext
107 lines
4.2 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
EVP_KEM_fetch, EVP_KEM_free, EVP_KEM_up_ref,
|
|
EVP_KEM_get0_name, EVP_KEM_is_a, EVP_KEM_get0_provider,
|
|
EVP_KEM_do_all_provided, EVP_KEM_names_do_all, EVP_KEM_get0_description,
|
|
EVP_KEM_gettable_ctx_params, EVP_KEM_settable_ctx_params
|
|
- Functions to manage EVP_KEM algorithm objects
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/evp.h>
|
|
|
|
EVP_KEM *EVP_KEM_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
|
|
const char *properties);
|
|
void EVP_KEM_free(EVP_KEM *kem);
|
|
int EVP_KEM_up_ref(EVP_KEM *kem);
|
|
const char *EVP_KEM_get0_name(const EVP_KEM *kem);
|
|
int EVP_KEM_is_a(const EVP_KEM *kem, const char *name);
|
|
OSSL_PROVIDER *EVP_KEM_get0_provider(const EVP_KEM *kem);
|
|
void EVP_KEM_do_all_provided(OSSL_LIB_CTX *libctx,
|
|
void (*fn)(EVP_KEM *kem, void *arg), void *arg);
|
|
int EVP_KEM_names_do_all(const EVP_KEM *kem,
|
|
void (*fn)(const char *name, void *data), void *data);
|
|
const char *EVP_KEM_get0_description(const EVP_KEM *kem);
|
|
const OSSL_PARAM *EVP_KEM_gettable_ctx_params(const EVP_KEM *kem);
|
|
const OSSL_PARAM *EVP_KEM_settable_ctx_params(const EVP_KEM *kem);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
EVP_KEM_fetch() fetches the implementation for the given B<algorithm> from any
|
|
provider offering it, within the criteria given by the B<properties> and in the
|
|
scope of the given library context B<ctx> (see L<OSSL_LIB_CTX(3)>). The algorithm
|
|
will be one offering functions for performing asymmetric kem related tasks such
|
|
as key encapsulation and decapsulation.
|
|
See L<crypto(7)/ALGORITHM FETCHING> for further information.
|
|
|
|
The returned value must eventually be freed with EVP_KEM_free().
|
|
|
|
EVP_KEM_free() decrements the reference count for the B<EVP_KEM> structure.
|
|
Typically this structure will have been obtained from an earlier call to
|
|
EVP_KEM_fetch(). If the reference count drops to 0 then the structure is freed.
|
|
If the argument is NULL, nothing is done.
|
|
|
|
EVP_KEM_up_ref() increments the reference count for an B<EVP_KEM> structure.
|
|
|
|
EVP_KEM_is_a() returns 1 if I<kem> is an implementation of an
|
|
algorithm that's identifiable with I<name>, otherwise 0.
|
|
|
|
EVP_KEM_get0_provider() returns the provider that I<kem> was fetched from.
|
|
|
|
EVP_KEM_do_all_provided() traverses all EVP_KEMs implemented by all activated
|
|
providers in the given library context I<libctx>, and for each of the
|
|
implementations, calls the given function I<fn> with the implementation method
|
|
and the given I<arg> as argument.
|
|
|
|
EVP_KEM_get0_name() returns the algorithm name from the provided
|
|
implementation for the given I<kem>. Note that the I<kem> may have
|
|
multiple synonyms associated with it. In this case the first name from the
|
|
algorithm definition is returned. Ownership of the returned string is retained
|
|
by the I<kem> object and should not be freed by the caller.
|
|
|
|
EVP_KEM_names_do_all() traverses all names for I<kem>, and calls I<fn> with
|
|
each name and I<data>.
|
|
|
|
EVP_KEM_get0_description() returns a description of the I<kem>, meant for
|
|
display and human consumption. The description is at the discretion of
|
|
the I<kem> implementation.
|
|
|
|
EVP_KEM_gettable_ctx_params() and EVP_KEM_settable_ctx_params() return
|
|
a constant L<OSSL_PARAM(3)> array that describes the names and types of key
|
|
parameters that can be retrieved or set by a key encapsulation algorithm using
|
|
L<EVP_PKEY_CTX_get_params(3)> and L<EVP_PKEY_CTX_set_params(3)>.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
EVP_KEM_fetch() returns a pointer to an B<EVP_KEM> for success or B<NULL> for
|
|
failure.
|
|
|
|
EVP_KEM_up_ref() returns 1 for success or 0 otherwise.
|
|
|
|
EVP_KEM_names_do_all() returns 1 if the callback was called for all names. A
|
|
return value of 0 means that the callback was not called for any names.
|
|
|
|
EVP_KEM_gettable_ctx_params() and EVP_KEM_settable_ctx_params() return
|
|
a constant L<OSSL_PARAM(3)> array or NULL on error.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<crypto(7)/ALGORITHM FETCHING>, L<OSSL_PROVIDER(3)>
|
|
|
|
=head1 HISTORY
|
|
|
|
The functions described here were added in OpenSSL 3.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2020-2024 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|