jcs.org
jcs's openbsd hax
openbsd
1.\" $OpenBSD: SSL_CTX_ctrl.3,v 1.8 2025/06/08 22:52:00 schwarze Exp $
2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
3.\"
4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
5.\" Copyright (c) 2001 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: June 8 2025 $
52.Dt SSL_CTX_CTRL 3
53.Os
54.Sh NAME
55.Nm SSL_CTX_ctrl ,
56.Nm SSL_CTX_callback_ctrl ,
57.Nm SSL_ctrl ,
58.Nm SSL_callback_ctrl
59.Nd internal handling functions for SSL_CTX and SSL objects
60.Sh SYNOPSIS
61.Lb libssl libcrypto
62.In openssl/ssl.h
63.Ft long
64.Fn SSL_CTX_ctrl "SSL_CTX *ctx" "int cmd" "long larg" "void *parg"
65.Ft long
66.Fn SSL_CTX_callback_ctrl "SSL_CTX *" "int cmd" "void (*fp)()"
67.Ft long
68.Fn SSL_ctrl "SSL *ssl" "int cmd" "long larg" "void *parg"
69.Ft long
70.Fn SSL_callback_ctrl "SSL *" "int cmd" "void (*fp)()"
71.Sh DESCRIPTION
72The
73.Fn SSL_*_ctrl
74family of functions is used to manipulate settings of
75the
76.Vt SSL_CTX
77and
78.Vt SSL
79objects.
80Depending on the command
81.Fa cmd
82the arguments
83.Fa larg ,
84.Fa parg ,
85or
86.Fa fp
87are evaluated.
88These functions should never be called directly.
89All functionalities needed are made available via other functions or macros.
90.Sh RETURN VALUES
91The return values of the
92.Fn SSL*_ctrl
93functions depend on the command supplied via the
94.Fn cmd
95parameter.
96.Sh SEE ALSO
97.Xr ssl 3 ,
98.Xr SSL_CTX_add_extra_chain_cert 3 ,
99.Xr SSL_CTX_sess_number 3 ,
100.Xr SSL_CTX_sess_set_cache_size 3 ,
101.Xr SSL_CTX_set_max_cert_list 3 ,
102.Xr SSL_CTX_set_mode 3 ,
103.Xr SSL_CTX_set_options 3 ,
104.Xr SSL_CTX_set_session_cache_mode 3 ,
105.Xr SSL_CTX_set_tlsext_servername_callback 3 ,
106.Xr SSL_CTX_set_tlsext_status_cb 3 ,
107.Xr SSL_CTX_set_tlsext_ticket_key_cb 3 ,
108.Xr SSL_get_server_tmp_key 3 ,
109.Xr SSL_num_renegotiations 3 ,
110.Xr SSL_session_reused 3 ,
111.Xr SSL_set_max_send_fragment 3
112.Sh HISTORY
113.Fn SSL_CTX_ctrl
114and
115.Fn SSL_ctrl
116first appeared in SSLeay 0.8.0 and have been available since
117.Ox 2.4 .
118.Pp
119.Fn SSL_CTX_callback_ctrl
120and
121.Fn SSL_callback_ctrl
122first appeared in OpenSSL 0.9.5 and have been available since
123.Ox 2.7 .