summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/lib/libcrypto/man/BIO_should_retry.371
1 files changed, 60 insertions, 11 deletions
diff --git a/src/lib/libcrypto/man/BIO_should_retry.3 b/src/lib/libcrypto/man/BIO_should_retry.3
index 4d7a214db6..9b93743516 100644
--- a/src/lib/libcrypto/man/BIO_should_retry.3
+++ b/src/lib/libcrypto/man/BIO_should_retry.3
@@ -1,8 +1,25 @@
1.\" $OpenBSD: BIO_should_retry.3,v 1.10 2022/11/27 19:11:11 schwarze Exp $ 1.\" $OpenBSD: BIO_should_retry.3,v 1.11 2023/04/30 14:03:47 schwarze Exp $
2.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400 2.\" full merge up to: OpenSSL 99d63d46 Oct 26 13:56:48 2016 -0400
3.\" selective merge up to: OpenSSL 57fd5170 May 13 11:24:11 2018 +0200 3.\" selective merge up to: OpenSSL 57fd5170 May 13 11:24:11 2018 +0200
4.\" 4.\"
5.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. 5.\" This file is a derived work.
6.\" The changes are covered by the following Copyright and license:
7.\"
8.\" Copyright (c) 2023 Ingo Schwarze <schwarze@openbsd.org>
9.\"
10.\" Permission to use, copy, modify, and distribute this software for any
11.\" purpose with or without fee is hereby granted, provided that the above
12.\" copyright notice and this permission notice appear in all copies.
13.\"
14.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
15.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
16.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
17.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
18.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
19.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
20.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21.\"
22.\" The original file was written by Dr. Stephen Henson <steve@openssl.org>.
6.\" Copyright (c) 2000, 2010, 2016 The OpenSSL Project. All rights reserved. 23.\" Copyright (c) 2000, 2010, 2016 The OpenSSL Project. All rights reserved.
7.\" 24.\"
8.\" Redistribution and use in source and binary forms, with or without 25.\" Redistribution and use in source and binary forms, with or without
@@ -49,7 +66,7 @@
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 66.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE. 67.\" OF THE POSSIBILITY OF SUCH DAMAGE.
51.\" 68.\"
52.Dd $Mdocdate: November 27 2022 $ 69.Dd $Mdocdate: April 30 2023 $
53.Dt BIO_SHOULD_RETRY 3 70.Dt BIO_SHOULD_RETRY 3
54.Os 71.Os
55.Sh NAME 72.Sh NAME
@@ -140,18 +157,50 @@ Current BIO types only set one of the flags at a time.
140.Pp 157.Pp
141.Fn BIO_get_retry_BIO 158.Fn BIO_get_retry_BIO
142determines the precise reason for the special condition. 159determines the precise reason for the special condition.
143It returns the BIO that caused this condition and if 160It walks the BIO chain starting at
161.Fa bio
162and returns the BIO that caused this condition.
163If there is no special condition,
164.Fa bio
165itself is returned.
166If
144.Fa reason 167.Fa reason
145is not 168is not a
146.Dv NULL 169.Dv NULL
147it contains the reason code. 170pointer,
148The meaning of the reason code and the action that should be taken 171.Pf * Fa reason
149depends on the type of BIO that resulted in this condition. 172is set to one of the following reason codes:
173.Bl -tag -width 1n -offset 3n
174.It 0
175There is no special condition.
176.It Dv BIO_RR_ACCEPT
177.Xr accept 2
178would have blocked.
179This can occur for BIOs created from
180.Xr BIO_s_accept 3
181or
182.Xr BIO_f_ssl 3 .
183.It Dv BIO_RR_CONNECT
184.Xr connect 2
185would have blocked.
186This can occur for BIOs created from
187.Xr BIO_s_connect 3
188or
189.Xr BIO_f_ssl 3 .
190.It Dv BIO_RR_SSL_X509_LOOKUP
191An application callback set by
192.Xr SSL_CTX_set_client_cert_cb 3
193has asked to be called again.
194This can occur for BIOs created from
195.Xr BIO_f_ssl 3 .
196.El
150.Pp 197.Pp
151.Fn BIO_get_retry_reason 198.Fn BIO_get_retry_reason
152returns the reason for a special condition 199returns one of the above reason codes for a special condition that occurred in
153if passed the relevant BIO, for example as returned by 200.Fa bio .
154.Fn BIO_get_retry_BIO . 201It does not walk the chain and returns 0 if no special condition occurred in
202.Fa bio
203itself.
155.Pp 204.Pp
156.Fn BIO_set_retry_reason 205.Fn BIO_set_retry_reason
157sets the retry reason for a special condition for the given 206sets the retry reason for a special condition for the given