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