14c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 24c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * All rights reserved. 34c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 44c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * This package is an SSL implementation written 54c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * by Eric Young (eay@cryptsoft.com). 64c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The implementation was written so as to conform with Netscapes SSL. 74c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 84c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * This library is free for commercial and non-commercial use as long as 94c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the following conditions are aheared to. The following conditions 104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * apply to all code found in this distribution, be it the RC4, RSA, 114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * lhash, DES, etc., code; not just the SSL code. The SSL documentation 124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * included with this distribution is covered by the same copyright terms 134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * except that the holder is Tim Hudson (tjh@cryptsoft.com). 144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Copyright remains Eric Young's, and as such any Copyright notices in 164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the code are not to be removed. 174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * If this package is used in a product, Eric Young should be given attribution 184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * as the author of the parts of the library used. 194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * This can be in the form of a textual message at program startup or 204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * in documentation (online or textual) provided with the package. 214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Redistribution and use in source and binary forms, with or without 234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * modification, are permitted provided that the following conditions 244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * are met: 254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1. Redistributions of source code must retain the copyright 264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * notice, this list of conditions and the following disclaimer. 274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2. Redistributions in binary form must reproduce the above copyright 284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * notice, this list of conditions and the following disclaimer in the 294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * documentation and/or other materials provided with the distribution. 304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3. All advertising materials mentioning features or use of this software 314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * must display the following acknowledgement: 324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * "This product includes cryptographic software written by 334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Eric Young (eay@cryptsoft.com)" 344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The word 'cryptographic' can be left out if the rouines from the library 354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * being used are not cryptographic related :-). 364c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4. If you include any Windows specific code (or a derivative thereof) from 374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the apps directory (application code) you must include an acknowledgement: 384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 504c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * SUCH DAMAGE. 514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The licence and distribution terms for any publically available version or 534c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * derivative of this code cannot be changed. i.e. this code cannot simply be 544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * copied and put under another distribution licence 554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * [including the GNU Public Licence.] */ 564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 574c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#ifndef OPENSSL_HEADER_BIO_H 584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define OPENSSL_HEADER_BIO_H 594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#include <openssl/base.h> 614c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 624c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#include <stdarg.h> 634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#include <stdio.h> /* For FILE */ 644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#include <openssl/ex_data.h> 664c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#include <openssl/stack.h> 674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#if defined(__cplusplus) 694c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleyextern "C" { 704c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#endif 714c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO abstracts over a file-descriptor like interface. */ 744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 754c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 764c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Allocation and freeing. */ 774c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam LangleyDEFINE_STACK_OF(BIO); 794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_new creates a new BIO with the given type and a reference count of one. 814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * It returns the fresh |BIO|, or NULL on error. */ 82eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_new(const BIO_METHOD *type); 834c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_free decrements the reference count of |bio|. If the reference count 854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * drops to zero, it (optionally) calls the BIO's callback with |BIO_CB_FREE|, 864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * frees the ex_data and then, if the BIO has a destroy callback for the 874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * method, calls it. Finally it frees |bio| itself. It then repeats that for 884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the next BIO in the chain, if any. 894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 904c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * It returns one on success or zero otherwise. */ 91eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_free(BIO *bio); 924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 934c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_vfree performs the same actions as |BIO_free|, but has a void return 944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * value. This is provided for API-compat. 954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * TODO(fork): remove. */ 97eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_vfree(BIO *bio); 984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Basic I/O. */ 1014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_read attempts to read |len| bytes into |data|. It returns the number of 1034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * bytes read, zero on EOF, or a negative number on error. */ 104eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_read(BIO *bio, void *data, int len); 1054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_gets "reads a line" from |bio| and puts at most |size| bytes into |buf|. 1074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * It returns the number of bytes read or a negative number on error. The 1084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * phrase "reads a line" is in quotes in the previous sentence because the 1094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * exact operation depends on the BIO's method. For example, a digest BIO will 1104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * return the digest in response to a |BIO_gets| call. 1114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * TODO(fork): audit the set of BIOs that we end up needing. If all actually 1134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * return a line for this call, remove the warning above. */ 114eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_gets(BIO *bio, char *buf, int size); 1154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_write writes |len| bytes from |data| to BIO. It returns the number of 1174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * bytes written or a negative number on error. */ 118eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_write(BIO *bio, const void *data, int len); 1194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_puts writes a NUL terminated string from |buf| to |bio|. It returns the 1214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * number of bytes written or a negative number on error. */ 122eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_puts(BIO *bio, const char *buf); 1234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_flush flushes any buffered output. It returns one on success and zero 1254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * otherwise. */ 126eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_flush(BIO *bio); 1274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Low-level control functions. 1304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * These are generic functions for sending control requests to a BIO. In 1324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * general one should use the wrapper functions like |BIO_get_close|. */ 1334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_ctrl sends the control request |cmd| to |bio|. The |cmd| argument should 1354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * be one of the |BIO_C_*| values. */ 136eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT long BIO_ctrl(BIO *bio, int cmd, long larg, void *parg); 1374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_ptr_ctrl acts like |BIO_ctrl| but passes the address of a |void*| 1394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * pointer as |parg| and returns the value that is written to it, or NULL if 1404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the control request returns <= 0. */ 141eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT char *BIO_ptr_ctrl(BIO *bp, int cmd, long larg); 1424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_int_ctrl acts like |BIO_ctrl| but passes the address of a copy of |iarg| 1444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * as |parg|. */ 145eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg); 1464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_reset resets |bio| to its initial state, the precise meaning of which 1484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * depends on the concrete type of |bio|. It returns one on success and zero 1494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * otherwise. */ 150eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_reset(BIO *bio); 1514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_flags ORs |flags| with |bio->flags|. */ 153eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_set_flags(BIO *bio, int flags); 1544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_test_flags returns |bio->flags| AND |flags|. */ 156eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_test_flags(const BIO *bio, int flags); 1574c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_should_read returns non-zero if |bio| encountered a temporary error 1594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * while reading (i.e. EAGAIN), indicating that the caller should retry the 1604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * read. */ 161eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_should_read(const BIO *bio); 1624c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_should_write returns non-zero if |bio| encountered a temporary error 1644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * while writing (i.e. EAGAIN), indicating that the caller should retry the 1654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * write. */ 166eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_should_write(const BIO *bio); 1674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_should_retry returns non-zero if the reason that caused a failed I/O 1694c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * operation is temporary and thus the operation should be retried. Otherwise, 1704c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * it was a permanent error and it returns zero. */ 171eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_should_retry(const BIO *bio); 1724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_should_io_special returns non-zero if |bio| encountered a temporary 1744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * error while performing a special I/O operation, indicating that the caller 1754c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * should retry. The operation that caused the error is returned by 1764c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_get_retry_reason|. */ 177eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_should_io_special(const BIO *bio); 1784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_RR_SSL_X509_LOOKUP indicates that an SSL BIO blocked because the SSL 1804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * library returned with SSL_ERROR_WANT_X509_LOOKUP. 1814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 1824c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * TODO(fork): remove. */ 1834c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_RR_SSL_X509_LOOKUP 0x01 1844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_RR_CONNECT indicates that a connect would have blocked */ 1864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_RR_CONNECT 0x02 1874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_RR_ACCEPT indicates that an accept would have blocked */ 1894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_RR_ACCEPT 0x03 1904c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1914c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_RR_SSL_CHANNEL_ID_LOOKUP indicates that the ChannelID code cannot find 1924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * a private key for a TLS connection. */ 1934c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_RR_SSL_CHANNEL_ID_LOOKUP 0x04 1944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_get_retry_reason returns the special I/O operation that needs to be 1964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * retried. The return value is one of the |BIO_RR_*| values. */ 197eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_get_retry_reason(const BIO *bio); 1984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 1994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_clear_flags ANDs |bio->flags| with the bitwise-complement of |flags|. */ 200eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_clear_flags(BIO *bio, int flags); 2014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_retry_read sets the |BIO_FLAGS_READ| and |BIO_FLAGS_SHOULD_RETRY| 2034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * flags on |bio|. */ 204eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_set_retry_read(BIO *bio); 2054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_retry_read sets the |BIO_FLAGS_WRITE| and |BIO_FLAGS_SHOULD_RETRY| 2074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * flags on |bio|. */ 208eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_set_retry_write(BIO *bio); 2094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_get_retry_flags gets the |BIO_FLAGS_READ|, |BIO_FLAGS_WRITE|, 2114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_FLAGS_IO_SPECIAL| and |BIO_FLAGS_SHOULD_RETRY| flags from |bio|. */ 212eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_get_retry_flags(BIO *bio); 2134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_clear_retry_flags clears the |BIO_FLAGS_READ|, |BIO_FLAGS_WRITE|, 2154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_FLAGS_IO_SPECIAL| and |BIO_FLAGS_SHOULD_RETRY| flags from |bio|. */ 216eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_clear_retry_flags(BIO *bio); 2174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_method_type returns the type of |bio|, which is one of the |BIO_TYPE_*| 2194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * values. */ 220eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_method_type(const BIO *bio); 2214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* bio_info_cb is the type of a callback function that can be called for most 2234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * BIO operations. The |event| argument is one of |BIO_CB_*| and can be ORed 2244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * with |BIO_CB_RETURN| if the callback is being made after the operation in 2254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * question. In that case, |return_value| will contain the return value from 2264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the operation. */ 2274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleytypedef long (*bio_info_cb)(BIO *bio, int event, const char *parg, int cmd, 2284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley long larg, long return_value); 2294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_callback_ctrl allows the callback function to be manipulated. The |cmd| 2314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * arg will generally be |BIO_CTRL_SET_CALLBACK| but arbitary command values 2324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * can be interpreted by the |BIO|. */ 233eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT long BIO_callback_ctrl(BIO *bio, int cmd, bio_info_cb fp); 2344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_pending returns the number of bytes pending to be read. */ 236eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT size_t BIO_pending(const BIO *bio); 2374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 238bed8ce78f001c600a143966b932f8e587c35e573Adam Langley/* BIO_ctrl_pending calls |BIO_pending| and exists only for compatibility with 239bed8ce78f001c600a143966b932f8e587c35e573Adam Langley * OpenSSL. */ 240bed8ce78f001c600a143966b932f8e587c35e573Adam LangleyOPENSSL_EXPORT size_t BIO_ctrl_pending(const BIO *bio); 241bed8ce78f001c600a143966b932f8e587c35e573Adam Langley 2424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_wpending returns the number of bytes pending to be written. */ 243eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT size_t BIO_wpending(const BIO *bio); 2444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_close sets the close flag for |bio|. The meaning of which depends on 2464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the type of |bio| but, for example, a memory BIO interprets the close flag 2474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * as meaning that it owns its buffer. It returns one on success and zero 2484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * otherwise. */ 249eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_set_close(BIO *bio, int close_flag); 2504c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2510cc81ff04f7364183f97ce2ca573a56fbfe3d156Adam Langley/* BIO_set_callback sets a callback function that will be called before and 2520cc81ff04f7364183f97ce2ca573a56fbfe3d156Adam Langley * after most operations. See the comment above |bio_info_cb|. */ 253eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_set_callback(BIO *bio, bio_info_cb callback_func); 2540cc81ff04f7364183f97ce2ca573a56fbfe3d156Adam Langley 2550cc81ff04f7364183f97ce2ca573a56fbfe3d156Adam Langley/* BIO_set_callback_arg sets the opaque pointer value that can be read within a 2560cc81ff04f7364183f97ce2ca573a56fbfe3d156Adam Langley * callback with |BIO_get_callback_arg|. */ 257eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_set_callback_arg(BIO *bio, char *arg); 2580cc81ff04f7364183f97ce2ca573a56fbfe3d156Adam Langley 2590cc81ff04f7364183f97ce2ca573a56fbfe3d156Adam Langley/* BIO_get_callback_arg returns the last value of the opaque callback pointer 2600cc81ff04f7364183f97ce2ca573a56fbfe3d156Adam Langley * set by |BIO_set_callback_arg|. */ 261eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT char *BIO_get_callback_arg(const BIO *bio); 2620cc81ff04f7364183f97ce2ca573a56fbfe3d156Adam Langley 263e2c4d262141f9a7de9baf6d0d7151682e9947357Adam Langley/* BIO_number_read returns the number of bytes that have been read from 264e2c4d262141f9a7de9baf6d0d7151682e9947357Adam Langley * |bio|. */ 265e2c4d262141f9a7de9baf6d0d7151682e9947357Adam LangleyOPENSSL_EXPORT size_t BIO_number_read(const BIO *bio); 266e2c4d262141f9a7de9baf6d0d7151682e9947357Adam Langley 267e2c4d262141f9a7de9baf6d0d7151682e9947357Adam Langley/* BIO_number_written returns the number of bytes that have been written to 268e2c4d262141f9a7de9baf6d0d7151682e9947357Adam Langley * |bio|. */ 269e2c4d262141f9a7de9baf6d0d7151682e9947357Adam LangleyOPENSSL_EXPORT size_t BIO_number_written(const BIO *bio); 270e2c4d262141f9a7de9baf6d0d7151682e9947357Adam Langley 2714c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Managing chains of BIOs. 2734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * BIOs can be put into chains where the output of one is used as the input of 2754c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the next etc. The most common case is a buffering BIO, which accepts and 2764c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * buffers writes until flushed into the next BIO in the chain. */ 2774c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_push adds |appended_bio| to the end of the chain with |bio| at the head. 2794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * It returns |bio|. Note that |appended_bio| may be the head of a chain itself 2804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * and thus this function can be used to join two chains. 2814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2824c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * BIO_push takes ownership of the caller's reference to |appended_bio|. */ 283eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_push(BIO *bio, BIO *appended_bio); 2844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_pop removes |bio| from the head of a chain and returns the next BIO in 2864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the chain, or NULL if there is no next BIO. 2874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The caller takes ownership of the chain's reference to |bio|. */ 289eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_pop(BIO *bio); 2904c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2914c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_next returns the next BIO in the chain after |bio|, or NULL if there is 2924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * no such BIO. */ 293eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_next(BIO *bio); 2944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 2954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_free_all calls |BIO_free|. 2964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 2974c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * TODO(fork): update callers and remove. */ 298eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_free_all(BIO *bio); 2994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_find_type walks a chain of BIOs and returns the first that matches 3014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |type|, which is one of the |BIO_TYPE_*| values. */ 302eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_find_type(BIO *bio, int type); 3034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3044c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_copy_next_retry sets the retry flags and |retry_reason| of |bio| from 3054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the next BIO in the chain. */ 306eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_copy_next_retry(BIO *bio); 3074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Printf functions. 3104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * These functions are versions of printf functions that output to a BIO rather 3124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * than a FILE. */ 3134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#ifdef __GNUC__ 3144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define __bio_h__attr__ __attribute__ 3154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#else 3164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define __bio_h__attr__(x) 3174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#endif 318eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_printf(BIO *bio, const char *format, ...) 3194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley __bio_h__attr__((__format__(__printf__, 2, 3))); 3204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#undef __bio_h__attr__ 3214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Utility functions. */ 3244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_indent prints min(|indent|, |max_indent|) spaces. It returns one on 3264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * success and zero otherwise. */ 327eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_indent(BIO *bio, unsigned indent, unsigned max_indent); 3284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_hexdump writes a hex dump of |data| to |bio|. Each line will be indented 3304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * by |indent| spaces. */ 331eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_hexdump(BIO *bio, const uint8_t *data, size_t len, 332eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley unsigned indent); 3334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_print_errors_fp prints the current contents of the error stack to |out| 3354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * using human readable strings where possible. */ 336eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_print_errors_fp(FILE *out); 3374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_print_errors prints the current contents of the error stack to |bio| 3394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * using human readable strings where possible. */ 340eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT void BIO_print_errors(BIO *bio); 3414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Memory BIOs. 3444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Memory BIOs can be used as a read-only source (with |BIO_new_mem_buf|) or a 3464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * writable sink (with |BIO_new|, |BIO_s_mem| and |BIO_get_mem_buf|). Data 3474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * written to a writable, memory BIO can be recalled by reading from it. 3484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Calling |BIO_reset| on a read-only BIO resets it to the original contents. 3504c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * On a writable BIO, it clears any data. 3514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * If the close flag is set to |BIO_NOCLOSE| (not the default) then the 3534c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * underlying |BUF_MEM| will not be freed when the |BIO| is freed. 3544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Memory BIOs support |BIO_gets| and |BIO_puts|. 3564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3574c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_eof| is true if no data is in the BIO. 3584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_ctrl_pending| returns the number of bytes currently stored. */ 3604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3614c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_s_mem returns a |BIO_METHOD| that uses a in-memory buffer. */ 362eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT const BIO_METHOD *BIO_s_mem(void); 3634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_new_mem_buf creates BIO that reads and writes from |len| bytes at |buf|. 3654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * It does not take ownership of |buf|. It returns the BIO or NULL on error. 3664c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 3674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * If |len| is negative, then |buf| is treated as a NUL-terminated string, but 3684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * don't depend on this in new code. */ 369eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_new_mem_buf(void *buf, int len); 3704c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 37137a623cf2932b8e7de6c6d58d1a6ce81c4b9f56eAdam Langley/* BIO_mem_contents sets |*out_contents| to point to the current contents of 37237a623cf2932b8e7de6c6d58d1a6ce81c4b9f56eAdam Langley * |bio| and |*out_len| to contain the length of that data. It returns one on 37337a623cf2932b8e7de6c6d58d1a6ce81c4b9f56eAdam Langley * success and zero otherwise. */ 374eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_mem_contents(const BIO *bio, 375eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley const uint8_t **out_contents, 376eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley size_t *out_len); 37737a623cf2932b8e7de6c6d58d1a6ce81c4b9f56eAdam Langley 3784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_get_mem_data sets |*contents| to point to the current contents of |bio| 37937a623cf2932b8e7de6c6d58d1a6ce81c4b9f56eAdam Langley * and returns the length of the data. 38037a623cf2932b8e7de6c6d58d1a6ce81c4b9f56eAdam Langley * 38137a623cf2932b8e7de6c6d58d1a6ce81c4b9f56eAdam Langley * WARNING: don't use this, use |BIO_mem_contents|. A return value of zero from 38237a623cf2932b8e7de6c6d58d1a6ce81c4b9f56eAdam Langley * this function can mean either that it failed or that the memory buffer is 38337a623cf2932b8e7de6c6d58d1a6ce81c4b9f56eAdam Langley * empty. */ 384eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT long BIO_get_mem_data(BIO *bio, char **contents); 3854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_get_mem_ptr sets |*out| to a BUF_MEM containing the current contents of 3874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |bio|. It returns one on success or zero on error. */ 388eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_get_mem_ptr(BIO *bio, BUF_MEM **out); 3894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3904c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_mem_buf sets |b| as the contents of |bio|. If |take_ownership| is 3914c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * non-zero, then |b| will be freed when |bio| is closed. Returns one on 3924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * success or zero otherwise. */ 393eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_set_mem_buf(BIO *bio, BUF_MEM *b, int take_ownership); 3944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 3954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_mem_eof_return sets the value that will be returned from reading 3964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |bio| when empty. If |eof_value| is zero then an empty memory BIO will 3974c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * return EOF (that is it will return zero and |BIO_should_retry| will be 3984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * false). If |eof_value| is non zero then it will return |eof_value| when it 3994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * is empty and it will set the read retry flag (that is |BIO_read_retry| is 4004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * true). To avoid ambiguity with a normal positive return value, |eof_value| 4014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * should be set to a negative value, typically -1. 4024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * For a read-only BIO, the default is zero (EOF). For a writable BIO, the 4044c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * default is -1 so that additional data can be written once exhausted. */ 405eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_set_mem_eof_return(BIO *bio, int eof_value); 4064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* File descriptor BIOs. 4094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * File descriptor BIOs are wrappers around the system's |read| and |write| 4114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * functions. If the close flag is set then then |close| is called on the 4124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * underlying file descriptor when the BIO is freed. 4134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_reset| attempts to seek the file pointer to the start of file using 4154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |lseek|. 4164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_seek| sets the file pointer to position |off| from start of file using 4184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |lseek|. 4194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_tell| returns the current file position. */ 4214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_s_fd returns a |BIO_METHOD| for file descriptor fds. */ 423eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT const BIO_METHOD *BIO_s_fd(void); 4244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_new_fd creates a new file descriptor BIO wrapping |fd|. If |close_flag| 4264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * is non-zero, then |fd| will be closed when the BIO is. */ 427eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_new_fd(int fd, int close_flag); 4284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_fd sets the file descriptor of |bio| to |fd|. If |close_flag| is 4304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * non-zero then |fd| will be closed when |bio| is. It returns one on success 4314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * or zero on error. */ 432eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_set_fd(BIO *bio, int fd, int close_flag); 4334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_get_fd sets |*out_fd| to the file descriptor currently in use by |bio|. 4354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * It returns one on success and zero on error. */ 436eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_get_fd(BIO *bio, int *out_fd); 4374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* File BIOs. 4404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * File BIOs are wrappers around a C |FILE| object. 4424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_flush| on a file BIO calls |fflush| on the wrapped stream. 4444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_reset| attempts to seek the file pointer to the start of file using 4464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |fseek|. 4474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_seek| sets the file pointer to the given position from the start of 4494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * file using |fseek|. 4504c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_eof| calls |feof|. 4524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 4534c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Setting the close flag causes |fclose| to be called on the stream when the 4544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * BIO is freed. */ 4554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_s_file returns a BIO_METHOD that wraps a |FILE|. */ 457eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT const BIO_METHOD *BIO_s_file(void); 4584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_new_file creates a file BIO by opening |filename| with the given mode. 4604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * See the |fopen| manual page for details of the mode argument. */ 461eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_new_file(const char *filename, const char *mode); 4624c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_new_fp creates a new file BIO that wraps the given |FILE|. If 4644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |close_flag| is |BIO_CLOSE|, then |fclose| will be called on |stream| when 4654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the BIO is closed. */ 466eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_new_fp(FILE *stream, int close_flag); 4674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_get_fp sets |*out_file| to the current |FILE| for |bio|. It returns one 4694c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * on success and zero otherwise. */ 470eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_get_fp(BIO *bio, FILE **out_file); 4714c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_fp sets the |FILE| for |bio|. If |close_flag| is |BIO_CLOSE| then 4734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |fclose| will be called on |file| when |bio| is closed. It returns one on 4744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * sucess and zero otherwise. */ 475eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_set_fp(BIO *bio, FILE *file, int close_flag); 4764c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4774c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_read_filename opens |filename| for reading and sets the result as the 4784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |FILE| for |bio|. It returns one on success and zero otherwise. The |FILE| 4794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * will be closed when |bio| is freed. */ 480eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_read_filename(BIO *bio, const char *filename); 4814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4824c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_write_filename opens |filename| for writing and sets the result as the 4834c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |FILE| for |bio|. It returns one on success and zero otherwise. The |FILE| 4844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * will be closed when |bio| is freed. */ 485eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_write_filename(BIO *bio, const char *filename); 4864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_append_filename opens |filename| for appending and sets the result as 4884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the |FILE| for |bio|. It returns one on success and zero otherwise. The 4894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |FILE| will be closed when |bio| is freed. */ 490eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_append_filename(BIO *bio, const char *filename); 4914c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_rw_filename opens |filename| for reading and writing and sets the result 4934c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * as the |FILE| for |bio|. It returns one on success and zero otherwise. The 4944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |FILE| will be closed when |bio| is freed. */ 495eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_rw_filename(BIO *bio, const char *filename); 4964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4974c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 4984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Buffer BIOs. 4994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 5004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * Buffer BIOs are a filter-type BIO, i.e. they are designed to be used in a 5014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * chain of BIOs. They provide buffering to reduce the number of operations on 5024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * the underlying BIOs. */ 5034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 504eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT const BIO_METHOD *BIO_f_buffer(void); 5054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_read_buffer_size sets the size, in bytes, of the read buffer and 5074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * clears it. It returns one on success and zero on failure. */ 508eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_set_read_buffer_size(BIO *bio, int buffer_size); 5094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_write_buffer_size sets the size, in bytes, of the write buffer and 5114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * clears it. It returns one on success and zero on failure. */ 512eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_set_write_buffer_size(BIO *bio, int buffer_size); 5134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Socket BIOs. */ 5164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 517eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT const BIO_METHOD *BIO_s_socket(void); 5184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_new_socket allocates and initialises a fresh BIO which will read and 5204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * write to the socket |fd|. If |close_flag| is |BIO_CLOSE| then closing the 5214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * BIO will close |fd|. It returns the fresh |BIO| or NULL on error. */ 522eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_new_socket(int fd, int close_flag); 5234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Connect BIOs. 5264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 5274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * A connection BIO creates a network connection and transfers data over the 5284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * resulting socket. */ 5294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 530eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT const BIO_METHOD *BIO_s_connect(void); 5314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_new_connect returns a BIO that connects to the given hostname and port. 5334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The |host_and_optional_port| argument should be of the form 5344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * "www.example.com" or "www.example.com:443". If the port is omitted, it must 5354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * be provided with |BIO_set_conn_port|. 5364c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 5374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * It returns the new BIO on success, or NULL on error. */ 538eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT BIO *BIO_new_connect(const char *host_and_optional_port); 5394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_conn_hostname sets |host_and_optional_port| as the hostname and 5414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * optional port that |bio| will connect to. If the port is omitted, it must be 5424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * provided with |BIO_set_conn_port|. 5434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 5444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * It returns one on success and zero otherwise. */ 545eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_set_conn_hostname(BIO *bio, 546eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley const char *host_and_optional_port); 5474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_conn_port sets |port_str| as the port or service name that |bio| 5494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * will connect to. It returns one on success and zero otherwise. */ 550eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_set_conn_port(BIO *bio, const char *port_str); 5514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_set_nbio sets whether |bio| will use non-blocking I/O operations. It 5534c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * returns one on success and zero otherwise. */ 554eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_set_nbio(BIO *bio, int on); 5554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5574c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Datagram BIOs. 5584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 5594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * TODO(fork): not implemented. */ 5604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5614c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_DGRAM_QUERY_MTU 40 /* as kernel for current MTU */ 5624c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_DGRAM_SET_MTU 42 /* set cached value for MTU. want to use 5644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley this if asking the kernel fails */ 5654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5664c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_DGRAM_MTU_EXCEEDED 43 /* check whether the MTU was exceed in 5674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley the previous write operation. */ 5684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5694c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT \ 5704c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 45 /* Next DTLS handshake timeout to adjust socket timeouts */ 5714c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_DGRAM_GET_PEER 46 5734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47 5754c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5764c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5774c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO Pairs. 5784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * 5794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * BIO pairs provide a "loopback" like system: a pair of BIOs where data 5804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * written to one can be read from the other and vice versa. */ 5814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5824c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_new_bio_pair sets |*out1| and |*out2| to two freshly created BIOs where 5834c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * data written to one can be read from the other and vice versa. The 5844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |writebuf1| argument gives the size of the buffer used in |*out1| and 5854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |writebuf2| for |*out2|. It returns one on success and zero on error. */ 586eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_new_bio_pair(BIO **out1, size_t writebuf1, BIO **out2, 587eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam Langley size_t writebuf2); 5884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_s_bio returns the method for a BIO pair. */ 590eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT const BIO_METHOD *BIO_s_bio(void); 5914c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_ctrl_get_read_request returns the number of bytes that the other side of 5934c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |bio| tried (unsuccessfully) to read. */ 594eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT size_t BIO_ctrl_get_read_request(BIO *bio); 5954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 5964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_ctrl_get_write_guarantee returns the number of bytes that |bio| (which 5974c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * must have been returned by |BIO_new_bio_pair|) will accept on the next 5984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_write| call. */ 599eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT size_t BIO_ctrl_get_write_guarantee(BIO *bio); 6004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_shutdown_wr marks |bio| as closed, from the point of view of the other 6024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * side of the pair. Future |BIO_write| calls on |bio| will fail. It returns 6034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * one on success and zero otherwise. */ 604eb7d2ed1fe8a33b3e3871502ba7e12efaf94360cAdam LangleyOPENSSL_EXPORT int BIO_shutdown_wr(BIO *bio); 6054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* BIO_NOCLOSE and |BIO_CLOSE| can be used as symbolic arguments when a "close 6084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * flag" is passed to a BIO function. */ 6094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_NOCLOSE 0 6104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CLOSE 1 6114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* These are passed to the BIO callback */ 6134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CB_FREE 0x01 6144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CB_READ 0x02 6154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CB_WRITE 0x03 6164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CB_PUTS 0x04 6174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CB_GETS 0x05 6184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CB_CTRL 0x06 6194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* The callback is called before and after the underling operation, 6214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * The BIO_CB_RETURN flag indicates if it is after the call */ 6224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CB_RETURN 0x80 6234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* These are values of the |cmd| argument to |BIO_ctrl|. */ 6254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_RESET 1 /* opt - rewind/zero etc */ 6264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_EOF 2 /* opt - are we at the eof */ 6274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_INFO 3 /* opt - extra tit-bits */ 6284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_SET 4 /* man - set the 'IO' type */ 6294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_GET 5 /* man - get the 'IO' type */ 6304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_PUSH 6 /* opt - internal, used to signify change */ 6314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_POP 7 /* opt - internal, used to signify change */ 6324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_GET_CLOSE 8 /* man - set the 'close' on free */ 6334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_SET_CLOSE 9 /* man - set the 'close' on free */ 6344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_PENDING 10 /* opt - is their more data buffered */ 6354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_FLUSH 11 /* opt - 'flush' buffered output */ 6364c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_WPENDING 13 /* opt - number of bytes still to write */ 6374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* callback is int cb(BIO *bio,state,ret); */ 6384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_SET_CALLBACK 14 /* opt - set callback function */ 6394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_GET_CALLBACK 15 /* opt - set callback function */ 6404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_CTRL_SET_FILENAME 30 /* BIO_s_file special */ 6414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* Private functions */ 6444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_FLAGS_READ 0x01 6464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_FLAGS_WRITE 0x02 6474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_FLAGS_IO_SPECIAL 0x04 6484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_FLAGS_RWS (BIO_FLAGS_READ | BIO_FLAGS_WRITE | BIO_FLAGS_IO_SPECIAL) 6494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_FLAGS_SHOULD_RETRY 0x08 6504c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_FLAGS_BASE64_NO_NL 0x100 6514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* This is used with memory BIOs: it means we shouldn't free up or change the 6524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * data in any way. */ 6534c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_FLAGS_MEM_RDONLY 0x200 6544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley/* These are the 'types' of BIOs */ 6564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_NONE 0 6574c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_MEM (1 | 0x0400) 6584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_FILE (2 | 0x0400) 6594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_FD (4 | 0x0400 | 0x0100) 6604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_SOCKET (5 | 0x0400 | 0x0100) 6614c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_NULL (6 | 0x0400) 6624c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_SSL (7 | 0x0200) 6634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_MD (8 | 0x0200) /* passive filter */ 6644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_BUFFER (9 | 0x0200) /* filter */ 6654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_CIPHER (10 | 0x0200) /* filter */ 6664c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_BASE64 (11 | 0x0200) /* filter */ 6674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_CONNECT (12 | 0x0400 | 0x0100) /* socket - connect */ 6684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_ACCEPT (13 | 0x0400 | 0x0100) /* socket for accept */ 6694c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_PROXY_CLIENT (14 | 0x0200) /* client proxy BIO */ 6704c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_PROXY_SERVER (15 | 0x0200) /* server proxy BIO */ 6714c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_NBIO_TEST (16 | 0x0200) /* server proxy BIO */ 6724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_NULL_FILTER (17 | 0x0200) 6734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_BER (18 | 0x0200) /* BER -> bin filter */ 6744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_BIO (19 | 0x0400) /* (half a) BIO pair */ 6754c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_LINEBUFFER (20 | 0x0200) /* filter */ 6764c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_DGRAM (21 | 0x0400 | 0x0100) 6774c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_ASN1 (22 | 0x0200) /* filter */ 6784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_COMP (23 | 0x0200) /* filter */ 6794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */ 6814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_FILTER 0x0200 6824c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_TYPE_SOURCE_SINK 0x0400 6834c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleystruct bio_method_st { 6854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int type; 6864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley const char *name; 6874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int (*bwrite)(BIO *, const char *, int); 6884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int (*bread)(BIO *, char *, int); 6894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* TODO(fork): remove bputs. */ 6904c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int (*bputs)(BIO *, const char *); 6914c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int (*bgets)(BIO *, char *, int); 6924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley long (*ctrl)(BIO *, int, long, void *); 6934c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int (*create)(BIO *); 6944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int (*destroy)(BIO *); 6954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley long (*callback_ctrl)(BIO *, int, bio_info_cb); 6964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley}; 6974c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 6984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langleystruct bio_st { 6994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley const BIO_METHOD *method; 7004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* bio, mode, argp, argi, argl, ret */ 7014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley long (*callback)(struct bio_st *, int, const char *, int, long, long); 7024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley char *cb_arg; /* first argument for the callback */ 7034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 7044c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* init is non-zero if this |BIO| has been initialised. */ 7054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int init; 7064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* shutdown is often used by specific |BIO_METHOD|s to determine whether 7074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * they own some underlying resource. This flag can often by controlled by 7084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * |BIO_set_close|. For example, whether an fd BIO closes the underlying fd 7094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * when it, itself, is closed. */ 7104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int shutdown; 7114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int flags; 7124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int retry_reason; 7134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* num is a BIO-specific value. For example, in fd BIOs it's used to store a 7144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * file descriptor. */ 7154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int num; 7164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* TODO(fork): reference counting is only used by the SSL BIO code. If we can 7174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * dump that then we can remove this. We could also drop 7184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * BIO_CTRL_PUSH/BIO_CTRL_POP. */ 7194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley int references; 7204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley void *ptr; 7214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley /* next_bio points to the next |BIO| in a chain. This |BIO| owns a reference 7224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley * to |next_bio|. */ 7234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley struct bio_st *next_bio; /* used by filter BIOs */ 724e2c4d262141f9a7de9baf6d0d7151682e9947357Adam Langley size_t num_read, num_write; 7254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 7264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley CRYPTO_EX_DATA ex_data; 7274c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley}; 7284c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 7294c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_CONNECT 100 7304c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_DO_STATE_MACHINE 101 7314c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_NBIO 102 7324c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_PROXY_PARAM 103 7334c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_FD 104 7344c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_FD 105 7354c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_FILE_PTR 106 7364c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_FILE_PTR 107 7374c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_FILENAME 108 7384c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_SSL 109 7394c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_SSL 110 7404c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_MD 111 7414c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_MD 112 7424c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_CIPHER_STATUS 113 7434c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_BUF_MEM 114 7444c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_BUF_MEM_PTR 115 7454c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_BUFF_NUM_LINES 116 7464c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_BUFF_SIZE 117 7474c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_ACCEPT 118 7484c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SSL_MODE 119 7494c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_MD_CTX 120 7504c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_PROXY_PARAM 121 7514c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */ 7524c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_CONNECT 123 7534c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_ACCEPT 124 7544c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125 7554c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_SSL_NUM_RENEGOTIATES 126 7564c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127 7574c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_FILE_SEEK 128 7584c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_CIPHER_CTX 129 7594c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/ 7604c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_BIND_MODE 131 7614c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_BIND_MODE 132 7624c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_FILE_TELL 133 7634c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_SOCKS 134 7644c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_SOCKS 135 7654c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 7664c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */ 7674c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_WRITE_BUF_SIZE 137 7684c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_WRITE_GUARANTEE 140 7694c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_READ_REQUEST 141 7704c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SHUTDOWN_WR 142 7714c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_NREAD0 143 7724c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_NREAD 144 7734c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_NWRITE0 145 7744c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_NWRITE 146 7754c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_RESET_READ_REQUEST 147 7764c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_MD_CTX 148 7774c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 7784c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_PREFIX 149 7794c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_PREFIX 150 7804c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_SUFFIX 151 7814c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_SUFFIX 152 7824c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 7834c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_SET_EX_ARG 153 7844c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_C_GET_EX_ARG 154 7854c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 7864c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 7874c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#if defined(__cplusplus) 7884c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley} /* extern C */ 7894c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#endif 7904c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 7914c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_bio_make_pair 100 7924c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_bio_ctrl 101 7934c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_buffer_ctrl 102 7944c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_BIO_new_file 103 7954c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_file_read 104 7964c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_BIO_new 105 7974c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_bio_io 106 7984c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_BIO_new_mem_buf 107 7994c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_mem_write 108 8004c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_conn_state 109 8014c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_conn_ctrl 110 8024c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_file_ctrl 111 8034c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_BIO_callback_ctrl 112 8044c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_bio_ip_and_port_to_socket_and_addr 113 8054c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_bio_write 114 8064c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_F_BIO_ctrl 115 8074c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_UNSUPPORTED_METHOD 100 8084c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_NO_PORT_SPECIFIED 101 8094c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_NO_HOSTNAME_SPECIFIED 102 8104c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_IN_USE 103 8114c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_UNINITIALIZED 104 8124c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_CONNECT_ERROR 105 8134c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_KEEPALIVE 106 8144c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_BROKEN_PIPE 107 8154c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_NBIO_CONNECT_ERROR 108 8164c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_BAD_FOPEN_MODE 109 8174c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_ASN1_OBJECT_TOO_LONG 110 8184c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_INVALID_ARGUMENT 111 8194c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_WRITE_TO_READ_ONLY_BIO 112 8204c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_ERROR_SETTING_NBIO 113 8214c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_SYS_LIB 114 8224c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_NO_SUCH_FILE 115 8234c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_NULL_PARAMETER 116 8244c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#define BIO_R_UNABLE_TO_CREATE_SOCKET 117 8254c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley 8264c921e1bbcc1d1cd23848e3b11ab2c9f85ee37eaAdam Langley#endif /* OPENSSL_HEADER_BIO_H */ 827