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