bio.h revision 68651
1192830Sed/* crypto/bio/bio.h */
2192830Sed/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3192830Sed * All rights reserved.
4192830Sed *
5192830Sed * This package is an SSL implementation written
6192830Sed * by Eric Young (eay@cryptsoft.com).
7192830Sed * The implementation was written so as to conform with Netscapes SSL.
8192830Sed *
9192830Sed * This library is free for commercial and non-commercial use as long as
10192830Sed * the following conditions are aheared to.  The following conditions
11192830Sed * apply to all code found in this distribution, be it the RC4, RSA,
12192830Sed * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13192830Sed * included with this distribution is covered by the same copyright terms
14192830Sed * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15192830Sed *
16192830Sed * Copyright remains Eric Young's, and as such any Copyright notices in
17192830Sed * the code are not to be removed.
18192830Sed * If this package is used in a product, Eric Young should be given attribution
19192830Sed * as the author of the parts of the library used.
20192830Sed * This can be in the form of a textual message at program startup or
21192830Sed * in documentation (online or textual) provided with the package.
22192830Sed *
23192830Sed * Redistribution and use in source and binary forms, with or without
24192830Sed * modification, are permitted provided that the following conditions
25192830Sed * are met:
26192830Sed * 1. Redistributions of source code must retain the copyright
27192830Sed *    notice, this list of conditions and the following disclaimer.
28192830Sed * 2. Redistributions in binary form must reproduce the above copyright
29192830Sed *    notice, this list of conditions and the following disclaimer in the
30192830Sed *    documentation and/or other materials provided with the distribution.
31192830Sed * 3. All advertising materials mentioning features or use of this software
32192830Sed *    must display the following acknowledgement:
33192830Sed *    "This product includes cryptographic software written by
34192830Sed *     Eric Young (eay@cryptsoft.com)"
35192830Sed *    The word 'cryptographic' can be left out if the rouines from the library
36192830Sed *    being used are not cryptographic related :-).
37192830Sed * 4. If you include any Windows specific code (or a derivative thereof) from
38192830Sed *    the apps directory (application code) you must include an acknowledgement:
39192830Sed *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40192830Sed *
41192830Sed * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42192830Sed * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43192830Sed * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44192830Sed * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45192830Sed * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46192830Sed * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47192830Sed * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48192830Sed * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49192830Sed * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50192830Sed * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51192830Sed * SUCH DAMAGE.
52192830Sed *
53192830Sed * The licence and distribution terms for any publically available version or
54192830Sed * derivative of this code cannot be changed.  i.e. this code cannot simply be
55192830Sed * copied and put under another distribution licence
56192830Sed * [including the GNU Public Licence.]
57192830Sed */
58192830Sed
59192830Sed#ifndef HEADER_BIO_H
60192830Sed#define HEADER_BIO_H
61192830Sed
62192830Sed#ifndef NO_FP_API
63192830Sed# include <stdio.h>
64192830Sed#endif
65192830Sed#include <stdarg.h>
66192830Sed
67192830Sed#include <openssl/crypto.h>
68192830Sed
69192830Sed#ifdef  __cplusplus
70192830Sedextern "C" {
71192830Sed#endif
72192830Sed
73192830Sed/* These are the 'types' of BIOs */
74192830Sed#define BIO_TYPE_NONE		0
75192830Sed#define BIO_TYPE_MEM		(1|0x0400)
76192830Sed#define BIO_TYPE_FILE		(2|0x0400)
77192830Sed
78192830Sed#define BIO_TYPE_FD		(4|0x0400|0x0100)
79192830Sed#define BIO_TYPE_SOCKET		(5|0x0400|0x0100)
80192830Sed#define BIO_TYPE_NULL		(6|0x0400)
81192830Sed#define BIO_TYPE_SSL		(7|0x0200)
82192830Sed#define BIO_TYPE_MD		(8|0x0200)		/* passive filter */
83192830Sed#define BIO_TYPE_BUFFER		(9|0x0200)		/* filter */
84192830Sed#define BIO_TYPE_CIPHER		(10|0x0200)		/* filter */
85192830Sed#define BIO_TYPE_BASE64		(11|0x0200)		/* filter */
86192830Sed#define BIO_TYPE_CONNECT	(12|0x0400|0x0100)	/* socket - connect */
87192830Sed#define BIO_TYPE_ACCEPT		(13|0x0400|0x0100)	/* socket for accept */
88192830Sed#define BIO_TYPE_PROXY_CLIENT	(14|0x0200)		/* client proxy BIO */
89192830Sed#define BIO_TYPE_PROXY_SERVER	(15|0x0200)		/* server proxy BIO */
90192830Sed#define BIO_TYPE_NBIO_TEST	(16|0x0200)		/* server proxy BIO */
91192830Sed#define BIO_TYPE_NULL_FILTER	(17|0x0200)
92192830Sed#define BIO_TYPE_BER		(18|0x0200)		/* BER -> bin filter */
93192830Sed#define BIO_TYPE_BIO		(19|0x0400)		/* (half a) BIO pair */
94192830Sed#define BIO_TYPE_LINEBUFFER	(20|0x0200)		/* filter */
95192830Sed
96192830Sed#define BIO_TYPE_DESCRIPTOR	0x0100	/* socket, fd, connect or accept */
97192830Sed#define BIO_TYPE_FILTER		0x0200
98192830Sed#define BIO_TYPE_SOURCE_SINK	0x0400
99192830Sed
100192830Sed/* BIO_FILENAME_READ|BIO_CLOSE to open or close on free.
101192830Sed * BIO_set_fp(in,stdin,BIO_NOCLOSE); */
102192830Sed#define BIO_NOCLOSE		0x00
103192830Sed#define BIO_CLOSE		0x01
104192830Sed
105192830Sed/* These are used in the following macros and are passed to
106192830Sed * BIO_ctrl() */
107192830Sed#define BIO_CTRL_RESET		1  /* opt - rewind/zero etc */
108192830Sed#define BIO_CTRL_EOF		2  /* opt - are we at the eof */
109192830Sed#define BIO_CTRL_INFO		3  /* opt - extra tit-bits */
110192830Sed#define BIO_CTRL_SET		4  /* man - set the 'IO' type */
111192830Sed#define BIO_CTRL_GET		5  /* man - get the 'IO' type */
112192830Sed#define BIO_CTRL_PUSH		6  /* opt - internal, used to signify change */
113192830Sed#define BIO_CTRL_POP		7  /* opt - internal, used to signify change */
114192830Sed#define BIO_CTRL_GET_CLOSE	8  /* man - set the 'close' on free */
115192830Sed#define BIO_CTRL_SET_CLOSE	9  /* man - set the 'close' on free */
116192830Sed#define BIO_CTRL_PENDING	10  /* opt - is their more data buffered */
117192830Sed#define BIO_CTRL_FLUSH		11  /* opt - 'flush' buffered output */
118192830Sed#define BIO_CTRL_DUP		12  /* man - extra stuff for 'duped' BIO */
119192830Sed#define BIO_CTRL_WPENDING	13  /* opt - number of bytes still to write */
120192830Sed/* callback is int cb(BIO *bio,state,ret); */
121192830Sed#define BIO_CTRL_SET_CALLBACK	14  /* opt - set callback function */
122192830Sed#define BIO_CTRL_GET_CALLBACK	15  /* opt - set callback function */
123192830Sed
124192830Sed#define BIO_CTRL_SET_FILENAME	30	/* BIO_s_file special */
125192830Sed
126192830Sed/* modifiers */
127192830Sed#define BIO_FP_READ		0x02
128192830Sed#define BIO_FP_WRITE		0x04
129192830Sed#define BIO_FP_APPEND		0x08
130192830Sed#define BIO_FP_TEXT		0x10
131192830Sed
132192830Sed#define BIO_FLAGS_READ		0x01
133192830Sed#define BIO_FLAGS_WRITE		0x02
134192830Sed#define BIO_FLAGS_IO_SPECIAL	0x04
135192830Sed#define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)
136192830Sed#define BIO_FLAGS_SHOULD_RETRY	0x08
137192830Sed
138192830Sed/* Used in BIO_gethostbyname() */
139192830Sed#define BIO_GHBN_CTRL_HITS		1
140192830Sed#define BIO_GHBN_CTRL_MISSES		2
141192830Sed#define BIO_GHBN_CTRL_CACHE_SIZE	3
142192830Sed#define BIO_GHBN_CTRL_GET_ENTRY		4
143192830Sed#define BIO_GHBN_CTRL_FLUSH		5
144192830Sed
145192830Sed/* Mostly used in the SSL BIO */
146192830Sed/* Not used anymore
147192830Sed * #define BIO_FLAGS_PROTOCOL_DELAYED_READ 0x10
148192830Sed * #define BIO_FLAGS_PROTOCOL_DELAYED_WRITE 0x20
149192830Sed * #define BIO_FLAGS_PROTOCOL_STARTUP	0x40
150192830Sed */
151192830Sed
152192830Sed#define BIO_FLAGS_BASE64_NO_NL	0x100
153192830Sed
154192830Sed/* This is used with memory BIOs: it means we shouldn't free up or change the
155192830Sed * data in any way.
156192830Sed */
157192830Sed#define BIO_FLAGS_MEM_RDONLY	0x200
158192830Sed
159192830Sed#define BIO_set_flags(b,f) ((b)->flags|=(f))
160192830Sed#define BIO_get_flags(b) ((b)->flags)
161192830Sed#define BIO_set_retry_special(b) \
162192830Sed		((b)->flags|=(BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))
163192830Sed#define BIO_set_retry_read(b) \
164192830Sed		((b)->flags|=(BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))
165192830Sed#define BIO_set_retry_write(b) \
166192830Sed		((b)->flags|=(BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))
167192830Sed
168192830Sed/* These are normally used internally in BIOs */
169192830Sed#define BIO_clear_flags(b,f) ((b)->flags&= ~(f))
170192830Sed#define BIO_clear_retry_flags(b) \
171192830Sed		((b)->flags&= ~(BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
172192830Sed#define BIO_get_retry_flags(b) \
173192830Sed		((b)->flags&(BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
174192830Sed
175192830Sed/* These should be used by the application to tell why we should retry */
176192830Sed#define BIO_should_read(a)		((a)->flags & BIO_FLAGS_READ)
177192830Sed#define BIO_should_write(a)		((a)->flags & BIO_FLAGS_WRITE)
178192830Sed#define BIO_should_io_special(a)	((a)->flags & BIO_FLAGS_IO_SPECIAL)
179192830Sed#define BIO_retry_type(a)		((a)->flags & BIO_FLAGS_RWS)
180192830Sed#define BIO_should_retry(a)		((a)->flags & BIO_FLAGS_SHOULD_RETRY)
181192830Sed
182192830Sed/* The next two are used in conjunction with the
183192830Sed * BIO_should_io_special() condition.  After this returns true,
184192830Sed * BIO *BIO_get_retry_BIO(BIO *bio, int *reason); will walk the BIO
185192830Sed * stack and return the 'reason' for the special and the offending BIO.
186192830Sed * Given a BIO, BIO_get_retry_reason(bio) will return the code. */
187192830Sed/* Returned from the SSL bio when the certificate retrieval code had an error */
188192830Sed#define BIO_RR_SSL_X509_LOOKUP		0x01
189192830Sed/* Returned from the connect BIO when a connect would have blocked */
190192830Sed#define BIO_RR_CONNECT			0x02
191192830Sed
192192830Sed/* These are passed by the BIO callback */
193192830Sed#define BIO_CB_FREE	0x01
194192830Sed#define BIO_CB_READ	0x02
195192830Sed#define BIO_CB_WRITE	0x03
196192830Sed#define BIO_CB_PUTS	0x04
197192830Sed#define BIO_CB_GETS	0x05
198192830Sed#define BIO_CB_CTRL	0x06
199192830Sed
200192830Sed/* The callback is called before and after the underling operation,
201192830Sed * The BIO_CB_RETURN flag indicates if it is after the call */
202192830Sed#define BIO_CB_RETURN	0x80
203192830Sed#define BIO_CB_return(a) ((a)|BIO_CB_RETURN))
204192830Sed#define BIO_cb_pre(a)	(!((a)&BIO_CB_RETURN))
205192830Sed#define BIO_cb_post(a)	((a)&BIO_CB_RETURN)
206192830Sed
207192830Sed#define BIO_set_callback(b,cb)		((b)->callback=(cb))
208192830Sed#define BIO_set_callback_arg(b,arg)	((b)->cb_arg=(char *)(arg))
209192830Sed#define BIO_get_callback_arg(b)		((b)->cb_arg)
210192830Sed#define BIO_get_callback(b)		((b)->callback)
211192830Sed#define BIO_method_name(b)		((b)->method->name)
212192830Sed#define BIO_method_type(b)		((b)->method->type)
213192830Sed
214192830Sedtypedef struct bio_st BIO;
215192830Sed
216192830Sedtypedef void bio_info_cb(struct bio_st *, int, const char *, int, long, long);
217192830Sed
218192830Sed#ifndef WIN16
219192830Sedtypedef struct bio_method_st
220192830Sed	{
221192830Sed	int type;
222192830Sed	const char *name;
223192830Sed	int (*bwrite)(BIO *, const char *, int);
224192830Sed	int (*bread)(BIO *, char *, int);
225192830Sed	int (*bputs)(BIO *, const char *);
226192830Sed	int (*bgets)(BIO *, char *, int);
227192830Sed	long (*ctrl)(BIO *, int, long, void *);
228192830Sed	int (*create)(BIO *);
229192830Sed	int (*destroy)(BIO *);
230192830Sed        long (*callback_ctrl)(BIO *, int, bio_info_cb *);
231192830Sed	} BIO_METHOD;
232192830Sed#else
233192830Sedtypedef struct bio_method_st
234192830Sed	{
235192830Sed	int type;
236192830Sed	const char *name;
237192830Sed	int (_far *bwrite)();
238192830Sed	int (_far *bread)();
239192830Sed	int (_far *bputs)();
240192830Sed	int (_far *bgets)();
241192830Sed	long (_far *ctrl)();
242192830Sed	int (_far *create)();
243192830Sed	int (_far *destroy)();
244192830Sed	long (_fat *callback_ctrl)();
245192830Sed	} BIO_METHOD;
246192830Sed#endif
247192830Sed
248192830Sedstruct bio_st
249192830Sed	{
250192830Sed	BIO_METHOD *method;
251192830Sed	/* bio, mode, argp, argi, argl, ret */
252192830Sed	long (*callback)(struct bio_st *,int,const char *,int, long,long);
253192830Sed	char *cb_arg; /* first argument for the callback */
254192830Sed
255192830Sed	int init;
256192830Sed	int shutdown;
257192830Sed	int flags;	/* extra storage */
258192830Sed	int retry_reason;
259192830Sed	int num;
260192830Sed	void *ptr;
261	struct bio_st *next_bio;	/* used by filter BIOs */
262	struct bio_st *prev_bio;	/* used by filter BIOs */
263	int references;
264	unsigned long num_read;
265	unsigned long num_write;
266
267	CRYPTO_EX_DATA ex_data;
268	};
269
270DECLARE_STACK_OF(BIO)
271
272typedef struct bio_f_buffer_ctx_struct
273	{
274	/* BIO *bio; */ /* this is now in the BIO struct */
275	int ibuf_size;	/* how big is the input buffer */
276	int obuf_size;	/* how big is the output buffer */
277
278	char *ibuf;		/* the char array */
279	int ibuf_len;		/* how many bytes are in it */
280	int ibuf_off;		/* write/read offset */
281
282	char *obuf;		/* the char array */
283	int obuf_len;		/* how many bytes are in it */
284	int obuf_off;		/* write/read offset */
285	} BIO_F_BUFFER_CTX;
286
287/* connect BIO stuff */
288#define BIO_CONN_S_BEFORE		1
289#define BIO_CONN_S_GET_IP		2
290#define BIO_CONN_S_GET_PORT		3
291#define BIO_CONN_S_CREATE_SOCKET	4
292#define BIO_CONN_S_CONNECT		5
293#define BIO_CONN_S_OK			6
294#define BIO_CONN_S_BLOCKED_CONNECT	7
295#define BIO_CONN_S_NBIO			8
296/*#define BIO_CONN_get_param_hostname	BIO_ctrl */
297
298#define BIO_C_SET_CONNECT			100
299#define BIO_C_DO_STATE_MACHINE			101
300#define BIO_C_SET_NBIO				102
301#define BIO_C_SET_PROXY_PARAM			103
302#define BIO_C_SET_FD				104
303#define BIO_C_GET_FD				105
304#define BIO_C_SET_FILE_PTR			106
305#define BIO_C_GET_FILE_PTR			107
306#define BIO_C_SET_FILENAME			108
307#define BIO_C_SET_SSL				109
308#define BIO_C_GET_SSL				110
309#define BIO_C_SET_MD				111
310#define BIO_C_GET_MD				112
311#define BIO_C_GET_CIPHER_STATUS			113
312#define BIO_C_SET_BUF_MEM			114
313#define BIO_C_GET_BUF_MEM_PTR			115
314#define BIO_C_GET_BUFF_NUM_LINES		116
315#define BIO_C_SET_BUFF_SIZE			117
316#define BIO_C_SET_ACCEPT			118
317#define BIO_C_SSL_MODE				119
318#define BIO_C_GET_MD_CTX			120
319#define BIO_C_GET_PROXY_PARAM			121
320#define BIO_C_SET_BUFF_READ_DATA		122 /* data to read first */
321#define BIO_C_GET_CONNECT			123
322#define BIO_C_GET_ACCEPT			124
323#define BIO_C_SET_SSL_RENEGOTIATE_BYTES		125
324#define BIO_C_GET_SSL_NUM_RENEGOTIATES		126
325#define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT	127
326#define BIO_C_FILE_SEEK				128
327#define BIO_C_GET_CIPHER_CTX			129
328#define BIO_C_SET_BUF_MEM_EOF_RETURN		130/*return end of input value*/
329#define BIO_C_SET_BIND_MODE			131
330#define BIO_C_GET_BIND_MODE			132
331#define BIO_C_FILE_TELL				133
332#define BIO_C_GET_SOCKS				134
333#define BIO_C_SET_SOCKS				135
334
335#define BIO_C_SET_WRITE_BUF_SIZE		136/* for BIO_s_bio */
336#define BIO_C_GET_WRITE_BUF_SIZE		137
337#define BIO_C_MAKE_BIO_PAIR			138
338#define BIO_C_DESTROY_BIO_PAIR			139
339#define BIO_C_GET_WRITE_GUARANTEE		140
340#define BIO_C_GET_READ_REQUEST			141
341#define BIO_C_SHUTDOWN_WR			142
342#define BIO_C_NREAD0				143
343#define BIO_C_NREAD				144
344#define BIO_C_NWRITE0				145
345#define BIO_C_NWRITE				146
346#define BIO_C_RESET_READ_REQUEST		147
347
348
349#define BIO_set_app_data(s,arg)		BIO_set_ex_data(s,0,arg)
350#define BIO_get_app_data(s)		BIO_get_ex_data(s,0)
351
352/* BIO_s_connect() and BIO_s_socks4a_connect() */
353#define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name)
354#define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
355#define BIO_set_conn_ip(b,ip)	  BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip)
356#define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port)
357#define BIO_get_conn_hostname(b)  BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0)
358#define BIO_get_conn_port(b)      BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1)
359#define BIO_get_conn_ip(b,ip) BIO_ptr_ctrl(b,BIO_C_SET_CONNECT,2)
360#define BIO_get_conn_int_port(b,port) BIO_int_ctrl(b,BIO_C_SET_CONNECT,3,port)
361
362
363#define BIO_set_nbio(b,n)	BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL)
364
365/* BIO_s_accept_socket() */
366#define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name)
367#define BIO_get_accept_port(b)	BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0)
368/* #define BIO_set_nbio(b,n)	BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */
369#define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?"a":NULL)
370#define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio)
371
372#define BIO_BIND_NORMAL			0
373#define BIO_BIND_REUSEADDR_IF_UNUSED	1
374#define BIO_BIND_REUSEADDR		2
375#define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL)
376#define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL)
377
378#define BIO_do_connect(b)	BIO_do_handshake(b)
379#define BIO_do_accept(b)	BIO_do_handshake(b)
380#define BIO_do_handshake(b)	BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL)
381
382/* BIO_s_proxy_client() */
383#define BIO_set_url(b,url)	BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,0,(char *)(url))
384#define BIO_set_proxies(b,p)	BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,1,(char *)(p))
385/* BIO_set_nbio(b,n) */
386#define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s))
387/* BIO *BIO_get_filter_bio(BIO *bio); */
388#define BIO_set_proxy_cb(b,cb) BIO_callback_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(void *(*cb)()))
389#define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk)
390#define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool)
391
392#define BIO_get_proxy_header(b,skp) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,0,(char *)skp)
393#define BIO_get_proxies(b,pxy_p) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,1,(char *)(pxy_p))
394#define BIO_get_url(b,url)	BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,2,(char *)(url))
395#define BIO_get_no_connect_return(b)	BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,5,NULL)
396
397#define BIO_set_fd(b,fd,c)	BIO_int_ctrl(b,BIO_C_SET_FD,c,fd)
398#define BIO_get_fd(b,c)		BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c)
399
400#define BIO_set_fp(b,fp,c)	BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp)
401#define BIO_get_fp(b,fpp)	BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp)
402
403#define BIO_seek(b,ofs)	(int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
404#define BIO_tell(b)	(int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
405
406/* name is cast to lose const, but might be better to route through a function
407   so we can do it safely */
408#ifdef CONST_STRICT
409/* If you are wondering why this isn't defined, its because CONST_STRICT is
410 * purely a compile-time kludge to allow const to be checked.
411 */
412int BIO_read_filename(BIO *b,const char *name);
413#else
414#define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
415		BIO_CLOSE|BIO_FP_READ,(char *)name)
416#endif
417#define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
418		BIO_CLOSE|BIO_FP_WRITE,name)
419#define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
420		BIO_CLOSE|BIO_FP_APPEND,name)
421#define BIO_rw_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
422		BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name)
423
424/* WARNING WARNING, this ups the reference count on the read bio of the
425 * SSL structure.  This is because the ssl read BIO is now pointed to by
426 * the next_bio field in the bio.  So when you free the BIO, make sure
427 * you are doing a BIO_free_all() to catch the underlying BIO. */
428#define BIO_set_ssl(b,ssl,c)	BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl)
429#define BIO_get_ssl(b,sslp)	BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp)
430#define BIO_set_ssl_mode(b,client)	BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL)
431#define BIO_set_ssl_renegotiate_bytes(b,num) \
432	BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL);
433#define BIO_get_num_renegotiates(b) \
434	BIO_ctrl(b,BIO_C_SET_SSL_NUM_RENEGOTIATES,0,NULL);
435#define BIO_set_ssl_renegotiate_timeout(b,seconds) \
436	BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL);
437
438/* defined in evp.h */
439/* #define BIO_set_md(b,md)	BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */
440
441#define BIO_get_mem_data(b,pp)	BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp)
442#define BIO_set_mem_buf(b,bm,c)	BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm)
443#define BIO_get_mem_ptr(b,pp)	BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp)
444#define BIO_set_mem_eof_return(b,v) \
445				BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL)
446
447/* For the BIO_f_buffer() type */
448#define BIO_get_buffer_num_lines(b)	BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL)
449#define BIO_set_buffer_size(b,size)	BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL)
450#define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0)
451#define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1)
452#define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf)
453
454/* Don't use the next one unless you know what you are doing :-) */
455#define BIO_dup_state(b,ret)	BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret))
456
457#define BIO_reset(b)		(int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL)
458#define BIO_eof(b)		(int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL)
459#define BIO_set_close(b,c)	(int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL)
460#define BIO_get_close(b)	(int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
461#define BIO_pending(b)		(int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
462#define BIO_wpending(b)		(int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
463/* ...pending macros have inappropriate return type */
464size_t BIO_ctrl_pending(BIO *b);
465size_t BIO_ctrl_wpending(BIO *b);
466#define BIO_flush(b)		(int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
467#define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0,(bio_info_cb **)(cbp))
468#define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,(bio_info_cb *)(cb))
469
470/* For the BIO_f_buffer() type */
471#define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
472
473/* For BIO_s_bio() */
474#define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
475#define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
476#define BIO_make_bio_pair(b1,b2)   (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
477#define BIO_destroy_bio_pair(b)    (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
478#define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL)
479/* macros with inappropriate type -- but ...pending macros use int too: */
480#define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
481#define BIO_get_read_request(b)    (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
482size_t BIO_ctrl_get_write_guarantee(BIO *b);
483size_t BIO_ctrl_get_read_request(BIO *b);
484int BIO_ctrl_reset_read_request(BIO *b);
485
486/* These two aren't currently implemented */
487/* int BIO_get_ex_num(BIO *bio); */
488/* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */
489int BIO_set_ex_data(BIO *bio,int idx,void *data);
490void *BIO_get_ex_data(BIO *bio,int idx);
491int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
492	CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
493unsigned long BIO_number_read(BIO *bio);
494unsigned long BIO_number_written(BIO *bio);
495
496# ifndef NO_FP_API
497#  if defined(WIN16) && defined(_WINDLL)
498BIO_METHOD *BIO_s_file_internal(void);
499BIO *BIO_new_file_internal(char *filename, char *mode);
500BIO *BIO_new_fp_internal(FILE *stream, int close_flag);
501#    define BIO_s_file	BIO_s_file_internal
502#    define BIO_new_file	BIO_new_file_internal
503#    define BIO_new_fp	BIO_new_fp_internal
504#  else /* FP_API */
505BIO_METHOD *BIO_s_file(void );
506BIO *BIO_new_file(const char *filename, const char *mode);
507BIO *BIO_new_fp(FILE *stream, int close_flag);
508#    define BIO_s_file_internal		BIO_s_file
509#    define BIO_new_file_internal	BIO_new_file
510#    define BIO_new_fp_internal		BIO_s_file
511#  endif /* FP_API */
512# endif
513BIO *	BIO_new(BIO_METHOD *type);
514int	BIO_set(BIO *a,BIO_METHOD *type);
515int	BIO_free(BIO *a);
516void	BIO_vfree(BIO *a);
517int	BIO_read(BIO *b, void *data, int len);
518int	BIO_gets(BIO *bp,char *buf, int size);
519int	BIO_write(BIO *b, const void *data, int len);
520int	BIO_puts(BIO *bp,const char *buf);
521long	BIO_ctrl(BIO *bp,int cmd,long larg,void *parg);
522long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long));
523char *	BIO_ptr_ctrl(BIO *bp,int cmd,long larg);
524long	BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg);
525BIO *	BIO_push(BIO *b,BIO *append);
526BIO *	BIO_pop(BIO *b);
527void	BIO_free_all(BIO *a);
528BIO *	BIO_find_type(BIO *b,int bio_type);
529BIO *	BIO_next(BIO *b);
530BIO *	BIO_get_retry_BIO(BIO *bio, int *reason);
531int	BIO_get_retry_reason(BIO *bio);
532BIO *	BIO_dup_chain(BIO *in);
533
534int BIO_nread0(BIO *bio, char **buf);
535int BIO_nread(BIO *bio, char **buf, int num);
536int BIO_nwrite0(BIO *bio, char **buf);
537int BIO_nwrite(BIO *bio, char **buf, int num);
538
539#ifndef WIN16
540long BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi,
541	long argl,long ret);
542#else
543long _far _loadds BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi,
544	long argl,long ret);
545#endif
546
547BIO_METHOD *BIO_s_mem(void);
548BIO *BIO_new_mem_buf(void *buf, int len);
549BIO_METHOD *BIO_s_socket(void);
550BIO_METHOD *BIO_s_connect(void);
551BIO_METHOD *BIO_s_accept(void);
552BIO_METHOD *BIO_s_fd(void);
553BIO_METHOD *BIO_s_log(void);
554BIO_METHOD *BIO_s_bio(void);
555BIO_METHOD *BIO_s_null(void);
556BIO_METHOD *BIO_f_null(void);
557BIO_METHOD *BIO_f_buffer(void);
558#ifdef VMS
559BIO_METHOD *BIO_f_linebuffer(void);
560#endif
561BIO_METHOD *BIO_f_nbio_test(void);
562/* BIO_METHOD *BIO_f_ber(void); */
563
564int BIO_sock_should_retry(int i);
565int BIO_sock_non_fatal_error(int error);
566int BIO_fd_should_retry(int i);
567int BIO_fd_non_fatal_error(int error);
568int BIO_dump(BIO *b,const char *bytes,int len);
569int BIO_dump_indent(BIO *b,const char *bytes,int len,int indent);
570
571struct hostent *BIO_gethostbyname(const char *name);
572/* We might want a thread-safe interface too:
573 * struct hostent *BIO_gethostbyname_r(const char *name,
574 *     struct hostent *result, void *buffer, size_t buflen);
575 * or something similar (caller allocates a struct hostent,
576 * pointed to by "result", and additional buffer space for the various
577 * substructures; if the buffer does not suffice, NULL is returned
578 * and an appropriate error code is set).
579 */
580int BIO_sock_error(int sock);
581int BIO_socket_ioctl(int fd, long type, unsigned long *arg);
582int BIO_socket_nbio(int fd,int mode);
583int BIO_get_port(const char *str, unsigned short *port_ptr);
584int BIO_get_host_ip(const char *str, unsigned char *ip);
585int BIO_get_accept_socket(char *host_port,int mode);
586int BIO_accept(int sock,char **ip_port);
587int BIO_sock_init(void );
588void BIO_sock_cleanup(void);
589int BIO_set_tcp_ndelay(int sock,int turn_on);
590
591void ERR_load_BIO_strings(void );
592
593BIO *BIO_new_socket(int sock, int close_flag);
594BIO *BIO_new_fd(int fd, int close_flag);
595BIO *BIO_new_connect(char *host_port);
596BIO *BIO_new_accept(char *host_port);
597
598int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
599	BIO **bio2, size_t writebuf2);
600/* If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
601 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL.
602 * Size 0 uses default value.
603 */
604
605void BIO_copy_next_retry(BIO *b);
606
607long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
608
609int BIO_printf(BIO *bio, const char *format, ...);
610int BIO_vprintf(BIO *bio, const char *format, va_list args);
611int BIO_snprintf(char *buf, size_t n, const char *format, ...);
612int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args);
613
614/* BEGIN ERROR CODES */
615/* The following lines are auto generated by the script mkerr.pl. Any changes
616 * made after this point may be overwritten when the script is next run.
617 */
618
619/* Error codes for the BIO functions. */
620
621/* Function codes. */
622#define BIO_F_ACPT_STATE				 100
623#define BIO_F_BIO_ACCEPT				 101
624#define BIO_F_BIO_BER_GET_HEADER			 102
625#define BIO_F_BIO_CTRL					 103
626#define BIO_F_BIO_GETHOSTBYNAME				 120
627#define BIO_F_BIO_GETS					 104
628#define BIO_F_BIO_GET_ACCEPT_SOCKET			 105
629#define BIO_F_BIO_GET_HOST_IP				 106
630#define BIO_F_BIO_GET_PORT				 107
631#define BIO_F_BIO_MAKE_PAIR				 121
632#define BIO_F_BIO_NEW					 108
633#define BIO_F_BIO_NEW_FILE				 109
634#define BIO_F_BIO_NEW_MEM_BUF				 126
635#define BIO_F_BIO_NREAD					 123
636#define BIO_F_BIO_NREAD0				 124
637#define BIO_F_BIO_NWRITE				 125
638#define BIO_F_BIO_NWRITE0				 122
639#define BIO_F_BIO_PUTS					 110
640#define BIO_F_BIO_READ					 111
641#define BIO_F_BIO_SOCK_INIT				 112
642#define BIO_F_BIO_WRITE					 113
643#define BIO_F_BUFFER_CTRL				 114
644#define BIO_F_CONN_CTRL					 127
645#define BIO_F_CONN_STATE				 115
646#define BIO_F_FILE_CTRL					 116
647#define BIO_F_LINEBUFFER_CTRL				 129
648#define BIO_F_MEM_READ					 128
649#define BIO_F_MEM_WRITE					 117
650#define BIO_F_SSL_NEW					 118
651#define BIO_F_WSASTARTUP				 119
652
653/* Reason codes. */
654#define BIO_R_ACCEPT_ERROR				 100
655#define BIO_R_BAD_FOPEN_MODE				 101
656#define BIO_R_BAD_HOSTNAME_LOOKUP			 102
657#define BIO_R_BROKEN_PIPE				 124
658#define BIO_R_CONNECT_ERROR				 103
659#define BIO_R_EOF_ON_MEMORY_BIO				 127
660#define BIO_R_ERROR_SETTING_NBIO			 104
661#define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET	 105
662#define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET	 106
663#define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET		 107
664#define BIO_R_INVALID_ARGUMENT				 125
665#define BIO_R_INVALID_IP_ADDRESS			 108
666#define BIO_R_IN_USE					 123
667#define BIO_R_KEEPALIVE					 109
668#define BIO_R_NBIO_CONNECT_ERROR			 110
669#define BIO_R_NO_ACCEPT_PORT_SPECIFIED			 111
670#define BIO_R_NO_HOSTNAME_SPECIFIED			 112
671#define BIO_R_NO_PORT_DEFINED				 113
672#define BIO_R_NO_PORT_SPECIFIED				 114
673#define BIO_R_NULL_PARAMETER				 115
674#define BIO_R_TAG_MISMATCH				 116
675#define BIO_R_UNABLE_TO_BIND_SOCKET			 117
676#define BIO_R_UNABLE_TO_CREATE_SOCKET			 118
677#define BIO_R_UNABLE_TO_LISTEN_SOCKET			 119
678#define BIO_R_UNINITIALIZED				 120
679#define BIO_R_UNSUPPORTED_METHOD			 121
680#define BIO_R_WRITE_TO_READ_ONLY_BIO			 126
681#define BIO_R_WSASTARTUP				 122
682
683#ifdef  __cplusplus
684}
685#endif
686#endif
687
688