update libressl to v2.7.4
[unleashed.git] / lib / libssl / man / SSL_CTX_set_tmp_rsa_callback.3
blobab32d41d97225d250fdf717ff100105e81eaa85c
1 .\"     $OpenBSD: SSL_CTX_set_tmp_rsa_callback.3,v 1.7 2018/03/24 00:55:37 schwarze Exp $
2 .\"     OpenSSL 0b30fc90 Dec 19 15:23:05 2013 -0500
3 .\"
4 .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
5 .\" Copyright (c) 2001, 2006, 2013 The OpenSSL Project.  All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\"
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\"    notice, this list of conditions and the following disclaimer.
13 .\"
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in
16 .\"    the documentation and/or other materials provided with the
17 .\"    distribution.
18 .\"
19 .\" 3. All advertising materials mentioning features or use of this
20 .\"    software must display the following acknowledgment:
21 .\"    "This product includes software developed by the OpenSSL Project
22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23 .\"
24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25 .\"    endorse or promote products derived from this software without
26 .\"    prior written permission. For written permission, please contact
27 .\"    openssl-core@openssl.org.
28 .\"
29 .\" 5. Products derived from this software may not be called "OpenSSL"
30 .\"    nor may "OpenSSL" appear in their names without prior written
31 .\"    permission of the OpenSSL Project.
32 .\"
33 .\" 6. Redistributions of any form whatsoever must retain the following
34 .\"    acknowledgment:
35 .\"    "This product includes software developed by the OpenSSL Project
36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37 .\"
38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
50 .\"
51 .Dd $Mdocdate: March 24 2018 $
52 .Dt SSL_CTX_SET_TMP_RSA_CALLBACK 3
53 .Os
54 .Sh NAME
55 .Nm SSL_CTX_set_tmp_rsa_callback ,
56 .Nm SSL_CTX_set_tmp_rsa ,
57 .Nm SSL_CTX_need_tmp_RSA ,
58 .Nm SSL_set_tmp_rsa_callback ,
59 .Nm SSL_set_tmp_rsa ,
60 .Nm SSL_need_tmp_RSA
61 .Nd handle RSA keys for ephemeral key exchange
62 .Sh SYNOPSIS
63 .In openssl/ssl.h
64 .Ft void
65 .Fo SSL_CTX_set_tmp_rsa_callback
66 .Fa "SSL_CTX *ctx"
67 .Fa "RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength)"
68 .Fc
69 .Ft long
70 .Fn SSL_CTX_set_tmp_rsa "SSL_CTX *ctx" "RSA *rsa"
71 .Ft long
72 .Fn SSL_CTX_need_tmp_RSA "SSL_CTX *ctx"
73 .Ft void
74 .Fo SSL_set_tmp_rsa_callback
75 .Fa "SSL_CTX *ctx"
76 .Fa "RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength)"
77 .Fc
78 .Ft long
79 .Fn SSL_set_tmp_rsa "SSL *ssl" "RSA *rsa"
80 .Ft long
81 .Fn SSL_need_tmp_RSA "SSL *ssl"
82 .Sh DESCRIPTION
83 Since they mattered only for deliberately insecure RSA authentication
84 mandated by historical U.S. export restrictions, these functions
85 are all deprecated and have no effect except that
86 .Fn SSL_CTX_set_tmp_rsa_callback ,
87 .Fn SSL_CTX_set_tmp_rsa ,
88 .Fn SSL_set_tmp_rsa_callback ,
89 and
90 .Fn SSL_set_tmp_rsa
91 issue error messages when called.
92 .Sh RETURN VALUES
93 These functions always return 0, indicating failure.
94 .Sh SEE ALSO
95 .Xr ssl 3 ,
96 .Xr SSL_CTX_set_cipher_list 3 ,
97 .Xr SSL_CTX_set_options 3 ,
98 .Xr SSL_CTX_set_tmp_dh_callback 3 ,
99 .Xr SSL_new 3 ,
100 .Xr SSL_set_tmp_ecdh 3
101 .Sh HISTORY
102 .Fn SSL_CTX_set_tmp_rsa_callback ,
103 .Fn SSL_CTX_set_tmp_rsa ,
105 .Fn SSL_CTX_need_tmp_RSA
106 appeared before SSLeay 0.8 and have been available since
107 .Ox 2.4 .
109 .Fn SSL_set_tmp_rsa_callback
110 .Fn SSL_set_tmp_rsa ,
112 .Fn SSL_need_tmp_RSA
113 first appeared in OpenSSL 0.9.2b and have been available since
114 .Ox 2.6 .