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