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