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