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