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