xref: /freebsd-src/crypto/openssl/doc/man3/SSL_CTX_set_tmp_ecdh.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre ProncherySSL_CTX_set_tmp_ecdh, SSL_set_tmp_ecdh, SSL_CTX_set_ecdh_auto, SSL_set_ecdh_auto
6*b077aed3SPierre Pronchery- handle ECDH keys for ephemeral key exchange
7*b077aed3SPierre Pronchery
8*b077aed3SPierre Pronchery=head1 SYNOPSIS
9*b077aed3SPierre Pronchery
10*b077aed3SPierre Pronchery #include <openssl/ssl.h>
11*b077aed3SPierre Pronchery
12*b077aed3SPierre Pronchery long SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ecdh);
13*b077aed3SPierre Pronchery long SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ecdh);
14*b077aed3SPierre Pronchery
15*b077aed3SPierre Pronchery long SSL_CTX_set_ecdh_auto(SSL_CTX *ctx, int state);
16*b077aed3SPierre Pronchery long SSL_set_ecdh_auto(SSL *ssl, int state);
17*b077aed3SPierre Pronchery
18*b077aed3SPierre Pronchery=head1 DESCRIPTION
19*b077aed3SPierre Pronchery
20*b077aed3SPierre ProncherySSL_CTX_set_tmp_ecdh() sets ECDH parameters to be used to be B<ecdh>.
21*b077aed3SPierre ProncheryThe key is inherited by all B<ssl> objects created from B<ctx>.
22*b077aed3SPierre ProncheryThis macro is deprecated in favor of L<SSL_CTX_set1_groups(3)>.
23*b077aed3SPierre Pronchery
24*b077aed3SPierre ProncherySSL_set_tmp_ecdh() sets the parameters only for B<ssl>.
25*b077aed3SPierre ProncheryThis macro is deprecated in favor of L<SSL_set1_groups(3)>.
26*b077aed3SPierre Pronchery
27*b077aed3SPierre ProncherySSL_CTX_set_ecdh_auto() and SSL_set_ecdh_auto() are deprecated and
28*b077aed3SPierre Proncheryhave no effect.
29*b077aed3SPierre Pronchery
30*b077aed3SPierre Pronchery=head1 RETURN VALUES
31*b077aed3SPierre Pronchery
32*b077aed3SPierre ProncherySSL_CTX_set_tmp_ecdh() and SSL_set_tmp_ecdh() return 1 on success and 0
33*b077aed3SPierre Proncheryon failure.
34*b077aed3SPierre Pronchery
35*b077aed3SPierre Pronchery=head1 SEE ALSO
36*b077aed3SPierre Pronchery
37*b077aed3SPierre ProncheryL<ssl(7)>, L<SSL_CTX_set1_curves(3)>, L<SSL_CTX_set_cipher_list(3)>,
38*b077aed3SPierre ProncheryL<SSL_CTX_set_options(3)>, L<SSL_CTX_set_tmp_dh_callback(3)>,
39*b077aed3SPierre ProncheryL<openssl-ciphers(1)>, L<openssl-ecparam(1)>
40*b077aed3SPierre Pronchery
41*b077aed3SPierre Pronchery=head1 COPYRIGHT
42*b077aed3SPierre Pronchery
43*b077aed3SPierre ProncheryCopyright 2018 The OpenSSL Project Authors. All Rights Reserved.
44*b077aed3SPierre Pronchery
45*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
46*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
47*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
48*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
49*b077aed3SPierre Pronchery
50*b077aed3SPierre Pronchery=cut
51