2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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>
22 # ifndef OPENSSL_NO_SCTP
23 # ifndef OPENSSL_SYS_VMS
26 # include <inttypes.h>
34 /* These are the 'types' of BIOs */
35 # define BIO_TYPE_NONE 0
36 # define BIO_TYPE_MEM (1|0x0400)
37 # define BIO_TYPE_FILE (2|0x0400)
39 # define BIO_TYPE_FD (4|0x0400|0x0100)
40 # define BIO_TYPE_SOCKET (5|0x0400|0x0100)
41 # define BIO_TYPE_NULL (6|0x0400)
42 # define BIO_TYPE_SSL (7|0x0200)
43 # define BIO_TYPE_MD (8|0x0200)/* passive filter */
44 # define BIO_TYPE_BUFFER (9|0x0200)/* filter */
45 # define BIO_TYPE_CIPHER (10|0x0200)/* filter */
46 # define BIO_TYPE_BASE64 (11|0x0200)/* filter */
47 # define BIO_TYPE_CONNECT (12|0x0400|0x0100)/* socket - connect */
48 # define BIO_TYPE_ACCEPT (13|0x0400|0x0100)/* socket for accept */
49 /* # define BIO_TYPE_PROXY_CLIENT (14|0x0200)*/ /* client proxy BIO */
50 /* # define BIO_TYPE_PROXY_SERVER (15|0x0200)*/ /* server proxy BIO */
51 # define BIO_TYPE_NBIO_TEST (16|0x0200)/* server proxy BIO */
52 # define BIO_TYPE_NULL_FILTER (17|0x0200)
53 # define BIO_TYPE_BER (18|0x0200)/* BER -> bin filter */
54 # define BIO_TYPE_BIO (19|0x0400)/* (half a) BIO pair */
55 # define BIO_TYPE_LINEBUFFER (20|0x0200)/* filter */
56 # define BIO_TYPE_DGRAM (21|0x0400|0x0100)
57 # ifndef OPENSSL_NO_SCTP
58 # define BIO_TYPE_DGRAM_SCTP (24|0x0400|0x0100)
60 # define BIO_TYPE_ASN1 (22|0x0200)/* filter */
61 # define BIO_TYPE_COMP (23|0x0200)/* filter */
63 # define BIO_TYPE_DESCRIPTOR 0x0100/* socket, fd, connect or accept */
64 # define BIO_TYPE_FILTER 0x0200
65 # define BIO_TYPE_SOURCE_SINK 0x0400
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_SET_FILENAME 30/* BIO_s_file special */
96 # define BIO_CTRL_DGRAM_CONNECT 31/* BIO dgram special */
97 # define BIO_CTRL_DGRAM_SET_CONNECTED 32/* allow for an externally connected
98 * socket to be passed in */
99 # define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33/* setsockopt, essentially */
100 # define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34/* getsockopt, essentially */
101 # define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35/* setsockopt, essentially */
102 # define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36/* getsockopt, essentially */
104 # define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37/* flag whether the last */
105 # define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38/* I/O operation tiemd out */
107 /* #ifdef IP_MTU_DISCOVER */
108 # define BIO_CTRL_DGRAM_MTU_DISCOVER 39/* set DF bit on egress packets */
111 # define BIO_CTRL_DGRAM_QUERY_MTU 40/* as kernel for current MTU */
112 # define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47
113 # define BIO_CTRL_DGRAM_GET_MTU 41/* get cached value for MTU */
114 # define BIO_CTRL_DGRAM_SET_MTU 42/* set cached value for MTU.
115 * want to use this if asking
116 * the kernel fails */
118 # define BIO_CTRL_DGRAM_MTU_EXCEEDED 43/* check whether the MTU was
119 * exceed in the previous write
122 # define BIO_CTRL_DGRAM_GET_PEER 46
123 # define BIO_CTRL_DGRAM_SET_PEER 44/* Destination for the data */
125 # define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45/* Next DTLS handshake timeout
126 * to adjust socket timeouts */
127 # define BIO_CTRL_DGRAM_SET_DONT_FRAG 48
129 # define BIO_CTRL_DGRAM_GET_MTU_OVERHEAD 49
131 # define BIO_CTRL_DGRAM_SET_PEEK_MODE 50
133 # ifndef OPENSSL_NO_SCTP
135 # define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE 50
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
149 # define BIO_FP_READ 0x02
150 # define BIO_FP_WRITE 0x04
151 # define BIO_FP_APPEND 0x08
152 # define BIO_FP_TEXT 0x10
154 # define BIO_FLAGS_READ 0x01
155 # define BIO_FLAGS_WRITE 0x02
156 # define BIO_FLAGS_IO_SPECIAL 0x04
157 # define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
158 # define BIO_FLAGS_SHOULD_RETRY 0x08
159 # ifndef BIO_FLAGS_UPLINK
161 * "UPLINK" flag denotes file descriptors provided by application. It
162 * defaults to 0, as most platforms don't require UPLINK interface.
164 # define BIO_FLAGS_UPLINK 0
167 # define BIO_FLAGS_BASE64_NO_NL 0x100
170 * This is used with memory BIOs:
171 * BIO_FLAGS_MEM_RDONLY means we shouldn't free up or change the data in any way;
172 * BIO_FLAGS_NONCLEAR_RST means we should't clear data on reset.
174 # define BIO_FLAGS_MEM_RDONLY 0x200
175 # define BIO_FLAGS_NONCLEAR_RST 0x400
177 typedef union bio_addr_st BIO_ADDR
;
178 typedef struct bio_addrinfo_st BIO_ADDRINFO
;
180 void BIO_set_flags(BIO
*b
, int flags
);
181 int BIO_test_flags(const BIO
*b
, int flags
);
182 void BIO_clear_flags(BIO
*b
, int flags
);
184 # define BIO_get_flags(b) BIO_test_flags(b, ~(0x0))
185 # define BIO_set_retry_special(b) \
186 BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
187 # define BIO_set_retry_read(b) \
188 BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
189 # define BIO_set_retry_write(b) \
190 BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
192 /* These are normally used internally in BIOs */
193 # define BIO_clear_retry_flags(b) \
194 BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
195 # define BIO_get_retry_flags(b) \
196 BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
198 /* These should be used by the application to tell why we should retry */
199 # define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ)
200 # define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE)
201 # define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL)
202 # define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS)
203 # define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY)
206 * The next three are used in conjunction with the BIO_should_io_special()
207 * condition. After this returns true, BIO *BIO_get_retry_BIO(BIO *bio, int
208 * *reason); will walk the BIO stack and return the 'reason' for the special
209 * and the offending BIO. Given a BIO, BIO_get_retry_reason(bio) will return
213 * Returned from the SSL bio when the certificate retrieval code had an error
215 # define BIO_RR_SSL_X509_LOOKUP 0x01
216 /* Returned from the connect BIO when a connect would have blocked */
217 # define BIO_RR_CONNECT 0x02
218 /* Returned from the accept BIO when an accept would have blocked */
219 # define BIO_RR_ACCEPT 0x03
221 /* These are passed by the BIO callback */
222 # define BIO_CB_FREE 0x01
223 # define BIO_CB_READ 0x02
224 # define BIO_CB_WRITE 0x03
225 # define BIO_CB_PUTS 0x04
226 # define BIO_CB_GETS 0x05
227 # define BIO_CB_CTRL 0x06
230 * The callback is called before and after the underling operation, The
231 * BIO_CB_RETURN flag indicates if it is after the call
233 # define BIO_CB_RETURN 0x80
234 # define BIO_CB_return(a) ((a)|BIO_CB_RETURN)
235 # define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN))
236 # define BIO_cb_post(a) ((a)&BIO_CB_RETURN)
238 typedef long (*BIO_callback_fn
)(BIO
*b
, int oper
, const char *argp
, int argi
,
239 long argl
, long ret
);
240 BIO_callback_fn
BIO_get_callback(const BIO
*b
);
241 void BIO_set_callback(BIO
*b
, BIO_callback_fn callback
);
242 char *BIO_get_callback_arg(const BIO
*b
);
243 void BIO_set_callback_arg(BIO
*b
, char *arg
);
245 typedef struct bio_method_st BIO_METHOD
;
247 const char *BIO_method_name(const BIO
*b
);
248 int BIO_method_type(const BIO
*b
);
250 typedef void bio_info_cb(BIO
*, int, const char *, int, long, long);
254 /* Prefix and suffix callback in ASN1 BIO */
255 typedef int asn1_ps_func (BIO
*b
, unsigned char **pbuf
, int *plen
,
258 # ifndef OPENSSL_NO_SCTP
259 /* SCTP parameter structs */
260 struct bio_dgram_sctp_sndinfo
{
264 uint32_t snd_context
;
267 struct bio_dgram_sctp_rcvinfo
{
274 uint32_t rcv_context
;
277 struct bio_dgram_sctp_prinfo
{
284 * #define BIO_CONN_get_param_hostname BIO_ctrl
287 # define BIO_C_SET_CONNECT 100
288 # define BIO_C_DO_STATE_MACHINE 101
289 # define BIO_C_SET_NBIO 102
290 /* # define BIO_C_SET_PROXY_PARAM 103 */
291 # define BIO_C_SET_FD 104
292 # define BIO_C_GET_FD 105
293 # define BIO_C_SET_FILE_PTR 106
294 # define BIO_C_GET_FILE_PTR 107
295 # define BIO_C_SET_FILENAME 108
296 # define BIO_C_SET_SSL 109
297 # define BIO_C_GET_SSL 110
298 # define BIO_C_SET_MD 111
299 # define BIO_C_GET_MD 112
300 # define BIO_C_GET_CIPHER_STATUS 113
301 # define BIO_C_SET_BUF_MEM 114
302 # define BIO_C_GET_BUF_MEM_PTR 115
303 # define BIO_C_GET_BUFF_NUM_LINES 116
304 # define BIO_C_SET_BUFF_SIZE 117
305 # define BIO_C_SET_ACCEPT 118
306 # define BIO_C_SSL_MODE 119
307 # define BIO_C_GET_MD_CTX 120
308 /* # define BIO_C_GET_PROXY_PARAM 121 */
309 # define BIO_C_SET_BUFF_READ_DATA 122/* data to read first */
310 # define BIO_C_GET_CONNECT 123
311 # define BIO_C_GET_ACCEPT 124
312 # define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
313 # define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
314 # define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
315 # define BIO_C_FILE_SEEK 128
316 # define BIO_C_GET_CIPHER_CTX 129
317 # define BIO_C_SET_BUF_MEM_EOF_RETURN 130/* return end of input
319 # define BIO_C_SET_BIND_MODE 131
320 # define BIO_C_GET_BIND_MODE 132
321 # define BIO_C_FILE_TELL 133
322 # define BIO_C_GET_SOCKS 134
323 # define BIO_C_SET_SOCKS 135
325 # define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
326 # define BIO_C_GET_WRITE_BUF_SIZE 137
327 # define BIO_C_MAKE_BIO_PAIR 138
328 # define BIO_C_DESTROY_BIO_PAIR 139
329 # define BIO_C_GET_WRITE_GUARANTEE 140
330 # define BIO_C_GET_READ_REQUEST 141
331 # define BIO_C_SHUTDOWN_WR 142
332 # define BIO_C_NREAD0 143
333 # define BIO_C_NREAD 144
334 # define BIO_C_NWRITE0 145
335 # define BIO_C_NWRITE 146
336 # define BIO_C_RESET_READ_REQUEST 147
337 # define BIO_C_SET_MD_CTX 148
339 # define BIO_C_SET_PREFIX 149
340 # define BIO_C_GET_PREFIX 150
341 # define BIO_C_SET_SUFFIX 151
342 # define BIO_C_GET_SUFFIX 152
344 # define BIO_C_SET_EX_ARG 153
345 # define BIO_C_GET_EX_ARG 154
347 # define BIO_C_SET_CONNECT_MODE 155
349 # define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg)
350 # define BIO_get_app_data(s) BIO_get_ex_data(s,0)
352 # define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
354 # ifndef OPENSSL_NO_SOCK
355 /* IP families we support, for BIO_s_connect() and BIO_s_accept() */
356 /* Note: the underlying operating system may not support some of them */
357 # define BIO_FAMILY_IPV4 4
358 # define BIO_FAMILY_IPV6 6
359 # define BIO_FAMILY_IPANY 256
361 /* BIO_s_connect() */
362 # define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name)
363 # define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
364 # define BIO_set_conn_address(b,addr) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)addr)
365 # define BIO_set_conn_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,f)
366 # define BIO_get_conn_hostname(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0,NULL))
367 # define BIO_get_conn_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1,NULL))
368 # define BIO_get_conn_address(b) ((const BIO_ADDR *)BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2,NULL))
369 # define BIO_get_conn_ip_family(b) BIO_ctrl(b,BIO_C_GET_CONNECT,3,NULL)
370 # define BIO_set_conn_mode(b,n) BIO_ctrl(b,BIO_C_SET_CONNECT_MODE,(n),NULL)
373 # define BIO_set_accept_name(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name)
374 # define BIO_set_accept_port(b,port) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(char *)port)
375 # define BIO_get_accept_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0))
376 # define BIO_get_accept_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,1))
377 # define BIO_get_peer_name(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,2))
378 # define BIO_get_peer_port(b) ((const char *)BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,3))
379 /* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
380 # define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(n)?(void *)"a":NULL)
381 # define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,3,(char *)bio)
382 # define BIO_set_accept_ip_family(b,f) BIO_int_ctrl(b,BIO_C_SET_ACCEPT,4,f)
383 # define BIO_get_accept_ip_family(b) BIO_ctrl(b,BIO_C_GET_ACCEPT,4,NULL)
385 /* Aliases kept for backward compatibility */
386 # define BIO_BIND_NORMAL 0
387 # define BIO_BIND_REUSEADDR BIO_SOCK_REUSEADDR
388 # define BIO_BIND_REUSEADDR_IF_UNUSED BIO_SOCK_REUSEADDR
389 # define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
390 # define BIO_get_bind_mode(b) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
392 /* BIO_s_accept() and BIO_s_connect() */
393 # define BIO_do_connect(b) BIO_do_handshake(b)
394 # define BIO_do_accept(b) BIO_do_handshake(b)
395 # endif /* OPENSSL_NO_SOCK */
397 # define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
399 /* BIO_s_datagram(), BIO_s_fd(), BIO_s_socket(), BIO_s_accept() and BIO_s_connect() */
400 # define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
401 # define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
404 # define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp)
405 # define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp)
407 /* BIO_s_fd() and BIO_s_file() */
408 # define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
409 # define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
412 * name is cast to lose const, but might be better to route through a
413 * function so we can do it safely
417 * If you are wondering why this isn't defined, its because CONST_STRICT is
418 * purely a compile-time kludge to allow const to be checked.
420 int BIO_read_filename(BIO
*b
, const char *name
);
422 # define BIO_read_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
423 BIO_CLOSE|BIO_FP_READ,(char *)name)
425 # define BIO_write_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
426 BIO_CLOSE|BIO_FP_WRITE,name)
427 # define BIO_append_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
428 BIO_CLOSE|BIO_FP_APPEND,name)
429 # define BIO_rw_filename(b,name) (int)BIO_ctrl(b,BIO_C_SET_FILENAME, \
430 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
433 * WARNING WARNING, this ups the reference count on the read bio of the SSL
434 * structure. This is because the ssl read BIO is now pointed to by the
435 * next_bio field in the bio. So when you free the BIO, make sure you are
436 * doing a BIO_free_all() to catch the underlying BIO.
438 # define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl)
439 # define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp)
440 # define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
441 # define BIO_set_ssl_renegotiate_bytes(b,num) \
442 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL)
443 # define BIO_get_num_renegotiates(b) \
444 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL)
445 # define BIO_set_ssl_renegotiate_timeout(b,seconds) \
446 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL)
448 /* defined in evp.h */
449 /* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */
451 # define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp)
452 # define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm)
453 # define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp)
454 # define BIO_set_mem_eof_return(b,v) \
455 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
457 /* For the BIO_f_buffer() type */
458 # define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
459 # define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
460 # define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
461 # define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
462 # define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
464 /* Don't use the next one unless you know what you are doing :-) */
465 # define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
467 # define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
468 # define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
469 # define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
470 # define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
471 # define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
472 # define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
473 /* ...pending macros have inappropriate return type */
474 size_t BIO_ctrl_pending(BIO
*b
);
475 size_t BIO_ctrl_wpending(BIO
*b
);
476 # define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
477 # define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
479 # define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
481 /* For the BIO_f_buffer() type */
482 # define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
484 /* For BIO_s_bio() */
485 # define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
486 # define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
487 # define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
488 # define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
489 # define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
490 /* macros with inappropriate type -- but ...pending macros use int too: */
491 # define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
492 # define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
493 size_t BIO_ctrl_get_write_guarantee(BIO
*b
);
494 size_t BIO_ctrl_get_read_request(BIO
*b
);
495 int BIO_ctrl_reset_read_request(BIO
*b
);
497 /* ctrl macros for dgram */
498 # define BIO_ctrl_dgram_connect(b,peer) \
499 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)peer)
500 # define BIO_ctrl_set_connected(b,peer) \
501 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, 0, (char *)peer)
502 # define BIO_dgram_recv_timedout(b) \
503 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
504 # define BIO_dgram_send_timedout(b) \
505 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
506 # define BIO_dgram_get_peer(b,peer) \
507 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)peer)
508 # define BIO_dgram_set_peer(b,peer) \
509 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)peer)
510 # define BIO_dgram_get_mtu_overhead(b) \
511 (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU_OVERHEAD, 0, NULL)
513 #define BIO_get_ex_new_index(l, p, newf, dupf, freef) \
514 CRYPTO_get_ex_new_index(CRYPTO_EX_INDEX_BIO, l, p, newf, dupf, freef)
515 int BIO_set_ex_data(BIO
*bio
, int idx
, void *data
);
516 void *BIO_get_ex_data(BIO
*bio
, int idx
);
517 uint64_t BIO_number_read(BIO
*bio
);
518 uint64_t BIO_number_written(BIO
*bio
);
520 /* For BIO_f_asn1() */
521 int BIO_asn1_set_prefix(BIO
*b
, asn1_ps_func
*prefix
,
522 asn1_ps_func
*prefix_free
);
523 int BIO_asn1_get_prefix(BIO
*b
, asn1_ps_func
**pprefix
,
524 asn1_ps_func
**pprefix_free
);
525 int BIO_asn1_set_suffix(BIO
*b
, asn1_ps_func
*suffix
,
526 asn1_ps_func
*suffix_free
);
527 int BIO_asn1_get_suffix(BIO
*b
, asn1_ps_func
**psuffix
,
528 asn1_ps_func
**psuffix_free
);
530 const BIO_METHOD
*BIO_s_file(void);
531 BIO
*BIO_new_file(const char *filename
, const char *mode
);
532 # ifndef OPENSSL_NO_STDIO
533 BIO
*BIO_new_fp(FILE *stream
, int close_flag
);
535 BIO
*BIO_new(const BIO_METHOD
*type
);
536 int BIO_set(BIO
*a
, const BIO_METHOD
*type
);
537 int BIO_free(BIO
*a
);
538 void BIO_set_data(BIO
*a
, void *ptr
);
539 void *BIO_get_data(BIO
*a
);
540 void BIO_set_init(BIO
*a
, int init
);
541 int BIO_get_init(BIO
*a
);
542 void BIO_set_shutdown(BIO
*a
, int shut
);
543 int BIO_get_shutdown(BIO
*a
);
544 void BIO_vfree(BIO
*a
);
545 int BIO_up_ref(BIO
*a
);
546 int BIO_read(BIO
*b
, void *data
, int len
);
547 int BIO_gets(BIO
*bp
, char *buf
, int size
);
548 int BIO_write(BIO
*b
, const void *data
, int len
);
549 int BIO_puts(BIO
*bp
, const char *buf
);
550 int BIO_indent(BIO
*b
, int indent
, int max
);
551 long BIO_ctrl(BIO
*bp
, int cmd
, long larg
, void *parg
);
552 long BIO_callback_ctrl(BIO
*b
, int cmd
,
553 void (*fp
) (BIO
*, int, const char *, int, long, long));
554 void *BIO_ptr_ctrl(BIO
*bp
, int cmd
, long larg
);
555 long BIO_int_ctrl(BIO
*bp
, int cmd
, long larg
, int iarg
);
556 BIO
*BIO_push(BIO
*b
, BIO
*append
);
557 BIO
*BIO_pop(BIO
*b
);
558 void BIO_free_all(BIO
*a
);
559 BIO
*BIO_find_type(BIO
*b
, int bio_type
);
560 BIO
*BIO_next(BIO
*b
);
561 void BIO_set_next(BIO
*b
, BIO
*next
);
562 BIO
*BIO_get_retry_BIO(BIO
*bio
, int *reason
);
563 int BIO_get_retry_reason(BIO
*bio
);
564 void BIO_set_retry_reason(BIO
*bio
, int reason
);
565 BIO
*BIO_dup_chain(BIO
*in
);
567 int BIO_nread0(BIO
*bio
, char **buf
);
568 int BIO_nread(BIO
*bio
, char **buf
, int num
);
569 int BIO_nwrite0(BIO
*bio
, char **buf
);
570 int BIO_nwrite(BIO
*bio
, char **buf
, int num
);
572 long BIO_debug_callback(BIO
*bio
, int cmd
, const char *argp
, int argi
,
573 long argl
, long ret
);
575 const BIO_METHOD
*BIO_s_mem(void);
576 const BIO_METHOD
*BIO_s_secmem(void);
577 BIO
*BIO_new_mem_buf(const void *buf
, int len
);
578 # ifndef OPENSSL_NO_SOCK
579 const BIO_METHOD
*BIO_s_socket(void);
580 const BIO_METHOD
*BIO_s_connect(void);
581 const BIO_METHOD
*BIO_s_accept(void);
583 const BIO_METHOD
*BIO_s_fd(void);
584 const BIO_METHOD
*BIO_s_log(void);
585 const BIO_METHOD
*BIO_s_bio(void);
586 const BIO_METHOD
*BIO_s_null(void);
587 const BIO_METHOD
*BIO_f_null(void);
588 const BIO_METHOD
*BIO_f_buffer(void);
589 const BIO_METHOD
*BIO_f_linebuffer(void);
590 const BIO_METHOD
*BIO_f_nbio_test(void);
591 # ifndef OPENSSL_NO_DGRAM
592 const BIO_METHOD
*BIO_s_datagram(void);
593 int BIO_dgram_non_fatal_error(int error
);
594 BIO
*BIO_new_dgram(int fd
, int close_flag
);
595 # ifndef OPENSSL_NO_SCTP
596 const BIO_METHOD
*BIO_s_datagram_sctp(void);
597 BIO
*BIO_new_dgram_sctp(int fd
, int close_flag
);
598 int BIO_dgram_is_sctp(BIO
*bio
);
599 int BIO_dgram_sctp_notification_cb(BIO
*b
,
600 void (*handle_notifications
) (BIO
*bio
,
604 int BIO_dgram_sctp_wait_for_dry(BIO
*b
);
605 int BIO_dgram_sctp_msg_waiting(BIO
*b
);
609 # ifndef OPENSSL_NO_SOCK
610 int BIO_sock_should_retry(int i
);
611 int BIO_sock_non_fatal_error(int error
);
614 int BIO_fd_should_retry(int i
);
615 int BIO_fd_non_fatal_error(int error
);
616 int BIO_dump_cb(int (*cb
) (const void *data
, size_t len
, void *u
),
617 void *u
, const char *s
, int len
);
618 int BIO_dump_indent_cb(int (*cb
) (const void *data
, size_t len
, void *u
),
619 void *u
, const char *s
, int len
, int indent
);
620 int BIO_dump(BIO
*b
, const char *bytes
, int len
);
621 int BIO_dump_indent(BIO
*b
, const char *bytes
, int len
, int indent
);
622 # ifndef OPENSSL_NO_STDIO
623 int BIO_dump_fp(FILE *fp
, const char *s
, int len
);
624 int BIO_dump_indent_fp(FILE *fp
, const char *s
, int len
, int indent
);
626 int BIO_hex_string(BIO
*out
, int indent
, int width
, unsigned char *data
,
629 # ifndef OPENSSL_NO_SOCK
630 BIO_ADDR
*BIO_ADDR_new(void);
631 int BIO_ADDR_rawmake(BIO_ADDR
*ap
, int family
,
632 const void *where
, size_t wherelen
, unsigned short port
);
633 void BIO_ADDR_free(BIO_ADDR
*);
634 void BIO_ADDR_clear(BIO_ADDR
*ap
);
635 int BIO_ADDR_family(const BIO_ADDR
*ap
);
636 int BIO_ADDR_rawaddress(const BIO_ADDR
*ap
, void *p
, size_t *l
);
637 unsigned short BIO_ADDR_rawport(const BIO_ADDR
*ap
);
638 char *BIO_ADDR_hostname_string(const BIO_ADDR
*ap
, int numeric
);
639 char *BIO_ADDR_service_string(const BIO_ADDR
*ap
, int numeric
);
640 char *BIO_ADDR_path_string(const BIO_ADDR
*ap
);
642 const BIO_ADDRINFO
*BIO_ADDRINFO_next(const BIO_ADDRINFO
*bai
);
643 int BIO_ADDRINFO_family(const BIO_ADDRINFO
*bai
);
644 int BIO_ADDRINFO_socktype(const BIO_ADDRINFO
*bai
);
645 int BIO_ADDRINFO_protocol(const BIO_ADDRINFO
*bai
);
646 const BIO_ADDR
*BIO_ADDRINFO_address(const BIO_ADDRINFO
*bai
);
647 void BIO_ADDRINFO_free(BIO_ADDRINFO
*bai
);
649 enum BIO_hostserv_priorities
{
650 BIO_PARSE_PRIO_HOST
, BIO_PARSE_PRIO_SERV
652 int BIO_parse_hostserv(const char *hostserv
, char **host
, char **service
,
653 enum BIO_hostserv_priorities hostserv_prio
);
654 enum BIO_lookup_type
{
655 BIO_LOOKUP_CLIENT
, BIO_LOOKUP_SERVER
657 int BIO_lookup(const char *host
, const char *service
,
658 enum BIO_lookup_type lookup_type
,
659 int family
, int socktype
, BIO_ADDRINFO
**res
);
660 int BIO_sock_error(int sock
);
661 int BIO_socket_ioctl(int fd
, long type
, void *arg
);
662 int BIO_socket_nbio(int fd
, int mode
);
663 int BIO_sock_init(void);
664 # if OPENSSL_API_COMPAT < 0x10100000L
665 # define BIO_sock_cleanup() while(0) continue
667 int BIO_set_tcp_ndelay(int sock
, int turn_on
);
669 DEPRECATEDIN_1_1_0(struct hostent
*BIO_gethostbyname(const char *name
))
670 DEPRECATEDIN_1_1_0(int BIO_get_port(const char *str
, unsigned short *port_ptr
))
671 DEPRECATEDIN_1_1_0(int BIO_get_host_ip(const char *str
, unsigned char *ip
))
672 DEPRECATEDIN_1_1_0(int BIO_get_accept_socket(char *host_port
, int mode
))
673 DEPRECATEDIN_1_1_0(int BIO_accept(int sock
, char **ip_port
))
675 union BIO_sock_info_u
{
678 enum BIO_sock_info_type
{
679 BIO_SOCK_INFO_ADDRESS
681 int BIO_sock_info(int sock
,
682 enum BIO_sock_info_type type
, union BIO_sock_info_u
*info
);
684 # define BIO_SOCK_REUSEADDR 0x01
685 # define BIO_SOCK_V6_ONLY 0x02
686 # define BIO_SOCK_KEEPALIVE 0x04
687 # define BIO_SOCK_NONBLOCK 0x08
688 # define BIO_SOCK_NODELAY 0x10
690 int BIO_socket(int domain
, int socktype
, int protocol
, int options
);
691 int BIO_connect(int sock
, const BIO_ADDR
*addr
, int options
);
692 int BIO_listen(int sock
, const BIO_ADDR
*addr
, int options
);
693 int BIO_accept_ex(int accept_sock
, BIO_ADDR
*addr
, int options
);
694 int BIO_closesocket(int sock
);
696 BIO
*BIO_new_socket(int sock
, int close_flag
);
697 BIO
*BIO_new_connect(const char *host_port
);
698 BIO
*BIO_new_accept(const char *host_port
);
699 # endif /* OPENSSL_NO_SOCK*/
701 BIO
*BIO_new_fd(int fd
, int close_flag
);
703 int BIO_new_bio_pair(BIO
**bio1
, size_t writebuf1
,
704 BIO
**bio2
, size_t writebuf2
);
706 * If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
707 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. Size 0 uses default
711 void BIO_copy_next_retry(BIO
*b
);
714 * long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
718 # define __bio_h__attr__ __attribute__
720 # define __bio_h__attr__(x)
722 int BIO_printf(BIO
*bio
, const char *format
, ...)
723 __bio_h__attr__((__format__(__printf__
, 2, 3)));
724 int BIO_vprintf(BIO
*bio
, const char *format
, va_list args
)
725 __bio_h__attr__((__format__(__printf__
, 2, 0)));
726 int BIO_snprintf(char *buf
, size_t n
, const char *format
, ...)
727 __bio_h__attr__((__format__(__printf__
, 3, 4)));
728 int BIO_vsnprintf(char *buf
, size_t n
, const char *format
, va_list args
)
729 __bio_h__attr__((__format__(__printf__
, 3, 0)));
730 # undef __bio_h__attr__
733 BIO_METHOD
*BIO_meth_new(int type
, const char *name
);
734 void BIO_meth_free(BIO_METHOD
*biom
);
735 int (*BIO_meth_get_write(BIO_METHOD
*biom
)) (BIO
*, const char *, int);
736 int BIO_meth_set_write(BIO_METHOD
*biom
,
737 int (*write
) (BIO
*, const char *, int));
738 int (*BIO_meth_get_read(BIO_METHOD
*biom
)) (BIO
*, char *, int);
739 int BIO_meth_set_read(BIO_METHOD
*biom
,
740 int (*read
) (BIO
*, char *, int));
741 int (*BIO_meth_get_puts(BIO_METHOD
*biom
)) (BIO
*, const char *);
742 int BIO_meth_set_puts(BIO_METHOD
*biom
,
743 int (*puts
) (BIO
*, const char *));
744 int (*BIO_meth_get_gets(BIO_METHOD
*biom
)) (BIO
*, char *, int);
745 int BIO_meth_set_gets(BIO_METHOD
*biom
,
746 int (*gets
) (BIO
*, char *, int));
747 long (*BIO_meth_get_ctrl(BIO_METHOD
*biom
)) (BIO
*, int, long, void *);
748 int BIO_meth_set_ctrl(BIO_METHOD
*biom
,
749 long (*ctrl
) (BIO
*, int, long, void *));
750 int (*BIO_meth_get_create(BIO_METHOD
*bion
)) (BIO
*);
751 int BIO_meth_set_create(BIO_METHOD
*biom
, int (*create
) (BIO
*));
752 int (*BIO_meth_get_destroy(BIO_METHOD
*biom
)) (BIO
*);
753 int BIO_meth_set_destroy(BIO_METHOD
*biom
, int (*destroy
) (BIO
*));
754 long (*BIO_meth_get_callback_ctrl(BIO_METHOD
*biom
))
755 (BIO
*, int, bio_info_cb
*);
756 int BIO_meth_set_callback_ctrl(BIO_METHOD
*biom
,
757 long (*callback_ctrl
) (BIO
*, int,
760 /* BEGIN ERROR CODES */
762 * The following lines are auto generated by the script mkerr.pl. Any changes
763 * made after this point may be overwritten when the script is next run.
766 void ERR_load_BIO_strings(void);
768 /* Error codes for the BIO functions. */
770 /* Function codes. */
771 # define BIO_F_ACPT_STATE 100
772 # define BIO_F_ADDR_STRINGS 134
773 # define BIO_F_BIO_ACCEPT 101
774 # define BIO_F_BIO_ACCEPT_EX 137
775 # define BIO_F_BIO_ADDR_NEW 144
776 # define BIO_F_BIO_CALLBACK_CTRL 131
777 # define BIO_F_BIO_CONNECT 138
778 # define BIO_F_BIO_CTRL 103
779 # define BIO_F_BIO_GETS 104
780 # define BIO_F_BIO_GET_HOST_IP 106
781 # define BIO_F_BIO_GET_PORT 107
782 # define BIO_F_BIO_LISTEN 139
783 # define BIO_F_BIO_LOOKUP 135
784 # define BIO_F_BIO_MAKE_PAIR 121
785 # define BIO_F_BIO_NEW 108
786 # define BIO_F_BIO_NEW_FILE 109
787 # define BIO_F_BIO_NEW_MEM_BUF 126
788 # define BIO_F_BIO_NREAD 123
789 # define BIO_F_BIO_NREAD0 124
790 # define BIO_F_BIO_NWRITE 125
791 # define BIO_F_BIO_NWRITE0 122
792 # define BIO_F_BIO_PARSE_HOSTSERV 136
793 # define BIO_F_BIO_PUTS 110
794 # define BIO_F_BIO_READ 111
795 # define BIO_F_BIO_SET 143
796 # define BIO_F_BIO_SOCKET 140
797 # define BIO_F_BIO_SOCKET_NBIO 142
798 # define BIO_F_BIO_SOCK_INFO 141
799 # define BIO_F_BIO_SOCK_INIT 112
800 # define BIO_F_BIO_WRITE 113
801 # define BIO_F_BUFFER_CTRL 114
802 # define BIO_F_CONN_CTRL 127
803 # define BIO_F_CONN_STATE 115
804 # define BIO_F_DGRAM_SCTP_READ 132
805 # define BIO_F_DGRAM_SCTP_WRITE 133
806 # define BIO_F_FILE_CTRL 116
807 # define BIO_F_FILE_READ 130
808 # define BIO_F_LINEBUFFER_CTRL 129
809 # define BIO_F_MEM_WRITE 117
810 # define BIO_F_SSL_NEW 118
813 # define BIO_R_ACCEPT_ERROR 100
814 # define BIO_R_ADDRINFO_ADDR_IS_NOT_AF_INET 141
815 # define BIO_R_AMBIGUOUS_HOST_OR_SERVICE 129
816 # define BIO_R_BAD_FOPEN_MODE 101
817 # define BIO_R_BROKEN_PIPE 124
818 # define BIO_R_CONNECT_ERROR 103
819 # define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET 107
820 # define BIO_R_GETSOCKNAME_ERROR 132
821 # define BIO_R_GETSOCKNAME_TRUNCATED_ADDRESS 133
822 # define BIO_R_GETTING_SOCKTYPE 134
823 # define BIO_R_INVALID_ARGUMENT 125
824 # define BIO_R_INVALID_SOCKET 135
825 # define BIO_R_IN_USE 123
826 # define BIO_R_LISTEN_V6_ONLY 136
827 # define BIO_R_LOOKUP_RETURNED_NOTHING 142
828 # define BIO_R_MALFORMED_HOST_OR_SERVICE 130
829 # define BIO_R_NBIO_CONNECT_ERROR 110
830 # define BIO_R_NO_ACCEPT_ADDR_OR_SERVICE_SPECIFIED 143
831 # define BIO_R_NO_HOSTNAME_OR_SERVICE_SPECIFIED 144
832 # define BIO_R_NO_PORT_DEFINED 113
833 # define BIO_R_NO_SUCH_FILE 128
834 # define BIO_R_NULL_PARAMETER 115
835 # define BIO_R_UNABLE_TO_BIND_SOCKET 117
836 # define BIO_R_UNABLE_TO_CREATE_SOCKET 118
837 # define BIO_R_UNABLE_TO_KEEPALIVE 137
838 # define BIO_R_UNABLE_TO_LISTEN_SOCKET 119
839 # define BIO_R_UNABLE_TO_NODELAY 138
840 # define BIO_R_UNABLE_TO_REUSEADDR 139
841 # define BIO_R_UNAVAILABLE_IP_FAMILY 145
842 # define BIO_R_UNINITIALIZED 120
843 # define BIO_R_UNKNOWN_INFO_TYPE 140
844 # define BIO_R_UNSUPPORTED_IP_FAMILY 146
845 # define BIO_R_UNSUPPORTED_METHOD 121
846 # define BIO_R_UNSUPPORTED_PROTOCOL_FAMILY 131
847 # define BIO_R_WRITE_TO_READ_ONLY_BIO 126
848 # define BIO_R_WSASTARTUP 122