Copyright year updates
[openssl.git] / include / openssl / bio.h.in
1 /*
2  * {- join("\n * ", @autowarntext) -}
3  *
4  * Copyright 1995-2023 The OpenSSL Project Authors. All Rights Reserved.
5  *
6  * Licensed under the Apache License 2.0 (the "License").  You may not use
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
10  */
11 {-
12 use OpenSSL::stackhash qw(generate_stack_macros);
13 -}
14
15 #ifndef OPENSSL_BIO_H
16 # define OPENSSL_BIO_H
17 # pragma once
18
19 # include <openssl/macros.h>
20 # ifndef OPENSSL_NO_DEPRECATED_3_0
21 #  define HEADER_BIO_H
22 # endif
23
24 # include <openssl/e_os2.h>
25
26 # ifndef OPENSSL_NO_STDIO
27 #  include <stdio.h>
28 # endif
29 # include <stdarg.h>
30
31 # include <openssl/crypto.h>
32 # include <openssl/bioerr.h>
33 # include <openssl/core.h>
34
35 #ifdef  __cplusplus
36 extern "C" {
37 #endif
38
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
44 /* These are the 'types' of BIOs */
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)
67 # ifndef OPENSSL_NO_SCTP
68 #  define BIO_TYPE_DGRAM_SCTP    (24|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
69 # endif
70 # define BIO_TYPE_CORE_TO_PROV   (25|BIO_TYPE_SOURCE_SINK)
71 # define BIO_TYPE_DGRAM_PAIR     (26|BIO_TYPE_SOURCE_SINK)
72 # define BIO_TYPE_DGRAM_MEM      (27|BIO_TYPE_SOURCE_SINK)
73
74 #define BIO_TYPE_START           128
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 */
99 # define BIO_CTRL_SET_CALLBACK   14/* opt - set callback function */
100 # define BIO_CTRL_GET_CALLBACK   15/* opt - set callback function */
101
102 # define BIO_CTRL_PEEK           29/* BIO_f_buffer special */
103 # define BIO_CTRL_SET_FILENAME   30/* BIO_s_file special */
104
105 /* dgram BIO stuff */
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 */
115 # define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38/* I/O operation timed out */
116
117 /* #ifdef IP_MTU_DISCOVER */
118 # define BIO_CTRL_DGRAM_MTU_DISCOVER       39/* set DF bit on egress packets */
119 /* #endif */
120
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 */
127
128 # define BIO_CTRL_DGRAM_MTU_EXCEEDED       43/* check whether the MTU was
129                                               * exceed in the previous write
130                                               * operation */
131
132 # define BIO_CTRL_DGRAM_GET_PEER           46
133 # define BIO_CTRL_DGRAM_SET_PEER           44/* Destination for the data */
134
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
138
139 # define BIO_CTRL_DGRAM_GET_MTU_OVERHEAD   49
140
141 /* Deliberately outside of OPENSSL_NO_SCTP - used in bss_dgram.c */
142 #  define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE    50
143 # ifndef OPENSSL_NO_SCTP
144 /* SCTP stuff */
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
156
157 # define BIO_CTRL_DGRAM_SET_PEEK_MODE      71
158
159 /*
160  * internal BIO:
161  * # define BIO_CTRL_SET_KTLS_SEND                 72
162  * # define BIO_CTRL_SET_KTLS_SEND_CTRL_MSG        74
163  * # define BIO_CTRL_CLEAR_KTLS_CTRL_MSG           75
164  */
165
166 # define BIO_CTRL_GET_KTLS_SEND                 73
167 # define BIO_CTRL_GET_KTLS_RECV                 76
168
169 # define BIO_CTRL_DGRAM_SCTP_WAIT_FOR_DRY       77
170 # define BIO_CTRL_DGRAM_SCTP_MSG_WAITING        78
171
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
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
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
186 /*
187  * internal BIO:
188  * # define BIO_CTRL_SET_KTLS_TX_ZEROCOPY_SENDFILE 90
189  */
190
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
194
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)
200
201 # ifndef OPENSSL_NO_KTLS
202 #  define BIO_get_ktls_send(b)         \
203      (BIO_ctrl(b, BIO_CTRL_GET_KTLS_SEND, 0, NULL) > 0)
204 #  define BIO_get_ktls_recv(b)         \
205      (BIO_ctrl(b, BIO_CTRL_GET_KTLS_RECV, 0, NULL) > 0)
206 # else
207 #  define BIO_get_ktls_send(b)  (0)
208 #  define BIO_get_ktls_recv(b)  (0)
209 # endif
210
211 /* modifiers */
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
222 # ifndef OPENSSL_NO_DEPRECATED_3_0
223 /* This #define was replaced by an internal constant and should not be used. */
224 #  define BIO_FLAGS_UPLINK       0
225 # endif
226
227 # define BIO_FLAGS_BASE64_NO_NL  0x100
228
229 /*
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;
232  * BIO_FLAGS_NONCLEAR_RST means we shouldn't clear data on reset.
233  */
234 # define BIO_FLAGS_MEM_RDONLY    0x200
235 # define BIO_FLAGS_NONCLEAR_RST  0x400
236 # define BIO_FLAGS_IN_EOF        0x800
237
238 /* the BIO FLAGS values 0x1000 to 0x8000 are reserved for internal KTLS flags */
239
240 typedef union bio_addr_st BIO_ADDR;
241 typedef struct bio_addrinfo_st BIO_ADDRINFO;
242
243 int BIO_get_new_index(void);
244 void BIO_set_flags(BIO *b, int flags);
245 int BIO_test_flags(const BIO *b, int flags);
246 void BIO_clear_flags(BIO *b, int flags);
247
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))
255
256 /* These are normally used internally in BIOs */
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))
261
262 /* These should be used by the application to tell why we should retry */
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
280 /* Returned from the connect BIO when a connect would have blocked */
281 # define BIO_RR_CONNECT                  0x02
282 /* Returned from the accept BIO when an accept would have blocked */
283 # define BIO_RR_ACCEPT                   0x03
284
285 /* These are passed by the BIO callback */
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
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
300 # define BIO_CB_return(a) ((a)|BIO_CB_RETURN)
301 # define BIO_cb_pre(a)   (!((a)&BIO_CB_RETURN))
302 # define BIO_cb_post(a)  ((a)&BIO_CB_RETURN)
303
304 # ifndef OPENSSL_NO_DEPRECATED_3_0
305 typedef long (*BIO_callback_fn)(BIO *b, int oper, const char *argp, int argi,
306                                 long argl, long ret);
307 OSSL_DEPRECATEDIN_3_0 BIO_callback_fn BIO_get_callback(const BIO *b);
308 OSSL_DEPRECATEDIN_3_0 void BIO_set_callback(BIO *b, BIO_callback_fn callback);
309 OSSL_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
314 typedef long (*BIO_callback_fn_ex)(BIO *b, int oper, const char *argp,
315                                    size_t len, int argi,
316                                    long argl, int ret, size_t *processed);
317 BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b);
318 void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex callback);
319 long BIO_debug_callback_ex(BIO *bio, int oper, const char *argp, size_t len,
320                            int argi, long argl, int ret, size_t *processed);
321
322 char *BIO_get_callback_arg(const BIO *b);
323 void BIO_set_callback_arg(BIO *b, char *arg);
324
325 typedef struct bio_method_st BIO_METHOD;
326
327 const char *BIO_method_name(const BIO *b);
328 int BIO_method_type(const BIO *b);
329
330 typedef int BIO_info_cb(BIO *, int, int);
331 typedef BIO_info_cb bio_info_cb;  /* backward compatibility */
332
333 {-
334     generate_stack_macros("BIO");
335 -}
336
337
338 /* Prefix and suffix callback in ASN1 BIO */
339 typedef int asn1_ps_func (BIO *b, unsigned char **pbuf, int *plen,
340                           void *parg);
341
342 typedef void (*BIO_dgram_sctp_notification_handler_fn) (BIO *b,
343                                                         void *context,
344                                                         void *buf);
345 # ifndef OPENSSL_NO_SCTP
346 /* SCTP parameter structs */
347 struct 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
354 struct 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
364 struct bio_dgram_sctp_prinfo {
365     uint16_t pr_policy;
366     uint32_t pr_value;
367 };
368 # endif
369
370 /* BIO_sendmmsg/BIO_recvmmsg-related definitions */
371 typedef 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
378 typedef 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
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
388
389 typedef struct bio_poll_descriptor_st {
390     uint32_t type;
391     union {
392         int         fd;
393         void        *custom;
394         uintptr_t   custom_ui;
395     } value;
396 } BIO_POLL_DESCRIPTOR;
397
398 /*
399  * #define BIO_CONN_get_param_hostname BIO_ctrl
400  */
401
402 # define BIO_C_SET_CONNECT                       100
403 # define BIO_C_DO_STATE_MACHINE                  101
404 # define BIO_C_SET_NBIO                          102
405 /* # define BIO_C_SET_PROXY_PARAM                   103 */
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
423 /* # define BIO_C_GET_PROXY_PARAM                   121 */
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
462 # define BIO_C_SET_CONNECT_MODE                  155
463
464 # define BIO_C_SET_TFO                           156 /* like BIO_C_SET_NBIO */
465
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
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)
472
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)
475
476 # ifndef OPENSSL_NO_SOCK
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 */
479 #  define BIO_FAMILY_IPV4                         4
480 #  define BIO_FAMILY_IPV6                         6
481 #  define BIO_FAMILY_IPANY                        256
482
483 /* BIO_s_connect() */
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))
490 #  define BIO_set_conn_ip_family(b,f)   BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,f)
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))
494 #  define BIO_get_conn_ip_family(b)     BIO_ctrl(b,BIO_C_GET_CONNECT,3,NULL)
495 #  define BIO_get_conn_mode(b)          BIO_ctrl(b,BIO_C_GET_CONNECT,4,NULL)
496 #  define BIO_set_conn_mode(b,n)        BIO_ctrl(b,BIO_C_SET_CONNECT_MODE,(n),NULL)
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)
499 #  define BIO_get0_dgram_bio(b, p)      BIO_ctrl(b,BIO_C_GET_DGRAM_BIO,0,(void *)(BIO **)(p))
500
501 /* BIO_s_accept() */
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))
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))
510 /* #define BIO_set_nbio(b,n)    BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
511 #  define BIO_set_nbio_accept(b,n)      BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(n)?(void *)"a":NULL)
512 #  define BIO_set_accept_bios(b,bio)    BIO_ctrl(b,BIO_C_SET_ACCEPT,3, \
513                                                  (char *)(bio))
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)
516 #  define BIO_set_tfo_accept(b,n)       BIO_ctrl(b,BIO_C_SET_ACCEPT,5,(n)?(void *)"a":NULL)
517
518 /* Aliases kept for backward compatibility */
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)
524 # endif /* OPENSSL_NO_SOCK */
525
526 # define BIO_do_connect(b)       BIO_do_handshake(b)
527 # define BIO_do_accept(b)        BIO_do_handshake(b)
528
529 # define BIO_do_handshake(b)     BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
530
531 /* BIO_s_datagram(), BIO_s_fd(), BIO_s_socket(), BIO_s_accept() and BIO_s_connect() */
532 # define BIO_set_fd(b,fd,c)      BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
533 # define BIO_get_fd(b,c)         BIO_ctrl(b,BIO_C_GET_FD,0,(char *)(c))
534
535 /* BIO_s_file() */
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))
538
539 /* BIO_s_fd() and BIO_s_file() */
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)
542
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
550  * purely a compile-time kludge to allow const to be checked.
551  */
552 int BIO_read_filename(BIO *b, const char *name);
553 # else
554 #  define BIO_read_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
555                 BIO_CLOSE|BIO_FP_READ,(char *)(name))
556 # endif
557 # define BIO_write_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
558                 BIO_CLOSE|BIO_FP_WRITE,name)
559 # define BIO_append_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
560                 BIO_CLOSE|BIO_FP_APPEND,name)
561 # define BIO_rw_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
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  */
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))
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) \
574         BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL)
575 # define BIO_get_num_renegotiates(b) \
576         BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL)
577 # define BIO_set_ssl_renegotiate_timeout(b,seconds) \
578         BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL)
579
580 /* defined in evp.h */
581 /* #define BIO_set_md(b,md)     BIO_ctrl(b,BIO_C_SET_MD,1,(char *)(md)) */
582
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))
587 # define BIO_set_mem_eof_return(b,v) \
588                                 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
589
590 /* For the BIO_f_buffer() type */
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)
596
597 /* Don't use the next one unless you know what you are doing :-) */
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)
606 /* ...pending macros have inappropriate return type */
607 size_t BIO_ctrl_pending(BIO *b);
608 size_t BIO_ctrl_wpending(BIO *b);
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)
613
614 /* For the BIO_f_buffer() type */
615 # define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
616 # define BIO_buffer_peek(b,s,l) BIO_ctrl(b,BIO_CTRL_PEEK,(l),(s))
617
618 /* For BIO_s_bio() */
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)
624 /* macros with inappropriate type -- but ...pending macros use int too: */
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)
627 size_t BIO_ctrl_get_write_guarantee(BIO *b);
628 size_t BIO_ctrl_get_read_request(BIO *b);
629 int BIO_ctrl_reset_read_request(BIO *b);
630
631 /* ctrl macros for dgram */
632 # define BIO_ctrl_dgram_connect(b,peer)  \
633                      (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)(peer))
634 # define BIO_ctrl_set_connected(b,peer) \
635          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, 0, (char *)(peer))
636 # define BIO_dgram_recv_timedout(b) \
637          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
638 # define BIO_dgram_send_timedout(b) \
639          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
640 # define BIO_dgram_get_peer(b,peer) \
641          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)(peer))
642 # define BIO_dgram_set_peer(b,peer) \
643          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)(peer))
644 # define BIO_dgram_detect_peer_addr(b,peer) \
645          (int)BIO_ctrl(b, BIO_CTRL_DGRAM_DETECT_PEER_ADDR, 0, (char *)(peer))
646 # define BIO_dgram_get_mtu_overhead(b) \
647          (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU_OVERHEAD, 0, NULL)
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)
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)
668
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
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)
676 int BIO_set_ex_data(BIO *bio, int idx, void *data);
677 void *BIO_get_ex_data(const BIO *bio, int idx);
678 uint64_t BIO_number_read(BIO *bio);
679 uint64_t BIO_number_written(BIO *bio);
680
681 /* For BIO_f_asn1() */
682 int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix,
683                         asn1_ps_func *prefix_free);
684 int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix,
685                         asn1_ps_func **pprefix_free);
686 int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix,
687                         asn1_ps_func *suffix_free);
688 int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix,
689                         asn1_ps_func **psuffix_free);
690
691 const BIO_METHOD *BIO_s_file(void);
692 BIO *BIO_new_file(const char *filename, const char *mode);
693 BIO *BIO_new_from_core_bio(OSSL_LIB_CTX *libctx, OSSL_CORE_BIO *corebio);
694 # ifndef OPENSSL_NO_STDIO
695 BIO *BIO_new_fp(FILE *stream, int close_flag);
696 # endif
697 BIO *BIO_new_ex(OSSL_LIB_CTX *libctx, const BIO_METHOD *method);
698 BIO *BIO_new(const BIO_METHOD *type);
699 int BIO_free(BIO *a);
700 void BIO_set_data(BIO *a, void *ptr);
701 void *BIO_get_data(BIO *a);
702 void BIO_set_init(BIO *a, int init);
703 int BIO_get_init(BIO *a);
704 void BIO_set_shutdown(BIO *a, int shut);
705 int BIO_get_shutdown(BIO *a);
706 void BIO_vfree(BIO *a);
707 int BIO_up_ref(BIO *a);
708 int BIO_read(BIO *b, void *data, int dlen);
709 int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes);
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);
713 int BIO_gets(BIO *bp, char *buf, int size);
714 int BIO_get_line(BIO *bio, char *buf, int size);
715 int BIO_write(BIO *b, const void *data, int dlen);
716 int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written);
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);
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);
722 int BIO_puts(BIO *bp, const char *buf);
723 int BIO_indent(BIO *b, int indent, int max);
724 long BIO_ctrl(BIO *bp, int cmd, long larg, void *parg);
725 long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp);
726 void *BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
727 long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
728 BIO *BIO_push(BIO *b, BIO *append);
729 BIO *BIO_pop(BIO *b);
730 void BIO_free_all(BIO *a);
731 BIO *BIO_find_type(BIO *b, int bio_type);
732 BIO *BIO_next(BIO *b);
733 void BIO_set_next(BIO *b, BIO *next);
734 BIO *BIO_get_retry_BIO(BIO *bio, int *reason);
735 int BIO_get_retry_reason(BIO *bio);
736 void BIO_set_retry_reason(BIO *bio, int reason);
737 BIO *BIO_dup_chain(BIO *in);
738
739 int BIO_nread0(BIO *bio, char **buf);
740 int BIO_nread(BIO *bio, char **buf, int num);
741 int BIO_nwrite0(BIO *bio, char **buf);
742 int BIO_nwrite(BIO *bio, char **buf, int num);
743
744 const BIO_METHOD *BIO_s_mem(void);
745 # ifndef OPENSSL_NO_DGRAM
746 const BIO_METHOD *BIO_s_dgram_mem(void);
747 # endif
748 const BIO_METHOD *BIO_s_secmem(void);
749 BIO *BIO_new_mem_buf(const void *buf, int len);
750 # ifndef OPENSSL_NO_SOCK
751 const BIO_METHOD *BIO_s_socket(void);
752 const BIO_METHOD *BIO_s_connect(void);
753 const BIO_METHOD *BIO_s_accept(void);
754 # endif
755 const BIO_METHOD *BIO_s_fd(void);
756 const BIO_METHOD *BIO_s_log(void);
757 const BIO_METHOD *BIO_s_bio(void);
758 const BIO_METHOD *BIO_s_null(void);
759 const BIO_METHOD *BIO_f_null(void);
760 const BIO_METHOD *BIO_f_buffer(void);
761 const BIO_METHOD *BIO_f_readbuffer(void);
762 const BIO_METHOD *BIO_f_linebuffer(void);
763 const BIO_METHOD *BIO_f_nbio_test(void);
764 const BIO_METHOD *BIO_f_prefix(void);
765 const BIO_METHOD *BIO_s_core(void);
766 # ifndef OPENSSL_NO_DGRAM
767 const BIO_METHOD *BIO_s_dgram_pair(void);
768 const BIO_METHOD *BIO_s_datagram(void);
769 int BIO_dgram_non_fatal_error(int error);
770 BIO *BIO_new_dgram(int fd, int close_flag);
771 #  ifndef OPENSSL_NO_SCTP
772 const BIO_METHOD *BIO_s_datagram_sctp(void);
773 BIO *BIO_new_dgram_sctp(int fd, int close_flag);
774 int BIO_dgram_is_sctp(BIO *bio);
775 int BIO_dgram_sctp_notification_cb(BIO *b,
776                 BIO_dgram_sctp_notification_handler_fn handle_notifications,
777                 void *context);
778 int BIO_dgram_sctp_wait_for_dry(BIO *b);
779 int BIO_dgram_sctp_msg_waiting(BIO *b);
780 #  endif
781 # endif
782
783 # ifndef OPENSSL_NO_SOCK
784 int BIO_sock_should_retry(int i);
785 int BIO_sock_non_fatal_error(int error);
786 int BIO_err_is_non_fatal(unsigned int errcode);
787 int BIO_socket_wait(int fd, int for_read, time_t max_time);
788 # endif
789 int BIO_wait(BIO *bio, time_t max_time, unsigned int nap_milliseconds);
790 int BIO_do_connect_retry(BIO *bio, int timeout, int nap_milliseconds);
791
792 int BIO_fd_should_retry(int i);
793 int BIO_fd_non_fatal_error(int error);
794 int BIO_dump_cb(int (*cb) (const void *data, size_t len, void *u),
795                 void *u, const void *s, int len);
796 int BIO_dump_indent_cb(int (*cb) (const void *data, size_t len, void *u),
797                        void *u, const void *s, int len, int indent);
798 int BIO_dump(BIO *b, const void *bytes, int len);
799 int BIO_dump_indent(BIO *b, const void *bytes, int len, int indent);
800 # ifndef OPENSSL_NO_STDIO
801 int BIO_dump_fp(FILE *fp, const void *s, int len);
802 int BIO_dump_indent_fp(FILE *fp, const void *s, int len, int indent);
803 # endif
804 int BIO_hex_string(BIO *out, int indent, int width, const void *data,
805                    int datalen);
806
807 # ifndef OPENSSL_NO_SOCK
808 BIO_ADDR *BIO_ADDR_new(void);
809 BIO_ADDR *BIO_ADDR_dup(const BIO_ADDR *ap);
810 int BIO_ADDR_rawmake(BIO_ADDR *ap, int family,
811                      const void *where, size_t wherelen, unsigned short port);
812 void BIO_ADDR_free(BIO_ADDR *);
813 void BIO_ADDR_clear(BIO_ADDR *ap);
814 int BIO_ADDR_family(const BIO_ADDR *ap);
815 int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l);
816 unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap);
817 char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric);
818 char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric);
819 char *BIO_ADDR_path_string(const BIO_ADDR *ap);
820
821 const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai);
822 int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai);
823 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai);
824 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai);
825 const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai);
826 void BIO_ADDRINFO_free(BIO_ADDRINFO *bai);
827
828 enum BIO_hostserv_priorities {
829     BIO_PARSE_PRIO_HOST, BIO_PARSE_PRIO_SERV
830 };
831 int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
832                        enum BIO_hostserv_priorities hostserv_prio);
833 enum BIO_lookup_type {
834     BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER
835 };
836 int BIO_lookup(const char *host, const char *service,
837                enum BIO_lookup_type lookup_type,
838                int family, int socktype, BIO_ADDRINFO **res);
839 int BIO_lookup_ex(const char *host, const char *service,
840                   int lookup_type, int family, int socktype, int protocol,
841                   BIO_ADDRINFO **res);
842 int BIO_sock_error(int sock);
843 int BIO_socket_ioctl(int fd, long type, void *arg);
844 int BIO_socket_nbio(int fd, int mode);
845 int BIO_sock_init(void);
846 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
847 #  define BIO_sock_cleanup() while(0) continue
848 # endif
849 int BIO_set_tcp_ndelay(int sock, int turn_on);
850 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
851 OSSL_DEPRECATEDIN_1_1_0 struct hostent *BIO_gethostbyname(const char *name);
852 OSSL_DEPRECATEDIN_1_1_0 int BIO_get_port(const char *str, unsigned short *port_ptr);
853 OSSL_DEPRECATEDIN_1_1_0 int BIO_get_host_ip(const char *str, unsigned char *ip);
854 OSSL_DEPRECATEDIN_1_1_0 int BIO_get_accept_socket(char *host_port, int mode);
855 OSSL_DEPRECATEDIN_1_1_0 int BIO_accept(int sock, char **ip_port);
856 # endif
857
858 union BIO_sock_info_u {
859     BIO_ADDR *addr;
860 };
861 enum BIO_sock_info_type {
862     BIO_SOCK_INFO_ADDRESS
863 };
864 int BIO_sock_info(int sock,
865                   enum BIO_sock_info_type type, union BIO_sock_info_u *info);
866
867 #  define BIO_SOCK_REUSEADDR    0x01
868 #  define BIO_SOCK_V6_ONLY      0x02
869 #  define BIO_SOCK_KEEPALIVE    0x04
870 #  define BIO_SOCK_NONBLOCK     0x08
871 #  define BIO_SOCK_NODELAY      0x10
872 #  define BIO_SOCK_TFO          0x20
873
874 int BIO_socket(int domain, int socktype, int protocol, int options);
875 int BIO_connect(int sock, const BIO_ADDR *addr, int options);
876 int BIO_bind(int sock, const BIO_ADDR *addr, int options);
877 int BIO_listen(int sock, const BIO_ADDR *addr, int options);
878 int BIO_accept_ex(int accept_sock, BIO_ADDR *addr, int options);
879 int BIO_closesocket(int sock);
880
881 BIO *BIO_new_socket(int sock, int close_flag);
882 BIO *BIO_new_connect(const char *host_port);
883 BIO *BIO_new_accept(const char *host_port);
884 # endif /* OPENSSL_NO_SOCK*/
885
886 BIO *BIO_new_fd(int fd, int close_flag);
887
888 int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
889                      BIO **bio2, size_t writebuf2);
890 # ifndef OPENSSL_NO_DGRAM
891 int BIO_new_bio_dgram_pair(BIO **bio1, size_t writebuf1,
892                            BIO **bio2, size_t writebuf2);
893 # endif
894
895 /*
896  * If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
897  * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. Size 0 uses default
898  * value.
899  */
900
901 void BIO_copy_next_retry(BIO *b);
902
903 /*
904  * long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
905  */
906
907 # define ossl_bio__attr__(x)
908 # if defined(__GNUC__) && defined(__STDC_VERSION__) \
909     && !defined(__MINGW32__) && !defined(__MINGW64__) \
910     && !defined(__APPLE__)
911     /*
912      * Because we support the 'z' modifier, which made its appearance in C99,
913      * we can't use __attribute__ with pre C99 dialects.
914      */
915 #  if __STDC_VERSION__ >= 199901L
916 #   undef ossl_bio__attr__
917 #   define ossl_bio__attr__ __attribute__
918 #   if __GNUC__*10 + __GNUC_MINOR__ >= 44
919 #    define ossl_bio__printf__ __gnu_printf__
920 #   else
921 #    define ossl_bio__printf__ __printf__
922 #   endif
923 #  endif
924 # endif
925 int BIO_printf(BIO *bio, const char *format, ...)
926 ossl_bio__attr__((__format__(ossl_bio__printf__, 2, 3)));
927 int BIO_vprintf(BIO *bio, const char *format, va_list args)
928 ossl_bio__attr__((__format__(ossl_bio__printf__, 2, 0)));
929 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
930 ossl_bio__attr__((__format__(ossl_bio__printf__, 3, 4)));
931 int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args)
932 ossl_bio__attr__((__format__(ossl_bio__printf__, 3, 0)));
933 # undef ossl_bio__attr__
934 # undef ossl_bio__printf__
935
936
937 BIO_METHOD *BIO_meth_new(int type, const char *name);
938 void BIO_meth_free(BIO_METHOD *biom);
939 int (*BIO_meth_get_write(const BIO_METHOD *biom)) (BIO *, const char *, int);
940 int (*BIO_meth_get_write_ex(const BIO_METHOD *biom)) (BIO *, const char *, size_t,
941                                                 size_t *);
942 int BIO_meth_set_write(BIO_METHOD *biom,
943                        int (*write) (BIO *, const char *, int));
944 int BIO_meth_set_write_ex(BIO_METHOD *biom,
945                        int (*bwrite) (BIO *, const char *, size_t, size_t *));
946 int BIO_meth_set_sendmmsg(BIO_METHOD *biom,
947                           int (*f) (BIO *, BIO_MSG *, size_t, size_t,
948                                     uint64_t, size_t *));
949 int (*BIO_meth_get_sendmmsg(const BIO_METHOD *biom))(BIO *, BIO_MSG *,
950                                                      size_t, size_t,
951                                                      uint64_t, size_t *);
952 int (*BIO_meth_get_read(const BIO_METHOD *biom)) (BIO *, char *, int);
953 int (*BIO_meth_get_read_ex(const BIO_METHOD *biom)) (BIO *, char *, size_t, size_t *);
954 int BIO_meth_set_read(BIO_METHOD *biom,
955                       int (*read) (BIO *, char *, int));
956 int BIO_meth_set_read_ex(BIO_METHOD *biom,
957                          int (*bread) (BIO *, char *, size_t, size_t *));
958 int BIO_meth_set_recvmmsg(BIO_METHOD *biom,
959                           int (*f) (BIO *, BIO_MSG *, size_t, size_t,
960                                     uint64_t, size_t *));
961 int (*BIO_meth_get_recvmmsg(const BIO_METHOD *biom))(BIO *, BIO_MSG *,
962                                                      size_t, size_t,
963                                                      uint64_t, size_t *);
964 int (*BIO_meth_get_puts(const BIO_METHOD *biom)) (BIO *, const char *);
965 int BIO_meth_set_puts(BIO_METHOD *biom,
966                       int (*puts) (BIO *, const char *));
967 int (*BIO_meth_get_gets(const BIO_METHOD *biom)) (BIO *, char *, int);
968 int BIO_meth_set_gets(BIO_METHOD *biom,
969                       int (*gets) (BIO *, char *, int));
970 long (*BIO_meth_get_ctrl(const BIO_METHOD *biom)) (BIO *, int, long, void *);
971 int BIO_meth_set_ctrl(BIO_METHOD *biom,
972                       long (*ctrl) (BIO *, int, long, void *));
973 int (*BIO_meth_get_create(const BIO_METHOD *bion)) (BIO *);
974 int BIO_meth_set_create(BIO_METHOD *biom, int (*create) (BIO *));
975 int (*BIO_meth_get_destroy(const BIO_METHOD *biom)) (BIO *);
976 int BIO_meth_set_destroy(BIO_METHOD *biom, int (*destroy) (BIO *));
977 long (*BIO_meth_get_callback_ctrl(const BIO_METHOD *biom))
978                                  (BIO *, int, BIO_info_cb *);
979 int BIO_meth_set_callback_ctrl(BIO_METHOD *biom,
980                                long (*callback_ctrl) (BIO *, int,
981                                                       BIO_info_cb *));
982
983 # ifdef  __cplusplus
984 }
985 # endif
986 #endif