1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young (eay (at) 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 (at) 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 (at) 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 (at) 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_ctrl_pending calls |BIO_pending| and exists only for compatibility with 239 * OpenSSL. */ 240 OPENSSL_EXPORT size_t BIO_ctrl_pending(const BIO *bio); 241 242 /* BIO_wpending returns the number of bytes pending to be written. */ 243 OPENSSL_EXPORT size_t BIO_wpending(const BIO *bio); 244 245 /* BIO_set_close sets the close flag for |bio|. The meaning of which depends on 246 * the type of |bio| but, for example, a memory BIO interprets the close flag 247 * as meaning that it owns its buffer. It returns one on success and zero 248 * otherwise. */ 249 OPENSSL_EXPORT int BIO_set_close(BIO *bio, int close_flag); 250 251 /* BIO_set_callback sets a callback function that will be called before and 252 * after most operations. See the comment above |bio_info_cb|. */ 253 OPENSSL_EXPORT void BIO_set_callback(BIO *bio, bio_info_cb callback_func); 254 255 /* BIO_set_callback_arg sets the opaque pointer value that can be read within a 256 * callback with |BIO_get_callback_arg|. */ 257 OPENSSL_EXPORT void BIO_set_callback_arg(BIO *bio, char *arg); 258 259 /* BIO_get_callback_arg returns the last value of the opaque callback pointer 260 * set by |BIO_set_callback_arg|. */ 261 OPENSSL_EXPORT char *BIO_get_callback_arg(const BIO *bio); 262 263 /* BIO_number_read returns the number of bytes that have been read from 264 * |bio|. */ 265 OPENSSL_EXPORT size_t BIO_number_read(const BIO *bio); 266 267 /* BIO_number_written returns the number of bytes that have been written to 268 * |bio|. */ 269 OPENSSL_EXPORT size_t BIO_number_written(const BIO *bio); 270 271 272 /* Managing chains of BIOs. 273 * 274 * BIOs can be put into chains where the output of one is used as the input of 275 * the next etc. The most common case is a buffering BIO, which accepts and 276 * buffers writes until flushed into the next BIO in the chain. */ 277 278 /* BIO_push adds |appended_bio| to the end of the chain with |bio| at the head. 279 * It returns |bio|. Note that |appended_bio| may be the head of a chain itself 280 * and thus this function can be used to join two chains. 281 * 282 * BIO_push takes ownership of the caller's reference to |appended_bio|. */ 283 OPENSSL_EXPORT BIO *BIO_push(BIO *bio, BIO *appended_bio); 284 285 /* BIO_pop removes |bio| from the head of a chain and returns the next BIO in 286 * the chain, or NULL if there is no next BIO. 287 * 288 * The caller takes ownership of the chain's reference to |bio|. */ 289 OPENSSL_EXPORT BIO *BIO_pop(BIO *bio); 290 291 /* BIO_next returns the next BIO in the chain after |bio|, or NULL if there is 292 * no such BIO. */ 293 OPENSSL_EXPORT BIO *BIO_next(BIO *bio); 294 295 /* BIO_free_all calls |BIO_free|. 296 * 297 * TODO(fork): update callers and remove. */ 298 OPENSSL_EXPORT void BIO_free_all(BIO *bio); 299 300 /* BIO_find_type walks a chain of BIOs and returns the first that matches 301 * |type|, which is one of the |BIO_TYPE_*| values. */ 302 OPENSSL_EXPORT BIO *BIO_find_type(BIO *bio, int type); 303 304 /* BIO_copy_next_retry sets the retry flags and |retry_reason| of |bio| from 305 * the next BIO in the chain. */ 306 OPENSSL_EXPORT void BIO_copy_next_retry(BIO *bio); 307 308 309 /* Printf functions. 310 * 311 * These functions are versions of printf functions that output to a BIO rather 312 * than a FILE. */ 313 #ifdef __GNUC__ 314 #define __bio_h__attr__ __attribute__ 315 #else 316 #define __bio_h__attr__(x) 317 #endif 318 OPENSSL_EXPORT int BIO_printf(BIO *bio, const char *format, ...) 319 __bio_h__attr__((__format__(__printf__, 2, 3))); 320 #undef __bio_h__attr__ 321 322 323 /* Utility functions. */ 324 325 /* BIO_indent prints min(|indent|, |max_indent|) spaces. It returns one on 326 * success and zero otherwise. */ 327 OPENSSL_EXPORT int BIO_indent(BIO *bio, unsigned indent, unsigned max_indent); 328 329 /* BIO_hexdump writes a hex dump of |data| to |bio|. Each line will be indented 330 * by |indent| spaces. */ 331 OPENSSL_EXPORT int BIO_hexdump(BIO *bio, const uint8_t *data, size_t len, 332 unsigned indent); 333 334 /* BIO_print_errors_fp prints the current contents of the error stack to |out| 335 * using human readable strings where possible. */ 336 OPENSSL_EXPORT void BIO_print_errors_fp(FILE *out); 337 338 /* BIO_print_errors prints the current contents of the error stack to |bio| 339 * using human readable strings where possible. */ 340 OPENSSL_EXPORT void BIO_print_errors(BIO *bio); 341 342 343 /* Memory BIOs. 344 * 345 * Memory BIOs can be used as a read-only source (with |BIO_new_mem_buf|) or a 346 * writable sink (with |BIO_new|, |BIO_s_mem| and |BIO_get_mem_buf|). Data 347 * written to a writable, memory BIO can be recalled by reading from it. 348 * 349 * Calling |BIO_reset| on a read-only BIO resets it to the original contents. 350 * On a writable BIO, it clears any data. 351 * 352 * If the close flag is set to |BIO_NOCLOSE| (not the default) then the 353 * underlying |BUF_MEM| will not be freed when the |BIO| is freed. 354 * 355 * Memory BIOs support |BIO_gets| and |BIO_puts|. 356 * 357 * |BIO_eof| is true if no data is in the BIO. 358 * 359 * |BIO_ctrl_pending| returns the number of bytes currently stored. */ 360 361 /* BIO_s_mem returns a |BIO_METHOD| that uses a in-memory buffer. */ 362 OPENSSL_EXPORT const BIO_METHOD *BIO_s_mem(void); 363 364 /* BIO_new_mem_buf creates BIO that reads and writes from |len| bytes at |buf|. 365 * It does not take ownership of |buf|. It returns the BIO or NULL on error. 366 * 367 * If |len| is negative, then |buf| is treated as a NUL-terminated string, but 368 * don't depend on this in new code. */ 369 OPENSSL_EXPORT BIO *BIO_new_mem_buf(void *buf, int len); 370 371 /* BIO_mem_contents sets |*out_contents| to point to the current contents of 372 * |bio| and |*out_len| to contain the length of that data. It returns one on 373 * success and zero otherwise. */ 374 OPENSSL_EXPORT int BIO_mem_contents(const BIO *bio, 375 const uint8_t **out_contents, 376 size_t *out_len); 377 378 /* BIO_get_mem_data sets |*contents| to point to the current contents of |bio| 379 * and returns the length of the data. 380 * 381 * WARNING: don't use this, use |BIO_mem_contents|. A return value of zero from 382 * this function can mean either that it failed or that the memory buffer is 383 * empty. */ 384 OPENSSL_EXPORT long BIO_get_mem_data(BIO *bio, char **contents); 385 386 /* BIO_get_mem_ptr sets |*out| to a BUF_MEM containing the current contents of 387 * |bio|. It returns one on success or zero on error. */ 388 OPENSSL_EXPORT int BIO_get_mem_ptr(BIO *bio, BUF_MEM **out); 389 390 /* BIO_set_mem_buf sets |b| as the contents of |bio|. If |take_ownership| is 391 * non-zero, then |b| will be freed when |bio| is closed. Returns one on 392 * success or zero otherwise. */ 393 OPENSSL_EXPORT int BIO_set_mem_buf(BIO *bio, BUF_MEM *b, int take_ownership); 394 395 /* BIO_set_mem_eof_return sets the value that will be returned from reading 396 * |bio| when empty. If |eof_value| is zero then an empty memory BIO will 397 * return EOF (that is it will return zero and |BIO_should_retry| will be 398 * false). If |eof_value| is non zero then it will return |eof_value| when it 399 * is empty and it will set the read retry flag (that is |BIO_read_retry| is 400 * true). To avoid ambiguity with a normal positive return value, |eof_value| 401 * should be set to a negative value, typically -1. 402 * 403 * For a read-only BIO, the default is zero (EOF). For a writable BIO, the 404 * default is -1 so that additional data can be written once exhausted. */ 405 OPENSSL_EXPORT int BIO_set_mem_eof_return(BIO *bio, int eof_value); 406 407 408 /* File descriptor BIOs. 409 * 410 * File descriptor BIOs are wrappers around the system's |read| and |write| 411 * functions. If the close flag is set then then |close| is called on the 412 * underlying file descriptor when the BIO is freed. 413 * 414 * |BIO_reset| attempts to seek the file pointer to the start of file using 415 * |lseek|. 416 * 417 * |BIO_seek| sets the file pointer to position |off| from start of file using 418 * |lseek|. 419 * 420 * |BIO_tell| returns the current file position. */ 421 422 /* BIO_s_fd returns a |BIO_METHOD| for file descriptor fds. */ 423 OPENSSL_EXPORT const BIO_METHOD *BIO_s_fd(void); 424 425 /* BIO_new_fd creates a new file descriptor BIO wrapping |fd|. If |close_flag| 426 * is non-zero, then |fd| will be closed when the BIO is. */ 427 OPENSSL_EXPORT BIO *BIO_new_fd(int fd, int close_flag); 428 429 /* BIO_set_fd sets the file descriptor of |bio| to |fd|. If |close_flag| is 430 * non-zero then |fd| will be closed when |bio| is. It returns one on success 431 * or zero on error. */ 432 OPENSSL_EXPORT int BIO_set_fd(BIO *bio, int fd, int close_flag); 433 434 /* BIO_get_fd sets |*out_fd| to the file descriptor currently in use by |bio|. 435 * It returns one on success and zero on error. */ 436 OPENSSL_EXPORT int BIO_get_fd(BIO *bio, int *out_fd); 437 438 439 /* File BIOs. 440 * 441 * File BIOs are wrappers around a C |FILE| object. 442 * 443 * |BIO_flush| on a file BIO calls |fflush| on the wrapped stream. 444 * 445 * |BIO_reset| attempts to seek the file pointer to the start of file using 446 * |fseek|. 447 * 448 * |BIO_seek| sets the file pointer to the given position from the start of 449 * file using |fseek|. 450 * 451 * |BIO_eof| calls |feof|. 452 * 453 * Setting the close flag causes |fclose| to be called on the stream when the 454 * BIO is freed. */ 455 456 /* BIO_s_file returns a BIO_METHOD that wraps a |FILE|. */ 457 OPENSSL_EXPORT const BIO_METHOD *BIO_s_file(void); 458 459 /* BIO_new_file creates a file BIO by opening |filename| with the given mode. 460 * See the |fopen| manual page for details of the mode argument. */ 461 OPENSSL_EXPORT BIO *BIO_new_file(const char *filename, const char *mode); 462 463 /* BIO_new_fp creates a new file BIO that wraps the given |FILE|. If 464 * |close_flag| is |BIO_CLOSE|, then |fclose| will be called on |stream| when 465 * the BIO is closed. */ 466 OPENSSL_EXPORT BIO *BIO_new_fp(FILE *stream, int close_flag); 467 468 /* BIO_get_fp sets |*out_file| to the current |FILE| for |bio|. It returns one 469 * on success and zero otherwise. */ 470 OPENSSL_EXPORT int BIO_get_fp(BIO *bio, FILE **out_file); 471 472 /* BIO_set_fp sets the |FILE| for |bio|. If |close_flag| is |BIO_CLOSE| then 473 * |fclose| will be called on |file| when |bio| is closed. It returns one on 474 * sucess and zero otherwise. */ 475 OPENSSL_EXPORT int BIO_set_fp(BIO *bio, FILE *file, int close_flag); 476 477 /* BIO_read_filename opens |filename| for reading and sets the result as the 478 * |FILE| for |bio|. It returns one on success and zero otherwise. The |FILE| 479 * will be closed when |bio| is freed. */ 480 OPENSSL_EXPORT int BIO_read_filename(BIO *bio, const char *filename); 481 482 /* BIO_write_filename opens |filename| for writing and sets the result as the 483 * |FILE| for |bio|. It returns one on success and zero otherwise. The |FILE| 484 * will be closed when |bio| is freed. */ 485 OPENSSL_EXPORT int BIO_write_filename(BIO *bio, const char *filename); 486 487 /* BIO_append_filename opens |filename| for appending and sets the result as 488 * the |FILE| for |bio|. It returns one on success and zero otherwise. The 489 * |FILE| will be closed when |bio| is freed. */ 490 OPENSSL_EXPORT int BIO_append_filename(BIO *bio, const char *filename); 491 492 /* BIO_rw_filename opens |filename| for reading and writing and sets the result 493 * as the |FILE| for |bio|. It returns one on success and zero otherwise. The 494 * |FILE| will be closed when |bio| is freed. */ 495 OPENSSL_EXPORT int BIO_rw_filename(BIO *bio, const char *filename); 496 497 498 /* Buffer BIOs. 499 * 500 * Buffer BIOs are a filter-type BIO, i.e. they are designed to be used in a 501 * chain of BIOs. They provide buffering to reduce the number of operations on 502 * the underlying BIOs. */ 503 504 OPENSSL_EXPORT const BIO_METHOD *BIO_f_buffer(void); 505 506 /* BIO_set_read_buffer_size sets the size, in bytes, of the read buffer and 507 * clears it. It returns one on success and zero on failure. */ 508 OPENSSL_EXPORT int BIO_set_read_buffer_size(BIO *bio, int buffer_size); 509 510 /* BIO_set_write_buffer_size sets the size, in bytes, of the write buffer and 511 * clears it. It returns one on success and zero on failure. */ 512 OPENSSL_EXPORT int BIO_set_write_buffer_size(BIO *bio, int buffer_size); 513 514 515 /* Socket BIOs. */ 516 517 OPENSSL_EXPORT const BIO_METHOD *BIO_s_socket(void); 518 519 /* BIO_new_socket allocates and initialises a fresh BIO which will read and 520 * write to the socket |fd|. If |close_flag| is |BIO_CLOSE| then closing the 521 * BIO will close |fd|. It returns the fresh |BIO| or NULL on error. */ 522 OPENSSL_EXPORT BIO *BIO_new_socket(int fd, int close_flag); 523 524 525 /* Connect BIOs. 526 * 527 * A connection BIO creates a network connection and transfers data over the 528 * resulting socket. */ 529 530 OPENSSL_EXPORT const BIO_METHOD *BIO_s_connect(void); 531 532 /* BIO_new_connect returns a BIO that connects to the given hostname and port. 533 * The |host_and_optional_port| argument should be of the form 534 * "www.example.com" or "www.example.com:443". If the port is omitted, it must 535 * be provided with |BIO_set_conn_port|. 536 * 537 * It returns the new BIO on success, or NULL on error. */ 538 OPENSSL_EXPORT BIO *BIO_new_connect(const char *host_and_optional_port); 539 540 /* BIO_set_conn_hostname sets |host_and_optional_port| as the hostname and 541 * optional port that |bio| will connect to. If the port is omitted, it must be 542 * provided with |BIO_set_conn_port|. 543 * 544 * It returns one on success and zero otherwise. */ 545 OPENSSL_EXPORT int BIO_set_conn_hostname(BIO *bio, 546 const char *host_and_optional_port); 547 548 /* BIO_set_conn_port sets |port_str| as the port or service name that |bio| 549 * will connect to. It returns one on success and zero otherwise. */ 550 OPENSSL_EXPORT int BIO_set_conn_port(BIO *bio, const char *port_str); 551 552 /* BIO_set_nbio sets whether |bio| will use non-blocking I/O operations. It 553 * returns one on success and zero otherwise. */ 554 OPENSSL_EXPORT int BIO_set_nbio(BIO *bio, int on); 555 556 557 /* Datagram BIOs. 558 * 559 * TODO(fork): not implemented. */ 560 561 #define BIO_CTRL_DGRAM_QUERY_MTU 40 /* as kernel for current MTU */ 562 563 #define BIO_CTRL_DGRAM_SET_MTU 42 /* set cached value for MTU. want to use 564 this if asking the kernel fails */ 565 566 #define BIO_CTRL_DGRAM_MTU_EXCEEDED 43 /* check whether the MTU was exceed in 567 the previous write operation. */ 568 569 #define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT \ 570 45 /* Next DTLS handshake timeout to adjust socket timeouts */ 571 572 #define BIO_CTRL_DGRAM_GET_PEER 46 573 574 #define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47 575 576 577 /* BIO Pairs. 578 * 579 * BIO pairs provide a "loopback" like system: a pair of BIOs where data 580 * written to one can be read from the other and vice versa. */ 581 582 /* BIO_new_bio_pair sets |*out1| and |*out2| to two freshly created BIOs where 583 * data written to one can be read from the other and vice versa. The 584 * |writebuf1| argument gives the size of the buffer used in |*out1| and 585 * |writebuf2| for |*out2|. It returns one on success and zero on error. */ 586 OPENSSL_EXPORT int BIO_new_bio_pair(BIO **out1, size_t writebuf1, BIO **out2, 587 size_t writebuf2); 588 589 /* BIO_s_bio returns the method for a BIO pair. */ 590 OPENSSL_EXPORT const BIO_METHOD *BIO_s_bio(void); 591 592 /* BIO_ctrl_get_read_request returns the number of bytes that the other side of 593 * |bio| tried (unsuccessfully) to read. */ 594 OPENSSL_EXPORT size_t BIO_ctrl_get_read_request(BIO *bio); 595 596 /* BIO_ctrl_get_write_guarantee returns the number of bytes that |bio| (which 597 * must have been returned by |BIO_new_bio_pair|) will accept on the next 598 * |BIO_write| call. */ 599 OPENSSL_EXPORT size_t BIO_ctrl_get_write_guarantee(BIO *bio); 600 601 /* BIO_shutdown_wr marks |bio| as closed, from the point of view of the other 602 * side of the pair. Future |BIO_write| calls on |bio| will fail. It returns 603 * one on success and zero otherwise. */ 604 OPENSSL_EXPORT int BIO_shutdown_wr(BIO *bio); 605 606 607 /* BIO_NOCLOSE and |BIO_CLOSE| can be used as symbolic arguments when a "close 608 * flag" is passed to a BIO function. */ 609 #define BIO_NOCLOSE 0 610 #define BIO_CLOSE 1 611 612 /* These are passed to the BIO callback */ 613 #define BIO_CB_FREE 0x01 614 #define BIO_CB_READ 0x02 615 #define BIO_CB_WRITE 0x03 616 #define BIO_CB_PUTS 0x04 617 #define BIO_CB_GETS 0x05 618 #define BIO_CB_CTRL 0x06 619 620 /* The callback is called before and after the underling operation, 621 * The BIO_CB_RETURN flag indicates if it is after the call */ 622 #define BIO_CB_RETURN 0x80 623 624 /* These are values of the |cmd| argument to |BIO_ctrl|. */ 625 #define BIO_CTRL_RESET 1 /* opt - rewind/zero etc */ 626 #define BIO_CTRL_EOF 2 /* opt - are we at the eof */ 627 #define BIO_CTRL_INFO 3 /* opt - extra tit-bits */ 628 #define BIO_CTRL_SET 4 /* man - set the 'IO' type */ 629 #define BIO_CTRL_GET 5 /* man - get the 'IO' type */ 630 #define BIO_CTRL_PUSH 6 /* opt - internal, used to signify change */ 631 #define BIO_CTRL_POP 7 /* opt - internal, used to signify change */ 632 #define BIO_CTRL_GET_CLOSE 8 /* man - set the 'close' on free */ 633 #define BIO_CTRL_SET_CLOSE 9 /* man - set the 'close' on free */ 634 #define BIO_CTRL_PENDING 10 /* opt - is their more data buffered */ 635 #define BIO_CTRL_FLUSH 11 /* opt - 'flush' buffered output */ 636 #define BIO_CTRL_WPENDING 13 /* opt - number of bytes still to write */ 637 /* callback is int cb(BIO *bio,state,ret); */ 638 #define BIO_CTRL_SET_CALLBACK 14 /* opt - set callback function */ 639 #define BIO_CTRL_GET_CALLBACK 15 /* opt - set callback function */ 640 #define BIO_CTRL_SET_FILENAME 30 /* BIO_s_file special */ 641 642 643 /* Private functions */ 644 645 #define BIO_FLAGS_READ 0x01 646 #define BIO_FLAGS_WRITE 0x02 647 #define BIO_FLAGS_IO_SPECIAL 0x04 648 #define BIO_FLAGS_RWS (BIO_FLAGS_READ | BIO_FLAGS_WRITE | BIO_FLAGS_IO_SPECIAL) 649 #define BIO_FLAGS_SHOULD_RETRY 0x08 650 #define BIO_FLAGS_BASE64_NO_NL 0x100 651 /* This is used with memory BIOs: it means we shouldn't free up or change the 652 * data in any way. */ 653 #define BIO_FLAGS_MEM_RDONLY 0x200 654 655 /* These are the 'types' of BIOs */ 656 #define BIO_TYPE_NONE 0 657 #define BIO_TYPE_MEM (1 | 0x0400) 658 #define BIO_TYPE_FILE (2 | 0x0400) 659 #define BIO_TYPE_FD (4 | 0x0400 | 0x0100) 660 #define BIO_TYPE_SOCKET (5 | 0x0400 | 0x0100) 661 #define BIO_TYPE_NULL (6 | 0x0400) 662 #define BIO_TYPE_SSL (7 | 0x0200) 663 #define BIO_TYPE_MD (8 | 0x0200) /* passive filter */ 664 #define BIO_TYPE_BUFFER (9 | 0x0200) /* filter */ 665 #define BIO_TYPE_CIPHER (10 | 0x0200) /* filter */ 666 #define BIO_TYPE_BASE64 (11 | 0x0200) /* filter */ 667 #define BIO_TYPE_CONNECT (12 | 0x0400 | 0x0100) /* socket - connect */ 668 #define BIO_TYPE_ACCEPT (13 | 0x0400 | 0x0100) /* socket for accept */ 669 #define BIO_TYPE_PROXY_CLIENT (14 | 0x0200) /* client proxy BIO */ 670 #define BIO_TYPE_PROXY_SERVER (15 | 0x0200) /* server proxy BIO */ 671 #define BIO_TYPE_NBIO_TEST (16 | 0x0200) /* server proxy BIO */ 672 #define BIO_TYPE_NULL_FILTER (17 | 0x0200) 673 #define BIO_TYPE_BER (18 | 0x0200) /* BER -> bin filter */ 674 #define BIO_TYPE_BIO (19 | 0x0400) /* (half a) BIO pair */ 675 #define BIO_TYPE_LINEBUFFER (20 | 0x0200) /* filter */ 676 #define BIO_TYPE_DGRAM (21 | 0x0400 | 0x0100) 677 #define BIO_TYPE_ASN1 (22 | 0x0200) /* filter */ 678 #define BIO_TYPE_COMP (23 | 0x0200) /* filter */ 679 680 #define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */ 681 #define BIO_TYPE_FILTER 0x0200 682 #define BIO_TYPE_SOURCE_SINK 0x0400 683 684 struct bio_method_st { 685 int type; 686 const char *name; 687 int (*bwrite)(BIO *, const char *, int); 688 int (*bread)(BIO *, char *, int); 689 /* TODO(fork): remove bputs. */ 690 int (*bputs)(BIO *, const char *); 691 int (*bgets)(BIO *, char *, int); 692 long (*ctrl)(BIO *, int, long, void *); 693 int (*create)(BIO *); 694 int (*destroy)(BIO *); 695 long (*callback_ctrl)(BIO *, int, bio_info_cb); 696 }; 697 698 struct bio_st { 699 const BIO_METHOD *method; 700 /* bio, mode, argp, argi, argl, ret */ 701 long (*callback)(struct bio_st *, int, const char *, int, long, long); 702 char *cb_arg; /* first argument for the callback */ 703 704 /* init is non-zero if this |BIO| has been initialised. */ 705 int init; 706 /* shutdown is often used by specific |BIO_METHOD|s to determine whether 707 * they own some underlying resource. This flag can often by controlled by 708 * |BIO_set_close|. For example, whether an fd BIO closes the underlying fd 709 * when it, itself, is closed. */ 710 int shutdown; 711 int flags; 712 int retry_reason; 713 /* num is a BIO-specific value. For example, in fd BIOs it's used to store a 714 * file descriptor. */ 715 int num; 716 /* TODO(fork): reference counting is only used by the SSL BIO code. If we can 717 * dump that then we can remove this. We could also drop 718 * BIO_CTRL_PUSH/BIO_CTRL_POP. */ 719 int references; 720 void *ptr; 721 /* next_bio points to the next |BIO| in a chain. This |BIO| owns a reference 722 * to |next_bio|. */ 723 struct bio_st *next_bio; /* used by filter BIOs */ 724 size_t num_read, num_write; 725 726 CRYPTO_EX_DATA ex_data; 727 }; 728 729 #define BIO_C_SET_CONNECT 100 730 #define BIO_C_DO_STATE_MACHINE 101 731 #define BIO_C_SET_NBIO 102 732 #define BIO_C_SET_PROXY_PARAM 103 733 #define BIO_C_SET_FD 104 734 #define BIO_C_GET_FD 105 735 #define BIO_C_SET_FILE_PTR 106 736 #define BIO_C_GET_FILE_PTR 107 737 #define BIO_C_SET_FILENAME 108 738 #define BIO_C_SET_SSL 109 739 #define BIO_C_GET_SSL 110 740 #define BIO_C_SET_MD 111 741 #define BIO_C_GET_MD 112 742 #define BIO_C_GET_CIPHER_STATUS 113 743 #define BIO_C_SET_BUF_MEM 114 744 #define BIO_C_GET_BUF_MEM_PTR 115 745 #define BIO_C_GET_BUFF_NUM_LINES 116 746 #define BIO_C_SET_BUFF_SIZE 117 747 #define BIO_C_SET_ACCEPT 118 748 #define BIO_C_SSL_MODE 119 749 #define BIO_C_GET_MD_CTX 120 750 #define BIO_C_GET_PROXY_PARAM 121 751 #define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */ 752 #define BIO_C_GET_CONNECT 123 753 #define BIO_C_GET_ACCEPT 124 754 #define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125 755 #define BIO_C_GET_SSL_NUM_RENEGOTIATES 126 756 #define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127 757 #define BIO_C_FILE_SEEK 128 758 #define BIO_C_GET_CIPHER_CTX 129 759 #define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/ 760 #define BIO_C_SET_BIND_MODE 131 761 #define BIO_C_GET_BIND_MODE 132 762 #define BIO_C_FILE_TELL 133 763 #define BIO_C_GET_SOCKS 134 764 #define BIO_C_SET_SOCKS 135 765 766 #define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */ 767 #define BIO_C_GET_WRITE_BUF_SIZE 137 768 #define BIO_C_GET_WRITE_GUARANTEE 140 769 #define BIO_C_GET_READ_REQUEST 141 770 #define BIO_C_SHUTDOWN_WR 142 771 #define BIO_C_NREAD0 143 772 #define BIO_C_NREAD 144 773 #define BIO_C_NWRITE0 145 774 #define BIO_C_NWRITE 146 775 #define BIO_C_RESET_READ_REQUEST 147 776 #define BIO_C_SET_MD_CTX 148 777 778 #define BIO_C_SET_PREFIX 149 779 #define BIO_C_GET_PREFIX 150 780 #define BIO_C_SET_SUFFIX 151 781 #define BIO_C_GET_SUFFIX 152 782 783 #define BIO_C_SET_EX_ARG 153 784 #define BIO_C_GET_EX_ARG 154 785 786 787 #if defined(__cplusplus) 788 } /* extern C */ 789 #endif 790 791 #define BIO_F_bio_make_pair 100 792 #define BIO_F_bio_ctrl 101 793 #define BIO_F_buffer_ctrl 102 794 #define BIO_F_BIO_new_file 103 795 #define BIO_F_file_read 104 796 #define BIO_F_BIO_new 105 797 #define BIO_F_bio_io 106 798 #define BIO_F_BIO_new_mem_buf 107 799 #define BIO_F_mem_write 108 800 #define BIO_F_conn_state 109 801 #define BIO_F_conn_ctrl 110 802 #define BIO_F_file_ctrl 111 803 #define BIO_F_BIO_callback_ctrl 112 804 #define BIO_F_bio_ip_and_port_to_socket_and_addr 113 805 #define BIO_F_bio_write 114 806 #define BIO_F_BIO_ctrl 115 807 #define BIO_R_UNSUPPORTED_METHOD 100 808 #define BIO_R_NO_PORT_SPECIFIED 101 809 #define BIO_R_NO_HOSTNAME_SPECIFIED 102 810 #define BIO_R_IN_USE 103 811 #define BIO_R_UNINITIALIZED 104 812 #define BIO_R_CONNECT_ERROR 105 813 #define BIO_R_KEEPALIVE 106 814 #define BIO_R_BROKEN_PIPE 107 815 #define BIO_R_NBIO_CONNECT_ERROR 108 816 #define BIO_R_BAD_FOPEN_MODE 109 817 #define BIO_R_ASN1_OBJECT_TOO_LONG 110 818 #define BIO_R_INVALID_ARGUMENT 111 819 #define BIO_R_WRITE_TO_READ_ONLY_BIO 112 820 #define BIO_R_ERROR_SETTING_NBIO 113 821 #define BIO_R_SYS_LIB 114 822 #define BIO_R_NO_SUCH_FILE 115 823 #define BIO_R_NULL_PARAMETER 116 824 #define BIO_R_UNABLE_TO_CREATE_SOCKET 117 825 826 #endif /* OPENSSL_HEADER_BIO_H */ 827
