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