08e88da3123eeb31c084fda13488d4b7f196cc9c
[openssl.git] / doc / man3 / SSL_CTX_set_tmp_ecdh.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_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
20 SSL_CTX_set_tmp_ecdh() sets ECDH parameters to be used to be B<ecdh>.
21 The key is inherited by all B<ssl> objects created from B<ctx>.
22
23 SSL_set_tmp_ecdh() sets the parameters only for B<ssl>.
24
25 SSL_CTX_set_ecdh_auto() and SSL_set_ecdh_auto() are deprecated and
26 have no effect.
27
28 =head1 RETURN VALUES
29
30 SSL_CTX_set_tmp_ecdh() and SSL_set_tmp_ecdh() return 1 on success and 0
31 on failure.
32
33 =head1 SEE ALSO
34
35 L<ssl(7)>, L<SSL_CTX_set1_curves(3)>, L<SSL_CTX_set_cipher_list(3)>,
36 L<SSL_CTX_set_options(3)>, L<SSL_CTX_set_tmp_dh_callback(3)>,
37 L<ciphers(1)>, L<ecparam(1)>
38
39 =head1 COPYRIGHT
40
41 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
42
43 Licensed under the OpenSSL license (the "License").  You may not use
44 this file except in compliance with the License.  You can obtain a copy
45 in the file LICENSE in the source distribution or at
46 L<https://www.openssl.org/source/license.html>.
47
48 =cut