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