Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_set_new_pending_conn_cb.3ssl

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