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