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