2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
11 # define OPENSSL_BIO_H
14 # include <openssl/macros.h>
15 # ifndef OPENSSL_NO_DEPRECATED_3_0
19 # include <openssl/e_os2.h>
21 # ifndef OPENSSL_NO_STDIO
26 # include <openssl/crypto.h>
27 # include <openssl/bioerr.h>
33 /* There are the classes of BIOs */
34 # define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */
35 # define BIO_TYPE_FILTER 0x0200
36 # define BIO_TYPE_SOURCE_SINK 0x0400
38 /* These are the 'types' of BIOs */
39 # define BIO_TYPE_NONE 0
40 # define BIO_TYPE_MEM ( 1|BIO_TYPE_SOURCE_SINK)
41 # define BIO_TYPE_FILE ( 2|BIO_TYPE_SOURCE_SINK)
43 # define BIO_TYPE_FD ( 4|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
44 # define BIO_TYPE_SOCKET ( 5|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
45 # define BIO_TYPE_NULL ( 6|BIO_TYPE_SOURCE_SINK)
46 # define BIO_TYPE_SSL ( 7|BIO_TYPE_FILTER)
47 # define BIO_TYPE_MD ( 8|BIO_TYPE_FILTER)
48 # define BIO_TYPE_BUFFER ( 9|BIO_TYPE_FILTER)
49 # define BIO_TYPE_CIPHER (10|BIO_TYPE_FILTER)
50 # define BIO_TYPE_BASE64 (11|BIO_TYPE_FILTER)
51 # define BIO_TYPE_CONNECT (12|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
52 # define BIO_TYPE_ACCEPT (13|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
54 # define BIO_TYPE_NBIO_TEST (16|BIO_TYPE_FILTER)/* server proxy BIO */
55 # define BIO_TYPE_NULL_FILTER (17|BIO_TYPE_FILTER)
56 # define BIO_TYPE_BIO (19|BIO_TYPE_SOURCE_SINK)/* half a BIO pair */
57 # define BIO_TYPE_LINEBUFFER (20|BIO_TYPE_FILTER)
58 # define BIO_TYPE_DGRAM (21|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
59 # define BIO_TYPE_ASN1 (22|BIO_TYPE_FILTER)
60 # define BIO_TYPE_COMP (23|BIO_TYPE_FILTER)
61 # ifndef OPENSSL_NO_SCTP
62 # define BIO_TYPE_DGRAM_SCTP (24|BIO_TYPE_SOURCE_SINK|BIO_TYPE_DESCRIPTOR)
65 #define BIO_TYPE_START 128
68 * BIO_FILENAME_READ|BIO_CLOSE to open or close on free.
69 * BIO_set_fp(in,stdin,BIO_NOCLOSE);
71 # define BIO_NOCLOSE 0x00
72 # define BIO_CLOSE 0x01
75 * These are used in the following macros and are passed to BIO_ctrl()
77 # define BIO_CTRL_RESET 1/* opt - rewind/zero etc */
78 # define BIO_CTRL_EOF 2/* opt - are we at the eof */
79 # define BIO_CTRL_INFO 3/* opt - extra tit-bits */
80 # define BIO_CTRL_SET 4/* man - set the 'IO' type */
81 # define BIO_CTRL_GET 5/* man - get the 'IO' type */
82 # define BIO_CTRL_PUSH 6/* opt - internal, used to signify change */
83 # define BIO_CTRL_POP 7/* opt - internal, used to signify change */
84 # define BIO_CTRL_GET_CLOSE 8/* man - set the 'close' on free */
85 # define BIO_CTRL_SET_CLOSE 9/* man - set the 'close' on free */
86 # define BIO_CTRL_PENDING 10/* opt - is their more data buffered */
87 # define BIO_CTRL_FLUSH 11/* opt - 'flush' buffered output */
88 # define BIO_CTRL_DUP 12/* man - extra stuff for 'duped' BIO */
89 # define BIO_CTRL_WPENDING 13/* opt - number of bytes still to write */
90 # define BIO_CTRL_SET_CALLBACK 14/* opt - set callback function */
91 # define BIO_CTRL_GET_CALLBACK 15/* opt - set callback function */
93 # define BIO_CTRL_PEEK 29/* BIO_f_buffer special */
94 # define BIO_CTRL_SET_FILENAME 30/* BIO_s_file special */
97 # define BIO_CTRL_DGRAM_CONNECT 31/* BIO dgram special */
98 # define BIO_CTRL_DGRAM_SET_CONNECTED 32/* allow for an externally connected
99 * socket to be passed in */
100 # define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33/* setsockopt, essentially */
101 # define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34/* getsockopt, essentially */
102 # define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35/* setsockopt, essentially */
103 # define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36/* getsockopt, essentially */
105 # define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37/* flag whether the last */
106 # define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38/* I/O operation tiemd out */
108 /* #ifdef IP_MTU_DISCOVER */
109 # define BIO_CTRL_DGRAM_MTU_DISCOVER 39/* set DF bit on egress packets */
112 # define BIO_CTRL_DGRAM_QUERY_MTU 40/* as kernel for current MTU */
113 # define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47
114 # define BIO_CTRL_DGRAM_GET_MTU 41/* get cached value for MTU */
115 # define BIO_CTRL_DGRAM_SET_MTU 42/* set cached value for MTU.
116 * want to use this if asking
117 * the kernel fails */
119 # define BIO_CTRL_DGRAM_MTU_EXCEEDED 43/* check whether the MTU was
120 * exceed in the previous write
123 # define BIO_CTRL_DGRAM_GET_PEER 46
124 # define BIO_CTRL_DGRAM_SET_PEER 44/* Destination for the data */
126 # define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45/* Next DTLS handshake timeout
127 * to adjust socket timeouts */
128 # define BIO_CTRL_DGRAM_SET_DONT_FRAG 48
130 # define BIO_CTRL_DGRAM_GET_MTU_OVERHEAD 49
132 /* Deliberately outside of OPENSSL_NO_SCTP - used in bss_dgram.c */
133 # define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE 50
134 # ifndef OPENSSL_NO_SCTP
136 # define BIO_CTRL_DGRAM_SCTP_ADD_AUTH_KEY 51
137 # define BIO_CTRL_DGRAM_SCTP_NEXT_AUTH_KEY 52
138 # define BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD 53
139 # define BIO_CTRL_DGRAM_SCTP_GET_SNDINFO 60
140 # define BIO_CTRL_DGRAM_SCTP_SET_SNDINFO 61
141 # define BIO_CTRL_DGRAM_SCTP_GET_RCVINFO 62
142 # define BIO_CTRL_DGRAM_SCTP_SET_RCVINFO 63
143 # define BIO_CTRL_DGRAM_SCTP_GET_PRINFO 64
144 # define BIO_CTRL_DGRAM_SCTP_SET_PRINFO 65
145 # define BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN 70
148 # define BIO_CTRL_DGRAM_SET_PEEK_MODE 71
152 * # define BIO_CTRL_SET_KTLS_SEND 72
153 * # define BIO_CTRL_SET_KTLS_SEND_CTRL_MSG 74
154 * # define BIO_CTRL_CLEAR_KTLS_CTRL_MSG 75
157 # define BIO_CTRL_GET_KTLS_SEND 73
158 # define BIO_CTRL_GET_KTLS_RECV 76
160 # define BIO_CTRL_DGRAM_SCTP_WAIT_FOR_DRY 77
161 # define BIO_CTRL_DGRAM_SCTP_MSG_WAITING 78
163 /* BIO_f_prefix controls */
164 # define BIO_CTRL_SET_PREFIX 79
165 # define BIO_CTRL_SET_INDENT 80
166 # define BIO_CTRL_GET_INDENT 81
168 # ifndef OPENSSL_NO_KTLS
169 # define BIO_get_ktls_send(b) \
170 BIO_ctrl(b, BIO_CTRL_GET_KTLS_SEND, 0, NULL)
171 # define BIO_get_ktls_recv(b) \
172 BIO_ctrl(b, BIO_CTRL_GET_KTLS_RECV, 0, NULL)
174 # define BIO_get_ktls_send(b) (0)
175 # define BIO_get_ktls_recv(b) (0)
179 # define BIO_FP_READ 0x02
180 # define BIO_FP_WRITE 0x04
181 # define BIO_FP_APPEND 0x08
182 # define BIO_FP_TEXT 0x10
184 # define BIO_FLAGS_READ 0x01
185 # define BIO_FLAGS_WRITE 0x02
186 # define BIO_FLAGS_IO_SPECIAL 0x04
187 # define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
188 # define BIO_FLAGS_SHOULD_RETRY 0x08
189 # ifndef OPENSSL_NO_DEPRECATED_3_0
190 /* This #define was replaced by an internal constant and should not be used. */
191 # define BIO_FLAGS_UPLINK 0
194 # define BIO_FLAGS_BASE64_NO_NL 0x100
197 * This is used with memory BIOs:
198 * BIO_FLAGS_MEM_RDONLY means we shouldn't free up or change the data in any way;
199 * BIO_FLAGS_NONCLEAR_RST means we shouldn't clear data on reset.
201 # define BIO_FLAGS_MEM_RDONLY 0x200
202 # define BIO_FLAGS_NONCLEAR_RST 0x400
204 typedef union bio_addr_st BIO_ADDR;
205 typedef struct bio_addrinfo_st BIO_ADDRINFO;
207 int BIO_get_new_index(void);
208 void BIO_set_flags(BIO *b, int flags);
209 int BIO_test_flags(const BIO *b, int flags);
210 void BIO_clear_flags(BIO *b, int flags);
212 # define BIO_get_flags(b) BIO_test_flags(b, ~(0x0))
213 # define BIO_set_retry_special(b) \
214 BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
215 # define BIO_set_retry_read(b) \
216 BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
217 # define BIO_set_retry_write(b) \
218 BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
220 /* These are normally used internally in BIOs */
221 # define BIO_clear_retry_flags(b) \
222 BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
223 # define BIO_get_retry_flags(b) \
224 BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
226 /* These should be used by the application to tell why we should retry */
227 # define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ)
228 # define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE)
229 # define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL)
230 # define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS)
231 # define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY)
234 * The next three are used in conjunction with the BIO_should_io_special()
235 * condition. After this returns true, BIO *BIO_get_retry_BIO(BIO *bio, int
236 * *reason); will walk the BIO stack and return the 'reason' for the special
237 * and the offending BIO. Given a BIO, BIO_get_retry_reason(bio) will return
241 * Returned from the SSL bio when the certificate retrieval code had an error
243 # define BIO_RR_SSL_X509_LOOKUP 0x01
244 /* Returned from the connect BIO when a connect would have blocked */
245 # define BIO_RR_CONNECT 0x02
246 /* Returned from the accept BIO when an accept would have blocked */
247 # define BIO_RR_ACCEPT 0x03
249 /* These are passed by the BIO callback */
250 # define BIO_CB_FREE 0x01
251 # define BIO_CB_READ 0x02
252 # define BIO_CB_WRITE 0x03
253 # define BIO_CB_PUTS 0x04
254 # define BIO_CB_GETS 0x05
255 # define BIO_CB_CTRL 0x06
258 * The callback is called before and after the underling operation, The
259 * BIO_CB_RETURN flag indicates if it is after the call
261 # define BIO_CB_RETURN 0x80
262 # define BIO_CB_return(a) ((a)|BIO_CB_RETURN)
263 # define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN))
264 # define BIO_cb_post(a) ((a)&BIO_CB_RETURN)
266 typedef long (*BIO_callback_fn)(BIO *b, int oper, const char *argp, int argi,
267 long argl, long ret);
268 typedef long (*BIO_callback_fn_ex)(BIO *b, int oper, const char *argp,
269 size_t len, int argi,
270 long argl, int ret, size_t *processed);
271 BIO_callback_fn BIO_get_callback(const BIO *b);
272 void BIO_set_callback(BIO *b, BIO_callback_fn callback);
274 BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b);
275 void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex callback);
277 char *BIO_get_callback_arg(const BIO *b);
278 void BIO_set_callback_arg(BIO *b, char *arg);
280 typedef struct bio_method_st BIO_METHOD;
282 const char *BIO_method_name(const BIO *b);
283 int BIO_method_type(const BIO *b);
285 typedef int BIO_info_cb(BIO *, int, int);
286 typedef BIO_info_cb bio_info_cb; /* backward compatibility */
290 /* Prefix and suffix callback in ASN1 BIO */
291 typedef int asn1_ps_func (BIO *b, unsigned char **pbuf, int *plen,
294 typedef void (*BIO_dgram_sctp_notification_handler_fn) (BIO *b,
297 # ifndef OPENSSL_NO_SCTP
298 /* SCTP parameter structs */
299 struct bio_dgram_sctp_sndinfo {
303 uint32_t snd_context;
306 struct bio_dgram_sctp_rcvinfo {
313 uint32_t rcv_context;
316 struct bio_dgram_sctp_prinfo {
323 * #define BIO_CONN_get_param_hostname BIO_ctrl
326 # define BIO_C_SET_CONNECT 100
327 # define BIO_C_DO_STATE_MACHINE 101
328 # define BIO_C_SET_NBIO 102
329 /* # define BIO_C_SET_PROXY_PARAM 103 */
330 # define BIO_C_SET_FD 104
331 # define BIO_C_GET_FD 105
332 # define BIO_C_SET_FILE_PTR 106
333 # define BIO_C_GET_FILE_PTR 107
334 # define BIO_C_SET_FILENAME 108
335 # define BIO_C_SET_SSL 109
336 # define BIO_C_GET_SSL 110
337 # define BIO_C_SET_MD 111
338 # define BIO_C_GET_MD 112
339 # define BIO_C_GET_CIPHER_STATUS 113
340 # define BIO_C_SET_BUF_MEM 114
341 # define BIO_C_GET_BUF_MEM_PTR 115
342 # define BIO_C_GET_BUFF_NUM_LINES 116
343 # define BIO_C_SET_BUFF_SIZE 117
344 # define BIO_C_SET_ACCEPT 118
345 # define BIO_C_SSL_MODE 119
346 # define BIO_C_GET_MD_CTX 120
347 /* # define BIO_C_GET_PROXY_PARAM 121 */
348 # define BIO_C_SET_BUFF_READ_DATA 122/* data to read first */
349 # define BIO_C_GET_CONNECT 123
350 # define BIO_C_GET_ACCEPT 124
351 # define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
352 # define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
353 # define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
354 # define BIO_C_FILE_SEEK 128
355 # define BIO_C_GET_CIPHER_CTX 129
356 # define BIO_C_SET_BUF_MEM_EOF_RETURN 130/* return end of input
358 # define BIO_C_SET_BIND_MODE 131
359 # define BIO_C_GET_BIND_MODE 132
360 # define BIO_C_FILE_TELL 133
361 # define BIO_C_GET_SOCKS 134
362 # define BIO_C_SET_SOCKS 135
364 # define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
365 # define BIO_C_GET_WRITE_BUF_SIZE 137
366 # define BIO_C_MAKE_BIO_PAIR 138
367 # define BIO_C_DESTROY_BIO_PAIR 139
368 # define BIO_C_GET_WRITE_GUARANTEE 140
369 # define BIO_C_GET_READ_REQUEST 141
370 # define BIO_C_SHUTDOWN_WR 142
371 # define BIO_C_NREAD0 143
372 # define BIO_C_NREAD 144
373 # define BIO_C_NWRITE0 145
374 # define BIO_C_NWRITE 146
375 # define BIO_C_RESET_READ_REQUEST 147
376 # define BIO_C_SET_MD_CTX 148
378 # define BIO_C_SET_PREFIX 149
379 # define BIO_C_GET_PREFIX 150
380 # define BIO_C_SET_SUFFIX 151
381 # define BIO_C_GET_SUFFIX 152
383 # define BIO_C_SET_EX_ARG 153
384 # define BIO_C_GET_EX_ARG 154
386 # define BIO_C_SET_CONNECT_MODE 155
388 # define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg)
389 # define BIO_get_app_data(s) BIO_get_ex_data(s,0)
391 # define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
393 # ifndef OPENSSL_NO_SOCK
394 /* IP families we support, for BIO_s_connect() and BIO_s_accept() */
395 /* Note: the underlying operating system may not support some of them */
396 # define BIO_FAMILY_IPV4 4
397 # define BIO_FAMILY_IPV6 6
398 # define BIO_FAMILY_IPANY 256
400 /* BIO_s_connect() */
401 # define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0, \
403 # define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1, \
405 # define BIO_set_conn_address(b,addr) BIO_ctrl(b,BIO_C_SET_CONNECT,2, \
407 # define BIO_set_conn_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,f)
408 # define BIO_get_conn_hostname(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0))
409 # define BIO_get_conn_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1))
410 # define BIO_get_conn_address(b) ((const BIO_ADDR *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2))
411 # define BIO_get_conn_ip_family(b) BIO_ctrl(b,BIO_C_GET_CONNECT,3,NULL)
412 # define BIO_set_conn_mode(b,n) BIO_ctrl(b,BIO_C_SET_CONNECT_MODE,(n),NULL)
415 # define BIO_set_accept_name(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0, \
417 # define BIO_set_accept_port(b,port) BIO_ctrl(b,BIO_C_SET_ACCEPT,1, \
419 # define BIO_get_accept_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0))
420 # define BIO_get_accept_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,1))
421 # define BIO_get_peer_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,2))
422 # define BIO_get_peer_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,3))
423 /* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
424 # define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(n)?(void *)"a":NULL)
425 # define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,3, \
427 # define BIO_set_accept_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_ACCEPT,4,f)
428 # define BIO_get_accept_ip_family(b) BIO_ctrl(b,BIO_C_GET_ACCEPT,4,NULL)
430 /* Aliases kept for backward compatibility */
431 # define BIO_BIND_NORMAL 0
432 # define BIO_BIND_REUSEADDR BIO_SOCK_REUSEADDR
433 # define BIO_BIND_REUSEADDR_IF_UNUSED BIO_SOCK_REUSEADDR
434 # define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
435 # define BIO_get_bind_mode(b) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
437 /* BIO_s_accept() and BIO_s_connect() */
438 # define BIO_do_connect(b) BIO_do_handshake(b)
439 # define BIO_do_accept(b) BIO_do_handshake(b)
440 # endif /* OPENSSL_NO_SOCK */
442 # define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
444 /* BIO_s_datagram(), BIO_s_fd(), BIO_s_socket(), BIO_s_accept() and BIO_s_connect() */
445 # define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
446 # define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)(c))
449 # define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)(fp))
450 # define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)(fpp))
452 /* BIO_s_fd() and BIO_s_file() */
453 # define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
454 # define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
457 * name is cast to lose const, but might be better to route through a
458 * function so we can do it safely
462 * If you are wondering why this isn't defined, its because CONST_STRICT is
463 * purely a compile-time kludge to allow const to be checked.
465 int BIO_read_filename(BIO *b, const char *name);
467 # define BIO_read_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
468 BIO_CLOSE|BIO_FP_READ,(char *)(name))
470 # define BIO_write_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
471 BIO_CLOSE|BIO_FP_WRITE,name)
472 # define BIO_append_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
473 BIO_CLOSE|BIO_FP_APPEND,name)
474 # define BIO_rw_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
475 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
478 * WARNING WARNING, this ups the reference count on the read bio of the SSL
479 * structure. This is because the ssl read BIO is now pointed to by the
480 * next_bio field in the bio. So when you free the BIO, make sure you are
481 * doing a BIO_free_all() to catch the underlying BIO.
483 # define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)(ssl))
484 # define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)(sslp))
485 # define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
486 # define BIO_set_ssl_renegotiate_bytes(b,num) \
487 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL)
488 # define BIO_get_num_renegotiates(b) \
489 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL)
490 # define BIO_set_ssl_renegotiate_timeout(b,seconds) \
491 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL)
493 /* defined in evp.h */
494 /* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)(md)) */
496 # define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)(pp))
497 # define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)(bm))
498 # define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0, \
500 # define BIO_set_mem_eof_return(b,v) \
501 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
503 /* For the BIO_f_buffer() type */
504 # define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
505 # define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
506 # define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
507 # define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
508 # define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
510 /* Don't use the next one unless you know what you are doing :-) */
511 # define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
513 # define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
514 # define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
515 # define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
516 # define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
517 # define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
518 # define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
519 /* ...pending macros have inappropriate return type */
520 size_t BIO_ctrl_pending(BIO *b);
521 size_t BIO_ctrl_wpending(BIO *b);
522 # define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
523 # define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
525 # define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
527 /* For the BIO_f_buffer() type */
528 # define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
529 # define BIO_buffer_peek(b,s,l) BIO_ctrl(b,BIO_CTRL_PEEK,(l),(s))
531 /* For BIO_s_bio() */
532 # define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
533 # define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
534 # define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
535 # define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
536 # define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
537 /* macros with inappropriate type -- but ...pending macros use int too: */
538 # define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
539 # define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
540 size_t BIO_ctrl_get_write_guarantee(BIO *b);
541 size_t BIO_ctrl_get_read_request(BIO *b);
542 int BIO_ctrl_reset_read_request(BIO *b);
544 /* ctrl macros for dgram */
545 # define BIO_ctrl_dgram_connect(b,peer) \
546 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)(peer))
547 # define BIO_ctrl_set_connected(b,peer) \
548 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, 0, (char *)(peer))
549 # define BIO_dgram_recv_timedout(b) \
550 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
551 # define BIO_dgram_send_timedout(b) \
552 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
553 # define BIO_dgram_get_peer(b,peer) \
554 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)(peer))
555 # define BIO_dgram_set_peer(b,peer) \
556 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)(peer))
557 # define BIO_dgram_get_mtu_overhead(b) \
558 (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU_OVERHEAD, 0, NULL)
560 /* ctrl macros for BIO_f_prefix */
561 # define BIO_set_prefix(b,p) BIO_ctrl((b), BIO_CTRL_SET_PREFIX, 0, (void *)(p))
562 # define BIO_set_indent(b,i) BIO_ctrl((b), BIO_CTRL_SET_INDENT, (i), NULL)
563 # define BIO_get_indent(b) BIO_ctrl((b), BIO_CTRL_GET_INDENT, 0, NULL)
565 #define BIO_get_ex_new_index(l, p, newf, dupf, freef) \
566 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_BIO, l, p, newf, dupf, freef)
567 int BIO_set_ex_data(BIO *bio, int idx, void *data);
568 void *BIO_get_ex_data(BIO *bio, int idx);
569 uint64_t BIO_number_read(BIO *bio);
570 uint64_t BIO_number_written(BIO *bio);
572 /* For BIO_f_asn1() */
573 int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix,
574 asn1_ps_func *prefix_free);
575 int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix,
576 asn1_ps_func **pprefix_free);
577 int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix,
578 asn1_ps_func *suffix_free);
579 int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix,
580 asn1_ps_func **psuffix_free);
582 const BIO_METHOD *BIO_s_file(void);
583 BIO *BIO_new_file(const char *filename, const char *mode);
584 # ifndef OPENSSL_NO_STDIO
585 BIO *BIO_new_fp(FILE *stream, int close_flag);
587 BIO *BIO_new(const BIO_METHOD *type);
588 int BIO_free(BIO *a);
589 void BIO_set_data(BIO *a, void *ptr);
590 void *BIO_get_data(BIO *a);
591 void BIO_set_init(BIO *a, int init);
592 int BIO_get_init(BIO *a);
593 void BIO_set_shutdown(BIO *a, int shut);
594 int BIO_get_shutdown(BIO *a);
595 void BIO_vfree(BIO *a);
596 int BIO_up_ref(BIO *a);
597 int BIO_read(BIO *b, void *data, int dlen);
598 int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes);
599 int BIO_gets(BIO *bp, char *buf, int size);
600 int BIO_write(BIO *b, const void *data, int dlen);
601 int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written);
602 int BIO_puts(BIO *bp, const char *buf);
603 int BIO_indent(BIO *b, int indent, int max);
604 long BIO_ctrl(BIO *bp, int cmd, long larg, void *parg);
605 long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp);
606 void *BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
607 long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
608 BIO *BIO_push(BIO *b, BIO *append);
609 BIO *BIO_pop(BIO *b);
610 void BIO_free_all(BIO *a);
611 BIO *BIO_find_type(BIO *b, int bio_type);
612 BIO *BIO_next(BIO *b);
613 void BIO_set_next(BIO *b, BIO *next);
614 BIO *BIO_get_retry_BIO(BIO *bio, int *reason);
615 int BIO_get_retry_reason(BIO *bio);
616 void BIO_set_retry_reason(BIO *bio, int reason);
617 BIO *BIO_dup_chain(BIO *in);
619 int BIO_nread0(BIO *bio, char **buf);
620 int BIO_nread(BIO *bio, char **buf, int num);
621 int BIO_nwrite0(BIO *bio, char **buf);
622 int BIO_nwrite(BIO *bio, char **buf, int num);
624 long BIO_debug_callback(BIO *bio, int cmd, const char *argp, int argi,
625 long argl, long ret);
627 const BIO_METHOD *BIO_s_mem(void);
628 const BIO_METHOD *BIO_s_secmem(void);
629 BIO *BIO_new_mem_buf(const void *buf, int len);
630 # ifndef OPENSSL_NO_SOCK
631 const BIO_METHOD *BIO_s_socket(void);
632 const BIO_METHOD *BIO_s_connect(void);
633 const BIO_METHOD *BIO_s_accept(void);
635 const BIO_METHOD *BIO_s_fd(void);
636 const BIO_METHOD *BIO_s_log(void);
637 const BIO_METHOD *BIO_s_bio(void);
638 const BIO_METHOD *BIO_s_null(void);
639 const BIO_METHOD *BIO_f_null(void);
640 const BIO_METHOD *BIO_f_buffer(void);
641 const BIO_METHOD *BIO_f_linebuffer(void);
642 const BIO_METHOD *BIO_f_nbio_test(void);
643 const BIO_METHOD *BIO_f_prefix(void);
644 # ifndef OPENSSL_NO_DGRAM
645 const BIO_METHOD *BIO_s_datagram(void);
646 int BIO_dgram_non_fatal_error(int error);
647 BIO *BIO_new_dgram(int fd, int close_flag);
648 # ifndef OPENSSL_NO_SCTP
649 const BIO_METHOD *BIO_s_datagram_sctp(void);
650 BIO *BIO_new_dgram_sctp(int fd, int close_flag);
651 int BIO_dgram_is_sctp(BIO *bio);
652 int BIO_dgram_sctp_notification_cb(BIO *b,
653 BIO_dgram_sctp_notification_handler_fn handle_notifications,
655 int BIO_dgram_sctp_wait_for_dry(BIO *b);
656 int BIO_dgram_sctp_msg_waiting(BIO *b);
660 # ifndef OPENSSL_NO_SOCK
661 int BIO_sock_should_retry(int i);
662 int BIO_sock_non_fatal_error(int error);
665 int BIO_fd_should_retry(int i);
666 int BIO_fd_non_fatal_error(int error);
667 int BIO_dump_cb(int (*cb) (const void *data, size_t len, void *u),
668 void *u, const void *s, int len);
669 int BIO_dump_indent_cb(int (*cb) (const void *data, size_t len, void *u),
670 void *u, const void *s, int len, int indent);
671 int BIO_dump(BIO *b, const void *bytes, int len);
672 int BIO_dump_indent(BIO *b, const void *bytes, int len, int indent);
673 # ifndef OPENSSL_NO_STDIO
674 int BIO_dump_fp(FILE *fp, const void *s, int len);
675 int BIO_dump_indent_fp(FILE *fp, const void *s, int len, int indent);
677 int BIO_hex_string(BIO *out, int indent, int width, const void *data,
680 # ifndef OPENSSL_NO_SOCK
681 BIO_ADDR *BIO_ADDR_new(void);
682 int BIO_ADDR_rawmake(BIO_ADDR *ap, int family,
683 const void *where, size_t wherelen, unsigned short port);
684 void BIO_ADDR_free(BIO_ADDR *);
685 void BIO_ADDR_clear(BIO_ADDR *ap);
686 int BIO_ADDR_family(const BIO_ADDR *ap);
687 int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l);
688 unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap);
689 char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric);
690 char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric);
691 char *BIO_ADDR_path_string(const BIO_ADDR *ap);
693 const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai);
694 int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai);
695 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai);
696 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai);
697 const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai);
698 void BIO_ADDRINFO_free(BIO_ADDRINFO *bai);
700 enum BIO_hostserv_priorities {
701 BIO_PARSE_PRIO_HOST, BIO_PARSE_PRIO_SERV
703 int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
704 enum BIO_hostserv_priorities hostserv_prio);
705 enum BIO_lookup_type {
706 BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER
708 int BIO_lookup(const char *host, const char *service,
709 enum BIO_lookup_type lookup_type,
710 int family, int socktype, BIO_ADDRINFO **res);
711 int BIO_lookup_ex(const char *host, const char *service,
712 int lookup_type, int family, int socktype, int protocol,
714 int BIO_sock_error(int sock);
715 int BIO_socket_ioctl(int fd, long type, void *arg);
716 int BIO_socket_nbio(int fd, int mode);
717 int BIO_sock_init(void);
718 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
719 # define BIO_sock_cleanup() while(0) continue
721 int BIO_set_tcp_ndelay(int sock, int turn_on);
723 DEPRECATEDIN_1_1_0(struct hostent *BIO_gethostbyname(const char *name))
724 DEPRECATEDIN_1_1_0(int BIO_get_port(const char *str, unsigned short *port_ptr))
725 DEPRECATEDIN_1_1_0(int BIO_get_host_ip(const char *str, unsigned char *ip))
726 DEPRECATEDIN_1_1_0(int BIO_get_accept_socket(char *host_port, int mode))
727 DEPRECATEDIN_1_1_0(int BIO_accept(int sock, char **ip_port))
729 union BIO_sock_info_u {
732 enum BIO_sock_info_type {
733 BIO_SOCK_INFO_ADDRESS
735 int BIO_sock_info(int sock,
736 enum BIO_sock_info_type type, union BIO_sock_info_u *info);
738 # define BIO_SOCK_REUSEADDR 0x01
739 # define BIO_SOCK_V6_ONLY 0x02
740 # define BIO_SOCK_KEEPALIVE 0x04
741 # define BIO_SOCK_NONBLOCK 0x08
742 # define BIO_SOCK_NODELAY 0x10
744 int BIO_socket(int domain, int socktype, int protocol, int options);
745 int BIO_connect(int sock, const BIO_ADDR *addr, int options);
746 int BIO_bind(int sock, const BIO_ADDR *addr, int options);
747 int BIO_listen(int sock, const BIO_ADDR *addr, int options);
748 int BIO_accept_ex(int accept_sock, BIO_ADDR *addr, int options);
749 int BIO_closesocket(int sock);
751 BIO *BIO_new_socket(int sock, int close_flag);
752 BIO *BIO_new_connect(const char *host_port);
753 BIO *BIO_new_accept(const char *host_port);
754 # endif /* OPENSSL_NO_SOCK*/
756 BIO *BIO_new_fd(int fd, int close_flag);
758 int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
759 BIO **bio2, size_t writebuf2);
761 * If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
762 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. Size 0 uses default
766 void BIO_copy_next_retry(BIO *b);
769 * long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
772 # define ossl_bio__attr__(x)
773 # if defined(__GNUC__) && defined(__STDC_VERSION__) \
774 && !defined(__APPLE__)
776 * Because we support the 'z' modifier, which made its appearance in C99,
777 * we can't use __attribute__ with pre C99 dialects.
779 # if __STDC_VERSION__ >= 199901L
780 # undef ossl_bio__attr__
781 # define ossl_bio__attr__ __attribute__
782 # if __GNUC__*10 + __GNUC_MINOR__ >= 44
783 # define ossl_bio__printf__ __gnu_printf__
785 # define ossl_bio__printf__ __printf__
789 int BIO_printf(BIO *bio, const char *format, ...)
790 ossl_bio__attr__((__format__(ossl_bio__printf__, 2, 3)));
791 int BIO_vprintf(BIO *bio, const char *format, va_list args)
792 ossl_bio__attr__((__format__(ossl_bio__printf__, 2, 0)));
793 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
794 ossl_bio__attr__((__format__(ossl_bio__printf__, 3, 4)));
795 int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args)
796 ossl_bio__attr__((__format__(ossl_bio__printf__, 3, 0)));
797 # undef ossl_bio__attr__
798 # undef ossl_bio__printf__
801 BIO_METHOD *BIO_meth_new(int type, const char *name);
802 void BIO_meth_free(BIO_METHOD *biom);
803 int (*BIO_meth_get_write(const BIO_METHOD *biom)) (BIO *, const char *, int);
804 int (*BIO_meth_get_write_ex(const BIO_METHOD *biom)) (BIO *, const char *, size_t,
806 int BIO_meth_set_write(BIO_METHOD *biom,
807 int (*write) (BIO *, const char *, int));
808 int BIO_meth_set_write_ex(BIO_METHOD *biom,
809 int (*bwrite) (BIO *, const char *, size_t, size_t *));
810 int (*BIO_meth_get_read(const BIO_METHOD *biom)) (BIO *, char *, int);
811 int (*BIO_meth_get_read_ex(const BIO_METHOD *biom)) (BIO *, char *, size_t, size_t *);
812 int BIO_meth_set_read(BIO_METHOD *biom,
813 int (*read) (BIO *, char *, int));
814 int BIO_meth_set_read_ex(BIO_METHOD *biom,
815 int (*bread) (BIO *, char *, size_t, size_t *));
816 int (*BIO_meth_get_puts(const BIO_METHOD *biom)) (BIO *, const char *);
817 int BIO_meth_set_puts(BIO_METHOD *biom,
818 int (*puts) (BIO *, const char *));
819 int (*BIO_meth_get_gets(const BIO_METHOD *biom)) (BIO *, char *, int);
820 int BIO_meth_set_gets(BIO_METHOD *biom,
821 int (*gets) (BIO *, char *, int));
822 long (*BIO_meth_get_ctrl(const BIO_METHOD *biom)) (BIO *, int, long, void *);
823 int BIO_meth_set_ctrl(BIO_METHOD *biom,
824 long (*ctrl) (BIO *, int, long, void *));
825 int (*BIO_meth_get_create(const BIO_METHOD *bion)) (BIO *);
826 int BIO_meth_set_create(BIO_METHOD *biom, int (*create) (BIO *));
827 int (*BIO_meth_get_destroy(const BIO_METHOD *biom)) (BIO *);
828 int BIO_meth_set_destroy(BIO_METHOD *biom, int (*destroy) (BIO *));
829 long (*BIO_meth_get_callback_ctrl(const BIO_METHOD *biom))
830 (BIO *, int, BIO_info_cb *);
831 int BIO_meth_set_callback_ctrl(BIO_METHOD *biom,
832 long (*callback_ctrl) (BIO *, int,