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