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