2019-06-28 16:50:56 +08:00
|
|
|
=pod
|
|
|
|
|
|
|
|
=head1 NAME
|
|
|
|
|
2019-07-18 18:24:55 +08:00
|
|
|
EVP_KEYEXCH_fetch, EVP_KEYEXCH_free, EVP_KEYEXCH_up_ref
|
2019-06-28 16:50:56 +08:00
|
|
|
- Functions to manage EVP_KEYEXCH algorithm objects
|
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
|
|
|
#include <openssl/evp.h>
|
|
|
|
|
2019-07-18 18:24:55 +08:00
|
|
|
EVP_KEYEXCH *EVP_KEYEXCH_fetch(OPENSSL_CTX *ctx, const char *algorithm,
|
|
|
|
const char *properties);
|
2019-06-28 16:50:56 +08:00
|
|
|
void EVP_KEYEXCH_free(EVP_KEYEXCH *exchange);
|
|
|
|
int EVP_KEYEXCH_up_ref(EVP_KEYEXCH *exchange);
|
|
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
2019-07-18 18:24:55 +08:00
|
|
|
EVP_KEYEXCH_fetch() fetches the key exchange implementation for the given
|
|
|
|
B<algorithm> from any provider offering it, within the criteria given
|
|
|
|
by the B<properties>.
|
|
|
|
See L<provider(7)/Fetching algorithms> for further information.
|
|
|
|
|
|
|
|
The returned value must eventually be freed with EVP_KEYEXCH_free().
|
|
|
|
|
2019-06-28 16:50:56 +08:00
|
|
|
EVP_KEYEXCH_free() decrements the reference count for the B<EVP_KEYEXCH>
|
|
|
|
structure. Typically this structure will have been obtained from an earlier call
|
2019-07-18 18:24:55 +08:00
|
|
|
to EVP_KEYEXCH_fetch(). If the reference count drops to 0 then the
|
2019-06-28 16:50:56 +08:00
|
|
|
structure is freed.
|
|
|
|
|
|
|
|
EVP_KEYEXCH_up_ref() increments the reference count for an B<EVP_KEYEXCH>
|
|
|
|
structure.
|
|
|
|
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
|
2019-07-18 18:24:55 +08:00
|
|
|
EVP_KEYEXCH_fetch() returns a pointer to a B<EVP_KEYEXCH> for success
|
|
|
|
or B<NULL> for failure.
|
|
|
|
|
2019-06-28 16:50:56 +08:00
|
|
|
EVP_KEYEXCH_up_ref() returns 1 for success or 0 otherwise.
|
|
|
|
|
|
|
|
=head1 SEE ALSO
|
|
|
|
|
2019-07-18 18:24:55 +08:00
|
|
|
L<provider(7)/Fetching algorithms>
|
2019-06-28 16:50:56 +08:00
|
|
|
|
|
|
|
=head1 HISTORY
|
|
|
|
|
|
|
|
The functions described here were added in OpenSSL 3.0.
|
|
|
|
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
|
|
|
|
Copyright 2019 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
|