src/third_party/boringssl/src/include/openssl/bio.h

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.] */
  56
  57 #ifndef OPENSSL_HEADER_BIO_H
  58 #define OPENSSL_HEADER_BIO_H
  59
  60 #include <openssl/base.h>
  61
  62 #include <stdarg.h>
  63 #include <stdio.h>  /* For FILE */
  64
  65 #include <openssl/ex_data.h>
  66 #include <openssl/stack.h>
  67
  68 #if defined(__cplusplus)
  69 extern "C" {
  70 #endif
  71
  72
  73 /* BIO abstracts over a file-descriptor like interface. */
  74
  75
  76 /* Allocation and freeing. */
  77
  78 DEFINE_STACK_OF(BIO);
  79
  80 /* BIO_new creates a new BIO with the given type and a reference count of one.
  81  * It returns the fresh |BIO|, or NULL on error. */
  82 OPENSSL_EXPORT BIO *BIO_new(const BIO_METHOD *type);
  83
  84 /* BIO_free decrements the reference count of |bio|. If the reference count
  85  * drops to zero, it (optionally) calls the BIO's callback with |BIO_CB_FREE|,
  86  * frees the ex_data and then, if the BIO has a destroy callback for the
  87  * method, calls it. Finally it frees |bio| itself. It then repeats that for
  88  * the next BIO in the chain, if any.
  89  *
  90  * It returns one on success or zero otherwise. */
  91 OPENSSL_EXPORT int BIO_free(BIO *bio);
  92
  93 /* BIO_vfree performs the same actions as |BIO_free|, but has a void return
  94  * value. This is provided for API-compat.
  95  *
  96  * TODO(fork): remove. */
  97 OPENSSL_EXPORT void BIO_vfree(BIO *bio);
  98
  99
 100 /* Basic I/O. */
 101
 102 /* BIO_read attempts to read |len| bytes into |data|. It returns the number of
 103  * bytes read, zero on EOF, or a negative number on error. */
 104 OPENSSL_EXPORT int BIO_read(BIO *bio, void *data, int len);
 105
 106 /* BIO_gets "reads a line" from |bio| and puts at most |size| bytes into |buf|.
 107  * It returns the number of bytes read or a negative number on error. The
 108  * phrase "reads a line" is in quotes in the previous sentence because the
 109  * exact operation depends on the BIO's method. For example, a digest BIO will
 110  * return the digest in response to a |BIO_gets| call.
 111  *
 112  * TODO(fork): audit the set of BIOs that we end up needing. If all actually
 113  * return a line for this call, remove the warning above. */
 114 OPENSSL_EXPORT int BIO_gets(BIO *bio, char *buf, int size);
 115
 116 /* BIO_write writes |len| bytes from |data| to BIO. It returns the number of
 117  * bytes written or a negative number on error. */
 118 OPENSSL_EXPORT int BIO_write(BIO *bio, const void *data, int len);
 119
 120 /* BIO_puts writes a NUL terminated string from |buf| to |bio|. It returns the
 121  * number of bytes written or a negative number on error. */
 122 OPENSSL_EXPORT int BIO_puts(BIO *bio, const char *buf);
 123
 124 /* BIO_flush flushes any buffered output. It returns one on success and zero
 125  * otherwise. */
 126 OPENSSL_EXPORT int BIO_flush(BIO *bio);
 127
 128
 129 /* Low-level control functions.
 130  *
 131  * These are generic functions for sending control requests to a BIO. In
 132  * general one should use the wrapper functions like |BIO_get_close|. */
 133
 134 /* BIO_ctrl sends the control request |cmd| to |bio|. The |cmd| argument should
 135  * be one of the |BIO_C_*| values. */
 136 OPENSSL_EXPORT long BIO_ctrl(BIO *bio, int cmd, long larg, void *parg);
 137
 138 /* BIO_ptr_ctrl acts like |BIO_ctrl| but passes the address of a |void*|
 139  * pointer as |parg| and returns the value that is written to it, or NULL if
 140  * the control request returns <= 0. */
 141 OPENSSL_EXPORT char *BIO_ptr_ctrl(BIO *bp, int cmd, long larg);
 142
 143 /* BIO_int_ctrl acts like |BIO_ctrl| but passes the address of a copy of |iarg|
 144  * as |parg|. */
 145 OPENSSL_EXPORT long BIO_int_ctrl(BIO *bp, int cmd, long larg, int iarg);
 146
 147 /* BIO_reset resets |bio| to its initial state, the precise meaning of which
 148  * depends on the concrete type of |bio|. It returns one on success and zero
 149  * otherwise. */
 150 OPENSSL_EXPORT int BIO_reset(BIO *bio);
 151
 152 /* BIO_set_flags ORs |flags| with |bio->flags|. */
 153 OPENSSL_EXPORT void BIO_set_flags(BIO *bio, int flags);
 154
 155 /* BIO_test_flags returns |bio->flags| AND |flags|. */
 156 OPENSSL_EXPORT int BIO_test_flags(const BIO *bio, int flags);
 157
 158 /* BIO_should_read returns non-zero if |bio| encountered a temporary error
 159  * while reading (i.e. EAGAIN), indicating that the caller should retry the
 160  * read. */
 161 OPENSSL_EXPORT int BIO_should_read(const BIO *bio);
 162
 163 /* BIO_should_write returns non-zero if |bio| encountered a temporary error
 164  * while writing (i.e. EAGAIN), indicating that the caller should retry the
 165  * write. */
 166 OPENSSL_EXPORT int BIO_should_write(const BIO *bio);
 167
 168 /* BIO_should_retry returns non-zero if the reason that caused a failed I/O
 169  * operation is temporary and thus the operation should be retried. Otherwise,
 170  * it was a permanent error and it returns zero. */
 171 OPENSSL_EXPORT int BIO_should_retry(const BIO *bio);
 172
 173 /* BIO_should_io_special returns non-zero if |bio| encountered a temporary
 174  * error while performing a special I/O operation, indicating that the caller
 175  * should retry. The operation that caused the error is returned by
 176  * |BIO_get_retry_reason|. */
 177 OPENSSL_EXPORT int BIO_should_io_special(const BIO *bio);
 178
 179 /* BIO_RR_SSL_X509_LOOKUP indicates that an SSL BIO blocked because the SSL
 180  * library returned with SSL_ERROR_WANT_X509_LOOKUP.
 181  *
 182  * TODO(fork): remove. */
 183 #define BIO_RR_SSL_X509_LOOKUP 0x01
 184
 185 /* BIO_RR_CONNECT indicates that a connect would have blocked */
 186 #define BIO_RR_CONNECT 0x02
 187
 188 /* BIO_RR_ACCEPT indicates that an accept would have blocked */
 189 #define BIO_RR_ACCEPT 0x03
 190
 191 /* BIO_RR_SSL_CHANNEL_ID_LOOKUP indicates that the ChannelID code cannot find
 192  * a private key for a TLS connection. */
 193 #define BIO_RR_SSL_CHANNEL_ID_LOOKUP 0x04
 194
 195 /* BIO_get_retry_reason returns the special I/O operation that needs to be
 196  * retried. The return value is one of the |BIO_RR_*| values. */
 197 OPENSSL_EXPORT int BIO_get_retry_reason(const BIO *bio);
 198
 199 /* BIO_clear_flags ANDs |bio->flags| with the bitwise-complement of |flags|. */
 200 OPENSSL_EXPORT void BIO_clear_flags(BIO *bio, int flags);
 201
 202 /* BIO_set_retry_read sets the |BIO_FLAGS_READ| and |BIO_FLAGS_SHOULD_RETRY|
 203  * flags on |bio|. */
 204 OPENSSL_EXPORT void BIO_set_retry_read(BIO *bio);
 205
 206 /* BIO_set_retry_read sets the |BIO_FLAGS_WRITE| and |BIO_FLAGS_SHOULD_RETRY|
 207  * flags on |bio|. */
 208 OPENSSL_EXPORT void BIO_set_retry_write(BIO *bio);
 209
 210 /* BIO_get_retry_flags gets the |BIO_FLAGS_READ|, |BIO_FLAGS_WRITE|,
 211  * |BIO_FLAGS_IO_SPECIAL| and |BIO_FLAGS_SHOULD_RETRY| flags from |bio|. */
 212 OPENSSL_EXPORT int BIO_get_retry_flags(BIO *bio);
 213
 214 /* BIO_clear_retry_flags clears the |BIO_FLAGS_READ|, |BIO_FLAGS_WRITE|,
 215  * |BIO_FLAGS_IO_SPECIAL| and |BIO_FLAGS_SHOULD_RETRY| flags from |bio|. */
 216 OPENSSL_EXPORT void BIO_clear_retry_flags(BIO *bio);
 217
 218 /* BIO_method_type returns the type of |bio|, which is one of the |BIO_TYPE_*|
 219  * values. */
 220 OPENSSL_EXPORT int BIO_method_type(const BIO *bio);
 221
 222 /* bio_info_cb is the type of a callback function that can be called for most
 223  * BIO operations. The |event| argument is one of |BIO_CB_*| and can be ORed
 224  * with |BIO_CB_RETURN| if the callback is being made after the operation in
 225  * question. In that case, |return_value| will contain the return value from
 226  * the operation. */
 227 typedef long (*bio_info_cb)(BIO *bio, int event, const char *parg, int cmd,
 228                             long larg, long return_value);
 229
 230 /* BIO_callback_ctrl allows the callback function to be manipulated. The |cmd|
 231  * arg will generally be |BIO_CTRL_SET_CALLBACK| but arbitary command values
 232  * can be interpreted by the |BIO|. */
 233 OPENSSL_EXPORT long BIO_callback_ctrl(BIO *bio, int cmd, bio_info_cb fp);
 234
 235 /* BIO_pending returns the number of bytes pending to be read. */
 236 OPENSSL_EXPORT size_t BIO_pending(const BIO *bio);
 237
 238 /* BIO_wpending returns the number of bytes pending to be written. */
 239 OPENSSL_EXPORT size_t BIO_wpending(const BIO *bio);
 240
 241 /* BIO_set_close sets the close flag for |bio|. The meaning of which depends on
 242  * the type of |bio| but, for example, a memory BIO interprets the close flag
 243  * as meaning that it owns its buffer. It returns one on success and zero
 244  * otherwise. */
 245 OPENSSL_EXPORT int BIO_set_close(BIO *bio, int close_flag);
 246
 247 /* BIO_set_callback sets a callback function that will be called before and
 248  * after most operations. See the comment above |bio_info_cb|. */
 249 OPENSSL_EXPORT void BIO_set_callback(BIO *bio, bio_info_cb callback_func);
 250
 251 /* BIO_set_callback_arg sets the opaque pointer value that can be read within a
 252  * callback with |BIO_get_callback_arg|. */
 253 OPENSSL_EXPORT void BIO_set_callback_arg(BIO *bio, char *arg);
 254
 255 /* BIO_get_callback_arg returns the last value of the opaque callback pointer
 256  * set by |BIO_set_callback_arg|. */
 257 OPENSSL_EXPORT char *BIO_get_callback_arg(const BIO *bio);
 258
 259
 260 /* Managing chains of BIOs.
 261  *
 262  * BIOs can be put into chains where the output of one is used as the input of
 263  * the next etc. The most common case is a buffering BIO, which accepts and
 264  * buffers writes until flushed into the next BIO in the chain. */
 265
 266 /* BIO_push adds |appended_bio| to the end of the chain with |bio| at the head.
 267  * It returns |bio|. Note that |appended_bio| may be the head of a chain itself
 268  * and thus this function can be used to join two chains.
 269  *
 270  * BIO_push takes ownership of the caller's reference to |appended_bio|. */
 271 OPENSSL_EXPORT BIO *BIO_push(BIO *bio, BIO *appended_bio);
 272
 273 /* BIO_pop removes |bio| from the head of a chain and returns the next BIO in
 274  * the chain, or NULL if there is no next BIO.
 275  *
 276  * The caller takes ownership of the chain's reference to |bio|. */
 277 OPENSSL_EXPORT BIO *BIO_pop(BIO *bio);
 278
 279 /* BIO_next returns the next BIO in the chain after |bio|, or NULL if there is
 280  * no such BIO. */
 281 OPENSSL_EXPORT BIO *BIO_next(BIO *bio);
 282
 283 /* BIO_free_all calls |BIO_free|.
 284  *
 285  * TODO(fork): update callers and remove. */
 286 OPENSSL_EXPORT void BIO_free_all(BIO *bio);
 287
 288 /* BIO_find_type walks a chain of BIOs and returns the first that matches
 289  * |type|, which is one of the |BIO_TYPE_*| values. */
 290 OPENSSL_EXPORT BIO *BIO_find_type(BIO *bio, int type);
 291
 292 /* BIO_copy_next_retry sets the retry flags and |retry_reason| of |bio| from
 293  * the next BIO in the chain. */
 294 OPENSSL_EXPORT void BIO_copy_next_retry(BIO *bio);
 295
 296
 297 /* Printf functions.
 298  *
 299  * These functions are versions of printf functions that output to a BIO rather
 300  * than a FILE. */
 301 #ifdef __GNUC__
 302 #define __bio_h__attr__ __attribute__
 303 #else
 304 #define __bio_h__attr__(x)
 305 #endif
 306 OPENSSL_EXPORT int BIO_printf(BIO *bio, const char *format, ...)
 307     __bio_h__attr__((__format__(__printf__, 2, 3)));
 308 #undef __bio_h__attr__
 309
 310
 311 /* Utility functions. */
 312
 313 /* BIO_indent prints min(|indent|, |max_indent|) spaces. It returns one on
 314  * success and zero otherwise. */
 315 OPENSSL_EXPORT int BIO_indent(BIO *bio, unsigned indent, unsigned max_indent);
 316
 317 /* BIO_hexdump writes a hex dump of |data| to |bio|. Each line will be indented
 318  * by |indent| spaces. */
 319 OPENSSL_EXPORT int BIO_hexdump(BIO *bio, const uint8_t *data, size_t len,
 320                                unsigned indent);
 321
 322 /* BIO_print_errors_fp prints the current contents of the error stack to |out|
 323  * using human readable strings where possible. */
 324 OPENSSL_EXPORT void BIO_print_errors_fp(FILE *out);
 325
 326 /* BIO_print_errors prints the current contents of the error stack to |bio|
 327  * using human readable strings where possible. */
 328 OPENSSL_EXPORT void BIO_print_errors(BIO *bio);
 329
 330
 331 /* Memory BIOs.
 332  *
 333  * Memory BIOs can be used as a read-only source (with |BIO_new_mem_buf|) or a
 334  * writable sink (with |BIO_new|, |BIO_s_mem| and |BIO_get_mem_buf|). Data
 335  * written to a writable, memory BIO can be recalled by reading from it.
 336  *
 337  * Calling |BIO_reset| on a read-only BIO resets it to the original contents.
 338  * On a writable BIO, it clears any data.
 339  *
 340  * If the close flag is set to |BIO_NOCLOSE| (not the default) then the
 341  * underlying |BUF_MEM| will not be freed when the |BIO| is freed.
 342  *
 343  * Memory BIOs support |BIO_gets| and |BIO_puts|.
 344  *
 345  * |BIO_eof| is true if no data is in the BIO.
 346  *
 347  * |BIO_ctrl_pending| returns the number of bytes currently stored. */
 348
 349 /* BIO_s_mem returns a |BIO_METHOD| that uses a in-memory buffer. */
 350 OPENSSL_EXPORT const BIO_METHOD *BIO_s_mem(void);
 351
 352 /* BIO_new_mem_buf creates BIO that reads and writes from |len| bytes at |buf|.
 353  * It does not take ownership of |buf|. It returns the BIO or NULL on error.
 354  *
 355  * If |len| is negative, then |buf| is treated as a NUL-terminated string, but
 356  * don't depend on this in new code. */
 357 OPENSSL_EXPORT BIO *BIO_new_mem_buf(void *buf, int len);
 358
 359 /* BIO_mem_contents sets |*out_contents| to point to the current contents of
 360  * |bio| and |*out_len| to contain the length of that data. It returns one on
 361  * success and zero otherwise. */
 362 OPENSSL_EXPORT int BIO_mem_contents(const BIO *bio,
 363                                     const uint8_t **out_contents,
 364                                     size_t *out_len);
 365
 366 /* BIO_get_mem_data sets |*contents| to point to the current contents of |bio|
 367  * and returns the length of the data.
 368  *
 369  * WARNING: don't use this, use |BIO_mem_contents|. A return value of zero from
 370  * this function can mean either that it failed or that the memory buffer is
 371  * empty. */
 372 OPENSSL_EXPORT long BIO_get_mem_data(BIO *bio, char **contents);
 373
 374 /* BIO_get_mem_ptr sets |*out| to a BUF_MEM containing the current contents of
 375  * |bio|. It returns one on success or zero on error. */
 376 OPENSSL_EXPORT int BIO_get_mem_ptr(BIO *bio, BUF_MEM **out);
 377
 378 /* BIO_set_mem_buf sets |b| as the contents of |bio|. If |take_ownership| is
 379  * non-zero, then |b| will be freed when |bio| is closed. Returns one on
 380  * success or zero otherwise. */
 381 OPENSSL_EXPORT int BIO_set_mem_buf(BIO *bio, BUF_MEM *b, int take_ownership);
 382
 383 /* BIO_set_mem_eof_return sets the value that will be returned from reading
 384  * |bio| when empty. If |eof_value| is zero then an empty memory BIO will
 385  * return EOF (that is it will return zero and |BIO_should_retry| will be
 386  * false). If |eof_value| is non zero then it will return |eof_value| when it
 387  * is empty and it will set the read retry flag (that is |BIO_read_retry| is
 388  * true). To avoid ambiguity with a normal positive return value, |eof_value|
 389  * should be set to a negative value, typically -1.
 390  *
 391  * For a read-only BIO, the default is zero (EOF). For a writable BIO, the
 392  * default is -1 so that additional data can be written once exhausted. */
 393 OPENSSL_EXPORT int BIO_set_mem_eof_return(BIO *bio, int eof_value);
 394
 395
 396 /* File descriptor BIOs.
 397  *
 398  * File descriptor BIOs are wrappers around the system's |read| and |write|
 399  * functions. If the close flag is set then then |close| is called on the
 400  * underlying file descriptor when the BIO is freed.
 401  *
 402  * |BIO_reset| attempts to seek the file pointer to the start of file using
 403  * |lseek|.
 404  *
 405  * |BIO_seek| sets the file pointer to position |off| from start of file using
 406  * |lseek|.
 407  *
 408  * |BIO_tell| returns the current file position. */
 409
 410 /* BIO_s_fd returns a |BIO_METHOD| for file descriptor fds. */
 411 OPENSSL_EXPORT const BIO_METHOD *BIO_s_fd(void);
 412
 413 /* BIO_new_fd creates a new file descriptor BIO wrapping |fd|. If |close_flag|
 414  * is non-zero, then |fd| will be closed when the BIO is. */
 415 OPENSSL_EXPORT BIO *BIO_new_fd(int fd, int close_flag);
 416
 417 /* BIO_set_fd sets the file descriptor of |bio| to |fd|. If |close_flag| is
 418  * non-zero then |fd| will be closed when |bio| is. It returns one on success
 419  * or zero on error. */
 420 OPENSSL_EXPORT int BIO_set_fd(BIO *bio, int fd, int close_flag);
 421
 422 /* BIO_get_fd sets |*out_fd| to the file descriptor currently in use by |bio|.
 423  * It returns one on success and zero on error. */
 424 OPENSSL_EXPORT int BIO_get_fd(BIO *bio, int *out_fd);
 425
 426
 427 /* File BIOs.
 428  *
 429  * File BIOs are wrappers around a C |FILE| object.
 430  *
 431  * |BIO_flush| on a file BIO calls |fflush| on the wrapped stream.
 432  *
 433  * |BIO_reset| attempts to seek the file pointer to the start of file using
 434  * |fseek|.
 435  *
 436  * |BIO_seek| sets the file pointer to the given position from the start of
 437  * file using |fseek|.
 438  *
 439  * |BIO_eof| calls |feof|.
 440  *
 441  * Setting the close flag causes |fclose| to be called on the stream when the
 442  * BIO is freed. */
 443
 444 /* BIO_s_file returns a BIO_METHOD that wraps a |FILE|. */
 445 OPENSSL_EXPORT const BIO_METHOD *BIO_s_file(void);
 446
 447 /* BIO_new_file creates a file BIO by opening |filename| with the given mode.
 448  * See the |fopen| manual page for details of the mode argument. */
 449 OPENSSL_EXPORT BIO *BIO_new_file(const char *filename, const char *mode);
 450
 451 /* BIO_new_fp creates a new file BIO that wraps the given |FILE|. If
 452  * |close_flag| is |BIO_CLOSE|, then |fclose| will be called on |stream| when
 453  * the BIO is closed. */
 454 OPENSSL_EXPORT BIO *BIO_new_fp(FILE *stream, int close_flag);
 455
 456 /* BIO_get_fp sets |*out_file| to the current |FILE| for |bio|. It returns one
 457  * on success and zero otherwise. */
 458 OPENSSL_EXPORT int BIO_get_fp(BIO *bio, FILE **out_file);
 459
 460 /* BIO_set_fp sets the |FILE| for |bio|. If |close_flag| is |BIO_CLOSE| then
 461  * |fclose| will be called on |file| when |bio| is closed. It returns one on
 462  * sucess and zero otherwise. */
 463 OPENSSL_EXPORT int BIO_set_fp(BIO *bio, FILE *file, int close_flag);
 464
 465 /* BIO_read_filename opens |filename| for reading and sets the result as the
 466  * |FILE| for |bio|. It returns one on success and zero otherwise. The |FILE|
 467  * will be closed when |bio| is freed. */
 468 OPENSSL_EXPORT int BIO_read_filename(BIO *bio, const char *filename);
 469
 470 /* BIO_write_filename opens |filename| for writing and sets the result as the
 471  * |FILE| for |bio|. It returns one on success and zero otherwise. The |FILE|
 472  * will be closed when |bio| is freed. */
 473 OPENSSL_EXPORT int BIO_write_filename(BIO *bio, const char *filename);
 474
 475 /* BIO_append_filename opens |filename| for appending and sets the result as
 476  * the |FILE| for |bio|. It returns one on success and zero otherwise. The
 477  * |FILE| will be closed when |bio| is freed. */
 478 OPENSSL_EXPORT int BIO_append_filename(BIO *bio, const char *filename);
 479
 480 /* BIO_rw_filename opens |filename| for reading and writing and sets the result
 481  * as the |FILE| for |bio|. It returns one on success and zero otherwise. The
 482  * |FILE| will be closed when |bio| is freed. */
 483 OPENSSL_EXPORT int BIO_rw_filename(BIO *bio, const char *filename);
 484
 485
 486 /* Buffer BIOs.
 487  *
 488  * Buffer BIOs are a filter-type BIO, i.e. they are designed to be used in a
 489  * chain of BIOs. They provide buffering to reduce the number of operations on
 490  * the underlying BIOs. */
 491
 492 OPENSSL_EXPORT const BIO_METHOD *BIO_f_buffer(void);
 493
 494 /* BIO_set_read_buffer_size sets the size, in bytes, of the read buffer and
 495  * clears it. It returns one on success and zero on failure. */
 496 OPENSSL_EXPORT int BIO_set_read_buffer_size(BIO *bio, int buffer_size);
 497
 498 /* BIO_set_write_buffer_size sets the size, in bytes, of the write buffer and
 499  * clears it. It returns one on success and zero on failure. */
 500 OPENSSL_EXPORT int BIO_set_write_buffer_size(BIO *bio, int buffer_size);
 501
 502
 503 /* Socket BIOs. */
 504
 505 OPENSSL_EXPORT const BIO_METHOD *BIO_s_socket(void);
 506
 507 /* BIO_new_socket allocates and initialises a fresh BIO which will read and
 508  * write to the socket |fd|. If |close_flag| is |BIO_CLOSE| then closing the
 509  * BIO will close |fd|. It returns the fresh |BIO| or NULL on error. */
 510 OPENSSL_EXPORT BIO *BIO_new_socket(int fd, int close_flag);
 511
 512
 513 /* Connect BIOs.
 514  *
 515  * A connection BIO creates a network connection and transfers data over the
 516  * resulting socket. */
 517
 518 OPENSSL_EXPORT const BIO_METHOD *BIO_s_connect(void);
 519
 520 /* BIO_new_connect returns a BIO that connects to the given hostname and port.
 521  * The |host_and_optional_port| argument should be of the form
 522  * "www.example.com" or "www.example.com:443". If the port is omitted, it must
 523  * be provided with |BIO_set_conn_port|.
 524  *
 525  * It returns the new BIO on success, or NULL on error. */
 526 OPENSSL_EXPORT BIO *BIO_new_connect(const char *host_and_optional_port);
 527
 528 /* BIO_set_conn_hostname sets |host_and_optional_port| as the hostname and
 529  * optional port that |bio| will connect to. If the port is omitted, it must be
 530  * provided with |BIO_set_conn_port|.
 531  *
 532  * It returns one on success and zero otherwise. */
 533 OPENSSL_EXPORT int BIO_set_conn_hostname(BIO *bio,
 534                                          const char *host_and_optional_port);
 535
 536 /* BIO_set_conn_port sets |port_str| as the port or service name that |bio|
 537  * will connect to. It returns one on success and zero otherwise. */
 538 OPENSSL_EXPORT int BIO_set_conn_port(BIO *bio, const char *port_str);
 539
 540 /* BIO_set_nbio sets whether |bio| will use non-blocking I/O operations. It
 541  * returns one on success and zero otherwise. */
 542 OPENSSL_EXPORT int BIO_set_nbio(BIO *bio, int on);
 543
 544
 545 /* Datagram BIOs.
 546  *
 547  * TODO(fork): not implemented. */
 548
 549 #define BIO_CTRL_DGRAM_QUERY_MTU 40 /* as kernel for current MTU */
 550
 551 #define BIO_CTRL_DGRAM_SET_MTU 42 /* set cached value for  MTU. want to use
 552                                      this if asking the kernel fails */
 553
 554 #define BIO_CTRL_DGRAM_MTU_EXCEEDED 43 /* check whether the MTU was exceed in
 555                                           the previous write operation. */
 556
 557 #define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT \
 558   45 /* Next DTLS handshake timeout to adjust socket timeouts */
 559
 560 #define BIO_CTRL_DGRAM_GET_PEER           46
 561
 562 #define BIO_CTRL_DGRAM_GET_FALLBACK_MTU   47
 563
 564
 565 /* BIO Pairs.
 566  *
 567  * BIO pairs provide a "loopback" like system: a pair of BIOs where data
 568  * written to one can be read from the other and vice versa. */
 569
 570 /* BIO_new_bio_pair sets |*out1| and |*out2| to two freshly created BIOs where
 571  * data written to one can be read from the other and vice versa. The
 572  * |writebuf1| argument gives the size of the buffer used in |*out1| and
 573  * |writebuf2| for |*out2|. It returns one on success and zero on error. */
 574 OPENSSL_EXPORT int BIO_new_bio_pair(BIO **out1, size_t writebuf1, BIO **out2,
 575                                     size_t writebuf2);
 576
 577 /* BIO_s_bio returns the method for a BIO pair. */
 578 OPENSSL_EXPORT const BIO_METHOD *BIO_s_bio(void);
 579
 580 /* BIO_ctrl_get_read_request returns the number of bytes that the other side of
 581  * |bio| tried (unsuccessfully) to read. */
 582 OPENSSL_EXPORT size_t BIO_ctrl_get_read_request(BIO *bio);
 583
 584 /* BIO_ctrl_get_write_guarantee returns the number of bytes that |bio| (which
 585  * must have been returned by |BIO_new_bio_pair|) will accept on the next
 586  * |BIO_write| call. */
 587 OPENSSL_EXPORT size_t BIO_ctrl_get_write_guarantee(BIO *bio);
 588
 589 /* BIO_shutdown_wr marks |bio| as closed, from the point of view of the other
 590  * side of the pair. Future |BIO_write| calls on |bio| will fail. It returns
 591  * one on success and zero otherwise. */
 592 OPENSSL_EXPORT int BIO_shutdown_wr(BIO *bio);
 593
 594
 595 /* BIO_NOCLOSE and |BIO_CLOSE| can be used as symbolic arguments when a "close
 596  * flag" is passed to a BIO function. */
 597 #define BIO_NOCLOSE 0
 598 #define BIO_CLOSE 1
 599
 600 /* These are passed to the BIO callback */
 601 #define BIO_CB_FREE 0x01
 602 #define BIO_CB_READ 0x02
 603 #define BIO_CB_WRITE 0x03
 604 #define BIO_CB_PUTS 0x04
 605 #define BIO_CB_GETS 0x05
 606 #define BIO_CB_CTRL 0x06
 607
 608 /* The callback is called before and after the underling operation,
 609  * The BIO_CB_RETURN flag indicates if it is after the call */
 610 #define BIO_CB_RETURN 0x80
 611
 612 /* These are values of the |cmd| argument to |BIO_ctrl|. */
 613 #define BIO_CTRL_RESET          1  /* opt - rewind/zero etc */
 614 #define BIO_CTRL_EOF            2  /* opt - are we at the eof */
 615 #define BIO_CTRL_INFO           3  /* opt - extra tit-bits */
 616 #define BIO_CTRL_SET            4  /* man - set the 'IO' type */
 617 #define BIO_CTRL_GET            5  /* man - get the 'IO' type */
 618 #define BIO_CTRL_PUSH           6  /* opt - internal, used to signify change */
 619 #define BIO_CTRL_POP            7  /* opt - internal, used to signify change */
 620 #define BIO_CTRL_GET_CLOSE      8  /* man - set the 'close' on free */
 621 #define BIO_CTRL_SET_CLOSE      9  /* man - set the 'close' on free */
 622 #define BIO_CTRL_PENDING        10  /* opt - is their more data buffered */
 623 #define BIO_CTRL_FLUSH          11  /* opt - 'flush' buffered output */
 624 #define BIO_CTRL_WPENDING       13  /* opt - number of bytes still to write */
 625 /* callback is int cb(BIO *bio,state,ret); */
 626 #define BIO_CTRL_SET_CALLBACK   14  /* opt - set callback function */
 627 #define BIO_CTRL_GET_CALLBACK   15  /* opt - set callback function */
 628 #define BIO_CTRL_SET_FILENAME   30      /* BIO_s_file special */
 629
 630
 631 /* Private functions */
 632
 633 #define BIO_FLAGS_READ 0x01
 634 #define BIO_FLAGS_WRITE 0x02
 635 #define BIO_FLAGS_IO_SPECIAL 0x04
 636 #define BIO_FLAGS_RWS (BIO_FLAGS_READ | BIO_FLAGS_WRITE | BIO_FLAGS_IO_SPECIAL)
 637 #define BIO_FLAGS_SHOULD_RETRY 0x08
 638 #define BIO_FLAGS_BASE64_NO_NL 0x100
 639 /* This is used with memory BIOs: it means we shouldn't free up or change the
 640  * data in any way. */
 641 #define BIO_FLAGS_MEM_RDONLY 0x200
 642
 643 /* These are the 'types' of BIOs */
 644 #define BIO_TYPE_NONE 0
 645 #define BIO_TYPE_MEM (1 | 0x0400)
 646 #define BIO_TYPE_FILE (2 | 0x0400)
 647 #define BIO_TYPE_FD (4 | 0x0400 | 0x0100)
 648 #define BIO_TYPE_SOCKET (5 | 0x0400 | 0x0100)
 649 #define BIO_TYPE_NULL (6 | 0x0400)
 650 #define BIO_TYPE_SSL (7 | 0x0200)
 651 #define BIO_TYPE_MD (8 | 0x0200)                /* passive filter */
 652 #define BIO_TYPE_BUFFER (9 | 0x0200)            /* filter */
 653 #define BIO_TYPE_CIPHER (10 | 0x0200)           /* filter */
 654 #define BIO_TYPE_BASE64 (11 | 0x0200)           /* filter */
 655 #define BIO_TYPE_CONNECT (12 | 0x0400 | 0x0100) /* socket - connect */
 656 #define BIO_TYPE_ACCEPT (13 | 0x0400 | 0x0100)  /* socket for accept */
 657 #define BIO_TYPE_PROXY_CLIENT (14 | 0x0200)     /* client proxy BIO */
 658 #define BIO_TYPE_PROXY_SERVER (15 | 0x0200)     /* server proxy BIO */
 659 #define BIO_TYPE_NBIO_TEST (16 | 0x0200)        /* server proxy BIO */
 660 #define BIO_TYPE_NULL_FILTER (17 | 0x0200)
 661 #define BIO_TYPE_BER (18 | 0x0200)        /* BER -> bin filter */
 662 #define BIO_TYPE_BIO (19 | 0x0400)        /* (half a) BIO pair */
 663 #define BIO_TYPE_LINEBUFFER (20 | 0x0200) /* filter */
 664 #define BIO_TYPE_DGRAM (21 | 0x0400 | 0x0100)
 665 #define BIO_TYPE_ASN1 (22 | 0x0200) /* filter */
 666 #define BIO_TYPE_COMP (23 | 0x0200) /* filter */
 667
 668 #define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */
 669 #define BIO_TYPE_FILTER 0x0200
 670 #define BIO_TYPE_SOURCE_SINK 0x0400
 671
 672 struct bio_method_st {
 673   int type;
 674   const char *name;
 675   int (*bwrite)(BIO *, const char *, int);
 676   int (*bread)(BIO *, char *, int);
 677   /* TODO(fork): remove bputs. */
 678   int (*bputs)(BIO *, const char *);
 679   int (*bgets)(BIO *, char *, int);
 680   long (*ctrl)(BIO *, int, long, void *);
 681   int (*create)(BIO *);
 682   int (*destroy)(BIO *);
 683   long (*callback_ctrl)(BIO *, int, bio_info_cb);
 684 };
 685
 686 struct bio_st {
 687   const BIO_METHOD *method;
 688   /* bio, mode, argp, argi, argl, ret */
 689   long (*callback)(struct bio_st *, int, const char *, int, long, long);
 690   char *cb_arg; /* first argument for the callback */
 691
 692   /* init is non-zero if this |BIO| has been initialised. */
 693   int init;
 694   /* shutdown is often used by specific |BIO_METHOD|s to determine whether
 695    * they own some underlying resource. This flag can often by controlled by
 696    * |BIO_set_close|. For example, whether an fd BIO closes the underlying fd
 697    * when it, itself, is closed. */
 698   int shutdown;
 699   int flags;
 700   int retry_reason;
 701   /* num is a BIO-specific value. For example, in fd BIOs it's used to store a
 702    * file descriptor. */
 703   int num;
 704   /* TODO(fork): reference counting is only used by the SSL BIO code. If we can
 705    * dump that then we can remove this. We could also drop
 706    * BIO_CTRL_PUSH/BIO_CTRL_POP. */
 707   int references;
 708   void *ptr;
 709   /* next_bio points to the next |BIO| in a chain. This |BIO| owns a reference
 710    * to |next_bio|. */
 711   struct bio_st *next_bio; /* used by filter BIOs */
 712   /* TODO(fork): either bring back BIO_number_read and write or remove these. */
 713   unsigned long num_read;
 714   unsigned long num_write;
 715
 716   CRYPTO_EX_DATA ex_data;
 717 };
 718
 719 #define BIO_C_SET_CONNECT                       100
 720 #define BIO_C_DO_STATE_MACHINE                  101
 721 #define BIO_C_SET_NBIO                          102
 722 #define BIO_C_SET_PROXY_PARAM                   103
 723 #define BIO_C_SET_FD                            104
 724 #define BIO_C_GET_FD                            105
 725 #define BIO_C_SET_FILE_PTR                      106
 726 #define BIO_C_GET_FILE_PTR                      107
 727 #define BIO_C_SET_FILENAME                      108
 728 #define BIO_C_SET_SSL                           109
 729 #define BIO_C_GET_SSL                           110
 730 #define BIO_C_SET_MD                            111
 731 #define BIO_C_GET_MD                            112
 732 #define BIO_C_GET_CIPHER_STATUS                 113
 733 #define BIO_C_SET_BUF_MEM                       114
 734 #define BIO_C_GET_BUF_MEM_PTR                   115
 735 #define BIO_C_GET_BUFF_NUM_LINES                116
 736 #define BIO_C_SET_BUFF_SIZE                     117
 737 #define BIO_C_SET_ACCEPT                        118
 738 #define BIO_C_SSL_MODE                          119
 739 #define BIO_C_GET_MD_CTX                        120
 740 #define BIO_C_GET_PROXY_PARAM                   121
 741 #define BIO_C_SET_BUFF_READ_DATA                122 /* data to read first */
 742 #define BIO_C_GET_CONNECT                       123
 743 #define BIO_C_GET_ACCEPT                        124
 744 #define BIO_C_SET_SSL_RENEGOTIATE_BYTES         125
 745 #define BIO_C_GET_SSL_NUM_RENEGOTIATES          126
 746 #define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT       127
 747 #define BIO_C_FILE_SEEK                         128
 748 #define BIO_C_GET_CIPHER_CTX                    129
 749 #define BIO_C_SET_BUF_MEM_EOF_RETURN            130/*return end of input value*/
 750 #define BIO_C_SET_BIND_MODE                     131
 751 #define BIO_C_GET_BIND_MODE                     132
 752 #define BIO_C_FILE_TELL                         133
 753 #define BIO_C_GET_SOCKS                         134
 754 #define BIO_C_SET_SOCKS                         135
 755
 756 #define BIO_C_SET_WRITE_BUF_SIZE                136/* for BIO_s_bio */
 757 #define BIO_C_GET_WRITE_BUF_SIZE                137
 758 #define BIO_C_GET_WRITE_GUARANTEE               140
 759 #define BIO_C_GET_READ_REQUEST                  141
 760 #define BIO_C_SHUTDOWN_WR                       142
 761 #define BIO_C_NREAD0                            143
 762 #define BIO_C_NREAD                             144
 763 #define BIO_C_NWRITE0                           145
 764 #define BIO_C_NWRITE                            146
 765 #define BIO_C_RESET_READ_REQUEST                147
 766 #define BIO_C_SET_MD_CTX                        148
 767
 768 #define BIO_C_SET_PREFIX                        149
 769 #define BIO_C_GET_PREFIX                        150
 770 #define BIO_C_SET_SUFFIX                        151
 771 #define BIO_C_GET_SUFFIX                        152
 772
 773 #define BIO_C_SET_EX_ARG                        153
 774 #define BIO_C_GET_EX_ARG                        154
 775
 776
 777 #if defined(__cplusplus)
 778 }  /* extern C */
 779 #endif
 780
 781 #define BIO_F_bio_make_pair 100
 782 #define BIO_F_bio_ctrl 101
 783 #define BIO_F_buffer_ctrl 102
 784 #define BIO_F_BIO_new_file 103
 785 #define BIO_F_file_read 104
 786 #define BIO_F_BIO_new 105
 787 #define BIO_F_bio_io 106
 788 #define BIO_F_BIO_new_mem_buf 107
 789 #define BIO_F_mem_write 108
 790 #define BIO_F_conn_state 109
 791 #define BIO_F_conn_ctrl 110
 792 #define BIO_F_file_ctrl 111
 793 #define BIO_F_BIO_callback_ctrl 112
 794 #define BIO_F_bio_ip_and_port_to_socket_and_addr 113
 795 #define BIO_F_bio_write 114
 796 #define BIO_F_BIO_ctrl 115
 797 #define BIO_R_UNSUPPORTED_METHOD 100
 798 #define BIO_R_NO_PORT_SPECIFIED 101
 799 #define BIO_R_NO_HOSTNAME_SPECIFIED 102
 800 #define BIO_R_IN_USE 103
 801 #define BIO_R_UNINITIALIZED 104
 802 #define BIO_R_CONNECT_ERROR 105
 803 #define BIO_R_KEEPALIVE 106
 804 #define BIO_R_BROKEN_PIPE 107
 805 #define BIO_R_NBIO_CONNECT_ERROR 108
 806 #define BIO_R_BAD_FOPEN_MODE 109
 807 #define BIO_R_ASN1_OBJECT_TOO_LONG 110
 808 #define BIO_R_INVALID_ARGUMENT 111
 809 #define BIO_R_WRITE_TO_READ_ONLY_BIO 112
 810 #define BIO_R_ERROR_SETTING_NBIO 113
 811 #define BIO_R_SYS_LIB 114
 812 #define BIO_R_NO_SUCH_FILE 115
 813 #define BIO_R_NULL_PARAMETER 116
 814 #define BIO_R_UNABLE_TO_CREATE_SOCKET 117
 815
 816 #endif  /* OPENSSL_HEADER_BIO_H */