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