/* crypto/bio/bio.h *//* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) * All rights reserved. * * This package is an SSL implementation written * by Eric Young (eay@cryptsoft.com). * The implementation was written so as to conform with Netscapes SSL. *  * This library is free for commercial and non-commercial use as long as * the following conditions are aheared to.  The following conditions * apply to all code found in this distribution, be it the RC4, RSA, * lhash, DES, etc., code; not just the SSL code.  The SSL documentation * included with this distribution is covered by the same copyright terms * except that the holder is Tim Hudson (tjh@cryptsoft.com). *  * Copyright remains Eric Young's, and as such any Copyright notices in * the code are not to be removed. * If this package is used in a product, Eric Young should be given attribution * as the author of the parts of the library used. * This can be in the form of a textual message at program startup or * in documentation (online or textual) provided with the package. *  * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the copyright *    notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright *    notice, this list of conditions and the following disclaimer in the *    documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software *    must display the following acknowledgement: *    "This product includes cryptographic software written by *     Eric Young (eay@cryptsoft.com)" *    The word 'cryptographic' can be left out if the rouines from the library *    being used are not cryptographic related :-). * 4. If you include any Windows specific code (or a derivative thereof) from  *    the apps directory (application code) you must include an acknowledgement: *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" *  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. *  * The licence and distribution terms for any publically available version or * derivative of this code cannot be changed.  i.e. this code cannot simply be * copied and put under another distribution licence * [including the GNU Public Licence.] */#ifndef HEADER_BIO_H#define HEADER_BIO_H#ifndef NO_FP_API# include <stdio.h>#endif#include <stdarg.h>#include <openssl/crypto.h>#ifdef  __cplusplusextern "C" {#endif/* These are the 'types' of BIOs */#define BIO_TYPE_NONE		0#define BIO_TYPE_MEM		(1|0x0400)#define BIO_TYPE_FILE		(2|0x0400)#define BIO_TYPE_FD		(4|0x0400|0x0100)#define BIO_TYPE_SOCKET		(5|0x0400|0x0100)#define BIO_TYPE_NULL		(6|0x0400)#define BIO_TYPE_SSL		(7|0x0200)#define BIO_TYPE_MD		(8|0x0200)	/* passive filter */#define BIO_TYPE_BUFFER		(9|0x0200)	/* filter */#define BIO_TYPE_CIPHER		(10|0x0200)	/* filter */#define BIO_TYPE_BASE64		(11|0x0200)	/* filter */#define BIO_TYPE_CONNECT	(12|0x0400|0x0100)	/* socket - connect */#define BIO_TYPE_ACCEPT		(13|0x0400|0x0100)	/* socket for accept */#define BIO_TYPE_PROXY_CLIENT	(14|0x0200)	/* client proxy BIO */#define BIO_TYPE_PROXY_SERVER	(15|0x0200)	/* server proxy BIO */#define BIO_TYPE_NBIO_TEST	(16|0x0200)	/* server proxy BIO */#define BIO_TYPE_NULL_FILTER	(17|0x0200)#define BIO_TYPE_BER		(18|0x0200)	/* BER -> bin filter */#define BIO_TYPE_BIO		(19|0x0400)	/* (half a) BIO pair */#define BIO_TYPE_LINEBUFFER	(20|0x0200)	/* filter */#define BIO_TYPE_DESCRIPTOR	0x0100	/* socket, fd, connect or accept */#define BIO_TYPE_FILTER		0x0200#define BIO_TYPE_SOURCE_SINK	0x0400/* BIO_FILENAME_READ|BIO_CLOSE to open or close on free. * BIO_set_fp(in,stdin,BIO_NOCLOSE); */#define BIO_NOCLOSE		0x00#define BIO_CLOSE		0x01/* These are used in the following macros and are passed to * BIO_ctrl() */#define BIO_CTRL_RESET		1	/* opt - rewind/zero etc */#define BIO_CTRL_EOF		2	/* opt - are we at the eof */#define BIO_CTRL_INFO		3	/* opt - extra tit-bits */#define BIO_CTRL_SET		4	/* man - set the 'IO' type */#define BIO_CTRL_GET		5	/* man - get the 'IO' type */#define BIO_CTRL_PUSH		6	/* opt - internal, used to signify change */#define BIO_CTRL_POP		7	/* opt - internal, used to signify change */#define BIO_CTRL_GET_CLOSE	8	/* man - set the 'close' on free */#define BIO_CTRL_SET_CLOSE	9	/* man - set the 'close' on free */#define BIO_CTRL_PENDING	10	/* opt - is their more data buffered */#define BIO_CTRL_FLUSH		11	/* opt - 'flush' buffered output */#define BIO_CTRL_DUP		12	/* man - extra stuff for 'duped' BIO */#define BIO_CTRL_WPENDING	13	/* opt - number of bytes still to write *//* callback is int cb(BIO *bio,state,ret); */#define BIO_CTRL_SET_CALLBACK	14	/* opt - set callback function */#define BIO_CTRL_GET_CALLBACK	15	/* opt - set callback function */#define BIO_CTRL_SET_FILENAME	30	/* BIO_s_file special *//* modifiers */#define BIO_FP_READ		0x02#define BIO_FP_WRITE		0x04#define BIO_FP_APPEND		0x08#define BIO_FP_TEXT		0x10#define BIO_FLAGS_READ		0x01#define BIO_FLAGS_WRITE		0x02#define BIO_FLAGS_IO_SPECIAL	0x04#define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL)#define BIO_FLAGS_SHOULD_RETRY	0x08/* Used in BIO_gethostbyname() */#define BIO_GHBN_CTRL_HITS		1#define BIO_GHBN_CTRL_MISSES		2#define BIO_GHBN_CTRL_CACHE_SIZE	3#define BIO_GHBN_CTRL_GET_ENTRY		4#define BIO_GHBN_CTRL_FLUSH		5/* Mostly used in the SSL BIO *//* Not used anymore * #define BIO_FLAGS_PROTOCOL_DELAYED_READ 0x10 * #define BIO_FLAGS_PROTOCOL_DELAYED_WRITE 0x20 * #define BIO_FLAGS_PROTOCOL_STARTUP	0x40 */#define BIO_FLAGS_BASE64_NO_NL	0x100/* This is used with memory BIOs: it means we shouldn't free up or change the * data in any way. */#define BIO_FLAGS_MEM_RDONLY	0x200#define BIO_set_flags(b,f) ((b)->flags|=(f))#define BIO_get_flags(b) ((b)->flags)#define BIO_set_retry_special(b) \		((b)->flags|=(BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))#define BIO_set_retry_read(b) \		((b)->flags|=(BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))#define BIO_set_retry_write(b) \		((b)->flags|=(BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))/* These are normally used internally in BIOs */#define BIO_clear_flags(b,f) ((b)->flags&= ~(f))#define BIO_clear_retry_flags(b) \		((b)->flags&= ~(BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))#define BIO_get_retry_flags(b) \		((b)->flags&(BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))/* These should be used by the application to tell why we should retry */#define BIO_should_read(a)		((a)->flags & BIO_FLAGS_READ)#define BIO_should_write(a)		((a)->flags & BIO_FLAGS_WRITE)#define BIO_should_io_special(a)	((a)->flags & BIO_FLAGS_IO_SPECIAL)#define BIO_retry_type(a)		((a)->flags & BIO_FLAGS_RWS)#define BIO_should_retry(a)		((a)->flags & BIO_FLAGS_SHOULD_RETRY)/* The next two are used in conjunction with the * BIO_should_io_special() condition.  After this returns true, * BIO *BIO_get_retry_BIO(BIO *bio, int *reason); will walk the BIO  * stack and return the 'reason' for the special and the offending BIO. * Given a BIO, BIO_get_retry_reason(bio) will return the code. *//* Returned from the SSL bio when the certificate retrieval code had an error */#define BIO_RR_SSL_X509_LOOKUP		0x01/* Returned from the connect BIO when a connect would have blocked */#define BIO_RR_CONNECT			0x02/* These are passed by the BIO callback */#define BIO_CB_FREE	0x01#define BIO_CB_READ	0x02#define BIO_CB_WRITE	0x03#define BIO_CB_PUTS	0x04#define BIO_CB_GETS	0x05#define BIO_CB_CTRL	0x06/* The callback is called before and after the underling operation, * The BIO_CB_RETURN flag indicates if it is after the call */#define BIO_CB_RETURN	0x80#define BIO_CB_return(a) ((a)|BIO_CB_RETURN))#define BIO_cb_pre(a)	(!((a)&BIO_CB_RETURN))#define BIO_cb_post(a)	((a)&BIO_CB_RETURN)#define BIO_set_callback(b,cb)		((b)->callback=(cb))#define BIO_set_callback_arg(b,arg)	((b)->cb_arg=(char *)(arg))#define BIO_get_callback_arg(b)		((b)->cb_arg)#define BIO_get_callback(b)		((b)->callback)#define BIO_method_name(b)		((b)->method->name)#define BIO_method_type(b)		((b)->method->type)    typedef struct bio_st BIO;    typedef void bio_info_cb(struct bio_st *, int, const char *, int, long,			     long);#ifndef WIN16    typedef struct bio_method_st {	int type;	const char *name;	int (*bwrite) (BIO *, const char *, int);	int (*bread) (BIO *, char *, int);	int (*bputs) (BIO *, const char *);	int (*bgets) (BIO *, char *, int);	long (*ctrl) (BIO *, int, long, void *);	int (*create) (BIO *);	int (*destroy) (BIO *);	long (*callback_ctrl) (BIO *, int, bio_info_cb *);    } BIO_METHOD;#else    typedef struct bio_method_st {	int type;	const char *name;	int (_far * bwrite) ();	int (_far * bread) ();	int (_far * bputs) ();	int (_far * bgets) ();	long (_far * ctrl) ();	int (_far * create) ();	int (_far * destroy) ();	long (_fat * callback_ctrl) ();    } BIO_METHOD;#endif    struct bio_st {	BIO_METHOD *method;	/* bio, mode, argp, argi, argl, ret */	long (*callback) (struct bio_st *, int, const char *, int, long,			  long);	char *cb_arg;		/* first argument for the callback */	int init;	int shutdown;	int flags;		/* extra storage */	int retry_reason;	int num;	void *ptr;	struct bio_st *next_bio;	/* used by filter BIOs */	struct bio_st *prev_bio;	/* used by filter BIOs */	int references;	unsigned long num_read;	unsigned long num_write;	CRYPTO_EX_DATA ex_data;    };     DECLARE_STACK_OF(BIO)	typedef struct bio_f_buffer_ctx_struct {	/* BIO *bio; *//* this is now in the BIO struct */	int ibuf_size;		/* how big is the input buffer */	int obuf_size;		/* how big is the output buffer */	char *ibuf;		/* the char array */	int ibuf_len;		/* how many bytes are in it */	int ibuf_off;		/* write/read offset */	char *obuf;		/* the char array */	int obuf_len;		/* how many bytes are in it */	int obuf_off;		/* write/read offset */    } BIO_F_BUFFER_CTX;/* connect BIO stuff */#define BIO_CONN_S_BEFORE		1#define BIO_CONN_S_GET_IP		2#define BIO_CONN_S_GET_PORT		3#define BIO_CONN_S_CREATE_SOCKET	4#define BIO_CONN_S_CONNECT		5#define BIO_CONN_S_OK			6#define BIO_CONN_S_BLOCKED_CONNECT	7#define BIO_CONN_S_NBIO			8/*#define BIO_CONN_get_param_hostname	BIO_ctrl */#define BIO_C_SET_CONNECT			100#define BIO_C_DO_STATE_MACHINE			101#define BIO_C_SET_NBIO				102#define BIO_C_SET_PROXY_PARAM			103#define BIO_C_SET_FD				104#define BIO_C_GET_FD				105#define BIO_C_SET_FILE_PTR			106#define BIO_C_GET_FILE_PTR			107#define BIO_C_SET_FILENAME			108#define BIO_C_SET_SSL				109#define BIO_C_GET_SSL				110#define BIO_C_SET_MD				111#define BIO_C_GET_MD				112#define BIO_C_GET_CIPHER_STATUS			113#define BIO_C_SET_BUF_MEM			114#define BIO_C_GET_BUF_MEM_PTR			115#define BIO_C_GET_BUFF_NUM_LINES		116#define BIO_C_SET_BUFF_SIZE			117#define BIO_C_SET_ACCEPT			118#define BIO_C_SSL_MODE				119#define BIO_C_GET_MD_CTX			120#define BIO_C_GET_PROXY_PARAM			121#define BIO_C_SET_BUFF_READ_DATA		122	/* data to read first */#define BIO_C_GET_CONNECT			123#define BIO_C_GET_ACCEPT			124#define BIO_C_SET_SSL_RENEGOTIATE_BYTES		125#define BIO_C_GET_SSL_NUM_RENEGOTIATES		126#define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT	127#define BIO_C_FILE_SEEK				128#define BIO_C_GET_CIPHER_CTX			129#define BIO_C_SET_BUF_MEM_EOF_RETURN		130	/*return end of input value */#define BIO_C_SET_BIND_MODE			131#define BIO_C_GET_BIND_MODE			132#define BIO_C_FILE_TELL				133#define BIO_C_GET_SOCKS				134#define BIO_C_SET_SOCKS				135#define BIO_C_SET_WRITE_BUF_SIZE		136	/* for BIO_s_bio */#define BIO_C_GET_WRITE_BUF_SIZE		137#define BIO_C_MAKE_BIO_PAIR			138#define BIO_C_DESTROY_BIO_PAIR			139#define BIO_C_GET_WRITE_GUARANTEE		140#define BIO_C_GET_READ_REQUEST			141#define BIO_C_SHUTDOWN_WR			142#define BIO_C_NREAD0				143#define BIO_C_NREAD				144#define BIO_C_NWRITE0				145#define BIO_C_NWRITE				146#define BIO_C_RESET_READ_REQUEST		147