/* 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#include <openssl/e_os2.h>#ifndef OPENSSL_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_DGRAM		(21|0x0400|0x0100)#define BIO_TYPE_COMP 		(23|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 *//* dgram BIO stuff */#define BIO_CTRL_DGRAM_CONNECT       31  /* BIO dgram special */#define BIO_CTRL_DGRAM_SET_CONNECTED 32  /* allow for an externally					  * connected socket to be					  * passed in */ #define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33 /* setsockopt, essentially */#define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34 /* getsockopt, essentially */#define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35 /* setsockopt, essentially */#define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36 /* getsockopt, essentially */#define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37 /* flag whether the last */#define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38 /* I/O operation tiemd out */					/* #ifdef IP_MTU_DISCOVER */#define BIO_CTRL_DGRAM_MTU_DISCOVER       39 /* set DF bit on egress packets *//* #endif */#define BIO_CTRL_DGRAM_QUERY_MTU          40 /* as kernel for current MTU */#define BIO_CTRL_DGRAM_GET_MTU            41 /* get cached value for MTU */#define BIO_CTRL_DGRAM_SET_MTU            42 /* set cached value for					      * MTU. want to use this					      * if asking the kernel					      * fails */#define BIO_CTRL_DGRAM_MTU_EXCEEDED       43 /* check whether the MTU					      * was exceed in the					      * previous write					      * operation */#define BIO_CTRL_DGRAM_SET_PEER           44 /* Destination for the data *//* 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#ifndef	BIO_FLAGS_UPLINK/* "UPLINK" flag denotes file descriptors provided by application.   It defaults to 0, as most platforms don't require UPLINK interface. */#define	BIO_FLAGS_UPLINK	0#endif/* 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	0x200typedef struct bio_st BIO;void BIO_set_flags(BIO *b, int flags);int  BIO_test_flags(const BIO *b, int flags);void BIO_clear_flags(BIO *b, int flags);#define BIO_get_flags(b) BIO_test_flags(b, ~(0x0))#define BIO_set_retry_special(b) \		BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY))#define BIO_set_retry_read(b) \		BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY))#define BIO_set_retry_write(b) \		BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY))/* These are normally used internally in BIOs */#define BIO_clear_retry_flags(b) \		BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))#define BIO_get_retry_flags(b) \		BIO_test_flags(b, (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)		BIO_test_flags(a, BIO_FLAGS_READ)#define BIO_should_write(a)		BIO_test_flags(a, BIO_FLAGS_WRITE)#define BIO_should_io_special(a)	BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL)#define BIO_retry_type(a)		BIO_test_flags(a, BIO_FLAGS_RWS)#define BIO_should_retry(a)		BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY)/* The next three 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/* Returned from the accept BIO when an accept would have blocked */#define BIO_RR_ACCEPT			0x03/* 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)long (*BIO_get_callback(const BIO *b)) (struct bio_st *,int,const char *,int, long,long);void BIO_set_callback(BIO *b, 	long (*callback)(struct bio_st *,int,const char *,int, long,long));char *BIO_get_callback_arg(const BIO *b);void BIO_set_callback_arg(BIO *b, char *arg);