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