summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorschwarze <>2023-04-29 12:01:53 +0000
committerschwarze <>2023-04-29 12:01:53 +0000
commit919808034f5d213600a83a03ff8482dbc0c15cf8 (patch)
treecc17a5c025f5d2b3cf6403b75ff932e8f50755eb /src
parentf6b66730a3c6c11a46d8cfb7d8e24644503149ae (diff)
downloadopenbsd-919808034f5d213600a83a03ff8482dbc0c15cf8.tar.gz
openbsd-919808034f5d213600a83a03ff8482dbc0c15cf8.tar.bz2
openbsd-919808034f5d213600a83a03ff8482dbc0c15cf8.zip
Mention the type-specific BIO_ctrl(3) command constants
in the manual pages of the respective BIO type. While here, fix some wrong return types in the SYNOPSIS.
Diffstat (limited to 'src')
-rw-r--r--src/lib/libcrypto/man/BIO_f_cipher.321
-rw-r--r--src/lib/libcrypto/man/BIO_s_bio.335
2 files changed, 40 insertions, 16 deletions
diff --git a/src/lib/libcrypto/man/BIO_f_cipher.3 b/src/lib/libcrypto/man/BIO_f_cipher.3
index de9d88493e..c5d00c6981 100644
--- a/src/lib/libcrypto/man/BIO_f_cipher.3
+++ b/src/lib/libcrypto/man/BIO_f_cipher.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: BIO_f_cipher.3,v 1.15 2023/04/28 16:49:00 schwarze Exp $ 1.\" $OpenBSD: BIO_f_cipher.3,v 1.16 2023/04/29 12:01:53 schwarze Exp $
2.\" full merge up to: OpenSSL e9b77246 Jan 20 19:58:49 2017 +0100 2.\" full merge up to: OpenSSL e9b77246 Jan 20 19:58:49 2017 +0100
3.\" 3.\"
4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. 4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>.
@@ -49,7 +49,7 @@
49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" OF THE POSSIBILITY OF SUCH DAMAGE.
51.\" 51.\"
52.Dd $Mdocdate: April 28 2023 $ 52.Dd $Mdocdate: April 29 2023 $
53.Dt BIO_F_CIPHER 3 53.Dt BIO_F_CIPHER 3
54.Os 54.Os
55.Sh NAME 55.Sh NAME
@@ -74,11 +74,11 @@
74.Fa "unsigned char *iv" 74.Fa "unsigned char *iv"
75.Fa "int enc" 75.Fa "int enc"
76.Fc 76.Fc
77.Ft int 77.Ft long
78.Fo BIO_get_cipher_status 78.Fo BIO_get_cipher_status
79.Fa "BIO *b" 79.Fa "BIO *b"
80.Fc 80.Fc
81.Ft int 81.Ft long
82.Fo BIO_get_cipher_ctx 82.Fo BIO_get_cipher_ctx
83.Fa "BIO *b" 83.Fa "BIO *b"
84.Fa "EVP_CIPHER_CTX **pctx" 84.Fa "EVP_CIPHER_CTX **pctx"
@@ -159,6 +159,19 @@ or
159.Xr BIO_puts 3 159.Xr BIO_puts 3
160support is needed, then it can be achieved 160support is needed, then it can be achieved
161by preceding the cipher BIO with a buffering BIO. 161by preceding the cipher BIO with a buffering BIO.
162.Pp
163.Xr BIO_ctrl 3
164.Fa cmd
165arguments correspond to macros as follows:
166.Bl -column BIO_C_GET_CIPHER_STATUS BIO_get_cipher_status() -offset 3n
167.It Fa cmd No constant Ta corresponding macro
168.It Dv BIO_C_GET_CIPHER_CTX Ta Fn BIO_get_cipher_ctx
169.It Dv BIO_C_GET_CIPHER_STATUS Ta Fn BIO_get_cipher_status
170.It Dv BIO_CTRL_FLUSH Ta Xr BIO_flush 3
171.It Dv BIO_CTRL_PENDING Ta Xr BIO_pending 3
172.It Dv BIO_CTRL_RESET Ta Xr BIO_reset 3
173.It Dv BIO_CTRL_WPENDING Ta Xr BIO_wpending 3
174.El
162.Sh RETURN VALUES 175.Sh RETURN VALUES
163.Fn BIO_f_cipher 176.Fn BIO_f_cipher
164returns the cipher BIO method. 177returns the cipher BIO method.
diff --git a/src/lib/libcrypto/man/BIO_s_bio.3 b/src/lib/libcrypto/man/BIO_s_bio.3
index faa6adfe3a..b3e6c3d32c 100644
--- a/src/lib/libcrypto/man/BIO_s_bio.3
+++ b/src/lib/libcrypto/man/BIO_s_bio.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: BIO_s_bio.3,v 1.18 2023/04/28 16:49:00 schwarze Exp $ 1.\" $OpenBSD: BIO_s_bio.3,v 1.19 2023/04/29 12:01:53 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.\" 3.\"
4.\" This file was written by 4.\" This file was written by
@@ -53,7 +53,7 @@
53.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 53.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
54.\" OF THE POSSIBILITY OF SUCH DAMAGE. 54.\" OF THE POSSIBILITY OF SUCH DAMAGE.
55.\" 55.\"
56.Dd $Mdocdate: April 28 2023 $ 56.Dd $Mdocdate: April 29 2023 $
57.Dt BIO_S_BIO 3 57.Dt BIO_S_BIO 3
58.Os 58.Os
59.Sh NAME 59.Sh NAME
@@ -116,7 +116,7 @@
116.Fa "BIO **bio2" 116.Fa "BIO **bio2"
117.Fa "size_t writebuf2" 117.Fa "size_t writebuf2"
118.Fc 118.Fc
119.Ft size_t 119.Ft int
120.Fo BIO_get_write_guarantee 120.Fo BIO_get_write_guarantee
121.Fa "BIO *b" 121.Fa "BIO *b"
122.Fc 122.Fc
@@ -300,15 +300,26 @@ it will never succeed because the request was never sent.
300.Xr BIO_eof 3 300.Xr BIO_eof 3
301is true if no data is in the peer BIO and the peer BIO has been shutdown. 301is true if no data is in the peer BIO and the peer BIO has been shutdown.
302.Pp 302.Pp
303.Fn BIO_make_bio_pair , 303.Xr BIO_ctrl 3
304.Fn BIO_destroy_bio_pair , 304.Fa cmd
305.Fn BIO_shutdown_wr , 305arguments correspond to macros as follows:
306.Fn BIO_set_write_buf_size , 306.Bl -column BIO_C_GET_WRITE_GUARANTEE BIO_ctrl_reset_read_request() -offset 3n
307.Fn BIO_get_write_buf_size , 307.It Fa cmd No constant Ta corresponding macro
308.Fn BIO_get_write_guarantee , 308.It Dv BIO_C_DESTROY_BIO_PAIR Ta Fn BIO_destroy_bio_pair
309and 309.It Dv BIO_C_GET_READ_REQUEST Ta Fn BIO_get_read_request
310.Fn BIO_get_read_request 310.It Dv BIO_C_GET_WRITE_BUF_SIZE Ta Fn BIO_get_write_buf_size
311are implemented as macros. 311.It Dv BIO_C_GET_WRITE_GUARANTEE Ta Fn BIO_get_write_guarantee
312.It Dv BIO_C_MAKE_BIO_PAIR Ta Fn BIO_make_bio_pair
313.It Dv BIO_C_RESET_READ_REQUEST Ta Fn BIO_ctrl_reset_read_request
314.It Dv BIO_C_SET_WRITE_BUF_SIZE Ta Fn BIO_set_write_buf_size
315.It Dv BIO_C_SHUTDOWN_WR Ta Fn BIO_shutdown_wr
316.It Dv BIO_CTRL_EOF Ta Xr BIO_eof 3
317.It Dv BIO_CTRL_GET_CLOSE Ta Xr BIO_get_close 3
318.It Dv BIO_CTRL_PENDING Ta Xr BIO_pending 3
319.It Dv BIO_CTRL_RESET Ta Xr BIO_reset 3
320.It Dv BIO_CTRL_SET_CLOSE Ta Xr BIO_set_close 3
321.It Dv BIO_CTRL_WPENDING Ta Xr BIO_wpending 3
322.El
312.Sh RETURN VALUES 323.Sh RETURN VALUES
313.Fn BIO_new_bio_pair 324.Fn BIO_new_bio_pair
314returns 1 on success, with the new BIOs available in 325returns 1 on success, with the new BIOs available in