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
203 # define BIO_FLAGS_IN_EOF 0x800
205 typedef union bio_addr_st BIO_ADDR;
206 typedef struct bio_addrinfo_st BIO_ADDRINFO;
208 int BIO_get_new_index(void);
209 void BIO_set_flags(BIO *b, int flags);
210 int BIO_test_flags(const BIO *b, int flags);
211 void BIO_clear_flags(BIO *b, int flags);
213 # define BIO_get_flags(b) BIO_test_flags(b, ~(0x0))
214 # define BIO_set_retry_special(b) \
215 BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
216 # define BIO_set_retry_read(b) \
217 BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
218 # define BIO_set_retry_write(b) \
219 BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
221 /* These are normally used internally in BIOs */
222 # define BIO_clear_retry_flags(b) \
223 BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
224 # define BIO_get_retry_flags(b) \
225 BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
227 /* These should be used by the application to tell why we should retry */
228 # define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ)
229 # define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE)
230 # define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL)
231 # define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS)
232 # define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY)
235 * The next three are used in conjunction with the BIO_should_io_special()
236 * condition. After this returns true, BIO *BIO_get_retry_BIO(BIO *bio, int
237 * *reason); will walk the BIO stack and return the 'reason' for the special
238 * and the offending BIO. Given a BIO, BIO_get_retry_reason(bio) will return
242 * Returned from the SSL bio when the certificate retrieval code had an error
244 # define BIO_RR_SSL_X509_LOOKUP 0x01
245 /* Returned from the connect BIO when a connect would have blocked */
246 # define BIO_RR_CONNECT 0x02
247 /* Returned from the accept BIO when an accept would have blocked */
248 # define BIO_RR_ACCEPT 0x03
250 /* These are passed by the BIO callback */
251 # define BIO_CB_FREE 0x01
252 # define BIO_CB_READ 0x02
253 # define BIO_CB_WRITE 0x03
254 # define BIO_CB_PUTS 0x04
255 # define BIO_CB_GETS 0x05
256 # define BIO_CB_CTRL 0x06
259 * The callback is called before and after the underling operation, The
260 * BIO_CB_RETURN flag indicates if it is after the call
262 # define BIO_CB_RETURN 0x80
263 # define BIO_CB_return(a) ((a)|BIO_CB_RETURN)
264 # define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN))
265 # define BIO_cb_post(a) ((a)&BIO_CB_RETURN)
267 typedef long (*BIO_callback_fn)(BIO *b, int oper, const char *argp, int argi,
268 long argl, long ret);
269 typedef long (*BIO_callback_fn_ex)(BIO *b, int oper, const char *argp,
270 size_t len, int argi,
271 long argl, int ret, size_t *processed);
272 BIO_callback_fn BIO_get_callback(const BIO *b);
273 void BIO_set_callback(BIO *b, BIO_callback_fn callback);
275 BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b);
276 void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex callback);
278 char *BIO_get_callback_arg(const BIO *b);
279 void BIO_set_callback_arg(BIO *b, char *arg);
281 typedef struct bio_method_st BIO_METHOD;
283 const char *BIO_method_name(const BIO *b);
284 int BIO_method_type(const BIO *b);
286 typedef int BIO_info_cb(BIO *, int, int);
287 typedef BIO_info_cb bio_info_cb; /* backward compatibility */
291 /* Prefix and suffix callback in ASN1 BIO */
292 typedef int asn1_ps_func (BIO *b, unsigned char **pbuf, int *plen,
295 typedef void (*BIO_dgram_sctp_notification_handler_fn) (BIO *b,
298 # ifndef OPENSSL_NO_SCTP
299 /* SCTP parameter structs */
300 struct bio_dgram_sctp_sndinfo {
304 uint32_t snd_context;
307 struct bio_dgram_sctp_rcvinfo {
314 uint32_t rcv_context;
317 struct bio_dgram_sctp_prinfo {
324 * #define BIO_CONN_get_param_hostname BIO_ctrl
327 # define BIO_C_SET_CONNECT 100
328 # define BIO_C_DO_STATE_MACHINE 101
329 # define BIO_C_SET_NBIO 102
330 /* # define BIO_C_SET_PROXY_PARAM 103 */
331 # define BIO_C_SET_FD 104
332 # define BIO_C_GET_FD 105
333 # define BIO_C_SET_FILE_PTR 106
334 # define BIO_C_GET_FILE_PTR 107
335 # define BIO_C_SET_FILENAME 108
336 # define BIO_C_SET_SSL 109
337 # define BIO_C_GET_SSL 110
338 # define BIO_C_SET_MD 111
339 # define BIO_C_GET_MD 112
340 # define BIO_C_GET_CIPHER_STATUS 113
341 # define BIO_C_SET_BUF_MEM 114
342 # define BIO_C_GET_BUF_MEM_PTR 115
343 # define BIO_C_GET_BUFF_NUM_LINES 116
344 # define BIO_C_SET_BUFF_SIZE 117
345 # define BIO_C_SET_ACCEPT 118
346 # define BIO_C_SSL_MODE 119
347 # define BIO_C_GET_MD_CTX 120
348 /* # define BIO_C_GET_PROXY_PARAM 121 */
349 # define BIO_C_SET_BUFF_READ_DATA 122/* data to read first */
350 # define BIO_C_GET_CONNECT 123
351 # define BIO_C_GET_ACCEPT 124
352 # define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
353 # define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
354 # define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
355 # define BIO_C_FILE_SEEK 128
356 # define BIO_C_GET_CIPHER_CTX 129
357 # define BIO_C_SET_BUF_MEM_EOF_RETURN 130/* return end of input
359 # define BIO_C_SET_BIND_MODE 131
360 # define BIO_C_GET_BIND_MODE 132
361 # define BIO_C_FILE_TELL 133
362 # define BIO_C_GET_SOCKS 134
363 # define BIO_C_SET_SOCKS 135
365 # define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
366 # define BIO_C_GET_WRITE_BUF_SIZE 137
367 # define BIO_C_MAKE_BIO_PAIR 138
368 # define BIO_C_DESTROY_BIO_PAIR 139
369 # define BIO_C_GET_WRITE_GUARANTEE 140
370 # define BIO_C_GET_READ_REQUEST 141
371 # define BIO_C_SHUTDOWN_WR 142
372 # define BIO_C_NREAD0 143
373 # define BIO_C_NREAD 144
374 # define BIO_C_NWRITE0 145
375 # define BIO_C_NWRITE 146
376 # define BIO_C_RESET_READ_REQUEST 147
377 # define BIO_C_SET_MD_CTX 148
379 # define BIO_C_SET_PREFIX 149
380 # define BIO_C_GET_PREFIX 150
381 # define BIO_C_SET_SUFFIX 151
382 # define BIO_C_GET_SUFFIX 152
384 # define BIO_C_SET_EX_ARG 153
385 # define BIO_C_GET_EX_ARG 154
387 # define BIO_C_SET_CONNECT_MODE 155
389 # define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg)
390 # define BIO_get_app_data(s) BIO_get_ex_data(s,0)
392 # define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
394 # ifndef OPENSSL_NO_SOCK
395 /* IP families we support, for BIO_s_connect() and BIO_s_accept() */
396 /* Note: the underlying operating system may not support some of them */
397 # define BIO_FAMILY_IPV4 4
398 # define BIO_FAMILY_IPV6 6
399 # define BIO_FAMILY_IPANY 256
401 /* BIO_s_connect() */
402 # define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0, \
404 # define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1, \
406 # define BIO_set_conn_address(b,addr) BIO_ctrl(b,BIO_C_SET_CONNECT,2, \
408 # define BIO_set_conn_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,f)
409 # define BIO_get_conn_hostname(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0))
410 # define BIO_get_conn_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1))
411 # define BIO_get_conn_address(b) ((const BIO_ADDR *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2))
412 # define BIO_get_conn_ip_family(b) BIO_ctrl(b,BIO_C_GET_CONNECT,3,NULL)
413 # define BIO_set_conn_mode(b,n) BIO_ctrl(b,BIO_C_SET_CONNECT_MODE,(n),NULL)
416 # define BIO_set_accept_name(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0, \
418 # define BIO_set_accept_port(b,port) BIO_ctrl(b,BIO_C_SET_ACCEPT,1, \
420 # define BIO_get_accept_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0))
421 # define BIO_get_accept_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,1))
422 # define BIO_get_peer_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,2))
423 # define BIO_get_peer_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,3))
424 /* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
425 # define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(n)?(void *)"a":NULL)
426 # define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,3, \
428 # define BIO_set_accept_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_ACCEPT,4,f)
429 # define BIO_get_accept_ip_family(b) BIO_ctrl(b,BIO_C_GET_ACCEPT,4,NULL)
431 /* Aliases kept for backward compatibility */
432 # define BIO_BIND_NORMAL 0
433 # define BIO_BIND_REUSEADDR BIO_SOCK_REUSEADDR
434 # define BIO_BIND_REUSEADDR_IF_UNUSED BIO_SOCK_REUSEADDR
435 # define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
436 # define BIO_get_bind_mode(b) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
438 /* BIO_s_accept() and BIO_s_connect() */
439 # define BIO_do_connect(b) BIO_do_handshake(b)
440 # define BIO_do_accept(b) BIO_do_handshake(b)
441 # endif /* OPENSSL_NO_SOCK */
443 # define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
445 /* BIO_s_datagram(), BIO_s_fd(), BIO_s_socket(), BIO_s_accept() and BIO_s_connect() */
446 # define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
447 # define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)(c))
450 # define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)(fp))
451 # define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)(fpp))
453 /* BIO_s_fd() and BIO_s_file() */
454 # define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
455 # define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
458 * name is cast to lose const, but might be better to route through a
459 * function so we can do it safely
463 * If you are wondering why this isn't defined, its because CONST_STRICT is
464 * purely a compile-time kludge to allow const to be checked.
466 int BIO_read_filename(BIO *b, const char *name);
468 # define BIO_read_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
469 BIO_CLOSE|BIO_FP_READ,(char *)(name))
471 # define BIO_write_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
472 BIO_CLOSE|BIO_FP_WRITE,name)
473 # define BIO_append_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
474 BIO_CLOSE|BIO_FP_APPEND,name)
475 # define BIO_rw_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
476 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
479 * WARNING WARNING, this ups the reference count on the read bio of the SSL
480 * structure. This is because the ssl read BIO is now pointed to by the
481 * next_bio field in the bio. So when you free the BIO, make sure you are
482 * doing a BIO_free_all() to catch the underlying BIO.
484 # define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)(ssl))
485 # define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)(sslp))
486 # define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
487 # define BIO_set_ssl_renegotiate_bytes(b,num) \
488 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL)
489 # define BIO_get_num_renegotiates(b) \
490 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL)
491 # define BIO_set_ssl_renegotiate_timeout(b,seconds) \
492 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL)
494 /* defined in evp.h */
495 /* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)(md)) */
497 # define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)(pp))
498 # define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)(bm))
499 # define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0, \
501 # define BIO_set_mem_eof_return(b,v) \
502 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
504 /* For the BIO_f_buffer() type */
505 # define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
506 # define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
507 # define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
508 # define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
509 # define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
511 /* Don't use the next one unless you know what you are doing :-) */
512 # define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
514 # define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
515 # define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
516 # define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
517 # define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
518 # define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
519 # define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
520 /* ...pending macros have inappropriate return type */
521 size_t BIO_ctrl_pending(BIO *b);
522 size_t BIO_ctrl_wpending(BIO *b);
523 # define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
524 # define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
526 # define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
528 /* For the BIO_f_buffer() type */
529 # define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
530 # define BIO_buffer_peek(b,s,l) BIO_ctrl(b,BIO_CTRL_PEEK,(l),(s))
532 /* For BIO_s_bio() */
533 # define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
534 # define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
535 # define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
536 # define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
537 # define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
538 /* macros with inappropriate type -- but ...pending macros use int too: */
539 # define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
540 # define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
541 size_t BIO_ctrl_get_write_guarantee(BIO *b);
542 size_t BIO_ctrl_get_read_request(BIO *b);
543 int BIO_ctrl_reset_read_request(BIO *b);
545 /* ctrl macros for dgram */
546 # define BIO_ctrl_dgram_connect(b,peer) \
547 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)(peer))
548 # define BIO_ctrl_set_connected(b,peer) \
549 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, 0, (char *)(peer))
550 # define BIO_dgram_recv_timedout(b) \
551 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
552 # define BIO_dgram_send_timedout(b) \
553 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
554 # define BIO_dgram_get_peer(b,peer) \
555 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)(peer))
556 # define BIO_dgram_set_peer(b,peer) \
557 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)(peer))
558 # define BIO_dgram_get_mtu_overhead(b) \
559 (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU_OVERHEAD, 0, NULL)
561 /* ctrl macros for BIO_f_prefix */
562 # define BIO_set_prefix(b,p) BIO_ctrl((b), BIO_CTRL_SET_PREFIX, 0, (void *)(p))
563 # define BIO_set_indent(b,i) BIO_ctrl((b), BIO_CTRL_SET_INDENT, (i), NULL)
564 # define BIO_get_indent(b) BIO_ctrl((b), BIO_CTRL_GET_INDENT, 0, NULL)
566 #define BIO_get_ex_new_index(l, p, newf, dupf, freef) \
567 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_BIO, l, p, newf, dupf, freef)
568 int BIO_set_ex_data(BIO *bio, int idx, void *data);
569 void *BIO_get_ex_data(const BIO *bio, int idx);
570 uint64_t BIO_number_read(BIO *bio);
571 uint64_t BIO_number_written(BIO *bio);
573 /* For BIO_f_asn1() */
574 int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix,
575 asn1_ps_func *prefix_free);
576 int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix,
577 asn1_ps_func **pprefix_free);
578 int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix,
579 asn1_ps_func *suffix_free);
580 int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix,
581 asn1_ps_func **psuffix_free);
583 const BIO_METHOD *BIO_s_file(void);
584 BIO *BIO_new_file(const char *filename, const char *mode);
585 # ifndef OPENSSL_NO_STDIO
586 BIO *BIO_new_fp(FILE *stream, int close_flag);
588 BIO *BIO_new(const BIO_METHOD *type);
589 int BIO_free(BIO *a);
590 void BIO_set_data(BIO *a, void *ptr);
591 void *BIO_get_data(BIO *a);
592 void BIO_set_init(BIO *a, int init);
593 int BIO_get_init(BIO *a);
594 void BIO_set_shutdown(BIO *a, int shut);
595 int BIO_get_shutdown(BIO *a);
596 void BIO_vfree(BIO *a);
597 int BIO_up_ref(BIO *a);
598 int BIO_read(BIO *b, void *data, int dlen);
599 int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes);
600 int BIO_gets(BIO *bp, char *buf, int size);
601 int BIO_write(BIO *b, const void *data, int dlen);
602 int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written);
603 int BIO_puts(BIO *bp, const char *buf);
604 int BIO_indent(BIO *b, int indent, int max);
605 long BIO_ctrl(BIO *bp, int cmd, long larg, void *parg);
606 long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp);
607 void *BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
608 long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
609 BIO *BIO_push(BIO *b, BIO *append);
610 BIO *BIO_pop(BIO *b);
611 void BIO_free_all(BIO *a);
612 BIO *BIO_find_type(BIO *b, int bio_type);
613 BIO *BIO_next(BIO *b);
614 void BIO_set_next(BIO *b, BIO *next);
615 BIO *BIO_get_retry_BIO(BIO *bio, int *reason);
616 int BIO_get_retry_reason(BIO *bio);
617 void BIO_set_retry_reason(BIO *bio, int reason);
618 BIO *BIO_dup_chain(BIO *in);
620 int BIO_nread0(BIO *bio, char **buf);
621 int BIO_nread(BIO *bio, char **buf, int num);
622 int BIO_nwrite0(BIO *bio, char **buf);
623 int BIO_nwrite(BIO *bio, char **buf, int num);
625 long BIO_debug_callback(BIO *bio, int cmd, const char *argp, int argi,
626 long argl, long ret);
628 const BIO_METHOD *BIO_s_mem(void);
629 const BIO_METHOD *BIO_s_secmem(void);
630 BIO *BIO_new_mem_buf(const void *buf, int len);
631 # ifndef OPENSSL_NO_SOCK
632 const BIO_METHOD *BIO_s_socket(void);
633 const BIO_METHOD *BIO_s_connect(void);
634 const BIO_METHOD *BIO_s_accept(void);
636 const BIO_METHOD *BIO_s_fd(void);
637 const BIO_METHOD *BIO_s_log(void);
638 const BIO_METHOD *BIO_s_bio(void);
639 const BIO_METHOD *BIO_s_null(void);
640 const BIO_METHOD *BIO_f_null(void);
641 const BIO_METHOD *BIO_f_buffer(void);
642 const BIO_METHOD *BIO_f_linebuffer(void);
643 const BIO_METHOD *BIO_f_nbio_test(void);
644 const BIO_METHOD *BIO_f_prefix(void);
645 # ifndef OPENSSL_NO_DGRAM
646 const BIO_METHOD *BIO_s_datagram(void);
647 int BIO_dgram_non_fatal_error(int error);
648 BIO *BIO_new_dgram(int fd, int close_flag);
649 # ifndef OPENSSL_NO_SCTP
650 const BIO_METHOD *BIO_s_datagram_sctp(void);
651 BIO *BIO_new_dgram_sctp(int fd, int close_flag);
652 int BIO_dgram_is_sctp(BIO *bio);
653 int BIO_dgram_sctp_notification_cb(BIO *b,
654 BIO_dgram_sctp_notification_handler_fn handle_notifications,
656 int BIO_dgram_sctp_wait_for_dry(BIO *b);
657 int BIO_dgram_sctp_msg_waiting(BIO *b);
661 # ifndef OPENSSL_NO_SOCK
662 int BIO_sock_should_retry(int i);
663 int BIO_sock_non_fatal_error(int error);
664 int BIO_socket_wait(int fd, int for_read, time_t max_time);
666 int BIO_wait(BIO *bio, time_t max_time, unsigned int milliseconds);
667 int BIO_connect_retry(BIO *bio, int timeout);
669 int BIO_fd_should_retry(int i);
670 int BIO_fd_non_fatal_error(int error);
671 int BIO_dump_cb(int (*cb) (const void *data, size_t len, void *u),
672 void *u, const void *s, int len);
673 int BIO_dump_indent_cb(int (*cb) (const void *data, size_t len, void *u),
674 void *u, const void *s, int len, int indent);
675 int BIO_dump(BIO *b, const void *bytes, int len);
676 int BIO_dump_indent(BIO *b, const void *bytes, int len, int indent);
677 # ifndef OPENSSL_NO_STDIO
678 int BIO_dump_fp(FILE *fp, const void *s, int len);
679 int BIO_dump_indent_fp(FILE *fp, const void *s, int len, int indent);
681 int BIO_hex_string(BIO *out, int indent, int width, const void *data,
684 # ifndef OPENSSL_NO_SOCK
685 BIO_ADDR *BIO_ADDR_new(void);
686 int BIO_ADDR_rawmake(BIO_ADDR *ap, int family,
687 const void *where, size_t wherelen, unsigned short port);
688 void BIO_ADDR_free(BIO_ADDR *);
689 void BIO_ADDR_clear(BIO_ADDR *ap);
690 int BIO_ADDR_family(const BIO_ADDR *ap);
691 int BIO_ADDR_rawaddress(const BIO_ADDR *ap, void *p, size_t *l);
692 unsigned short BIO_ADDR_rawport(const BIO_ADDR *ap);
693 char *BIO_ADDR_hostname_string(const BIO_ADDR *ap, int numeric);
694 char *BIO_ADDR_service_string(const BIO_ADDR *ap, int numeric);
695 char *BIO_ADDR_path_string(const BIO_ADDR *ap);
697 const BIO_ADDRINFO *BIO_ADDRINFO_next(const BIO_ADDRINFO *bai);
698 int BIO_ADDRINFO_family(const BIO_ADDRINFO *bai);
699 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO *bai);
700 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO *bai);
701 const BIO_ADDR *BIO_ADDRINFO_address(const BIO_ADDRINFO *bai);
702 void BIO_ADDRINFO_free(BIO_ADDRINFO *bai);
704 enum BIO_hostserv_priorities {
705 BIO_PARSE_PRIO_HOST, BIO_PARSE_PRIO_SERV
707 int BIO_parse_hostserv(const char *hostserv, char **host, char **service,
708 enum BIO_hostserv_priorities hostserv_prio);
709 enum BIO_lookup_type {
710 BIO_LOOKUP_CLIENT, BIO_LOOKUP_SERVER
712 int BIO_lookup(const char *host, const char *service,
713 enum BIO_lookup_type lookup_type,
714 int family, int socktype, BIO_ADDRINFO **res);
715 int BIO_lookup_ex(const char *host, const char *service,
716 int lookup_type, int family, int socktype, int protocol,
718 int BIO_sock_error(int sock);
719 int BIO_socket_ioctl(int fd, long type, void *arg);
720 int BIO_socket_nbio(int fd, int mode);
721 int BIO_sock_init(void);
722 # ifndef OPENSSL_NO_DEPRECATED_1_1_0
723 # define BIO_sock_cleanup() while(0) continue
725 int BIO_set_tcp_ndelay(int sock, int turn_on);
727 DEPRECATEDIN_1_1_0(struct hostent *BIO_gethostbyname(const char *name))
728 DEPRECATEDIN_1_1_0(int BIO_get_port(const char *str, unsigned short *port_ptr))
729 DEPRECATEDIN_1_1_0(int BIO_get_host_ip(const char *str, unsigned char *ip))
730 DEPRECATEDIN_1_1_0(int BIO_get_accept_socket(char *host_port, int mode))
731 DEPRECATEDIN_1_1_0(int BIO_accept(int sock, char **ip_port))
733 union BIO_sock_info_u {
736 enum BIO_sock_info_type {
737 BIO_SOCK_INFO_ADDRESS
739 int BIO_sock_info(int sock,
740 enum BIO_sock_info_type type, union BIO_sock_info_u *info);
742 # define BIO_SOCK_REUSEADDR 0x01
743 # define BIO_SOCK_V6_ONLY 0x02
744 # define BIO_SOCK_KEEPALIVE 0x04
745 # define BIO_SOCK_NONBLOCK 0x08
746 # define BIO_SOCK_NODELAY 0x10
748 int BIO_socket(int domain, int socktype, int protocol, int options);
749 int BIO_connect(int sock, const BIO_ADDR *addr, int options);
750 int BIO_bind(int sock, const BIO_ADDR *addr, int options);
751 int BIO_listen(int sock, const BIO_ADDR *addr, int options);
752 int BIO_accept_ex(int accept_sock, BIO_ADDR *addr, int options);
753 int BIO_closesocket(int sock);
755 BIO *BIO_new_socket(int sock, int close_flag);
756 BIO *BIO_new_connect(const char *host_port);
757 BIO *BIO_new_accept(const char *host_port);
758 # endif /* OPENSSL_NO_SOCK*/
760 BIO *BIO_new_fd(int fd, int close_flag);
762 int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
763 BIO **bio2, size_t writebuf2);
765 * If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
766 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. Size 0 uses default
770 void BIO_copy_next_retry(BIO *b);
773 * long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
776 # define ossl_bio__attr__(x)
777 # if defined(__GNUC__) && defined(__STDC_VERSION__) \
778 && !defined(__APPLE__)
780 * Because we support the 'z' modifier, which made its appearance in C99,
781 * we can't use __attribute__ with pre C99 dialects.
783 # if __STDC_VERSION__ >= 199901L
784 # undef ossl_bio__attr__
785 # define ossl_bio__attr__ __attribute__
786 # if __GNUC__*10 + __GNUC_MINOR__ >= 44
787 # define ossl_bio__printf__ __gnu_printf__
789 # define ossl_bio__printf__ __printf__
793 int BIO_printf(BIO *bio, const char *format, ...)
794 ossl_bio__attr__((__format__(ossl_bio__printf__, 2, 3)));
795 int BIO_vprintf(BIO *bio, const char *format, va_list args)
796 ossl_bio__attr__((__format__(ossl_bio__printf__, 2, 0)));
797 int BIO_snprintf(char *buf, size_t n, const char *format, ...)
798 ossl_bio__attr__((__format__(ossl_bio__printf__, 3, 4)));
799 int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args)
800 ossl_bio__attr__((__format__(ossl_bio__printf__, 3, 0)));
801 # undef ossl_bio__attr__
802 # undef ossl_bio__printf__
805 BIO_METHOD *BIO_meth_new(int type, const char *name);
806 void BIO_meth_free(BIO_METHOD *biom);
807 int (*BIO_meth_get_write(const BIO_METHOD *biom)) (BIO *, const char *, int);
808 int (*BIO_meth_get_write_ex(const BIO_METHOD *biom)) (BIO *, const char *, size_t,
810 int BIO_meth_set_write(BIO_METHOD *biom,
811 int (*write) (BIO *, const char *, int));
812 int BIO_meth_set_write_ex(BIO_METHOD *biom,
813 int (*bwrite) (BIO *, const char *, size_t, size_t *));
814 int (*BIO_meth_get_read(const BIO_METHOD *biom)) (BIO *, char *, int);
815 int (*BIO_meth_get_read_ex(const BIO_METHOD *biom)) (BIO *, char *, size_t, size_t *);
816 int BIO_meth_set_read(BIO_METHOD *biom,
817 int (*read) (BIO *, char *, int));
818 int BIO_meth_set_read_ex(BIO_METHOD *biom,
819 int (*bread) (BIO *, char *, size_t, size_t *));
820 int (*BIO_meth_get_puts(const BIO_METHOD *biom)) (BIO *, const char *);
821 int BIO_meth_set_puts(BIO_METHOD *biom,
822 int (*puts) (BIO *, const char *));
823 int (*BIO_meth_get_gets(const BIO_METHOD *biom)) (BIO *, char *, int);
824 int BIO_meth_set_gets(BIO_METHOD *biom,
825 int (*gets) (BIO *, char *, int));
826 long (*BIO_meth_get_ctrl(const BIO_METHOD *biom)) (BIO *, int, long, void *);
827 int BIO_meth_set_ctrl(BIO_METHOD *biom,
828 long (*ctrl) (BIO *, int, long, void *));
829 int (*BIO_meth_get_create(const BIO_METHOD *bion)) (BIO *);
830 int BIO_meth_set_create(BIO_METHOD *biom, int (*create) (BIO *));
831 int (*BIO_meth_get_destroy(const BIO_METHOD *biom)) (BIO *);
832 int BIO_meth_set_destroy(BIO_METHOD *biom, int (*destroy) (BIO *));
833 long (*BIO_meth_get_callback_ctrl(const BIO_METHOD *biom))
834 (BIO *, int, BIO_info_cb *);
835 int BIO_meth_set_callback_ctrl(BIO_METHOD *biom,
836 long (*callback_ctrl) (BIO *, int,