1 /* $OpenBSD: bio.h,v 1.40 2018/03/17 15:05:55 tb Exp $ */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
9 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
16 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
37 * 4. If you include any Windows specific code (or a derivative thereof) from
38 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
61 #if !defined(HAVE_ATTRIBUTE__BOUNDED__) && !defined(__OpenBSD__)
62 #define __bounded__(x, y, z)
64 #include <openssl/opensslconf.h>
69 #include <openssl/crypto.h>
76 /* These are the 'types' of BIOs */
77 #define BIO_TYPE_NONE 0
78 #define BIO_TYPE_MEM (1|0x0400)
79 #define BIO_TYPE_FILE (2|0x0400)
81 #define BIO_TYPE_FD (4|0x0400|0x0100)
82 #define BIO_TYPE_SOCKET (5|0x0400|0x0100)
83 #define BIO_TYPE_NULL (6|0x0400)
84 #define BIO_TYPE_SSL (7|0x0200)
85 #define BIO_TYPE_MD (8|0x0200) /* passive filter */
86 #define BIO_TYPE_BUFFER (9|0x0200) /* filter */
87 #define BIO_TYPE_CIPHER (10|0x0200) /* filter */
88 #define BIO_TYPE_BASE64 (11|0x0200) /* filter */
89 #define BIO_TYPE_CONNECT (12|0x0400|0x0100) /* socket - connect */
90 #define BIO_TYPE_ACCEPT (13|0x0400|0x0100) /* socket for accept */
91 #define BIO_TYPE_PROXY_CLIENT (14|0x0200) /* client proxy BIO */
92 #define BIO_TYPE_PROXY_SERVER (15|0x0200) /* server proxy BIO */
93 #define BIO_TYPE_NBIO_TEST (16|0x0200) /* server proxy BIO */
94 #define BIO_TYPE_NULL_FILTER (17|0x0200)
95 #define BIO_TYPE_BER (18|0x0200) /* BER -> bin filter */
96 #define BIO_TYPE_BIO (19|0x0400) /* (half a) BIO pair */
97 #define BIO_TYPE_LINEBUFFER (20|0x0200) /* filter */
98 #define BIO_TYPE_DGRAM (21|0x0400|0x0100)
99 #define BIO_TYPE_ASN1 (22|0x0200) /* filter */
100 #define BIO_TYPE_COMP (23|0x0200) /* filter */
102 #define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */
103 #define BIO_TYPE_FILTER 0x0200
104 #define BIO_TYPE_SOURCE_SINK 0x0400
107 * BIO_TYPE_START is the first user-allocated BIO type. No pre-defined type,
108 * flag bits aside, may exceed this value.
110 #define BIO_TYPE_START 128
112 /* BIO_FILENAME_READ|BIO_CLOSE to open or close on free.
113 * BIO_set_fp(in,stdin,BIO_NOCLOSE); */
114 #define BIO_NOCLOSE 0x00
115 #define BIO_CLOSE 0x01
117 /* These are used in the following macros and are passed to
119 #define BIO_CTRL_RESET 1 /* opt - rewind/zero etc */
120 #define BIO_CTRL_EOF 2 /* opt - are we at the eof */
121 #define BIO_CTRL_INFO 3 /* opt - extra tit-bits */
122 #define BIO_CTRL_SET 4 /* man - set the 'IO' type */
123 #define BIO_CTRL_GET 5 /* man - get the 'IO' type */
124 #define BIO_CTRL_PUSH 6 /* opt - internal, used to signify change */
125 #define BIO_CTRL_POP 7 /* opt - internal, used to signify change */
126 #define BIO_CTRL_GET_CLOSE 8 /* man - set the 'close' on free */
127 #define BIO_CTRL_SET_CLOSE 9 /* man - set the 'close' on free */
128 #define BIO_CTRL_PENDING 10 /* opt - is their more data buffered */
129 #define BIO_CTRL_FLUSH 11 /* opt - 'flush' buffered output */
130 #define BIO_CTRL_DUP 12 /* man - extra stuff for 'duped' BIO */
131 #define BIO_CTRL_WPENDING 13 /* opt - number of bytes still to write */
132 /* callback is int cb(BIO *bio,state,ret); */
133 #define BIO_CTRL_SET_CALLBACK 14 /* opt - set callback function */
134 #define BIO_CTRL_GET_CALLBACK 15 /* opt - set callback function */
136 #define BIO_CTRL_SET_FILENAME 30 /* BIO_s_file special */
138 /* dgram BIO stuff */
139 #define BIO_CTRL_DGRAM_CONNECT 31 /* BIO dgram special */
140 #define BIO_CTRL_DGRAM_SET_CONNECTED 32 /* allow for an externally
141 * connected socket to be
143 #define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33 /* setsockopt, essentially */
144 #define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34 /* getsockopt, essentially */
145 #define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35 /* setsockopt, essentially */
146 #define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36 /* getsockopt, essentially */
148 #define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37 /* flag whether the last */
149 #define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38 /* I/O operation tiemd out */
151 /* #ifdef IP_MTU_DISCOVER */
152 #define BIO_CTRL_DGRAM_MTU_DISCOVER 39 /* set DF bit on egress packets */
155 #define BIO_CTRL_DGRAM_QUERY_MTU 40 /* as kernel for current MTU */
156 #define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47
157 #define BIO_CTRL_DGRAM_GET_MTU 41 /* get cached value for MTU */
158 #define BIO_CTRL_DGRAM_SET_MTU 42 /* set cached value for
159 * MTU. want to use this
160 * if asking the kernel
163 #define BIO_CTRL_DGRAM_MTU_EXCEEDED 43 /* check whether the MTU
168 #define BIO_CTRL_DGRAM_GET_PEER 46
169 #define BIO_CTRL_DGRAM_SET_PEER 44 /* Destination for the data */
171 #define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45 /* Next DTLS handshake timeout to
172 * adjust socket timeouts */
176 #define BIO_FP_READ 0x02
177 #define BIO_FP_WRITE 0x04
178 #define BIO_FP_APPEND 0x08
179 #define BIO_FP_TEXT 0x10
181 #define BIO_FLAGS_READ 0x01
182 #define BIO_FLAGS_WRITE 0x02
183 #define BIO_FLAGS_IO_SPECIAL 0x04
184 #define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
185 #define BIO_FLAGS_SHOULD_RETRY 0x08
187 /* Used in BIO_gethostbyname() */
188 #define BIO_GHBN_CTRL_HITS 1
189 #define BIO_GHBN_CTRL_MISSES 2
190 #define BIO_GHBN_CTRL_CACHE_SIZE 3
191 #define BIO_GHBN_CTRL_GET_ENTRY 4
192 #define BIO_GHBN_CTRL_FLUSH 5
194 /* Mostly used in the SSL BIO */
196 * #define BIO_FLAGS_PROTOCOL_DELAYED_READ 0x10
197 * #define BIO_FLAGS_PROTOCOL_DELAYED_WRITE 0x20
198 * #define BIO_FLAGS_PROTOCOL_STARTUP 0x40
201 #define BIO_FLAGS_BASE64_NO_NL 0x100
203 /* This is used with memory BIOs: it means we shouldn't free up or change the
206 #define BIO_FLAGS_MEM_RDONLY 0x200
208 typedef struct bio_st BIO
;
210 void BIO_set_flags(BIO
*b
, int flags
);
211 int BIO_test_flags(const BIO
*b
, int flags
);
212 void BIO_clear_flags(BIO
*b
, int flags
);
214 #define BIO_get_flags(b) BIO_test_flags(b, ~(0x0))
215 #define BIO_set_retry_special(b) \
216 BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
217 #define BIO_set_retry_read(b) \
218 BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
219 #define BIO_set_retry_write(b) \
220 BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
222 /* These are normally used internally in BIOs */
223 #define BIO_clear_retry_flags(b) \
224 BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
225 #define BIO_get_retry_flags(b) \
226 BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
228 /* These should be used by the application to tell why we should retry */
229 #define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ)
230 #define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE)
231 #define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL)
232 #define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS)
233 #define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY)
235 /* The next three are used in conjunction with the
236 * BIO_should_io_special() condition. After this returns true,
237 * BIO *BIO_get_retry_BIO(BIO *bio, int *reason); will walk the BIO
238 * stack and return the 'reason' for the special and the offending BIO.
239 * Given a BIO, BIO_get_retry_reason(bio) will return the code. */
240 /* Returned from the SSL bio when the certificate retrieval code had an error */
241 #define BIO_RR_SSL_X509_LOOKUP 0x01
242 /* Returned from the connect BIO when a connect would have blocked */
243 #define BIO_RR_CONNECT 0x02
244 /* Returned from the accept BIO when an accept would have blocked */
245 #define BIO_RR_ACCEPT 0x03
247 /* These are passed by the BIO callback */
248 #define BIO_CB_FREE 0x01
249 #define BIO_CB_READ 0x02
250 #define BIO_CB_WRITE 0x03
251 #define BIO_CB_PUTS 0x04
252 #define BIO_CB_GETS 0x05
253 #define BIO_CB_CTRL 0x06
255 /* The callback is called before and after the underling operation,
256 * The BIO_CB_RETURN flag indicates if it is after the call */
257 #define BIO_CB_RETURN 0x80
258 #define BIO_CB_return(a) ((a)|BIO_CB_RETURN))
259 #define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN))
260 #define BIO_cb_post(a) ((a)&BIO_CB_RETURN)
262 long (*BIO_get_callback(const BIO
*b
))(struct bio_st
*, int, const char *,
264 void BIO_set_callback(BIO
*b
,
265 long (*callback
)(struct bio_st
*, int, const char *, int, long, long));
266 char *BIO_get_callback_arg(const BIO
*b
);
267 void BIO_set_callback_arg(BIO
*b
, char *arg
);
269 const char * BIO_method_name(const BIO
*b
);
270 int BIO_method_type(const BIO
*b
);
272 typedef void bio_info_cb(struct bio_st
*, int, const char *, int, long, long);
273 typedef int BIO_info_cb(BIO
*, int, int);
275 typedef struct bio_method_st
{
278 int (*bwrite
)(BIO
*, const char *, int);
279 int (*bread
)(BIO
*, char *, int);
280 int (*bputs
)(BIO
*, const char *);
281 int (*bgets
)(BIO
*, char *, int);
282 long (*ctrl
)(BIO
*, int, long, void *);
283 int (*create
)(BIO
*);
284 int (*destroy
)(BIO
*);
285 long (*callback_ctrl
)(BIO
*, int, bio_info_cb
*);
290 /* bio, mode, argp, argi, argl, ret */
291 long (*callback
)(struct bio_st
*, int, const char *, int, long, long);
292 char *cb_arg
; /* first argument for the callback */
296 int flags
; /* extra storage */
300 struct bio_st
*next_bio
; /* used by filter BIOs */
301 struct bio_st
*prev_bio
; /* used by filter BIOs */
303 unsigned long num_read
;
304 unsigned long num_write
;
306 CRYPTO_EX_DATA ex_data
;
309 DECLARE_STACK_OF(BIO
)
311 typedef struct bio_f_buffer_ctx_struct
{
312 /* Buffers are setup like this:
314 * <---------------------- size ----------------------->
315 * +---------------------------------------------------+
316 * | consumed | remaining | free space |
317 * +---------------------------------------------------+
318 * <-- off --><------- len ------->
321 /* BIO *bio; */ /* this is now in the BIO struct */
322 int ibuf_size
; /* how big is the input buffer */
323 int obuf_size
; /* how big is the output buffer */
325 char *ibuf
; /* the char array */
326 int ibuf_len
; /* how many bytes are in it */
327 int ibuf_off
; /* write/read offset */
329 char *obuf
; /* the char array */
330 int obuf_len
; /* how many bytes are in it */
331 int obuf_off
; /* write/read offset */
334 /* Prefix and suffix callback in ASN1 BIO */
335 typedef int asn1_ps_func(BIO
*b
, unsigned char **pbuf
, int *plen
, void *parg
);
337 /* BIO_METHOD accessors */
338 BIO_METHOD
*BIO_meth_new(int type
, const char *name
);
339 void BIO_meth_free(BIO_METHOD
*biom
);
340 int (*BIO_meth_get_write(BIO_METHOD
*biom
))(BIO
*, const char *, int);
341 int BIO_meth_set_write(BIO_METHOD
*biom
,
342 int (*write
)(BIO
*, const char *, int));
343 int (*BIO_meth_get_read(BIO_METHOD
*biom
))(BIO
*, char *, int);
344 int BIO_meth_set_read(BIO_METHOD
*biom
, int (*read
)(BIO
*, char *, int));
345 int (*BIO_meth_get_puts(BIO_METHOD
*biom
))(BIO
*, const char *);
346 int BIO_meth_set_puts(BIO_METHOD
*biom
, int (*puts
)(BIO
*, const char *));
347 int (*BIO_meth_get_gets(BIO_METHOD
*biom
))(BIO
*, char *, int);
348 int BIO_meth_set_gets(BIO_METHOD
*biom
, int (*gets
)(BIO
*, char *, int));
349 long (*BIO_meth_get_ctrl(BIO_METHOD
*biom
))(BIO
*, int, long, void *);
350 int BIO_meth_set_ctrl(BIO_METHOD
*biom
, long (*ctrl
)(BIO
*, int, long, void *));
351 int (*BIO_meth_get_create(BIO_METHOD
*biom
))(BIO
*);
352 int BIO_meth_set_create(BIO_METHOD
*biom
, int (*create
)(BIO
*));
353 int (*BIO_meth_get_destroy(BIO_METHOD
*biom
))(BIO
*);
354 int BIO_meth_set_destroy(BIO_METHOD
*biom
, int (*destroy
)(BIO
*));
355 long (*BIO_meth_get_callback_ctrl(BIO_METHOD
*biom
))(BIO
*, int, BIO_info_cb
*);
356 int BIO_meth_set_callback_ctrl(BIO_METHOD
*biom
,
357 long (*callback_ctrl
)(BIO
*, int, BIO_info_cb
*));
359 /* connect BIO stuff */
360 #define BIO_CONN_S_BEFORE 1
361 #define BIO_CONN_S_GET_IP 2
362 #define BIO_CONN_S_GET_PORT 3
363 #define BIO_CONN_S_CREATE_SOCKET 4
364 #define BIO_CONN_S_CONNECT 5
365 #define BIO_CONN_S_OK 6
366 #define BIO_CONN_S_BLOCKED_CONNECT 7
367 #define BIO_CONN_S_NBIO 8
368 /*#define BIO_CONN_get_param_hostname BIO_ctrl */
370 #define BIO_C_SET_CONNECT 100
371 #define BIO_C_DO_STATE_MACHINE 101
372 #define BIO_C_SET_NBIO 102
373 #define BIO_C_SET_PROXY_PARAM 103
374 #define BIO_C_SET_FD 104
375 #define BIO_C_GET_FD 105
376 #define BIO_C_SET_FILE_PTR 106
377 #define BIO_C_GET_FILE_PTR 107
378 #define BIO_C_SET_FILENAME 108
379 #define BIO_C_SET_SSL 109
380 #define BIO_C_GET_SSL 110
381 #define BIO_C_SET_MD 111
382 #define BIO_C_GET_MD 112
383 #define BIO_C_GET_CIPHER_STATUS 113
384 #define BIO_C_SET_BUF_MEM 114
385 #define BIO_C_GET_BUF_MEM_PTR 115
386 #define BIO_C_GET_BUFF_NUM_LINES 116
387 #define BIO_C_SET_BUFF_SIZE 117
388 #define BIO_C_SET_ACCEPT 118
389 #define BIO_C_SSL_MODE 119
390 #define BIO_C_GET_MD_CTX 120
391 #define BIO_C_GET_PROXY_PARAM 121
392 #define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */
393 #define BIO_C_GET_CONNECT 123
394 #define BIO_C_GET_ACCEPT 124
395 #define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
396 #define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
397 #define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
398 #define BIO_C_FILE_SEEK 128
399 #define BIO_C_GET_CIPHER_CTX 129
400 #define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/
401 #define BIO_C_SET_BIND_MODE 131
402 #define BIO_C_GET_BIND_MODE 132
403 #define BIO_C_FILE_TELL 133
404 #define BIO_C_GET_SOCKS 134
405 #define BIO_C_SET_SOCKS 135
407 #define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
408 #define BIO_C_GET_WRITE_BUF_SIZE 137
409 #define BIO_C_MAKE_BIO_PAIR 138
410 #define BIO_C_DESTROY_BIO_PAIR 139
411 #define BIO_C_GET_WRITE_GUARANTEE 140
412 #define BIO_C_GET_READ_REQUEST 141
413 #define BIO_C_SHUTDOWN_WR 142
414 #define BIO_C_NREAD0 143
415 #define BIO_C_NREAD 144
416 #define BIO_C_NWRITE0 145
417 #define BIO_C_NWRITE 146
418 #define BIO_C_RESET_READ_REQUEST 147
419 #define BIO_C_SET_MD_CTX 148
421 #define BIO_C_SET_PREFIX 149
422 #define BIO_C_GET_PREFIX 150
423 #define BIO_C_SET_SUFFIX 151
424 #define BIO_C_GET_SUFFIX 152
426 #define BIO_C_SET_EX_ARG 153
427 #define BIO_C_GET_EX_ARG 154
429 #define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg)
430 #define BIO_get_app_data(s) BIO_get_ex_data(s,0)
432 /* BIO_s_connect() and BIO_s_socks4a_connect() */
433 #define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name)
434 #define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
435 #define BIO_set_conn_ip(b,ip) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip)
436 #define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port)
437 #define BIO_get_conn_hostname(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0)
438 #define BIO_get_conn_port(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1)
439 #define BIO_get_conn_ip(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2)
440 #define BIO_get_conn_int_port(b) BIO_int_ctrl(b,BIO_C_GET_CONNECT,3,0)
443 #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
445 /* BIO_s_accept_socket() */
446 #define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name)
447 #define BIO_get_accept_port(b) BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0)
448 /* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
449 #define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?(void *)"a":NULL)
450 #define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio)
452 #define BIO_BIND_NORMAL 0
453 #define BIO_BIND_REUSEADDR_IF_UNUSED 1
454 #define BIO_BIND_REUSEADDR 2
455 #define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
456 #define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
458 #define BIO_do_connect(b) BIO_do_handshake(b)
459 #define BIO_do_accept(b) BIO_do_handshake(b)
460 #define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
462 /* BIO_s_proxy_client() */
463 #define BIO_set_url(b,url) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,0,(char *)(url))
464 #define BIO_set_proxies(b,p) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,1,(char *)(p))
465 /* BIO_set_nbio(b,n) */
466 #define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s))
467 /* BIO *BIO_get_filter_bio(BIO *bio); */
468 #define BIO_set_proxy_cb(b,cb) BIO_callback_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(void *(*cb)()))
469 #define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk)
470 #define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool)
472 #define BIO_get_proxy_header(b,skp) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,0,(char *)skp)
473 #define BIO_get_proxies(b,pxy_p) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,1,(char *)(pxy_p))
474 #define BIO_get_url(b,url) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,2,(char *)(url))
475 #define BIO_get_no_connect_return(b) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,5,NULL)
477 #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
478 #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
480 #define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp)
481 #define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp)
483 #define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
484 #define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
486 /* name is cast to lose const, but might be better to route through a function
487 so we can do it safely */
488 #define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
489 BIO_CLOSE|BIO_FP_READ,(char *)name)
490 #define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
491 BIO_CLOSE|BIO_FP_WRITE,name)
492 #define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
493 BIO_CLOSE|BIO_FP_APPEND,name)
494 #define BIO_rw_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
495 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
497 /* WARNING WARNING, this ups the reference count on the read bio of the
498 * SSL structure. This is because the ssl read BIO is now pointed to by
499 * the next_bio field in the bio. So when you free the BIO, make sure
500 * you are doing a BIO_free_all() to catch the underlying BIO. */
501 #define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl)
502 #define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp)
503 #define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
504 #define BIO_set_ssl_renegotiate_bytes(b,num) \
505 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL)
506 #define BIO_get_num_renegotiates(b) \
507 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL)
508 #define BIO_set_ssl_renegotiate_timeout(b,seconds) \
509 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL)
511 /* defined in evp.h */
512 /* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */
514 #define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp)
515 #define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm)
516 #define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp)
517 #define BIO_set_mem_eof_return(b,v) \
518 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
520 /* For the BIO_f_buffer() type */
521 #define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
522 #define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
523 #define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
524 #define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
525 #define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
527 /* Don't use the next one unless you know what you are doing :-) */
528 #define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
530 #define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
531 #define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
532 #define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
533 #define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
534 #define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
535 #define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
536 /* ...pending macros have inappropriate return type */
537 size_t BIO_ctrl_pending(BIO
*b
);
538 size_t BIO_ctrl_wpending(BIO
*b
);
539 #define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
540 #define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \
542 #define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb)
544 /* For the BIO_f_buffer() type */
545 #define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
547 /* For BIO_s_bio() */
548 #define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
549 #define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
550 #define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
551 #define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
552 #define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
553 /* macros with inappropriate type -- but ...pending macros use int too: */
554 #define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
555 #define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
556 size_t BIO_ctrl_get_write_guarantee(BIO
*b
);
557 size_t BIO_ctrl_get_read_request(BIO
*b
);
558 int BIO_ctrl_reset_read_request(BIO
*b
);
560 /* ctrl macros for dgram */
561 #define BIO_ctrl_dgram_connect(b,peer) \
562 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)peer)
563 #define BIO_ctrl_set_connected(b, state, peer) \
564 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, state, (char *)peer)
565 #define BIO_dgram_recv_timedout(b) \
566 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL)
567 #define BIO_dgram_send_timedout(b) \
568 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL)
569 #define BIO_dgram_get_peer(b,peer) \
570 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)peer)
571 #define BIO_dgram_set_peer(b,peer) \
572 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)peer)
574 /* These two aren't currently implemented */
575 /* int BIO_get_ex_num(BIO *bio); */
576 /* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */
577 int BIO_set_ex_data(BIO
*bio
, int idx
, void *data
);
578 void *BIO_get_ex_data(BIO
*bio
, int idx
);
580 BIO_get_ex_new_index(long argl
, void *argp
, CRYPTO_EX_new
*new_func
,
581 CRYPTO_EX_dup
*dup_func
, CRYPTO_EX_free
*free_func
);
582 unsigned long BIO_number_read(BIO
*bio
);
583 unsigned long BIO_number_written(BIO
*bio
);
585 /* For BIO_f_asn1() */
587 BIO_asn1_set_prefix(BIO
*b
, asn1_ps_func
*prefix
,
588 asn1_ps_func
*prefix_free
);
590 BIO_asn1_get_prefix(BIO
*b
, asn1_ps_func
**pprefix
,
591 asn1_ps_func
**pprefix_free
);
593 BIO_asn1_set_suffix(BIO
*b
, asn1_ps_func
*suffix
,
594 asn1_ps_func
*suffix_free
);
596 BIO_asn1_get_suffix(BIO
*b
, asn1_ps_func
**psuffix
,
597 asn1_ps_func
**psuffix_free
);
599 int BIO_get_new_index(void);
600 BIO_METHOD
*BIO_s_file(void );
601 BIO
*BIO_new_file(const char *filename
, const char *mode
);
602 BIO
*BIO_new_fp(FILE *stream
, int close_flag
);
603 # define BIO_s_file_internal BIO_s_file
604 BIO
* BIO_new(BIO_METHOD
*type
);
605 int BIO_set(BIO
*a
, BIO_METHOD
*type
);
606 int BIO_free(BIO
*a
);
607 int BIO_up_ref(BIO
*bio
);
608 void *BIO_get_data(BIO
*a
);
609 void BIO_set_data(BIO
*a
, void *ptr
);
610 void BIO_set_init(BIO
*a
, int init
);
611 int BIO_get_shutdown(BIO
*a
);
612 void BIO_set_shutdown(BIO
*a
, int shut
);
613 void BIO_vfree(BIO
*a
);
614 int BIO_read(BIO
*b
, void *data
, int len
)
615 __attribute__((__bounded__(__buffer__
,2,3)));
616 int BIO_gets(BIO
*bp
, char *buf
, int size
)
617 __attribute__((__bounded__ (__string__
,2,3)));
618 int BIO_write(BIO
*b
, const void *data
, int len
)
619 __attribute__((__bounded__(__buffer__
,2,3)));
620 int BIO_puts(BIO
*bp
, const char *buf
);
621 int BIO_indent(BIO
*b
, int indent
, int max
);
622 long BIO_ctrl(BIO
*bp
, int cmd
, long larg
, void *parg
);
623 long BIO_callback_ctrl(BIO
*b
, int cmd
,
624 void (*fp
)(struct bio_st
*, int, const char *, int, long, long));
625 char * BIO_ptr_ctrl(BIO
*bp
, int cmd
, long larg
);
626 long BIO_int_ctrl(BIO
*bp
, int cmd
, long larg
, int iarg
);
627 BIO
* BIO_push(BIO
*b
, BIO
*append
);
628 BIO
* BIO_pop(BIO
*b
);
629 void BIO_free_all(BIO
*a
);
630 BIO
* BIO_find_type(BIO
*b
, int bio_type
);
631 BIO
* BIO_next(BIO
*b
);
632 BIO
* BIO_get_retry_BIO(BIO
*bio
, int *reason
);
633 int BIO_get_retry_reason(BIO
*bio
);
634 BIO
* BIO_dup_chain(BIO
*in
);
636 int BIO_nread0(BIO
*bio
, char **buf
);
637 int BIO_nread(BIO
*bio
, char **buf
, int num
);
638 int BIO_nwrite0(BIO
*bio
, char **buf
);
639 int BIO_nwrite(BIO
*bio
, char **buf
, int num
);
641 long BIO_debug_callback(BIO
*bio
, int cmd
, const char *argp
, int argi
,
642 long argl
, long ret
);
644 BIO_METHOD
*BIO_s_mem(void);
645 BIO
*BIO_new_mem_buf(void *buf
, int len
);
646 BIO_METHOD
*BIO_s_socket(void);
647 BIO_METHOD
*BIO_s_connect(void);
648 BIO_METHOD
*BIO_s_accept(void);
649 BIO_METHOD
*BIO_s_fd(void);
650 BIO_METHOD
*BIO_s_log(void);
651 BIO_METHOD
*BIO_s_bio(void);
652 BIO_METHOD
*BIO_s_null(void);
653 BIO_METHOD
*BIO_f_null(void);
654 BIO_METHOD
*BIO_f_buffer(void);
655 BIO_METHOD
*BIO_f_nbio_test(void);
656 #ifndef OPENSSL_NO_DGRAM
657 BIO_METHOD
*BIO_s_datagram(void);
660 /* BIO_METHOD *BIO_f_ber(void); */
662 int BIO_sock_should_retry(int i
);
663 int BIO_sock_non_fatal_error(int _error
);
664 int BIO_dgram_non_fatal_error(int _error
);
666 int BIO_fd_should_retry(int i
);
667 int BIO_fd_non_fatal_error(int _error
);
669 BIO_dump_cb(int (*cb
)(const void *data
, size_t len
, void *u
),
670 void *u
, const char *s
, int len
);
672 BIO_dump_indent_cb(int (*cb
)(const void *data
, size_t len
, void *u
),
673 void *u
, const char *s
, int len
, int indent
);
674 int BIO_dump(BIO
*b
, const char *bytes
, int len
);
675 int BIO_dump_indent(BIO
*b
, const char *bytes
, int len
, int indent
);
676 int BIO_dump_fp(FILE *fp
, const char *s
, int len
);
677 int BIO_dump_indent_fp(FILE *fp
, const char *s
, int len
, int indent
);
678 struct hostent
*BIO_gethostbyname(const char *name
);
679 /* We might want a thread-safe interface too:
680 * struct hostent *BIO_gethostbyname_r(const char *name,
681 * struct hostent *result, void *buffer, size_t buflen);
682 * or something similar (caller allocates a struct hostent,
683 * pointed to by "result", and additional buffer space for the various
684 * substructures; if the buffer does not suffice, NULL is returned
685 * and an appropriate error code is set).
687 int BIO_sock_error(int sock
);
688 int BIO_socket_ioctl(int fd
, long type
, void *arg
);
689 int BIO_socket_nbio(int fd
, int mode
);
690 int BIO_get_port(const char *str
, unsigned short *port_ptr
);
691 int BIO_get_host_ip(const char *str
, unsigned char *ip
);
692 int BIO_get_accept_socket(char *host_port
, int mode
);
693 int BIO_accept(int sock
, char **ip_port
);
694 int BIO_sock_init(void );
695 void BIO_sock_cleanup(void);
696 int BIO_set_tcp_ndelay(int sock
, int turn_on
);
698 BIO
*BIO_new_socket(int sock
, int close_flag
);
699 BIO
*BIO_new_dgram(int fd
, int close_flag
);
700 BIO
*BIO_new_fd(int fd
, int close_flag
);
701 BIO
*BIO_new_connect(char *host_port
);
702 BIO
*BIO_new_accept(char *host_port
);
705 BIO_new_bio_pair(BIO
**bio1
, size_t writebuf1
,
706 BIO
**bio2
, size_t writebuf2
);
707 /* If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
708 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL.
709 * Size 0 uses default value.
712 void BIO_copy_next_retry(BIO
*b
);
714 /*long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);*/
717 BIO_printf(BIO
*bio
, const char *format
, ...)
718 __attribute__((__format__(__printf__
, 2, 3), __nonnull__(2)));
720 BIO_vprintf(BIO
*bio
, const char *format
, va_list args
)
721 __attribute__((__format__(__printf__
, 2, 0), __nonnull__(2)));
723 BIO_snprintf(char *buf
, size_t n
, const char *format
, ...)
724 __attribute__((__deprecated__
, __format__(__printf__
, 3, 4),
727 BIO_vsnprintf(char *buf
, size_t n
, const char *format
, va_list args
)
728 __attribute__((__deprecated__
, __format__(__printf__
, 3, 0),
731 /* BEGIN ERROR CODES */
732 /* The following lines are auto generated by the script mkerr.pl. Any changes
733 * made after this point may be overwritten when the script is next run.
735 void ERR_load_BIO_strings(void);
737 /* Error codes for the BIO functions. */
739 /* Function codes. */
740 #define BIO_F_ACPT_STATE 100
741 #define BIO_F_BIO_ACCEPT 101
742 #define BIO_F_BIO_BER_GET_HEADER 102
743 #define BIO_F_BIO_CALLBACK_CTRL 131
744 #define BIO_F_BIO_CTRL 103
745 #define BIO_F_BIO_GETHOSTBYNAME 120
746 #define BIO_F_BIO_GETS 104
747 #define BIO_F_BIO_GET_ACCEPT_SOCKET 105
748 #define BIO_F_BIO_GET_HOST_IP 106
749 #define BIO_F_BIO_GET_PORT 107
750 #define BIO_F_BIO_MAKE_PAIR 121
751 #define BIO_F_BIO_NEW 108
752 #define BIO_F_BIO_NEW_FILE 109
753 #define BIO_F_BIO_NEW_MEM_BUF 126
754 #define BIO_F_BIO_NREAD 123
755 #define BIO_F_BIO_NREAD0 124
756 #define BIO_F_BIO_NWRITE 125
757 #define BIO_F_BIO_NWRITE0 122
758 #define BIO_F_BIO_PUTS 110
759 #define BIO_F_BIO_READ 111
760 #define BIO_F_BIO_SOCK_INIT 112
761 #define BIO_F_BIO_WRITE 113
762 #define BIO_F_BUFFER_CTRL 114
763 #define BIO_F_CONN_CTRL 127
764 #define BIO_F_CONN_STATE 115
765 #define BIO_F_DGRAM_SCTP_READ 132
766 #define BIO_F_FILE_CTRL 116
767 #define BIO_F_FILE_READ 130
768 #define BIO_F_LINEBUFFER_CTRL 129
769 #define BIO_F_MEM_READ 128
770 #define BIO_F_MEM_WRITE 117
771 #define BIO_F_SSL_NEW 118
772 #define BIO_F_WSASTARTUP 119
775 #define BIO_R_ACCEPT_ERROR 100
776 #define BIO_R_BAD_FOPEN_MODE 101
777 #define BIO_R_BAD_HOSTNAME_LOOKUP 102
778 #define BIO_R_BROKEN_PIPE 124
779 #define BIO_R_CONNECT_ERROR 103
780 #define BIO_R_EOF_ON_MEMORY_BIO 127
781 #define BIO_R_ERROR_SETTING_NBIO 104
782 #define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET 105
783 #define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET 106
784 #define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET 107
785 #define BIO_R_INVALID_ARGUMENT 125
786 #define BIO_R_INVALID_IP_ADDRESS 108
787 #define BIO_R_INVALID_PORT_NUMBER 129
788 #define BIO_R_IN_USE 123
789 #define BIO_R_KEEPALIVE 109
790 #define BIO_R_NBIO_CONNECT_ERROR 110
791 #define BIO_R_NO_ACCEPT_PORT_SPECIFIED 111
792 #define BIO_R_NO_HOSTNAME_SPECIFIED 112
793 #define BIO_R_NO_PORT_DEFINED 113
794 #define BIO_R_NO_PORT_SPECIFIED 114
795 #define BIO_R_NO_SUCH_FILE 128
796 #define BIO_R_NULL_PARAMETER 115
797 #define BIO_R_TAG_MISMATCH 116
798 #define BIO_R_UNABLE_TO_BIND_SOCKET 117
799 #define BIO_R_UNABLE_TO_CREATE_SOCKET 118
800 #define BIO_R_UNABLE_TO_LISTEN_SOCKET 119
801 #define BIO_R_UNINITIALIZED 120
802 #define BIO_R_UNSUPPORTED_METHOD 121
803 #define BIO_R_WRITE_TO_READ_ONLY_BIO 126
804 #define BIO_R_WSASTARTUP 122