]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/bio/bio.h
Fix server behaviour when facing backwards-compatible client hellos.
[thirdparty/openssl.git] / crypto / bio / bio.h
CommitLineData
d02b48c6 1/* crypto/bio/bio.h */
58964a49 2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6
RE
3 * All rights reserved.
4 *
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.
8 *
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).
15 *
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.
22 *
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
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)"
40 *
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
51 * SUCH DAMAGE.
52 *
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.]
57 */
58
59#ifndef HEADER_BIO_H
60#define HEADER_BIO_H
61
62#ifdef __cplusplus
63extern "C" {
64#endif
65
0b86eb3e 66#include <stdio.h>
95d29597 67#include <stdlib.h>
ec577822 68#include <openssl/crypto.h>
58964a49 69
d02b48c6
RE
70/* These are the 'types' of BIOs */
71#define BIO_TYPE_NONE 0
72#define BIO_TYPE_MEM (1|0x0400)
73#define BIO_TYPE_FILE (2|0x0400)
74
75#define BIO_TYPE_FD (4|0x0400|0x0100)
76#define BIO_TYPE_SOCKET (5|0x0400|0x0100)
77#define BIO_TYPE_NULL (6|0x0400)
78#define BIO_TYPE_SSL (7|0x0200)
79#define BIO_TYPE_MD (8|0x0200) /* pasive filter */
80#define BIO_TYPE_BUFFER (9|0x0200) /* filter */
81#define BIO_TYPE_CIPHER (10|0x0200) /* filter */
82#define BIO_TYPE_BASE64 (11|0x0200) /* filter */
83#define BIO_TYPE_CONNECT (12|0x0400|0x0100) /* socket - connect */
84#define BIO_TYPE_ACCEPT (13|0x0400|0x0100) /* socket for accept */
58964a49 85#define BIO_TYPE_PROXY_CLIENT (14|0x0200) /* client proxy BIO */
d02b48c6
RE
86#define BIO_TYPE_PROXY_SERVER (15|0x0200) /* server proxy BIO */
87#define BIO_TYPE_NBIO_TEST (16|0x0200) /* server proxy BIO */
88#define BIO_TYPE_NULL_FILTER (17|0x0200)
dfeab068 89#define BIO_TYPE_BER (18|0x0200) /* BER -> bin filter */
9e06f6f6 90#define BIO_TYPE_BIO (19|0x0400) /* (half a) BIO pair */
d02b48c6
RE
91
92#define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */
93#define BIO_TYPE_FILTER 0x0200
94#define BIO_TYPE_SOURCE_SINK 0x0400
95
96/* BIO_FILENAME_READ|BIO_CLOSE to open or close on free.
97 * BIO_set_fp(in,stdin,BIO_NOCLOSE); */
98#define BIO_NOCLOSE 0x00
99#define BIO_CLOSE 0x01
100
101/* These are used in the following macros and are passed to
102 * BIO_ctrl() */
103#define BIO_CTRL_RESET 1 /* opt - rewind/zero etc */
104#define BIO_CTRL_EOF 2 /* opt - are we at the eof */
105#define BIO_CTRL_INFO 3 /* opt - extra tit-bits */
106#define BIO_CTRL_SET 4 /* man - set the 'IO' type */
107#define BIO_CTRL_GET 5 /* man - get the 'IO' type */
108#define BIO_CTRL_PUSH 6 /* opt - internal, used to signify change */
109#define BIO_CTRL_POP 7 /* opt - internal, used to signify change */
110#define BIO_CTRL_GET_CLOSE 8 /* man - set the 'close' on free */
111#define BIO_CTRL_SET_CLOSE 9 /* man - set the 'close' on free */
112#define BIO_CTRL_PENDING 10 /* opt - is their more data buffered */
113#define BIO_CTRL_FLUSH 11 /* opt - 'flush' buffered output */
114#define BIO_CTRL_DUP 12 /* man - extra stuff for 'duped' BIO */
115#define BIO_CTRL_WPENDING 13 /* opt - number of bytes still to write */
58964a49
RE
116/* callback is int cb(BIO *bio,state,ret); */
117#define BIO_CTRL_SET_CALLBACK 14 /* opt - set callback function */
118#define BIO_CTRL_GET_CALLBACK 15 /* opt - set callback function */
d02b48c6
RE
119
120#define BIO_CTRL_SET_FILENAME 30 /* BIO_s_file special */
121
122/* modifiers */
123#define BIO_FP_READ 0x02
124#define BIO_FP_WRITE 0x04
125#define BIO_FP_APPEND 0x08
126#define BIO_FP_TEXT 0x10
127
128#define BIO_FLAGS_READ 0x01
129#define BIO_FLAGS_WRITE 0x02
130#define BIO_FLAGS_IO_SPECIAL 0x04
131#define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
132#define BIO_FLAGS_SHOULD_RETRY 0x08
133
58964a49
RE
134/* Used in BIO_gethostbyname() */
135#define BIO_GHBN_CTRL_HITS 1
136#define BIO_GHBN_CTRL_MISSES 2
137#define BIO_GHBN_CTRL_CACHE_SIZE 3
138#define BIO_GHBN_CTRL_GET_ENTRY 4
139#define BIO_GHBN_CTRL_FLUSH 5
140
d02b48c6 141/* Mostly used in the SSL BIO */
58964a49
RE
142/* Not used anymore
143 * #define BIO_FLAGS_PROTOCOL_DELAYED_READ 0x10
144 * #define BIO_FLAGS_PROTOCOL_DELAYED_WRITE 0x20
145 * #define BIO_FLAGS_PROTOCOL_STARTUP 0x40
146 */
147
148#define BIO_FLAGS_BASE64_NO_NL 0x100
d02b48c6 149
8484721a
DSH
150/* This is used with memory BIOs: it means we shouldn't free up or change the
151 * data in any way.
152 */
153#define BIO_FLAGS_MEM_RDONLY 0x200
154
d02b48c6 155#define BIO_set_flags(b,f) ((b)->flags|=(f))
58964a49 156#define BIO_get_flags(b) ((b)->flags)
d02b48c6
RE
157#define BIO_set_retry_special(b) \
158 ((b)->flags|=(BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
159#define BIO_set_retry_read(b) \
160 ((b)->flags|=(BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
161#define BIO_set_retry_write(b) \
162 ((b)->flags|=(BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
163
164/* These are normally used internally in BIOs */
165#define BIO_clear_flags(b,f) ((b)->flags&= ~(f))
166#define BIO_clear_retry_flags(b) \
167 ((b)->flags&= ~(BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
168#define BIO_get_retry_flags(b) \
169 ((b)->flags&(BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
170
171/* These shouldbe used by the application to tell why we should retry */
172#define BIO_should_read(a) ((a)->flags & BIO_FLAGS_READ)
173#define BIO_should_write(a) ((a)->flags & BIO_FLAGS_WRITE)
174#define BIO_should_io_special(a) ((a)->flags & BIO_FLAGS_IO_SPECIAL)
175#define BIO_retry_type(a) ((a)->flags & BIO_FLAGS_RWS)
176#define BIO_should_retry(a) ((a)->flags & BIO_FLAGS_SHOULD_RETRY)
177
178/* The next two are used in conjunction with the
179 * BIO_should_io_special() condition. After this returns true,
180 * BIO *BIO_get_retry_BIO(BIO *bio, int *reason); will walk the BIO
181 * stack and return the 'reason' for the special and the offending BIO.
182 * Given a BIO, BIO_get_retry_reason(bio) will return the code. */
183/* Returned from the SSL bio when the certificate retrieval code had an error */
184#define BIO_RR_SSL_X509_LOOKUP 0x01
185/* Returned from the connect BIO when a connect would have blocked */
186#define BIO_RR_CONNECT 0x02
187
188/* These are passed by the BIO callback */
189#define BIO_CB_FREE 0x01
190#define BIO_CB_READ 0x02
191#define BIO_CB_WRITE 0x03
192#define BIO_CB_PUTS 0x04
193#define BIO_CB_GETS 0x05
194#define BIO_CB_CTRL 0x06
195
196/* The callback is called before and after the underling operation,
197 * The BIO_CB_RETURN flag indicates if it is after the call */
198#define BIO_CB_RETURN 0x80
199#define BIO_CB_return(a) ((a)|BIO_CB_RETURN))
200#define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN))
201#define BIO_cb_post(a) ((a)&BIO_CB_RETURN)
202
203#define BIO_set_callback(b,cb) ((b)->callback=(cb))
204#define BIO_set_callback_arg(b,arg) ((b)->cb_arg=(char *)(arg))
205#define BIO_get_callback_arg(b) ((b)->cb_arg)
206#define BIO_get_callback(b) ((b)->callback)
207#define BIO_method_name(b) ((b)->method->name)
208#define BIO_method_type(b) ((b)->method->type)
209
210#ifndef WIN16
211typedef struct bio_method_st
212 {
213 int type;
e778802f 214 const char *name;
d02b48c6
RE
215 int (*bwrite)();
216 int (*bread)();
217 int (*bputs)();
218 int (*bgets)();
219 long (*ctrl)();
220 int (*create)();
221 int (*destroy)();
222 } BIO_METHOD;
223#else
224typedef struct bio_method_st
225 {
226 int type;
e778802f 227 const char *name;
d02b48c6
RE
228 int (_far *bwrite)();
229 int (_far *bread)();
230 int (_far *bputs)();
231 int (_far *bgets)();
232 long (_far *ctrl)();
233 int (_far *create)();
234 int (_far *destroy)();
235 } BIO_METHOD;
236#endif
237
238typedef struct bio_st
239 {
240 BIO_METHOD *method;
d02b48c6 241 /* bio, mode, argp, argi, argl, ret */
e778802f 242 long (*callback)(struct bio_st *,int,const char *,int, long,long);
d02b48c6
RE
243 char *cb_arg; /* first argument for the callback */
244
245 int init;
246 int shutdown;
247 int flags; /* extra storage */
248 int retry_reason;
249 int num;
9e06f6f6 250 void *ptr;
d02b48c6
RE
251 struct bio_st *next_bio; /* used by filter BIOs */
252 struct bio_st *prev_bio; /* used by filter BIOs */
253 int references;
254 unsigned long num_read;
255 unsigned long num_write;
256
58964a49 257 CRYPTO_EX_DATA ex_data;
d02b48c6
RE
258 } BIO;
259
260typedef struct bio_f_buffer_ctx_struct
261 {
262 /* BIO *bio; */ /* this is now in the BIO struct */
263 int ibuf_size; /* how big is the input buffer */
264 int obuf_size; /* how big is the output buffer */
265
266 char *ibuf; /* the char array */
267 int ibuf_len; /* how many bytes are in it */
268 int ibuf_off; /* write/read offset */
269
270 char *obuf; /* the char array */
271 int obuf_len; /* how many bytes are in it */
272 int obuf_off; /* write/read offset */
273 } BIO_F_BUFFER_CTX;
274
58964a49
RE
275/* connect BIO stuff */
276#define BIO_CONN_S_BEFORE 1
277#define BIO_CONN_S_GET_IP 2
278#define BIO_CONN_S_GET_PORT 3
279#define BIO_CONN_S_CREATE_SOCKET 4
280#define BIO_CONN_S_CONNECT 5
281#define BIO_CONN_S_OK 6
282#define BIO_CONN_S_BLOCKED_CONNECT 7
283#define BIO_CONN_S_NBIO 8
dfeab068 284/*#define BIO_CONN_get_param_hostname BIO_ctrl */
58964a49 285
d02b48c6
RE
286#define BIO_number_read(b) ((b)->num_read)
287#define BIO_number_written(b) ((b)->num_write)
288
289#define BIO_C_SET_CONNECT 100
290#define BIO_C_DO_STATE_MACHINE 101
291#define BIO_C_SET_NBIO 102
292#define BIO_C_SET_PROXY_PARAM 103
293#define BIO_C_SET_FD 104
294#define BIO_C_GET_FD 105
295#define BIO_C_SET_FILE_PTR 106
296#define BIO_C_GET_FILE_PTR 107
297#define BIO_C_SET_FILENAME 108
298#define BIO_C_SET_SSL 109
299#define BIO_C_GET_SSL 110
300#define BIO_C_SET_MD 111
301#define BIO_C_GET_MD 112
302#define BIO_C_GET_CIPHER_STATUS 113
303#define BIO_C_SET_BUF_MEM 114
304#define BIO_C_GET_BUF_MEM_PTR 115
305#define BIO_C_GET_BUFF_NUM_LINES 116
306#define BIO_C_SET_BUFF_SIZE 117
307#define BIO_C_SET_ACCEPT 118
308#define BIO_C_SSL_MODE 119
309#define BIO_C_GET_MD_CTX 120
310#define BIO_C_GET_PROXY_PARAM 121
58964a49
RE
311#define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */
312#define BIO_C_GET_CONNECT 123
313#define BIO_C_GET_ACCEPT 124
314#define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125
315#define BIO_C_GET_SSL_NUM_RENEGOTIATES 126
316#define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127
dfeab068
RE
317#define BIO_C_FILE_SEEK 128
318#define BIO_C_GET_CIPHER_CTX 129
319#define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/
320#define BIO_C_SET_BIND_MODE 131
321#define BIO_C_GET_BIND_MODE 132
322#define BIO_C_FILE_TELL 133
323#define BIO_C_GET_SOCKS 134
324#define BIO_C_SET_SOCKS 135
58964a49 325
95d29597
BM
326#define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */
327#define BIO_C_GET_WRITE_BUF_SIZE 137
328#define BIO_C_MAKE_BIO_PAIR 138
329#define BIO_C_DESTROY_BIO_PAIR 139
330#define BIO_C_GET_WRITE_GUARANTEE 140
331#define BIO_C_GET_READ_REQUEST 141
332#define BIO_C_SHUTDOWN_WR 142
019a7aba
BM
333#define BIO_C_NREAD0 143
334#define BIO_C_NREAD 144
335#define BIO_C_NWRITE0 145
336#define BIO_C_NWRITE 146
95d29597
BM
337
338
58964a49
RE
339#define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,(char *)arg)
340#define BIO_get_app_data(s) BIO_get_ex_data(s,0)
341
dfeab068 342/* BIO_s_connect() and BIO_s_socks4a_connect() */
58964a49
RE
343#define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name)
344#define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
345#define BIO_set_conn_ip(b,ip) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip)
346#define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port)
347#define BIO_get_conn_hostname(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0)
348#define BIO_get_conn_port(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1)
349#define BIO_get_conn_ip(b,ip) BIO_ptr_ctrl(b,BIO_C_SET_CONNECT,2)
dfeab068
RE
350#define BIO_get_conn_int_port(b,port) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,port)
351
58964a49 352
d02b48c6
RE
353#define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
354
355/* BIO_s_accept_socket() */
356#define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name)
58964a49 357#define BIO_get_accept_port(b) BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0)
d02b48c6 358/* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
58964a49 359#define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?"a":NULL)
d02b48c6
RE
360#define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio)
361
dfeab068
RE
362#define BIO_BIND_NORMAL 0
363#define BIO_BIND_REUSEADDR_IF_UNUSED 1
364#define BIO_BIND_REUSEADDR 2
365#define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
366#define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
367
d02b48c6
RE
368#define BIO_do_connect(b) BIO_do_handshake(b)
369#define BIO_do_accept(b) BIO_do_handshake(b)
370#define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
371
372/* BIO_s_proxy_client() */
373#define BIO_set_url(b,url) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,0,(char *)(url))
374#define BIO_set_proxies(b,p) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,1,(char *)(p))
375/* BIO_set_nbio(b,n) */
376#define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s))
377/* BIO *BIO_get_filter_bio(BIO *bio); */
378#define BIO_set_proxy_cb(b,cb) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(char *)(cb))
379#define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk)
58964a49 380#define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool)
d02b48c6
RE
381
382#define BIO_get_proxy_header(b,skp) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,0,(char *)skp)
383#define BIO_get_proxies(b,pxy_p) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,1,(char *)(pxy_p))
384#define BIO_get_url(b,url) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,2,(char *)(url))
58964a49 385#define BIO_get_no_connect_return(b) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,5,NULL)
d02b48c6 386
58964a49 387#define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
d02b48c6
RE
388#define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
389
390#define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp)
391#define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp)
392
dfeab068
RE
393#define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
394#define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
395
eb90a483
BL
396/* name is cast to lose const, but might be better to route through a function
397 so we can do it safely */
e778802f
BL
398#ifdef CONST_STRICT
399/* If you are wondering why this isn't defined, its because CONST_STRICT is
400 * purely a compile-time kludge to allow const to be checked.
401 */
402int BIO_read_filename(BIO *b,const char *name);
403#else
d02b48c6 404#define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
eb90a483 405 BIO_CLOSE|BIO_FP_READ,(char *)name)
e778802f 406#endif
d02b48c6
RE
407#define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
408 BIO_CLOSE|BIO_FP_WRITE,name)
409#define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
410 BIO_CLOSE|BIO_FP_APPEND,name)
dfeab068
RE
411#define BIO_rw_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
412 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
d02b48c6 413
58964a49
RE
414/* WARNING WARNING, this ups the reference count on the read bio of the
415 * SSL structure. This is because the ssl read BIO is now pointed to by
416 * the next_bio field in the bio. So when you free the BIO, make sure
417 * you are doing a BIO_free_all() to catch the underlying BIO. */
d02b48c6
RE
418#define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl)
419#define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp)
420#define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
58964a49
RE
421#define BIO_set_ssl_renegotiate_bytes(b,num) \
422 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL);
423#define BIO_get_num_renegotiates(b) \
424 BIO_ctrl(b,BIO_C_SET_SSL_NUM_RENEGOTIATES,0,NULL);
425#define BIO_set_ssl_renegotiate_timeout(b,seconds) \
426 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL);
d02b48c6
RE
427
428/* defined in evp.h */
429/* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */
430
dfeab068 431#define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp)
d02b48c6
RE
432#define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm)
433#define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp)
dfeab068
RE
434#define BIO_set_mem_eof_return(b,v) \
435 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
d02b48c6
RE
436
437/* For the BIO_f_buffer() type */
438#define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
439#define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
58964a49
RE
440#define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
441#define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
442#define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
d02b48c6
RE
443
444/* Don't use the next one unless you know what you are doing :-) */
58964a49 445#define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
d02b48c6
RE
446
447#define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
448#define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
449#define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
450#define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
451#define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
452#define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
95d29597
BM
453/* ...pending macros have inappropriate return type */
454size_t BIO_ctrl_pending(BIO *b);
455size_t BIO_ctrl_wpending(BIO *b);
d02b48c6 456#define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
58964a49
RE
457#define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0,(char *)cbp)
458#define BIO_set_info_callback(b,cb) (int)BIO_ctrl(b,BIO_CTRL_SET_CALLBACK,0,(char *)cb)
d02b48c6
RE
459
460/* For the BIO_f_buffer() type */
461#define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
462
95d29597
BM
463/* For BIO_s_bio() */
464#define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
465#define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
466#define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
467#define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
468/* macros with inappropriate type -- but ...pending macros use int too: */
469#define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
470#define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
471size_t BIO_ctrl_get_write_guarantee(BIO *b);
472size_t BIO_ctrl_get_read_request(BIO *b);
473
58964a49
RE
474#ifdef NO_STDIO
475#define NO_FP_API
476#endif
477
0cc39579 478
0ae645db
UM
479/* These two aren't currently implemented */
480/* int BIO_get_ex_num(BIO *bio); */
481/* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */
0cc39579
DSH
482int BIO_set_ex_data(BIO *bio,int idx,char *data);
483char *BIO_get_ex_data(BIO *bio,int idx);
0cc39579
DSH
484int BIO_get_ex_new_index(long argl, char *argp, int (*new_func)(),
485 int (*dup_func)(), void (*free_func)());
486
58964a49
RE
487# if defined(WIN16) && defined(_WINDLL)
488BIO_METHOD *BIO_s_file_internal(void);
489BIO *BIO_new_file_internal(char *filename, char *mode);
490BIO *BIO_new_fp_internal(FILE *stream, int close_flag);
491# define BIO_s_file BIO_s_file_internal
492# define BIO_new_file BIO_new_file_internal
493# define BIO_new_fp BIO_new_fp_internal
494# else /* FP_API */
495BIO_METHOD *BIO_s_file(void );
72fbe87d 496BIO *BIO_new_file(const char *filename, const char *mode);
58964a49
RE
497BIO *BIO_new_fp(FILE *stream, int close_flag);
498# define BIO_s_file_internal BIO_s_file
499# define BIO_new_file_internal BIO_new_file
500# define BIO_new_fp_internal BIO_s_file
501# endif /* FP_API */
d02b48c6
RE
502BIO * BIO_new(BIO_METHOD *type);
503int BIO_set(BIO *a,BIO_METHOD *type);
504int BIO_free(BIO *a);
61f5b6f3 505int BIO_read(BIO *b, void *data, int len);
d02b48c6 506int BIO_gets(BIO *bp,char *buf, int size);
e778802f
BL
507int BIO_write(BIO *b, const char *data, int len);
508int BIO_puts(BIO *bp,const char *buf);
95d29597 509long BIO_ctrl(BIO *bp,int cmd,long larg,void *parg);
58964a49
RE
510char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg);
511long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg);
d02b48c6
RE
512BIO * BIO_push(BIO *b,BIO *append);
513BIO * BIO_pop(BIO *b);
514void BIO_free_all(BIO *a);
515BIO * BIO_find_type(BIO *b,int bio_type);
516BIO * BIO_get_retry_BIO(BIO *bio, int *reason);
517int BIO_get_retry_reason(BIO *bio);
518BIO * BIO_dup_chain(BIO *in);
519
074309b7 520#if 0 /* not yet */
019a7aba
BM
521int BIO_nread0(BIO *bio, char **buf);
522int BIO_nread(BIO *bio, char **buf, int num);
523int BIO_nwrite0(BIO *bio, char **buf);
524int BIO_nwrite(BIO *bio, char **buf, int num);
074309b7 525#endif
019a7aba 526
d02b48c6 527#ifndef WIN16
e778802f 528long BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi,
d02b48c6
RE
529 long argl,long ret);
530#else
e778802f 531long _far _loadds BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi,
d02b48c6
RE
532 long argl,long ret);
533#endif
534
d02b48c6 535BIO_METHOD *BIO_s_mem(void);
8484721a 536BIO *BIO_new_mem_buf(void *buf, int len);
d02b48c6
RE
537BIO_METHOD *BIO_s_socket(void);
538BIO_METHOD *BIO_s_connect(void);
539BIO_METHOD *BIO_s_accept(void);
540BIO_METHOD *BIO_s_fd(void);
0849d138 541BIO_METHOD *BIO_s_log(void);
9e06f6f6 542BIO_METHOD *BIO_s_bio(void);
d02b48c6
RE
543BIO_METHOD *BIO_s_null(void);
544BIO_METHOD *BIO_f_null(void);
d02b48c6 545BIO_METHOD *BIO_f_buffer(void);
dfeab068
RE
546BIO_METHOD *BIO_f_nbio_test(void);
547/* BIO_METHOD *BIO_f_ber(void); */
d02b48c6
RE
548
549int BIO_sock_should_retry(int i);
550int BIO_sock_non_fatal_error(int error);
551int BIO_fd_should_retry(int i);
552int BIO_fd_non_fatal_error(int error);
e778802f 553int BIO_dump(BIO *b,const char *bytes,int len);
d02b48c6 554
e778802f 555struct hostent *BIO_gethostbyname(const char *name);
1aad3392
BM
556/* We might want a thread-safe interface too:
557 * struct hostent *BIO_gethostbyname_r(const char *name,
558 * struct hostent *result, void *buffer, size_t buflen);
559 * or something similar (caller allocates a struct hostent,
560 * pointed to by "result", and additional buffer space for the various
561 * substructures; if the buffer does not suffice, NULL is returned
562 * and an appropriate error code is set).
563 */
d02b48c6
RE
564int BIO_sock_error(int sock);
565int BIO_socket_ioctl(int fd, long type, unsigned long *arg);
dfeab068 566int BIO_socket_nbio(int fd,int mode);
e778802f
BL
567int BIO_get_port(const char *str, unsigned short *port_ptr);
568int BIO_get_host_ip(const char *str, unsigned char *ip);
dfeab068 569int BIO_get_accept_socket(char *host_port,int mode);
d02b48c6
RE
570int BIO_accept(int sock,char **ip_port);
571int BIO_sock_init(void );
572void BIO_sock_cleanup(void);
573int BIO_set_tcp_ndelay(int sock,int turn_on);
574
575void ERR_load_BIO_strings(void );
576
d02b48c6
RE
577BIO *BIO_new_socket(int sock, int close_flag);
578BIO *BIO_new_fd(int fd, int close_flag);
579BIO *BIO_new_connect(char *host_port);
580BIO *BIO_new_accept(char *host_port);
581
95d29597
BM
582int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
583 BIO **bio2, size_t writebuf2);
584/* If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
585 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL.
586 * Size 0 uses default value.
587 */
588
d02b48c6
RE
589void BIO_copy_next_retry(BIO *b);
590
58964a49
RE
591long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
592
4565c3e3 593int BIO_printf(BIO *bio, ...);
d02b48c6 594
d02b48c6 595/* BEGIN ERROR CODES */
6d311938
DSH
596/* The following lines are auto generated by the script mkerr.pl. Any changes
597 * made after this point may be overwritten when the script is next run.
598 */
599
d02b48c6
RE
600/* Error codes for the BIO functions. */
601
602/* Function codes. */
603#define BIO_F_ACPT_STATE 100
604#define BIO_F_BIO_ACCEPT 101
dfeab068
RE
605#define BIO_F_BIO_BER_GET_HEADER 102
606#define BIO_F_BIO_CTRL 103
2a82c7cf 607#define BIO_F_BIO_GETHOSTBYNAME 120
dfeab068
RE
608#define BIO_F_BIO_GETS 104
609#define BIO_F_BIO_GET_ACCEPT_SOCKET 105
610#define BIO_F_BIO_GET_HOST_IP 106
611#define BIO_F_BIO_GET_PORT 107
9e06f6f6 612#define BIO_F_BIO_MAKE_PAIR 121
dfeab068
RE
613#define BIO_F_BIO_NEW 108
614#define BIO_F_BIO_NEW_FILE 109
8484721a 615#define BIO_F_BIO_NEW_MEM_BUF 126
019a7aba
BM
616#define BIO_F_BIO_NREAD 123
617#define BIO_F_BIO_NREAD0 124
618#define BIO_F_BIO_NWRITE 125
619#define BIO_F_BIO_NWRITE0 122
dfeab068
RE
620#define BIO_F_BIO_PUTS 110
621#define BIO_F_BIO_READ 111
622#define BIO_F_BIO_SOCK_INIT 112
623#define BIO_F_BIO_WRITE 113
624#define BIO_F_BUFFER_CTRL 114
625#define BIO_F_CONN_STATE 115
626#define BIO_F_FILE_CTRL 116
627#define BIO_F_MEM_WRITE 117
651d0aff
RE
628#define BIO_F_SSL_NEW 118
629#define BIO_F_WSASTARTUP 119
d02b48c6
RE
630
631/* Reason codes. */
632#define BIO_R_ACCEPT_ERROR 100
633#define BIO_R_BAD_FOPEN_MODE 101
634#define BIO_R_BAD_HOSTNAME_LOOKUP 102
95d29597 635#define BIO_R_BROKEN_PIPE 124
d02b48c6
RE
636#define BIO_R_CONNECT_ERROR 103
637#define BIO_R_ERROR_SETTING_NBIO 104
638#define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET 105
639#define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET 106
640#define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET 107
6c82fda2 641#define BIO_R_INVALID_ARGUMENT 125
d02b48c6 642#define BIO_R_INVALID_IP_ADDRESS 108
9e06f6f6 643#define BIO_R_IN_USE 123
58964a49
RE
644#define BIO_R_KEEPALIVE 109
645#define BIO_R_NBIO_CONNECT_ERROR 110
646#define BIO_R_NO_ACCEPT_PORT_SPECIFIED 111
df82f5c8 647#define BIO_R_NO_HOSTNAME_SPECIFIED 112
58964a49
RE
648#define BIO_R_NO_PORT_DEFINED 113
649#define BIO_R_NO_PORT_SPECIFIED 114
650#define BIO_R_NULL_PARAMETER 115
651d0aff
RE
651#define BIO_R_TAG_MISMATCH 116
652#define BIO_R_UNABLE_TO_BIND_SOCKET 117
653#define BIO_R_UNABLE_TO_CREATE_SOCKET 118
654#define BIO_R_UNABLE_TO_LISTEN_SOCKET 119
df82f5c8 655#define BIO_R_UNINITIALIZED 120
651d0aff 656#define BIO_R_UNSUPPORTED_METHOD 121
8484721a 657#define BIO_R_WRITE_TO_READ_ONLY_BIO 126
651d0aff 658#define BIO_R_WSASTARTUP 122
6d311938 659
d02b48c6
RE
660#ifdef __cplusplus
661}
662#endif
663#endif
664