summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
authorschwarze <>2023-04-25 15:59:45 +0000
committerschwarze <>2023-04-25 15:59:45 +0000
commitd05ab2065f197a796d440b6d16c5a157ecfc3531 (patch)
treee3d66cd1db0149501ef62a6b8697c2853c7c38b1 /src/lib
parent3e0ee65ba3ad76b2e0c8dd558a7f75c44bf51f56 (diff)
downloadopenbsd-d05ab2065f197a796d440b6d16c5a157ecfc3531.tar.gz
openbsd-d05ab2065f197a796d440b6d16c5a157ecfc3531.tar.bz2
openbsd-d05ab2065f197a796d440b6d16c5a157ecfc3531.zip
Document most command constants.
They are part of the public API, may be needed for implementing custom BIO types, and application programmers need to avoid clashing with them.
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/libcrypto/man/BIO_ctrl.362
1 files changed, 60 insertions, 2 deletions
diff --git a/src/lib/libcrypto/man/BIO_ctrl.3 b/src/lib/libcrypto/man/BIO_ctrl.3
index 0c2ad2b737..845e2fa147 100644
--- a/src/lib/libcrypto/man/BIO_ctrl.3
+++ b/src/lib/libcrypto/man/BIO_ctrl.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: BIO_ctrl.3,v 1.18 2023/04/06 19:06:51 schwarze Exp $ 1.\" $OpenBSD: BIO_ctrl.3,v 1.19 2023/04/25 15:59:45 schwarze Exp $
2.\" full merge up to: OpenSSL 24a535eaf Tue Sep 22 13:14:20 2020 +0100 2.\" full merge up to: OpenSSL 24a535eaf Tue Sep 22 13:14:20 2020 +0100
3.\" selective merge up to: OpenSSL 0c5bc96f Tue Mar 15 13:57:22 2022 +0000 3.\" selective merge up to: OpenSSL 0c5bc96f Tue Mar 15 13:57:22 2022 +0000
4.\" 4.\"
@@ -66,7 +66,7 @@
66.\" 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
67.\" OF THE POSSIBILITY OF SUCH DAMAGE. 67.\" OF THE POSSIBILITY OF SUCH DAMAGE.
68.\" 68.\"
69.Dd $Mdocdate: April 6 2023 $ 69.Dd $Mdocdate: April 25 2023 $
70.Dt BIO_CTRL 3 70.Dt BIO_CTRL 3
71.Os 71.Os
72.Sh NAME 72.Sh NAME
@@ -349,6 +349,64 @@ The function type name
349is a deprecated synonym for 349is a deprecated synonym for
350.Vt BIO_info_cb 350.Vt BIO_info_cb
351provided for backward compatibility with some existing application software. 351provided for backward compatibility with some existing application software.
352.Pp
353The following
354.Fa cmd
355constants correspond to macros:
356.Bl -column BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT BIO_set_ssl_renegotiate_timeout(3)
357.It Dv BIO_C_DESTROY_BIO_PAIR Ta Xr BIO_destroy_bio_pair 3
358.It Dv BIO_C_DO_STATE_MACHINE Ta Xr BIO_do_handshake 3
359.It Dv BIO_C_FILE_SEEK Ta Fn BIO_seek
360.It Dv BIO_C_FILE_TELL Ta Fn BIO_tell
361.It Dv BIO_C_GET_ACCEPT Ta Xr BIO_get_accept_port 3
362.It Dv BIO_C_GET_BIND_MODE Ta Xr BIO_get_bind_mode 3
363.It Dv BIO_C_GET_BUF_MEM_PTR Ta Xr BIO_get_mem_ptr 3
364.It Dv BIO_C_GET_BUFF_NUM_LINES Ta Xr BIO_get_buffer_num_lines 3
365.It Dv BIO_C_GET_CIPHER_CTX Ta Xr BIO_get_cipher_ctx 3
366.It Dv BIO_C_GET_CIPHER_STATUS Ta Xr BIO_get_cipher_status 3
367.It Dv BIO_C_GET_FD Ta Xr BIO_get_fd 3
368.It Dv BIO_C_GET_FILE_PTR Ta Xr BIO_get_fp 3
369.It Dv BIO_C_GET_MD Ta Xr BIO_get_md 3
370.It Dv BIO_C_GET_MD_CTX Ta Xr BIO_get_md_ctx 3
371.It Dv BIO_C_GET_READ_REQUEST Ta Xr BIO_get_read_request 3
372.It Dv BIO_C_GET_SSL Ta Xr BIO_get_ssl 3
373.It Dv BIO_C_GET_SSL_NUM_RENEGOTIATES Ta Xr BIO_get_num_renegotiates 3
374.It Dv BIO_C_GET_WRITE_BUF_SIZE Ta Xr BIO_get_write_buf_size 3
375.It Dv BIO_C_GET_WRITE_GUARANTEE Ta Xr BIO_get_write_guarantee 3
376.It Dv BIO_C_MAKE_BIO_PAIR Ta Xr BIO_make_bio_pair 3
377.It Dv BIO_C_RESET_READ_REQUEST Ta Xr BIO_ctrl_reset_read_request 3
378.It Dv BIO_C_SET_BIND_MODE Ta Xr BIO_set_bind_mode 3
379.It Dv BIO_C_SET_BUF_MEM Ta Xr BIO_set_mem_buf 3
380.It Dv BIO_C_SET_BUF_MEM_EOF_RETURN Ta Xr BIO_set_mem_eof_return 3
381.It Dv BIO_C_SET_BUFF_READ_DATA Ta Xr BIO_set_buffer_read_data 3
382.It Dv BIO_C_SET_FD Ta Xr BIO_set_fd 3
383.It Dv BIO_C_SET_FILE_PTR Ta Xr BIO_set_fp 3
384.It Dv BIO_C_SET_MD Ta Xr BIO_set_md 3
385.It Dv BIO_C_SET_NBIO Ta Xr BIO_set_nbio 3
386.It Dv BIO_C_SET_SSL Ta Xr BIO_set_ssl 3
387.It Dv BIO_C_SET_SSL_RENEGOTIATE_BYTES Ta Xr BIO_set_ssl_renegotiate_bytes 3
388.It Dv BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT Ta Xr BIO_set_ssl_renegotiate_timeout 3
389.It Dv BIO_C_SET_WRITE_BUF_SIZE Ta Xr BIO_set_write_buf_size 3
390.It Dv BIO_C_SHUTDOWN_WR Ta Xr BIO_shutdown_wr 3
391.It Dv BIO_C_SSL_MODE Ta Xr BIO_set_ssl_mode 3
392.It Dv BIO_CTRL_DGRAM_CONNECT Ta Xr BIO_ctrl_dgram_connect 3
393.It Dv BIO_CTRL_DGRAM_GET_PEER Ta Xr BIO_dgram_get_peer 3
394.It Dv BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP Ta Xr BIO_dgram_recv_timedout 3
395.It Dv BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP Ta Xr BIO_dgram_send_timedout 3
396.It Dv BIO_CTRL_DGRAM_SET_CONNECTED Ta Xr BIO_ctrl_set_connected 3
397.It Dv BIO_CTRL_DGRAM_SET_PEER Ta Xr BIO_dgram_set_peer 3
398.It Dv BIO_CTRL_DUP Ta Xr BIO_dup_state 3
399.It Dv BIO_CTRL_EOF Ta Fn BIO_eof
400.It Dv BIO_CTRL_FLUSH Ta Fn BIO_flush
401.It Dv BIO_CTRL_GET_CALLBACK Ta Fn BIO_get_info_callback
402.It Dv BIO_CTRL_GET_CLOSE Ta Fn BIO_get_close
403.It Dv BIO_CTRL_INFO Ta Xr BIO_get_mem_data 3
404.It Dv BIO_CTRL_PENDING Ta Fn BIO_pending
405.It Dv BIO_CTRL_RESET Ta Fn BIO_reset
406.It Dv BIO_CTRL_SET_CALLBACK Ta Fn BIO_set_info_callback
407.It Dv BIO_CTRL_SET_CLOSE Ta Fn BIO_set_close
408.It Dv BIO_CTRL_WPENDING Ta Fn BIO_wpending
409.El
352.Sh RETURN VALUES 410.Sh RETURN VALUES
353The meaning of the return values of 411The meaning of the return values of
354.Fn BIO_ctrl , 412.Fn BIO_ctrl ,