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