source: trunk/sys/libcrypto/include/openssl/bio.h @ 1

Last change on this file since 1 was 1, checked in by alain, 7 years ago

First import

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