mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-03-07 19:38:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for new callback registration

Browse Source 
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)
This commit is contained in:
Neil Horman 2025-01-09 08:27:58 -05:00
parent a477b4ec16
commit 016ddac4da
2 changed files with 52 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/build.info
View File

@ -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

48
doc/man3/SSL_CTX_set_new_pending_ssl_cb.pod Normal file
View File

@ -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