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