summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/SSL_CTX_set_new_pending_conn_cb.3
blob: 013f125948acaaf5337fe5dd79e4390017f37cfc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
.\"	$NetBSD: SSL_CTX_set_new_pending_conn_cb.3,v 1.5 2026/04/08 17:06:47 christos Exp $
.\"
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "SSL_CTX_set_new_pending_conn_cb 3"
.TH SSL_CTX_set_new_pending_conn_cb 3 2026-04-07 3.5.6 OpenSSL
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SSL_CTX_set_new_pending_conn_cb, SSL_set_new_pending_conn_cb_fn \- callback function to report creation of QUIC connection SSL objects
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\& typedef int (*SSL_set_new_pending_conn_cb_fn)(SSL_CTX *c, SSL *new_ssl,
\&                                               void *arg);
\& void SSL_CTX_set_new_pending_conn_cb(SSL_CTX *c,
\&                                     SSL_set_new_pending_conn_cb_fn *f,
\&                                     void *arg);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBSSL_CTX_set_new_pending_conn_cb()\fR sets the new_pending_conn callback function and
associated application data argument \fIarg\fR.  When using the QUIC transport, TLS
handshake processing may occur independently from the thread which accepts the
connection that the handshake is establishing.  As such, \fBSSL\fR objects
representing the connection may be allocated and initialized prior to a call to
\&\fBSSL_accept_connection()\fR.  This registered callback may be used to decorate the
preallocated \fBSSL\fR object or create other associations with its parent
\&\fBSSL\fR prior to a call to \fBSSL_accept_connection()\fR.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fBSSL_CTX_set_new_pending_conn_cb()\fR returns no value.
.PP
\&\fBSSL_set_new_pending_conn_cb_fn()\fR returns an integer value.  A return value of
0 indicates that the QUIC stack must discard this newly created \fBSSL\fR object,
implying that the associated new connection will not be available for handling
on a subsequent call to \fBSSL_accept_connection()\fR.  A nonzero return
value is treated as success, allowing the new connection to be enqueued to the
accept queue.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBSSL_set_ex_data\fR\|(3)
.SH NOTES
.IX Header "NOTES"
Callbacks in QUIC connections have some limitations to them that should be taken
into consideration when writing an application.
.Sp
.RS 4
QUIC connections may begin processing prior to when an application calls
\&\fBSSL_accept_connection()\fR on them.  As such, it may occur that callbacks are
delivered to applications\*(Aq registered TLS callbacks prior to those SSL objects
being returned in \fBSSL_accept_connection()\fR.  Applications should expect this
possibility.
.Sp
In particular no references should be held on SSL objects passed to callbacks
for QUIC connections until such time as they are returned through a call to
SSL_accept_connection.
.RE
.SH HISTORY
.IX Header "HISTORY"
\&\fBSSL_CTX_set_new_pending_conn_cb()\fR was added in OpenSSL 3.5
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2025 The OpenSSL Project Authors. All Rights Reserved.
.PP
Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.