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