mirror of
https://github.com/openssl/openssl.git
synced 2024-12-15 06:01:37 +08:00
b425001010
Many of the new types introduced by OpenSSL 3.0 have an OSSL_ prefix, e.g., OSSL_CALLBACK, OSSL_PARAM, OSSL_ALGORITHM, OSSL_SERIALIZER. The OPENSSL_CTX type stands out a little by using a different prefix. For consistency reasons, this type is renamed to OSSL_LIB_CTX. Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/12621)
102 lines
3.7 KiB
Plaintext
102 lines
3.7 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
EVP_KEYEXCH_fetch, EVP_KEYEXCH_free, EVP_KEYEXCH_up_ref, EVP_KEYEXCH_provider,
|
|
EVP_KEYEXCH_is_a, EVP_KEYEXCH_do_all_provided,
|
|
EVP_KEYEXCH_number, EVP_KEYEXCH_names_do_all,
|
|
EVP_KEYEXCH_gettable_ctx_params, EVP_KEYEXCH_settable_ctx_params
|
|
- Functions to manage EVP_KEYEXCH algorithm objects
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/evp.h>
|
|
|
|
EVP_KEYEXCH *EVP_KEYEXCH_fetch(OSSL_LIB_CTX *ctx, const char *algorithm,
|
|
const char *properties);
|
|
void EVP_KEYEXCH_free(EVP_KEYEXCH *exchange);
|
|
int EVP_KEYEXCH_up_ref(EVP_KEYEXCH *exchange);
|
|
OSSL_PROVIDER *EVP_KEYEXCH_provider(const EVP_KEYEXCH *exchange);
|
|
int EVP_KEYEXCH_is_a(const EVP_KEYEXCH *exchange, const char *name);
|
|
int EVP_KEYEXCH_number(const EVP_KEYEXCH *exchange);
|
|
void EVP_KEYEXCH_do_all_provided(OSSL_LIB_CTX *libctx,
|
|
void (*fn)(EVP_KEYEXCH *exchange, void *arg),
|
|
void *arg);
|
|
void EVP_KEYEXCH_names_do_all(const EVP_KEYEXCH *exchange,
|
|
void (*fn)(const char *name, void *data),
|
|
void *data);
|
|
const OSSL_PARAM *EVP_KEYEXCH_gettable_ctx_params(const EVP_KEYEXCH *keyexch);
|
|
const OSSL_PARAM *EVP_KEYEXCH_settable_ctx_params(const EVP_KEYEXCH *keyexch);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
EVP_KEYEXCH_fetch() fetches the key exchange implementation for the given
|
|
I<algorithm> from any provider offering it, within the criteria given
|
|
by the I<properties>.
|
|
See L<provider(7)/Fetching algorithms> for further information.
|
|
|
|
The returned value must eventually be freed with EVP_KEYEXCH_free().
|
|
|
|
EVP_KEYEXCH_free() decrements the reference count for the B<EVP_KEYEXCH>
|
|
structure. Typically this structure will have been obtained from an earlier call
|
|
to EVP_KEYEXCH_fetch(). If the reference count drops to 0 then the
|
|
structure is freed.
|
|
|
|
EVP_KEYEXCH_up_ref() increments the reference count for an B<EVP_KEYEXCH>
|
|
structure.
|
|
|
|
EVP_KEYEXCH_provider() returns the provider that I<exchange> was fetched from.
|
|
|
|
EVP_KEYEXCH_is_a() checks if I<exchange> is an implementation of an
|
|
algorithm that's identifiable with I<name>.
|
|
|
|
EVP_KEYEXCH_number() returns the internal dynamic number assigned to
|
|
the I<exchange>.
|
|
|
|
EVP_KEYEXCH_names_do_all() traverses all names for the I<exchange>, and
|
|
calls I<fn> with each name and I<data>.
|
|
|
|
EVP_KEYEXCH_do_all_provided() traverses all key exchange implementations by
|
|
all activated providers in the library context I<libctx>, and for each
|
|
of the implementations, calls I<fn> with the implementation method and
|
|
I<data> as arguments.
|
|
|
|
EVP_KEYEXCH_gettable_ctx_params() and EVP_KEYEXCH_settable_ctx_params() return
|
|
a constant B<OSSL_PARAM> array that describes the names and types of key
|
|
parameters that can be retrieved or set by a key exchange algorithm using
|
|
L<EVP_PKEY_CTX_get_params(3)> and L<EVP_PKEY_CTX_set_params(3)>.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
EVP_KEYEXCH_fetch() returns a pointer to a B<EVP_KEYEXCH> for success
|
|
or NULL for failure.
|
|
|
|
EVP_KEYEXCH_up_ref() returns 1 for success or 0 otherwise.
|
|
|
|
EVP_KEYEXCH_is_a() returns 1 of I<exchange> was identifiable,
|
|
otherwise 0.
|
|
|
|
EVP_KEYEXCH_number() returns an integer.
|
|
|
|
EVP_KEYEXCH_gettable_ctx_params() and EVP_KEYEXCH_settable_ctx_params() return
|
|
a constant B<OSSL_PARAM> array or NULL on error.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<provider(7)/Fetching algorithms>, L<OSSL_PROVIDER(3)>
|
|
|
|
=head1 HISTORY
|
|
|
|
The functions described here were added in OpenSSL 3.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2019-2020 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
|