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