]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/openssl/bio.h.in
quic: documentation and demo nits
[thirdparty/openssl.git] / include / openssl / bio.h.in
CommitLineData
21dcbebc 1/*
dd731474
MC
2 * {- join("\n * ", @autowarntext) -}
3 *
da1c088f 4 * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
d02b48c6 5 *
48f4ad77 6 * Licensed under the Apache License 2.0 (the "License"). You may not use
21dcbebc
RS
7 * this file except in compliance with the License. You can obtain a copy
8 * in the file LICENSE in the source distribution or at
9 * https://www.openssl.org/source/license.html
d02b48c6 10 */
dd731474
MC
11{-
12use OpenSSL::stackhash qw(generate_stack_macros);
13-}
d02b48c6 14
ae4186b0
DMSP
15#ifndef OPENSSL_BIO_H
16# define OPENSSL_BIO_H
d86167ec
DMSP
17# pragma once
18
19# include <openssl/macros.h>
936c2b9e 20# ifndef OPENSSL_NO_DEPRECATED_3_0
d86167ec
DMSP
21# define HEADER_BIO_H
22# endif
d02b48c6 23
0f113f3e 24# include <openssl/e_os2.h>
7b5a6c7a 25
0f113f3e
MC
26# ifndef OPENSSL_NO_STDIO
27# include <stdio.h>
28# endif
29# include <stdarg.h>
922ebc7b 30
0f113f3e 31# include <openssl/crypto.h>
52df25cf 32# include <openssl/bioerr.h>
b0ee1de9 33# include <openssl/core.h>
58964a49 34
82271cee
RL
35#ifdef __cplusplus
36extern "C" {
37#endif
38
8b8d963d
RS
39/* There are the classes of BIOs */
40# define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */
41# define BIO_TYPE_FILTER 0x0200
42# define BIO_TYPE_SOURCE_SINK 0x0400
43
d02b48c6 44/* These are the 'types' of BIOs */
8b8d963d
RS
45# define BIO_TYPE_NONE 0
46# define BIO_TYPE_MEM ( 1|BIO_TYPE_SOURCE_SINK)
47# define BIO_TYPE_FILE ( 2|BIO_TYPE_SOURCE_SINK)
48
49# define BIO_TYPE_FD ( 4|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
50# define BIO_TYPE_SOCKET ( 5|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
51# define BIO_TYPE_NULL ( 6|BIO_TYPE_SOURCE_SINK)
52# define BIO_TYPE_SSL ( 7|BIO_TYPE_FILTER)
53# define BIO_TYPE_MD ( 8|BIO_TYPE_FILTER)
54# define BIO_TYPE_BUFFER ( 9|BIO_TYPE_FILTER)
55# define BIO_TYPE_CIPHER (10|BIO_TYPE_FILTER)
56# define BIO_TYPE_BASE64 (11|BIO_TYPE_FILTER)
57# define BIO_TYPE_CONNECT (12|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
58# define BIO_TYPE_ACCEPT (13|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
59
60# define BIO_TYPE_NBIO_TEST (16|BIO_TYPE_FILTER)/* server proxy BIO */
61# define BIO_TYPE_NULL_FILTER (17|BIO_TYPE_FILTER)
62# define BIO_TYPE_BIO (19|BIO_TYPE_SOURCE_SINK)/* half a BIO pair */
63# define BIO_TYPE_LINEBUFFER (20|BIO_TYPE_FILTER)
64# define BIO_TYPE_DGRAM (21|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
65# define BIO_TYPE_ASN1 (22|BIO_TYPE_FILTER)
66# define BIO_TYPE_COMP (23|BIO_TYPE_FILTER)
0f113f3e 67# ifndef OPENSSL_NO_SCTP
8b8d963d 68# define BIO_TYPE_DGRAM_SCTP (24|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
0f113f3e 69# endif
b0ee1de9 70# define BIO_TYPE_CORE_TO_PROV (25|BIO_TYPE_SOURCE_SINK)
b88ce46e 71# define BIO_TYPE_DGRAM_PAIR (26|BIO_TYPE_SOURCE_SINK)
3a857b95 72# define BIO_TYPE_DGRAM_MEM (27|BIO_TYPE_SOURCE_SINK)
0f113f3e 73
8b8d963d 74#define BIO_TYPE_START 128
0f113f3e
MC
75
76/*
77 * BIO_FILENAME_READ|BIO_CLOSE to open or close on free.
78 * BIO_set_fp(in,stdin,BIO_NOCLOSE);
79 */
80# define BIO_NOCLOSE 0x00
81# define BIO_CLOSE 0x01
82
83/*
84 * These are used in the following macros and are passed to BIO_ctrl()
85 */
86# define BIO_CTRL_RESET 1/* opt - rewind/zero etc */
87# define BIO_CTRL_EOF 2/* opt - are we at the eof */
88# define BIO_CTRL_INFO 3/* opt - extra tit-bits */
89# define BIO_CTRL_SET 4/* man - set the 'IO' type */
90# define BIO_CTRL_GET 5/* man - get the 'IO' type */
91# define BIO_CTRL_PUSH 6/* opt - internal, used to signify change */
92# define BIO_CTRL_POP 7/* opt - internal, used to signify change */
93# define BIO_CTRL_GET_CLOSE 8/* man - set the 'close' on free */
94# define BIO_CTRL_SET_CLOSE 9/* man - set the 'close' on free */
95# define BIO_CTRL_PENDING 10/* opt - is their more data buffered */
96# define BIO_CTRL_FLUSH 11/* opt - 'flush' buffered output */
97# define BIO_CTRL_DUP 12/* man - extra stuff for 'duped' BIO */
98# define BIO_CTRL_WPENDING 13/* opt - number of bytes still to write */
0f113f3e
MC
99# define BIO_CTRL_SET_CALLBACK 14/* opt - set callback function */
100# define BIO_CTRL_GET_CALLBACK 15/* opt - set callback function */
d02b48c6 101
dc10560e 102# define BIO_CTRL_PEEK 29/* BIO_f_buffer special */
0f113f3e 103# define BIO_CTRL_SET_FILENAME 30/* BIO_s_file special */
d02b48c6 104
36d16f8e 105/* dgram BIO stuff */
0f113f3e
MC
106# define BIO_CTRL_DGRAM_CONNECT 31/* BIO dgram special */
107# define BIO_CTRL_DGRAM_SET_CONNECTED 32/* allow for an externally connected
108 * socket to be passed in */
109# define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33/* setsockopt, essentially */
110# define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34/* getsockopt, essentially */
111# define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35/* setsockopt, essentially */
112# define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36/* getsockopt, essentially */
113
114# define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37/* flag whether the last */
09a17655 115# define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38/* I/O operation timed out */
0f113f3e 116
36d16f8e 117/* #ifdef IP_MTU_DISCOVER */
0f113f3e 118# define BIO_CTRL_DGRAM_MTU_DISCOVER 39/* set DF bit on egress packets */
36d16f8e
BL
119/* #endif */
120
0f113f3e
MC
121# define BIO_CTRL_DGRAM_QUERY_MTU 40/* as kernel for current MTU */
122# define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47
123# define BIO_CTRL_DGRAM_GET_MTU 41/* get cached value for MTU */
124# define BIO_CTRL_DGRAM_SET_MTU 42/* set cached value for MTU.
125 * want to use this if asking
126 * the kernel fails */
36d16f8e 127
0f113f3e
MC
128# define BIO_CTRL_DGRAM_MTU_EXCEEDED 43/* check whether the MTU was
129 * exceed in the previous write
130 * operation */
36d16f8e 131
0f113f3e
MC
132# define BIO_CTRL_DGRAM_GET_PEER 46
133# define BIO_CTRL_DGRAM_SET_PEER 44/* Destination for the data */
36d16f8e 134
0f113f3e
MC
135# define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45/* Next DTLS handshake timeout
136 * to adjust socket timeouts */
137# define BIO_CTRL_DGRAM_SET_DONT_FRAG 48
7e159e01 138
0f113f3e 139# define BIO_CTRL_DGRAM_GET_MTU_OVERHEAD 49
0d3ae34d 140
99240875
MC
141/* Deliberately outside of OPENSSL_NO_SCTP - used in bss_dgram.c */
142# define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE 50
0f113f3e 143# ifndef OPENSSL_NO_SCTP
7e159e01 144/* SCTP stuff */
0f113f3e
MC
145# define BIO_CTRL_DGRAM_SCTP_ADD_AUTH_KEY 51
146# define BIO_CTRL_DGRAM_SCTP_NEXT_AUTH_KEY 52
147# define BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD 53
148# define BIO_CTRL_DGRAM_SCTP_GET_SNDINFO 60
149# define BIO_CTRL_DGRAM_SCTP_SET_SNDINFO 61
150# define BIO_CTRL_DGRAM_SCTP_GET_RCVINFO 62
151# define BIO_CTRL_DGRAM_SCTP_SET_RCVINFO 63
152# define BIO_CTRL_DGRAM_SCTP_GET_PRINFO 64
153# define BIO_CTRL_DGRAM_SCTP_SET_PRINFO 65
154# define BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN 70
155# endif
36d16f8e 156
99240875
MC
157# define BIO_CTRL_DGRAM_SET_PEEK_MODE 71
158
e401ef80 159/*
bd9faf11 160 * internal BIO:
6ba76c4f
BP
161 * # define BIO_CTRL_SET_KTLS_SEND 72
162 * # define BIO_CTRL_SET_KTLS_SEND_CTRL_MSG 74
e401ef80 163 * # define BIO_CTRL_CLEAR_KTLS_CTRL_MSG 75
6ba76c4f
BP
164 */
165
3119ab3c
MC
166# define BIO_CTRL_GET_KTLS_SEND 73
167# define BIO_CTRL_GET_KTLS_RECV 76
e401ef80 168
c8edb04f 169# define BIO_CTRL_DGRAM_SCTP_WAIT_FOR_DRY 77
170# define BIO_CTRL_DGRAM_SCTP_MSG_WAITING 78
171
319cee9e
RL
172/* BIO_f_prefix controls */
173# define BIO_CTRL_SET_PREFIX 79
174# define BIO_CTRL_SET_INDENT 80
175# define BIO_CTRL_GET_INDENT 81
176
e0c4e43e
HL
177# define BIO_CTRL_DGRAM_GET_LOCAL_ADDR_CAP 82
178# define BIO_CTRL_DGRAM_GET_LOCAL_ADDR_ENABLE 83
179# define BIO_CTRL_DGRAM_SET_LOCAL_ADDR_ENABLE 84
b88ce46e
HL
180# define BIO_CTRL_DGRAM_GET_EFFECTIVE_CAPS 85
181# define BIO_CTRL_DGRAM_GET_CAPS 86
182# define BIO_CTRL_DGRAM_SET_CAPS 87
183# define BIO_CTRL_DGRAM_GET_NO_TRUNC 88
184# define BIO_CTRL_DGRAM_SET_NO_TRUNC 89
185
cd715b7e
MM
186/*
187 * internal BIO:
188 * # define BIO_CTRL_SET_KTLS_TX_ZEROCOPY_SENDFILE 90
189 */
190
3760747f
HL
191# define BIO_CTRL_GET_RPOLL_DESCRIPTOR 91
192# define BIO_CTRL_GET_WPOLL_DESCRIPTOR 92
193# define BIO_CTRL_DGRAM_DETECT_PEER_ADDR 93
68801bcb 194
b88ce46e
HL
195# define BIO_DGRAM_CAP_NONE 0U
196# define BIO_DGRAM_CAP_HANDLES_SRC_ADDR (1U << 0)
197# define BIO_DGRAM_CAP_HANDLES_DST_ADDR (1U << 1)
198# define BIO_DGRAM_CAP_PROVIDES_SRC_ADDR (1U << 2)
199# define BIO_DGRAM_CAP_PROVIDES_DST_ADDR (1U << 3)
e0c4e43e 200
3119ab3c 201# ifndef OPENSSL_NO_KTLS
6ba76c4f 202# define BIO_get_ktls_send(b) \
524bac57 203 (BIO_ctrl(b, BIO_CTRL_GET_KTLS_SEND, 0, NULL) > 0)
e401ef80 204# define BIO_get_ktls_recv(b) \
524bac57 205 (BIO_ctrl(b, BIO_CTRL_GET_KTLS_RECV, 0, NULL) > 0)
3119ab3c
MC
206# else
207# define BIO_get_ktls_send(b) (0)
208# define BIO_get_ktls_recv(b) (0)
209# endif
6ba76c4f 210
d02b48c6 211/* modifiers */
0f113f3e
MC
212# define BIO_FP_READ 0x02
213# define BIO_FP_WRITE 0x04
214# define BIO_FP_APPEND 0x08
215# define BIO_FP_TEXT 0x10
216
217# define BIO_FLAGS_READ 0x01
218# define BIO_FLAGS_WRITE 0x02
219# define BIO_FLAGS_IO_SPECIAL 0x04
220# define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
221# define BIO_FLAGS_SHOULD_RETRY 0x08
936c2b9e 222# ifndef OPENSSL_NO_DEPRECATED_3_0
b1132792
BE
223/* This #define was replaced by an internal constant and should not be used. */
224# define BIO_FLAGS_UPLINK 0
0f113f3e 225# endif
d02b48c6 226
0f113f3e 227# define BIO_FLAGS_BASE64_NO_NL 0x100
d02b48c6 228
0f113f3e 229/*
9fe9d046
KM
230 * This is used with memory BIOs:
231 * BIO_FLAGS_MEM_RDONLY means we shouldn't free up or change the data in any way;
69687aa8 232 * BIO_FLAGS_NONCLEAR_RST means we shouldn't clear data on reset.
8484721a 233 */
0f113f3e 234# define BIO_FLAGS_MEM_RDONLY 0x200
9fe9d046 235# define BIO_FLAGS_NONCLEAR_RST 0x400
d924dbf4 236# define BIO_FLAGS_IN_EOF 0x800
8484721a 237
cd715b7e 238/* the BIO FLAGS values 0x1000 to 0x8000 are reserved for internal KTLS flags */
e278f185 239
28a0841b
RL
240typedef union bio_addr_st BIO_ADDR;
241typedef struct bio_addrinfo_st BIO_ADDRINFO;
242
8b8d963d 243int BIO_get_new_index(void);
7806f3dd 244void BIO_set_flags(BIO *b, int flags);
0f113f3e 245int BIO_test_flags(const BIO *b, int flags);
7806f3dd
NL
246void BIO_clear_flags(BIO *b, int flags);
247
0f113f3e
MC
248# define BIO_get_flags(b) BIO_test_flags(b, ~(0x0))
249# define BIO_set_retry_special(b) \
250 BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
251# define BIO_set_retry_read(b) \
252 BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
253# define BIO_set_retry_write(b) \
254 BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
d02b48c6
RE
255
256/* These are normally used internally in BIOs */
0f113f3e
MC
257# define BIO_clear_retry_flags(b) \
258 BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
259# define BIO_get_retry_flags(b) \
260 BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
d02b48c6 261
657e60fa 262/* These should be used by the application to tell why we should retry */
0f113f3e
MC
263# define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ)
264# define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE)
265# define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL)
266# define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS)
267# define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY)
268
269/*
270 * The next three are used in conjunction with the BIO_should_io_special()
271 * condition. After this returns true, BIO *BIO_get_retry_BIO(BIO *bio, int
272 * *reason); will walk the BIO stack and return the 'reason' for the special
273 * and the offending BIO. Given a BIO, BIO_get_retry_reason(bio) will return
274 * the code.
275 */
276/*
277 * Returned from the SSL bio when the certificate retrieval code had an error
278 */
279# define BIO_RR_SSL_X509_LOOKUP 0x01
d02b48c6 280/* Returned from the connect BIO when a connect would have blocked */
0f113f3e 281# define BIO_RR_CONNECT 0x02
924046ce 282/* Returned from the accept BIO when an accept would have blocked */
0f113f3e 283# define BIO_RR_ACCEPT 0x03
d02b48c6
RE
284
285/* These are passed by the BIO callback */
e0c4e43e
HL
286# define BIO_CB_FREE 0x01
287# define BIO_CB_READ 0x02
288# define BIO_CB_WRITE 0x03
289# define BIO_CB_PUTS 0x04
290# define BIO_CB_GETS 0x05
291# define BIO_CB_CTRL 0x06
292# define BIO_CB_RECVMMSG 0x07
293# define BIO_CB_SENDMMSG 0x08
0f113f3e
MC
294
295/*
296 * The callback is called before and after the underling operation, The
297 * BIO_CB_RETURN flag indicates if it is after the call
298 */
299# define BIO_CB_RETURN 0x80
30cf9178 300# define BIO_CB_return(a) ((a)|BIO_CB_RETURN)
0f113f3e
MC
301# define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN))
302# define BIO_cb_post(a) ((a)&BIO_CB_RETURN)
303
0800318a 304# ifndef OPENSSL_NO_DEPRECATED_3_0
91da5e77
RS
305typedef long (*BIO_callback_fn)(BIO *b, int oper, const char *argp, int argi,
306 long argl, long ret);
0800318a
TM
307OSSL_DEPRECATEDIN_3_0 BIO_callback_fn BIO_get_callback(const BIO *b);
308OSSL_DEPRECATEDIN_3_0 void BIO_set_callback(BIO *b, BIO_callback_fn callback);
309OSSL_DEPRECATEDIN_3_0 long BIO_debug_callback(BIO *bio, int cmd,
310 const char *argp, int argi,
311 long argl, long ret);
312# endif
313
d07aee2c
MC
314typedef long (*BIO_callback_fn_ex)(BIO *b, int oper, const char *argp,
315 size_t len, int argi,
98e553d2 316 long argl, int ret, size_t *processed);
d07aee2c
MC
317BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b);
318void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex callback);
0800318a
TM
319long BIO_debug_callback_ex(BIO *bio, int oper, const char *argp, size_t len,
320 int argi, long argl, int ret, size_t *processed);
d07aee2c 321
7806f3dd
NL
322char *BIO_get_callback_arg(const BIO *b);
323void BIO_set_callback_arg(BIO *b, char *arg);
d02b48c6 324
a146ae55
MC
325typedef struct bio_method_st BIO_METHOD;
326
0f113f3e 327const char *BIO_method_name(const BIO *b);
7806f3dd 328int BIO_method_type(const BIO *b);
0e1c0612 329
fce78bd4
BE
330typedef int BIO_info_cb(BIO *, int, int);
331typedef BIO_info_cb bio_info_cb; /* backward compatibility */
0f113f3e 332
dd731474
MC
333{-
334 generate_stack_macros("BIO");
335-}
336
371acb22 337
11d8cdc6 338/* Prefix and suffix callback in ASN1 BIO */
0f113f3e
MC
339typedef int asn1_ps_func (BIO *b, unsigned char **pbuf, int *plen,
340 void *parg);
11d8cdc6 341
c8edb04f 342typedef void (*BIO_dgram_sctp_notification_handler_fn) (BIO *b,
343 void *context,
344 void *buf);
0f113f3e 345# ifndef OPENSSL_NO_SCTP
7e159e01 346/* SCTP parameter structs */
0f113f3e
MC
347struct bio_dgram_sctp_sndinfo {
348 uint16_t snd_sid;
349 uint16_t snd_flags;
350 uint32_t snd_ppid;
351 uint32_t snd_context;
352};
353
354struct bio_dgram_sctp_rcvinfo {
355 uint16_t rcv_sid;
356 uint16_t rcv_ssn;
357 uint16_t rcv_flags;
358 uint32_t rcv_ppid;
359 uint32_t rcv_tsn;
360 uint32_t rcv_cumtsn;
361 uint32_t rcv_context;
362};
363
364struct bio_dgram_sctp_prinfo {
365 uint16_t pr_policy;
366 uint32_t pr_value;
367};
368# endif
7e159e01 369
e0c4e43e
HL
370/* BIO_sendmmsg/BIO_recvmmsg-related definitions */
371typedef struct bio_msg_st {
372 void *data;
373 size_t data_len;
374 BIO_ADDR *peer, *local;
375 uint64_t flags;
376} BIO_MSG;
377
378typedef struct bio_mmsg_cb_args_st {
379 BIO_MSG *msg;
380 size_t stride, num_msg;
381 uint64_t flags;
382 size_t *msgs_processed;
383} BIO_MMSG_CB_ARGS;
384
68801bcb
HL
385#define BIO_POLL_DESCRIPTOR_TYPE_NONE 0
386#define BIO_POLL_DESCRIPTOR_TYPE_SOCK_FD 1
387#define BIO_POLL_DESCRIPTOR_CUSTOM_START 8192
68801bcb
HL
388
389typedef struct bio_poll_descriptor_st {
2619d10a 390 uint32_t type;
68801bcb 391 union {
2619d10a
HL
392 int fd;
393 void *custom;
394 uintptr_t custom_ui;
68801bcb
HL
395 } value;
396} BIO_POLL_DESCRIPTOR;
397
0f113f3e
MC
398/*
399 * #define BIO_CONN_get_param_hostname BIO_ctrl
400 */
58964a49 401
0f113f3e
MC
402# define BIO_C_SET_CONNECT 100
403# define BIO_C_DO_STATE_MACHINE 101
404# define BIO_C_SET_NBIO 102
7281cbaa 405/* # define BIO_C_SET_PROXY_PARAM 103 */
0f113f3e
MC
406# define BIO_C_SET_FD 104
407# define BIO_C_GET_FD 105
408# define BIO_C_SET_FILE_PTR 106
409# define BIO_C_GET_FILE_PTR 107
410# define BIO_C_SET_FILENAME 108
411# define BIO_C_SET_SSL 109
412# define BIO_C_GET_SSL 110
413# define BIO_C_SET_MD 111
414# define BIO_C_GET_MD 112
415# define BIO_C_GET_CIPHER_STATUS 113
416# define BIO_C_SET_BUF_MEM 114
417# define BIO_C_GET_BUF_MEM_PTR 115
418# define BIO_C_GET_BUFF_NUM_LINES 116
419# define BIO_C_SET_BUFF_SIZE 117
420# define BIO_C_SET_ACCEPT 118
421# define BIO_C_SSL_MODE 119
422# define BIO_C_GET_MD_CTX 120
7281cbaa 423/* # define BIO_C_GET_PROXY_PARAM 121 */
0f113f3e
MC
424# define BIO_C_SET_BUFF_READ_DATA 122/* data to read first */
425# define BIO_C_GET_CONNECT 123
426# define BIO_C_GET_ACCEPT 124
427# define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
428# define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
429# define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
430# define BIO_C_FILE_SEEK 128
431# define BIO_C_GET_CIPHER_CTX 129
432# define BIO_C_SET_BUF_MEM_EOF_RETURN 130/* return end of input
433 * value */
434# define BIO_C_SET_BIND_MODE 131
435# define BIO_C_GET_BIND_MODE 132
436# define BIO_C_FILE_TELL 133
437# define BIO_C_GET_SOCKS 134
438# define BIO_C_SET_SOCKS 135
439
440# define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
441# define BIO_C_GET_WRITE_BUF_SIZE 137
442# define BIO_C_MAKE_BIO_PAIR 138
443# define BIO_C_DESTROY_BIO_PAIR 139
444# define BIO_C_GET_WRITE_GUARANTEE 140
445# define BIO_C_GET_READ_REQUEST 141
446# define BIO_C_SHUTDOWN_WR 142
447# define BIO_C_NREAD0 143
448# define BIO_C_NREAD 144
449# define BIO_C_NWRITE0 145
450# define BIO_C_NWRITE 146
451# define BIO_C_RESET_READ_REQUEST 147
452# define BIO_C_SET_MD_CTX 148
453
454# define BIO_C_SET_PREFIX 149
455# define BIO_C_GET_PREFIX 150
456# define BIO_C_SET_SUFFIX 151
457# define BIO_C_GET_SUFFIX 152
458
459# define BIO_C_SET_EX_ARG 153
460# define BIO_C_GET_EX_ARG 154
461
417be660
RL
462# define BIO_C_SET_CONNECT_MODE 155
463
a3e53d56
TS
464# define BIO_C_SET_TFO 156 /* like BIO_C_SET_NBIO */
465
7841dbab
HL
466# define BIO_C_SET_SOCK_TYPE 157
467# define BIO_C_GET_SOCK_TYPE 158
468# define BIO_C_GET_DGRAM_BIO 159
469
0f113f3e
MC
470# define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg)
471# define BIO_get_app_data(s) BIO_get_ex_data(s,0)
dfeab068 472
a3e53d56
TS
473# define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
474# define BIO_set_tfo(b,n) BIO_ctrl(b,BIO_C_SET_TFO,(n),NULL)
f863ad0c
MC
475
476# ifndef OPENSSL_NO_SOCK
417be660
RL
477/* IP families we support, for BIO_s_connect() and BIO_s_accept() */
478/* Note: the underlying operating system may not support some of them */
f863ad0c
MC
479# define BIO_FAMILY_IPV4 4
480# define BIO_FAMILY_IPV6 6
481# define BIO_FAMILY_IPANY 256
417be660
RL
482
483/* BIO_s_connect() */
37659ea4
BE
484# define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0, \
485 (char *)(name))
486# define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1, \
487 (char *)(port))
488# define BIO_set_conn_address(b,addr) BIO_ctrl(b,BIO_C_SET_CONNECT,2, \
489 (char *)(addr))
f863ad0c 490# define BIO_set_conn_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,f)
c2efa783
VS
491# define BIO_get_conn_hostname(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0))
492# define BIO_get_conn_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1))
493# define BIO_get_conn_address(b) ((const BIO_ADDR *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2))
f863ad0c 494# define BIO_get_conn_ip_family(b) BIO_ctrl(b,BIO_C_GET_CONNECT,3,NULL)
a3e53d56 495# define BIO_get_conn_mode(b) BIO_ctrl(b,BIO_C_GET_CONNECT,4,NULL)
f863ad0c 496# define BIO_set_conn_mode(b,n) BIO_ctrl(b,BIO_C_SET_CONNECT_MODE,(n),NULL)
7841dbab
HL
497# define BIO_set_sock_type(b,t) BIO_ctrl(b,BIO_C_SET_SOCK_TYPE,(t),NULL)
498# define BIO_get_sock_type(b) BIO_ctrl(b,BIO_C_GET_SOCK_TYPE,0,NULL)
abeb41b4 499# define BIO_get0_dgram_bio(b, p) BIO_ctrl(b,BIO_C_GET_DGRAM_BIO,0,(void *)(BIO **)(p))
d02b48c6 500
f564acda 501/* BIO_s_accept() */
37659ea4
BE
502# define BIO_set_accept_name(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0, \
503 (char *)(name))
504# define BIO_set_accept_port(b,port) BIO_ctrl(b,BIO_C_SET_ACCEPT,1, \
505 (char *)(port))
f863ad0c
MC
506# define BIO_get_accept_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0))
507# define BIO_get_accept_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,1))
508# define BIO_get_peer_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,2))
509# define BIO_get_peer_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,3))
0f113f3e 510/* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
f863ad0c 511# define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(n)?(void *)"a":NULL)
37659ea4
BE
512# define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,3, \
513 (char *)(bio))
f863ad0c
MC
514# define BIO_set_accept_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_ACCEPT,4,f)
515# define BIO_get_accept_ip_family(b) BIO_ctrl(b,BIO_C_GET_ACCEPT,4,NULL)
a3e53d56 516# define BIO_set_tfo_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,5,(n)?(void *)"a":NULL)
0f113f3e 517
417be660 518/* Aliases kept for backward compatibility */
f863ad0c
MC
519# define BIO_BIND_NORMAL 0
520# define BIO_BIND_REUSEADDR BIO_SOCK_REUSEADDR
521# define BIO_BIND_REUSEADDR_IF_UNUSED BIO_SOCK_REUSEADDR
522# define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
523# define BIO_get_bind_mode(b) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
f863ad0c
MC
524# endif /* OPENSSL_NO_SOCK */
525
c195c882
MC
526# define BIO_do_connect(b) BIO_do_handshake(b)
527# define BIO_do_accept(b) BIO_do_handshake(b)
528
0f113f3e 529# define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
d02b48c6 530
f564acda 531/* BIO_s_datagram(), BIO_s_fd(), BIO_s_socket(), BIO_s_accept() and BIO_s_connect() */
0f113f3e 532# define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
37659ea4 533# define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)(c))
d02b48c6 534
f564acda 535/* BIO_s_file() */
37659ea4
BE
536# define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)(fp))
537# define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)(fpp))
d02b48c6 538
24430304 539/* BIO_s_fd() and BIO_s_file() */
0f113f3e
MC
540# define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
541# define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
dfeab068 542
0f113f3e
MC
543/*
544 * name is cast to lose const, but might be better to route through a
545 * function so we can do it safely
546 */
547# ifdef CONST_STRICT
548/*
549 * If you are wondering why this isn't defined, its because CONST_STRICT is
e778802f
BL
550 * purely a compile-time kludge to allow const to be checked.
551 */
0f113f3e
MC
552int BIO_read_filename(BIO *b, const char *name);
553# else
5a339364 554# define BIO_read_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
37659ea4 555 BIO_CLOSE|BIO_FP_READ,(char *)(name))
0f113f3e 556# endif
5a339364 557# define BIO_write_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
0f113f3e 558 BIO_CLOSE|BIO_FP_WRITE,name)
5a339364 559# define BIO_append_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
0f113f3e 560 BIO_CLOSE|BIO_FP_APPEND,name)
5a339364 561# define BIO_rw_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
0f113f3e
MC
562 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
563
564/*
565 * WARNING WARNING, this ups the reference count on the read bio of the SSL
566 * structure. This is because the ssl read BIO is now pointed to by the
567 * next_bio field in the bio. So when you free the BIO, make sure you are
568 * doing a BIO_free_all() to catch the underlying BIO.
569 */
37659ea4
BE
570# define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)(ssl))
571# define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)(sslp))
0f113f3e
MC
572# define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
573# define BIO_set_ssl_renegotiate_bytes(b,num) \
54f24e3e 574 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL)
0f113f3e 575# define BIO_get_num_renegotiates(b) \
54f24e3e 576 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL)
0f113f3e 577# define BIO_set_ssl_renegotiate_timeout(b,seconds) \
54f24e3e 578 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL)
d02b48c6
RE
579
580/* defined in evp.h */
37659ea4 581/* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)(md)) */
d02b48c6 582
37659ea4
BE
583# define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)(pp))
584# define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)(bm))
585# define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0, \
586 (char *)(pp))
0f113f3e
MC
587# define BIO_set_mem_eof_return(b,v) \
588 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
d02b48c6
RE
589
590/* For the BIO_f_buffer() type */
0f113f3e
MC
591# define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
592# define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
593# define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
594# define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
595# define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
d02b48c6
RE
596
597/* Don't use the next one unless you know what you are doing :-) */
0f113f3e
MC
598# define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
599
600# define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
601# define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
602# define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
603# define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
604# define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
605# define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
95d29597
BM
606/* ...pending macros have inappropriate return type */
607size_t BIO_ctrl_pending(BIO *b);
608size_t BIO_ctrl_wpending(BIO *b);
0f113f3e
MC
609# define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
610# define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
611 cbp)
612# define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
d02b48c6
RE
613
614/* For the BIO_f_buffer() type */
0f113f3e 615# define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
dc10560e 616# define BIO_buffer_peek(b,s,l) BIO_ctrl(b,BIO_CTRL_PEEK,(l),(s))
d02b48c6 617
95d29597 618/* For BIO_s_bio() */
0f113f3e
MC
619# define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
620# define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
621# define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
622# define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
623# define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
95d29597 624/* macros with inappropriate type -- but ...pending macros use int too: */
0f113f3e
MC
625# define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
626# define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
95d29597
BM
627size_t BIO_ctrl_get_write_guarantee(BIO *b);
628size_t BIO_ctrl_get_read_request(BIO *b);
e405b8d1 629int BIO_ctrl_reset_read_request(BIO *b);
95d29597 630
36d16f8e 631/* ctrl macros for dgram */
0f113f3e 632# define BIO_ctrl_dgram_connect(b,peer) \
37659ea4 633 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)(peer))
009e9d99 634# define BIO_ctrl_set_connected(b,peer) \
37659ea4 635 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, 0, (char *)(peer))
0f113f3e 636# define BIO_dgram_recv_timedout(b) \
36d16f8e 637 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
0f113f3e 638# define BIO_dgram_send_timedout(b) \
36d16f8e 639 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
0f113f3e 640# define BIO_dgram_get_peer(b,peer) \
37659ea4 641 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)(peer))
0f113f3e 642# define BIO_dgram_set_peer(b,peer) \
37659ea4 643 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)(peer))
000ef781
HL
644# define BIO_dgram_detect_peer_addr(b,peer) \
645 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_DETECT_PEER_ADDR, 0, (char *)(peer))
0f113f3e 646# define BIO_dgram_get_mtu_overhead(b) \
0d3ae34d 647 (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU_OVERHEAD, 0, NULL)
e0c4e43e
HL
648# define BIO_dgram_get_local_addr_cap(b) \
649 (int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_LOCAL_ADDR_CAP, 0, NULL)
650# define BIO_dgram_get_local_addr_enable(b, penable) \
651 (int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_LOCAL_ADDR_ENABLE, 0, (char *)(penable))
652# define BIO_dgram_set_local_addr_enable(b, enable) \
653 (int)BIO_ctrl((b), BIO_CTRL_DGRAM_SET_LOCAL_ADDR_ENABLE, (enable), NULL)
b88ce46e
HL
654# define BIO_dgram_get_effective_caps(b) \
655 (uint32_t)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_EFFECTIVE_CAPS, 0, NULL)
656# define BIO_dgram_get_caps(b) \
657 (uint32_t)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_CAPS, 0, NULL)
658# define BIO_dgram_set_caps(b, caps) \
659 (int)BIO_ctrl((b), BIO_CTRL_DGRAM_SET_CAPS, (long)(caps), NULL)
660# define BIO_dgram_get_no_trunc(b) \
661 (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_NO_TRUNC, 0, NULL)
662# define BIO_dgram_set_no_trunc(b, enable) \
663 (int)BIO_ctrl((b), BIO_CTRL_DGRAM_SET_NO_TRUNC, (enable), NULL)
664# define BIO_dgram_get_mtu(b) \
665 (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU, 0, NULL)
666# define BIO_dgram_set_mtu(b, mtu) \
667 (int)BIO_ctrl((b), BIO_CTRL_DGRAM_SET_MTU, (mtu), NULL)
36d16f8e 668
319cee9e
RL
669/* ctrl macros for BIO_f_prefix */
670# define BIO_set_prefix(b,p) BIO_ctrl((b), BIO_CTRL_SET_PREFIX, 0, (void *)(p))
671# define BIO_set_indent(b,i) BIO_ctrl((b), BIO_CTRL_SET_INDENT, (i), NULL)
672# define BIO_get_indent(b) BIO_ctrl((b), BIO_CTRL_GET_INDENT, 0, NULL)
673
e6390aca
RS
674#define BIO_get_ex_new_index(l, p, newf, dupf, freef) \
675 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_BIO, l, p, newf, dupf, freef)
0f113f3e 676int BIO_set_ex_data(BIO *bio, int idx, void *data);
8cc86b81 677void *BIO_get_ex_data(const BIO *bio, int idx);
b8b12aad
MC
678uint64_t BIO_number_read(BIO *bio);
679uint64_t BIO_number_written(BIO *bio);
0cc39579 680
11d8cdc6
DSH
681/* For BIO_f_asn1() */
682int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix,
0f113f3e 683 asn1_ps_func *prefix_free);
11d8cdc6 684int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix,
0f113f3e 685 asn1_ps_func **pprefix_free);
11d8cdc6 686int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix,
0f113f3e 687 asn1_ps_func *suffix_free);
11d8cdc6 688int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix,
0f113f3e 689 asn1_ps_func **psuffix_free);
11d8cdc6 690
04f6b0fd 691const BIO_METHOD *BIO_s_file(void);
72fbe87d 692BIO *BIO_new_file(const char *filename, const char *mode);
b0ee1de9 693BIO *BIO_new_from_core_bio(OSSL_LIB_CTX *libctx, OSSL_CORE_BIO *corebio);
984d6c60 694# ifndef OPENSSL_NO_STDIO
58964a49 695BIO *BIO_new_fp(FILE *stream, int close_flag);
922ebc7b 696# endif
b0ee1de9 697BIO *BIO_new_ex(OSSL_LIB_CTX *libctx, const BIO_METHOD *method);
04f6b0fd 698BIO *BIO_new(const BIO_METHOD *type);
0f113f3e 699int BIO_free(BIO *a);
a146ae55
MC
700void BIO_set_data(BIO *a, void *ptr);
701void *BIO_get_data(BIO *a);
702void BIO_set_init(BIO *a, int init);
703int BIO_get_init(BIO *a);
704void BIO_set_shutdown(BIO *a, int shut);
705int BIO_get_shutdown(BIO *a);
0f113f3e 706void BIO_vfree(BIO *a);
fb46be03 707int BIO_up_ref(BIO *a);
7bf79e33 708int BIO_read(BIO *b, void *data, int dlen);
4e3973b4 709int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes);
e0c4e43e
HL
710__owur int BIO_recvmmsg(BIO *b, BIO_MSG *msg,
711 size_t stride, size_t num_msg, uint64_t flags,
712 size_t *msgs_processed);
0f113f3e 713int BIO_gets(BIO *bp, char *buf, int size);
18423879 714int BIO_get_line(BIO *bio, char *buf, int size);
7bf79e33
MC
715int BIO_write(BIO *b, const void *data, int dlen);
716int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written);
e0c4e43e
HL
717__owur int BIO_sendmmsg(BIO *b, BIO_MSG *msg,
718 size_t stride, size_t num_msg, uint64_t flags,
719 size_t *msgs_processed);
68801bcb
HL
720__owur int BIO_get_rpoll_descriptor(BIO *b, BIO_POLL_DESCRIPTOR *desc);
721__owur int BIO_get_wpoll_descriptor(BIO *b, BIO_POLL_DESCRIPTOR *desc);
0f113f3e
MC
722int BIO_puts(BIO *bp, const char *buf);
723int BIO_indent(BIO *b, int indent, int max);
724long BIO_ctrl(BIO *bp, int cmd, long larg, void *parg);
fce78bd4 725long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp);
417be660 726void *BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
0f113f3e
MC
727long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
728BIO *BIO_push(BIO *b, BIO *append);
729BIO *BIO_pop(BIO *b);
730void BIO_free_all(BIO *a);
731BIO *BIO_find_type(BIO *b, int bio_type);
732BIO *BIO_next(BIO *b);
a146ae55 733void BIO_set_next(BIO *b, BIO *next);
0f113f3e
MC
734BIO *BIO_get_retry_BIO(BIO *bio, int *reason);
735int BIO_get_retry_reason(BIO *bio);
a146ae55 736void BIO_set_retry_reason(BIO *bio, int reason);
0f113f3e 737BIO *BIO_dup_chain(BIO *in);
d02b48c6 738
019a7aba
BM
739int BIO_nread0(BIO *bio, char **buf);
740int BIO_nread(BIO *bio, char **buf, int num);
741int BIO_nwrite0(BIO *bio, char **buf);
742int BIO_nwrite(BIO *bio, char **buf, int num);
743
04f6b0fd 744const BIO_METHOD *BIO_s_mem(void);
3a857b95 745# ifndef OPENSSL_NO_DGRAM
5a4ba72f 746const BIO_METHOD *BIO_s_dgram_mem(void);
3a857b95 747# endif
04f6b0fd 748const BIO_METHOD *BIO_s_secmem(void);
8ab31975 749BIO *BIO_new_mem_buf(const void *buf, int len);
f863ad0c 750# ifndef OPENSSL_NO_SOCK
04f6b0fd
DB
751const BIO_METHOD *BIO_s_socket(void);
752const BIO_METHOD *BIO_s_connect(void);
753const BIO_METHOD *BIO_s_accept(void);
f863ad0c 754# endif
04f6b0fd
DB
755const BIO_METHOD *BIO_s_fd(void);
756const BIO_METHOD *BIO_s_log(void);
757const BIO_METHOD *BIO_s_bio(void);
758const BIO_METHOD *BIO_s_null(void);
759const BIO_METHOD *BIO_f_null(void);
760const BIO_METHOD *BIO_f_buffer(void);
a30823c8 761const BIO_METHOD *BIO_f_readbuffer(void);
04f6b0fd 762const BIO_METHOD *BIO_f_linebuffer(void);
04f6b0fd 763const BIO_METHOD *BIO_f_nbio_test(void);
319cee9e 764const BIO_METHOD *BIO_f_prefix(void);
b0ee1de9 765const BIO_METHOD *BIO_s_core(void);
0f113f3e 766# ifndef OPENSSL_NO_DGRAM
b88ce46e 767const BIO_METHOD *BIO_s_dgram_pair(void);
04f6b0fd 768const BIO_METHOD *BIO_s_datagram(void);
9fb80e3c
MC
769int BIO_dgram_non_fatal_error(int error);
770BIO *BIO_new_dgram(int fd, int close_flag);
0f113f3e 771# ifndef OPENSSL_NO_SCTP
04f6b0fd 772const BIO_METHOD *BIO_s_datagram_sctp(void);
9fb80e3c
MC
773BIO *BIO_new_dgram_sctp(int fd, int close_flag);
774int BIO_dgram_is_sctp(BIO *bio);
775int BIO_dgram_sctp_notification_cb(BIO *b,
c8edb04f 776 BIO_dgram_sctp_notification_handler_fn handle_notifications,
777 void *context);
9fb80e3c
MC
778int BIO_dgram_sctp_wait_for_dry(BIO *b);
779int BIO_dgram_sctp_msg_waiting(BIO *b);
0f113f3e
MC
780# endif
781# endif
36d16f8e 782
f863ad0c 783# ifndef OPENSSL_NO_SOCK
d02b48c6
RE
784int BIO_sock_should_retry(int i);
785int BIO_sock_non_fatal_error(int error);
e0c4e43e 786int BIO_err_is_non_fatal(unsigned int errcode);
bcbb30af 787int BIO_socket_wait(int fd, int for_read, time_t max_time);
f863ad0c 788# endif
e98c7350
DDO
789int BIO_wait(BIO *bio, time_t max_time, unsigned int nap_milliseconds);
790int BIO_do_connect_retry(BIO *bio, int timeout, int nap_milliseconds);
36d16f8e 791
d02b48c6
RE
792int BIO_fd_should_retry(int i);
793int BIO_fd_non_fatal_error(int error);
0f113f3e 794int BIO_dump_cb(int (*cb) (const void *data, size_t len, void *u),
807989df 795 void *u, const void *s, int len);
0f113f3e 796int BIO_dump_indent_cb(int (*cb) (const void *data, size_t len, void *u),
807989df
RL
797 void *u, const void *s, int len, int indent);
798int BIO_dump(BIO *b, const void *bytes, int len);
799int BIO_dump_indent(BIO *b, const void *bytes, int len, int indent);
0f113f3e 800# ifndef OPENSSL_NO_STDIO
807989df
RL
801int BIO_dump_fp(FILE *fp, const void *s, int len);
802int BIO_dump_indent_fp(FILE *fp, const void *s, int len, int indent);
0f113f3e 803# endif
807989df 804int BIO_hex_string(BIO *out, int indent, int width, const void *data,
0f113f3e 805 int datalen);
b263f212 806
f863ad0c 807# ifndef OPENSSL_NO_SOCK
28a0841b 808BIO_ADDR *BIO_ADDR_new(void);
a18c9f80 809int BIO_ADDR_copy(BIO_ADDR *dst, const BIO_ADDR *src);
a3e53d56 810BIO_ADDR *BIO_ADDR_dup(const BIO_ADDR *ap);
28a0841b
RL
811int BIO_ADDR_rawmake(BIO_ADDR *ap, int family,
812 const void *where, size_t wherelen, unsigned short port);
813void BIO_ADDR_free(BIO_ADDR *);
7d1d48a2 814void BIO_ADDR_clear(BIO_ADDR *ap);
28a0841b
RL
815int BIO_ADDR_family(const BIO_ADDR *ap);
816int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l);
817unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap);
818char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric);
819char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric);
820char *BIO_ADDR_path_string(const BIO_ADDR *ap);
821
822const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai);
823int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai);
824int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai);
825int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai);
826const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai);
827void BIO_ADDRINFO_free(BIO_ADDRINFO *bai);
828
829enum BIO_hostserv_priorities {
830 BIO_PARSE_PRIO_HOST, BIO_PARSE_PRIO_SERV
831};
832int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
833 enum BIO_hostserv_priorities hostserv_prio);
834enum BIO_lookup_type {
835 BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER
836};
837int BIO_lookup(const char *host, const char *service,
838 enum BIO_lookup_type lookup_type,
839 int family, int socktype, BIO_ADDRINFO **res);
5114d822 840int BIO_lookup_ex(const char *host, const char *service,
e8291428
MC
841 int lookup_type, int family, int socktype, int protocol,
842 BIO_ADDRINFO **res);
d02b48c6 843int BIO_sock_error(int sock);
c029841e 844int BIO_socket_ioctl(int fd, long type, void *arg);
0f113f3e 845int BIO_socket_nbio(int fd, int mode);
0f113f3e 846int BIO_sock_init(void);
00db8c60 847# ifndef OPENSSL_NO_DEPRECATED_1_1_0
f863ad0c
MC
848# define BIO_sock_cleanup() while(0) continue
849# endif
0f113f3e 850int BIO_set_tcp_ndelay(int sock, int turn_on);
894fe6e1
RL
851# ifndef OPENSSL_NO_DEPRECATED_1_1_0
852OSSL_DEPRECATEDIN_1_1_0 struct hostent *BIO_gethostbyname(const char *name);
853OSSL_DEPRECATEDIN_1_1_0 int BIO_get_port(const char *str, unsigned short *port_ptr);
854OSSL_DEPRECATEDIN_1_1_0 int BIO_get_host_ip(const char *str, unsigned char *ip);
855OSSL_DEPRECATEDIN_1_1_0 int BIO_get_accept_socket(char *host_port, int mode);
856OSSL_DEPRECATEDIN_1_1_0 int BIO_accept(int sock, char **ip_port);
857# endif
d33b215b
RL
858
859union BIO_sock_info_u {
860 BIO_ADDR *addr;
861};
862enum BIO_sock_info_type {
863 BIO_SOCK_INFO_ADDRESS
864};
865int BIO_sock_info(int sock,
866 enum BIO_sock_info_type type, union BIO_sock_info_u *info);
867
f863ad0c
MC
868# define BIO_SOCK_REUSEADDR 0x01
869# define BIO_SOCK_V6_ONLY 0x02
870# define BIO_SOCK_KEEPALIVE 0x04
871# define BIO_SOCK_NONBLOCK 0x08
872# define BIO_SOCK_NODELAY 0x10
a3e53d56 873# define BIO_SOCK_TFO 0x20
d33b215b
RL
874
875int BIO_socket(int domain, int socktype, int protocol, int options);
876int BIO_connect(int sock, const BIO_ADDR *addr, int options);
ebc01683 877int BIO_bind(int sock, const BIO_ADDR *addr, int options);
d33b215b
RL
878int BIO_listen(int sock, const BIO_ADDR *addr, int options);
879int BIO_accept_ex(int accept_sock, BIO_ADDR *addr, int options);
d33b215b
RL
880int BIO_closesocket(int sock);
881
d02b48c6 882BIO *BIO_new_socket(int sock, int close_flag);
c45a48c1
BL
883BIO *BIO_new_connect(const char *host_port);
884BIO *BIO_new_accept(const char *host_port);
f863ad0c
MC
885# endif /* OPENSSL_NO_SOCK*/
886
887BIO *BIO_new_fd(int fd, int close_flag);
d02b48c6 888
95d29597 889int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
0f113f3e 890 BIO **bio2, size_t writebuf2);
b88ce46e
HL
891# ifndef OPENSSL_NO_DGRAM
892int BIO_new_bio_dgram_pair(BIO **bio1, size_t writebuf1,
893 BIO **bio2, size_t writebuf2);
894# endif
895
0f113f3e
MC
896/*
897 * If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
898 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. Size 0 uses default
899 * value.
95d29597
BM
900 */
901
d02b48c6
RE
902void BIO_copy_next_retry(BIO *b);
903
0f113f3e
MC
904/*
905 * long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
906 */
58964a49 907
4f090f76 908# define ossl_bio__attr__(x)
f3ac964b 909# if defined(__GNUC__) && defined(__STDC_VERSION__) \
a1de5eb8 910 && !defined(__MINGW32__) && !defined(__MINGW64__) \
f3ac964b 911 && !defined(__APPLE__)
1e53a9fd
RL
912 /*
913 * Because we support the 'z' modifier, which made its appearance in C99,
914 * we can't use __attribute__ with pre C99 dialects.
915 */
916# if __STDC_VERSION__ >= 199901L
4f090f76
BE
917# undef ossl_bio__attr__
918# define ossl_bio__attr__ __attribute__
919# if __GNUC__*10 + __GNUC_MINOR__ >= 44
920# define ossl_bio__printf__ __gnu_printf__
921# else
922# define ossl_bio__printf__ __printf__
923# endif
1e53a9fd 924# endif
0f113f3e 925# endif
68b42986 926int BIO_printf(BIO *bio, const char *format, ...)
4f090f76 927ossl_bio__attr__((__format__(ossl_bio__printf__, 2, 3)));
68b42986 928int BIO_vprintf(BIO *bio, const char *format, va_list args)
4f090f76 929ossl_bio__attr__((__format__(ossl_bio__printf__, 2, 0)));
68b42986 930int BIO_snprintf(char *buf, size_t n, const char *format, ...)
4f090f76 931ossl_bio__attr__((__format__(ossl_bio__printf__, 3, 4)));
68b42986 932int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args)
4f090f76
BE
933ossl_bio__attr__((__format__(ossl_bio__printf__, 3, 0)));
934# undef ossl_bio__attr__
935# undef ossl_bio__printf__
d02b48c6 936
a146ae55
MC
937
938BIO_METHOD *BIO_meth_new(int type, const char *name);
939void BIO_meth_free(BIO_METHOD *biom);
693be9a2
JB
940int (*BIO_meth_get_write(const BIO_METHOD *biom)) (BIO *, const char *, int);
941int (*BIO_meth_get_write_ex(const BIO_METHOD *biom)) (BIO *, const char *, size_t,
3befffa3 942 size_t *);
a146ae55
MC
943int BIO_meth_set_write(BIO_METHOD *biom,
944 int (*write) (BIO *, const char *, int));
3befffa3
MC
945int BIO_meth_set_write_ex(BIO_METHOD *biom,
946 int (*bwrite) (BIO *, const char *, size_t, size_t *));
e0c4e43e
HL
947int BIO_meth_set_sendmmsg(BIO_METHOD *biom,
948 int (*f) (BIO *, BIO_MSG *, size_t, size_t,
949 uint64_t, size_t *));
950int (*BIO_meth_get_sendmmsg(const BIO_METHOD *biom))(BIO *, BIO_MSG *,
951 size_t, size_t,
952 uint64_t, size_t *);
693be9a2
JB
953int (*BIO_meth_get_read(const BIO_METHOD *biom)) (BIO *, char *, int);
954int (*BIO_meth_get_read_ex(const BIO_METHOD *biom)) (BIO *, char *, size_t, size_t *);
a146ae55
MC
955int BIO_meth_set_read(BIO_METHOD *biom,
956 int (*read) (BIO *, char *, int));
d07aee2c
MC
957int BIO_meth_set_read_ex(BIO_METHOD *biom,
958 int (*bread) (BIO *, char *, size_t, size_t *));
e0c4e43e
HL
959int BIO_meth_set_recvmmsg(BIO_METHOD *biom,
960 int (*f) (BIO *, BIO_MSG *, size_t, size_t,
961 uint64_t, size_t *));
962int (*BIO_meth_get_recvmmsg(const BIO_METHOD *biom))(BIO *, BIO_MSG *,
963 size_t, size_t,
964 uint64_t, size_t *);
693be9a2 965int (*BIO_meth_get_puts(const BIO_METHOD *biom)) (BIO *, const char *);
a146ae55
MC
966int BIO_meth_set_puts(BIO_METHOD *biom,
967 int (*puts) (BIO *, const char *));
693be9a2 968int (*BIO_meth_get_gets(const BIO_METHOD *biom)) (BIO *, char *, int);
a146ae55
MC
969int BIO_meth_set_gets(BIO_METHOD *biom,
970 int (*gets) (BIO *, char *, int));
693be9a2 971long (*BIO_meth_get_ctrl(const BIO_METHOD *biom)) (BIO *, int, long, void *);
a146ae55
MC
972int BIO_meth_set_ctrl(BIO_METHOD *biom,
973 long (*ctrl) (BIO *, int, long, void *));
693be9a2 974int (*BIO_meth_get_create(const BIO_METHOD *bion)) (BIO *);
a146ae55 975int BIO_meth_set_create(BIO_METHOD *biom, int (*create) (BIO *));
693be9a2 976int (*BIO_meth_get_destroy(const BIO_METHOD *biom)) (BIO *);
a146ae55 977int BIO_meth_set_destroy(BIO_METHOD *biom, int (*destroy) (BIO *));
693be9a2 978long (*BIO_meth_get_callback_ctrl(const BIO_METHOD *biom))
fce78bd4 979 (BIO *, int, BIO_info_cb *);
a146ae55
MC
980int BIO_meth_set_callback_ctrl(BIO_METHOD *biom,
981 long (*callback_ctrl) (BIO *, int,
fce78bd4 982 BIO_info_cb *));
0cd0a820 983
0cd0a820 984# ifdef __cplusplus
d02b48c6 985}
0cd0a820 986# endif
d02b48c6 987#endif