diff options
author | Hugo Landau <hlandau@openssl.org> | 2023-05-08 19:52:45 +0100 |
---|---|---|
committer | Hugo Landau <hlandau@openssl.org> | 2023-05-12 14:47:15 +0100 |
commit | 83df44ae53c3c3bb1e79785af38ab52bb4f865cb (patch) | |
tree | bd14faf149ba8be864620b4d80bb9f9c776d0a13 /doc | |
parent | bb9b8a333ffaf998e60016819ee1e8c2da58f0fd (diff) |
QUIC MSST: Rename SSL_set_incoming_stream_reject_policy
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20765)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/build.info | 12 | ||||
-rw-r--r-- | doc/man3/SSL_accept_stream.pod | 4 | ||||
-rw-r--r-- | doc/man3/SSL_attach_stream.pod | 6 | ||||
-rw-r--r-- | doc/man3/SSL_set_incoming_stream_policy.pod (renamed from doc/man3/SSL_set_incoming_stream_reject_policy.pod) | 24 |
4 files changed, 23 insertions, 23 deletions
diff --git a/doc/build.info b/doc/build.info index a82221a9fa..e501b455b9 100644 --- a/doc/build.info +++ b/doc/build.info @@ -2683,10 +2683,10 @@ DEPEND[html/man3/SSL_set_fd.html]=man3/SSL_set_fd.pod GENERATE[html/man3/SSL_set_fd.html]=man3/SSL_set_fd.pod DEPEND[man/man3/SSL_set_fd.3]=man3/SSL_set_fd.pod GENERATE[man/man3/SSL_set_fd.3]=man3/SSL_set_fd.pod -DEPEND[html/man3/SSL_set_incoming_stream_reject_policy.html]=man3/SSL_set_incoming_stream_reject_policy.pod -GENERATE[html/man3/SSL_set_incoming_stream_reject_policy.html]=man3/SSL_set_incoming_stream_reject_policy.pod -DEPEND[man/man3/SSL_set_incoming_stream_reject_policy.3]=man3/SSL_set_incoming_stream_reject_policy.pod -GENERATE[man/man3/SSL_set_incoming_stream_reject_policy.3]=man3/SSL_set_incoming_stream_reject_policy.pod +DEPEND[html/man3/SSL_set_incoming_stream_policy.html]=man3/SSL_set_incoming_stream_policy.pod +GENERATE[html/man3/SSL_set_incoming_stream_policy.html]=man3/SSL_set_incoming_stream_policy.pod +DEPEND[man/man3/SSL_set_incoming_stream_policy.3]=man3/SSL_set_incoming_stream_policy.pod +GENERATE[man/man3/SSL_set_incoming_stream_policy.3]=man3/SSL_set_incoming_stream_policy.pod DEPEND[html/man3/SSL_set_initial_peer_addr.html]=man3/SSL_set_initial_peer_addr.pod GENERATE[html/man3/SSL_set_initial_peer_addr.html]=man3/SSL_set_initial_peer_addr.pod DEPEND[man/man3/SSL_set_initial_peer_addr.3]=man3/SSL_set_initial_peer_addr.pod @@ -3562,7 +3562,7 @@ html/man3/SSL_set_bio.html \ html/man3/SSL_set_blocking_mode.html \ html/man3/SSL_set_connect_state.html \ html/man3/SSL_set_fd.html \ -html/man3/SSL_set_incoming_stream_reject_policy.html \ +html/man3/SSL_set_incoming_stream_policy.html \ html/man3/SSL_set_initial_peer_addr.html \ html/man3/SSL_set_retry_verify.html \ html/man3/SSL_set_session.html \ @@ -4197,7 +4197,7 @@ man/man3/SSL_set_bio.3 \ man/man3/SSL_set_blocking_mode.3 \ man/man3/SSL_set_connect_state.3 \ man/man3/SSL_set_fd.3 \ -man/man3/SSL_set_incoming_stream_reject_policy.3 \ +man/man3/SSL_set_incoming_stream_policy.3 \ man/man3/SSL_set_initial_peer_addr.3 \ man/man3/SSL_set_retry_verify.3 \ man/man3/SSL_set_session.3 \ diff --git a/doc/man3/SSL_accept_stream.pod b/doc/man3/SSL_accept_stream.pod index e72af899b3..d2a0644561 100644 --- a/doc/man3/SSL_accept_stream.pod +++ b/doc/man3/SSL_accept_stream.pod @@ -44,8 +44,8 @@ TODO(QUIC): Revise in MSMT PR to mention threading considerations. =end comment Depending on whether default stream functionality is being used, it may be -necessary to explicitly configure the incoming stream rejection policy before -streams can be accepted; see L<SSL_set_incoming_stream_reject_policy(3)>. +necessary to explicitly configure the incoming stream policy before streams can +be accepted; see L<SSL_set_incoming_stream_policy(3)>. =begin comment diff --git a/doc/man3/SSL_attach_stream.pod b/doc/man3/SSL_attach_stream.pod index 298000ac2e..60f6315070 100644 --- a/doc/man3/SSL_attach_stream.pod +++ b/doc/man3/SSL_attach_stream.pod @@ -129,8 +129,8 @@ object if the default stream mode is set to B<SSL_DEFAULT_STREAM_MODE_NONE>, or if the QUIC connection SSL object previously had a default stream which was detached using SSL_detach_stream(). -L<SSL_set_incoming_stream_reject_policy(3)> interacts significantly with the -default stream functionality. +L<SSL_set_incoming_stream_policy(3)> interacts significantly with the default +stream functionality. =head1 RETURN VALUES @@ -153,7 +153,7 @@ object. =head1 SEE ALSO L<SSL_new_stream(3)>, L<SSL_accept_stream(3)>, L<SSL_free(3)>, -L<SSL_set_incoming_stream_reject_policy(3)> +L<SSL_set_incoming_stream_policy(3)> =head1 HISTORY diff --git a/doc/man3/SSL_set_incoming_stream_reject_policy.pod b/doc/man3/SSL_set_incoming_stream_policy.pod index dfc3dffb03..a89cbcfb94 100644 --- a/doc/man3/SSL_set_incoming_stream_reject_policy.pod +++ b/doc/man3/SSL_set_incoming_stream_policy.pod @@ -2,25 +2,25 @@ =head1 NAME -SSL_set_incoming_stream_reject_policy, SSL_INCOMING_STREAM_REJECT_POLICY_AUTO, -SSL_INCOMING_STREAM_REJECT_POLICY_ACCEPT, -SSL_INCOMING_STREAM_REJECT_POLICY_REJECT - manage the QUIC incoming stream +SSL_set_incoming_stream_policy, SSL_INCOMING_STREAM_POLICY_AUTO, +SSL_INCOMING_STREAM_POLICY_ACCEPT, +SSL_INCOMING_STREAM_POLICY_REJECT - manage the QUIC incoming stream rejection policy =head1 SYNOPSIS #include <openssl/ssl.h> - #define SSL_INCOMING_STREAM_REJECT_POLICY_AUTO - #define SSL_INCOMING_STREAM_REJECT_POLICY_ACCEPT - #define SSL_INCOMING_STREAM_REJECT_POLICY_REJECT + #define SSL_INCOMING_STREAM_POLICY_AUTO + #define SSL_INCOMING_STREAM_POLICY_ACCEPT + #define SSL_INCOMING_STREAM_POLICY_REJECT - int SSL_set_incoming_stream_reject_policy(SSL *conn, int policy, + int SSL_set_incoming_stream_policy(SSL *conn, int policy, uint64_t app_error_code); =head1 DESCRIPTION -SSL_set_incoming_stream_reject_policy() policy changes the incoming stream +SSL_set_incoming_stream_policy() policy changes the incoming stream rejection policy for a QUIC connection. Depending on the policy configured, OpenSSL QUIC may automatically reject incoming streams initiated by the peer. This is intended to ensure that legacy applications using single-stream @@ -36,7 +36,7 @@ The valid values for I<policy> are: =over 4 -=item SSL_INCOMING_STREAM_REJECT_POLICY_AUTO +=item SSL_INCOMING_STREAM_POLICY_AUTO This is the default setting. Incoming streams are accepted according to the following rules: @@ -64,12 +64,12 @@ accepted. =back -=item SSL_INCOMING_STREAM_REJECT_POLICY_ACCEPT +=item SSL_INCOMING_STREAM_POLICY_ACCEPT Always accept incoming streams, allowing them to be dequeued using L<SSL_accept_stream(3)>. -=item SSL_INCOMING_STREAM_REJECT_POLICY_REJECT +=item SSL_INCOMING_STREAM_POLICY_REJECT Always reject incoming streams. @@ -94,7 +94,7 @@ L<SSL_set_default_stream_mode(3)>, L<SSL_accept_stream(3)> =head1 HISTORY -SSL_set_incoming_stream_reject_policy() was added in OpenSSL 3.2. +SSL_set_incoming_stream_policy() was added in OpenSSL 3.2. =head1 COPYRIGHT |