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