From: Neil Horman <nhorman@openssl.org>
Date: Thu, 9 Jan 2025 13:27:58 +0000 (-0500)
Subject: Add docs for new callback registration
X-Git-Tag: openssl-3.5.0-alpha1~265
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=016ddac4dac8655ea6992022606ba75e2162d60f;p=thirdparty%2Fopenssl.git

Add docs for new callback registration

Add docs for SSL_CTX_set_new_pending_ssl_cb

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Saša Nedvědický <sashan@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/26361)
---

diff --git a/doc/build.info b/doc/build.info
index 2b40cfc77f3..8fa78afb772 100644
--- a/doc/build.info
+++ b/doc/build.info
@@ -2339,6 +2339,10 @@ DEPEND[html/man3/SSL_CTX_set_client_hello_cb.html]=man3/SSL_CTX_set_client_hello
 GENERATE[html/man3/SSL_CTX_set_client_hello_cb.html]=man3/SSL_CTX_set_client_hello_cb.pod
 DEPEND[man/man3/SSL_CTX_set_client_hello_cb.3]=man3/SSL_CTX_set_client_hello_cb.pod
 GENERATE[man/man3/SSL_CTX_set_client_hello_cb.3]=man3/SSL_CTX_set_client_hello_cb.pod
+DEPEND[html/man3/SSL_CTX_set_new_pending_ssl_cb.html]=man3/SSL_CTX_set_new_pending_ssl_cb.pod
+GENERATE[html/man3/SSL_CTX_set_new_pending_ssl_cb.html]=man3/SSL_CTX_set_new_pending_ssl_cb.pod
+DEPEND[man/man3/SSL_CTX_set_new_pending_ssl_cb.3]=man3/SSL_CTX_set_new_pending_ssl_cb.pod
+GENERATE[man/man3/SSL_CTX_set_new_pending_ssl_cb.3]=man3/SSL_CTX_set_new_pending_ssl_cb.pod
 DEPEND[html/man3/SSL_CTX_set_ct_validation_callback.html]=man3/SSL_CTX_set_ct_validation_callback.pod
 GENERATE[html/man3/SSL_CTX_set_ct_validation_callback.html]=man3/SSL_CTX_set_ct_validation_callback.pod
 DEPEND[man/man3/SSL_CTX_set_ct_validation_callback.3]=man3/SSL_CTX_set_ct_validation_callback.pod
diff --git a/doc/man3/SSL_CTX_set_new_pending_ssl_cb.pod b/doc/man3/SSL_CTX_set_new_pending_ssl_cb.pod
new file mode 100644
index 00000000000..e4433ed2e9c
--- /dev/null
+++ b/doc/man3/SSL_CTX_set_new_pending_ssl_cb.pod
@@ -0,0 +1,48 @@
+=pod
+
+=head1 NAME
+
+SSL_CTX_set_new_pending_ssl_cb - callback function to report creation of QUIC connection SSL objects 
+
+=head1 SYNOPSIS
+
+ typedef int (*SSL_set_new_pending_ssl_cb_fn)(SSL_CTX *c, SSL *new_ssl,
+                                               void *arg);
+ void SSL_CTX_set_new_pending_ssl_cb(SSL_CTX *c,
+                                     SSL_set_new_pending_ssl_cb_fn *f,
+                                     void *arg);
+
+=head1 DESCRIPTION
+
+SSL_CTX_set_new_pending_ssl_cb() sets the new_pending_ssl callback function and
+associated application data argument I<arg>.  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, B<SSL> objects
+representing the connection may be allocated and initialized prior to a call to
+SSL_accept_connection().
+
+=head1 RETURN VALUES
+
+SSL_CTX_set_new_pending_ssl_cb() returns no value.
+
+SSL_set_new_pending_ssl_cb_fn() must return an integer value.  A return value of
+0 indicates that the QUIC stack should discard this newly created B<SSL> object,
+implying that the associated new connection will not be available for handling
+on a subsequent call to SSL_accept_connection().  Any other non-zero return
+value is treated as success, allowing the new connection to be enqueued to the
+accept queue.
+
+=head1 HISTORY
+
+SSL_CTX_set_new_pending_ssl_cb() was added in OpenSSL 3.5.0
+
+=head1 COPYRIGHT
+
+Copyright 2024 The OpenSSL Project Authors. All Rights Reserved.
+
+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
+L<https://www.openssl.org/source/license.html>.
+
+=cut