1/* crypto/bio/bio.h */ 2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 3 * All rights reserved. 4 * 5 * This package is an SSL implementation written 6 * by Eric Young (eay@cryptsoft.com). 7 * The implementation was written so as to conform with Netscapes SSL. 8 * 9 * This library is free for commercial and non-commercial use as long as 10 * the following conditions are aheared to. The following conditions 11 * apply to all code found in this distribution, be it the RC4, RSA, 12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 13 * included with this distribution is covered by the same copyright terms 14 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 15 * 16 * Copyright remains Eric Young's, and as such any Copyright notices in 17 * the code are not to be removed. 18 * If this package is used in a product, Eric Young should be given attribution 19 * as the author of the parts of the library used. 20 * This can be in the form of a textual message at program startup or 21 * in documentation (online or textual) provided with the package. 22 * 23 * Redistribution and use in source and binary forms, with or without 24 * modification, are permitted provided that the following conditions 25 * are met: 26 * 1. Redistributions of source code must retain the copyright 27 * notice, this list of conditions and the following disclaimer. 28 * 2. Redistributions in binary form must reproduce the above copyright 29 * notice, this list of conditions and the following disclaimer in the 30 * documentation and/or other materials provided with the distribution. 31 * 3. All advertising materials mentioning features or use of this software 32 * must display the following acknowledgement: 33 * "This product includes cryptographic software written by 34 * Eric Young (eay@cryptsoft.com)" 35 * The word 'cryptographic' can be left out if the rouines from the library 36 * being used are not cryptographic related :-). 37 * 4. If you include any Windows specific code (or a derivative thereof) from 38 * the apps directory (application code) you must include an acknowledgement: 39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 40 * 41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 51 * SUCH DAMAGE. 52 * 53 * The licence and distribution terms for any publically available version or 54 * derivative of this code cannot be changed. i.e. this code cannot simply be 55 * copied and put under another distribution licence 56 * [including the GNU Public Licence.] 57 */ 58 59#ifndef HEADER_BIO_H 60#define HEADER_BIO_H 61 62#include <openssl/e_os2.h> 63 64#ifndef OPENSSL_NO_FP_API 65# include <stdio.h> 66#endif 67#include <stdarg.h> 68 69#include <openssl/crypto.h> 70 71#ifndef OPENSSL_NO_SCTP 72# ifndef OPENSSL_SYS_VMS 73# include <stdint.h> 74# else 75# include <inttypes.h> 76# endif 77#endif 78 79#ifdef __cplusplus 80extern "C" { 81#endif 82 83/* These are the 'types' of BIOs */ 84#define BIO_TYPE_NONE 0 85#define BIO_TYPE_MEM (1|0x0400) 86#define BIO_TYPE_FILE (2|0x0400) 87 88#define BIO_TYPE_FD (4|0x0400|0x0100) 89#define BIO_TYPE_SOCKET (5|0x0400|0x0100) 90#define BIO_TYPE_NULL (6|0x0400) 91#define BIO_TYPE_SSL (7|0x0200) 92#define BIO_TYPE_MD (8|0x0200) /* passive filter */ 93#define BIO_TYPE_BUFFER (9|0x0200) /* filter */ 94#define BIO_TYPE_CIPHER (10|0x0200) /* filter */ 95#define BIO_TYPE_BASE64 (11|0x0200) /* filter */ 96#define BIO_TYPE_CONNECT (12|0x0400|0x0100) /* socket - connect */ 97#define BIO_TYPE_ACCEPT (13|0x0400|0x0100) /* socket for accept */ 98#define BIO_TYPE_PROXY_CLIENT (14|0x0200) /* client proxy BIO */ 99#define BIO_TYPE_PROXY_SERVER (15|0x0200) /* server proxy BIO */ 100#define BIO_TYPE_NBIO_TEST (16|0x0200) /* server proxy BIO */ 101#define BIO_TYPE_NULL_FILTER (17|0x0200) 102#define BIO_TYPE_BER (18|0x0200) /* BER -> bin filter */ 103#define BIO_TYPE_BIO (19|0x0400) /* (half a) BIO pair */ 104#define BIO_TYPE_LINEBUFFER (20|0x0200) /* filter */ 105#define BIO_TYPE_DGRAM (21|0x0400|0x0100) 106#ifndef OPENSSL_NO_SCTP 107#define BIO_TYPE_DGRAM_SCTP (24|0x0400|0x0100) 108#endif 109#define BIO_TYPE_ASN1 (22|0x0200) /* filter */ 110#define BIO_TYPE_COMP (23|0x0200) /* filter */ 111 112#define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */ 113#define BIO_TYPE_FILTER 0x0200 114#define BIO_TYPE_SOURCE_SINK 0x0400 115 116/* BIO_FILENAME_READ|BIO_CLOSE to open or close on free. 117 * BIO_set_fp(in,stdin,BIO_NOCLOSE); */ 118#define BIO_NOCLOSE 0x00 119#define BIO_CLOSE 0x01 120 121/* These are used in the following macros and are passed to 122 * BIO_ctrl() */ 123#define BIO_CTRL_RESET 1 /* opt - rewind/zero etc */ 124#define BIO_CTRL_EOF 2 /* opt - are we at the eof */ 125#define BIO_CTRL_INFO 3 /* opt - extra tit-bits */ 126#define BIO_CTRL_SET 4 /* man - set the 'IO' type */ 127#define BIO_CTRL_GET 5 /* man - get the 'IO' type */ 128#define BIO_CTRL_PUSH 6 /* opt - internal, used to signify change */ 129#define BIO_CTRL_POP 7 /* opt - internal, used to signify change */ 130#define BIO_CTRL_GET_CLOSE 8 /* man - set the 'close' on free */ 131#define BIO_CTRL_SET_CLOSE 9 /* man - set the 'close' on free */ 132#define BIO_CTRL_PENDING 10 /* opt - is their more data buffered */ 133#define BIO_CTRL_FLUSH 11 /* opt - 'flush' buffered output */ 134#define BIO_CTRL_DUP 12 /* man - extra stuff for 'duped' BIO */ 135#define BIO_CTRL_WPENDING 13 /* opt - number of bytes still to write */ 136/* callback is int cb(BIO *bio,state,ret); */ 137#define BIO_CTRL_SET_CALLBACK 14 /* opt - set callback function */ 138#define BIO_CTRL_GET_CALLBACK 15 /* opt - set callback function */ 139 140#define BIO_CTRL_SET_FILENAME 30 /* BIO_s_file special */ 141 142/* dgram BIO stuff */ 143#define BIO_CTRL_DGRAM_CONNECT 31 /* BIO dgram special */ 144#define BIO_CTRL_DGRAM_SET_CONNECTED 32 /* allow for an externally 145 * connected socket to be 146 * passed in */ 147#define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33 /* setsockopt, essentially */ 148#define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34 /* getsockopt, essentially */ 149#define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35 /* setsockopt, essentially */ 150#define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36 /* getsockopt, essentially */ 151 152#define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37 /* flag whether the last */ 153#define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38 /* I/O operation tiemd out */ 154 155/* #ifdef IP_MTU_DISCOVER */ 156#define BIO_CTRL_DGRAM_MTU_DISCOVER 39 /* set DF bit on egress packets */ 157/* #endif */ 158 159#define BIO_CTRL_DGRAM_QUERY_MTU 40 /* as kernel for current MTU */ 160#define BIO_CTRL_DGRAM_GET_FALLBACK_MTU 47 161#define BIO_CTRL_DGRAM_GET_MTU 41 /* get cached value for MTU */ 162#define BIO_CTRL_DGRAM_SET_MTU 42 /* set cached value for 163 * MTU. want to use this 164 * if asking the kernel 165 * fails */ 166 167#define BIO_CTRL_DGRAM_MTU_EXCEEDED 43 /* check whether the MTU 168 * was exceed in the 169 * previous write 170 * operation */ 171 172#define BIO_CTRL_DGRAM_GET_PEER 46 173#define BIO_CTRL_DGRAM_SET_PEER 44 /* Destination for the data */ 174 175#define BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT 45 /* Next DTLS handshake timeout to 176 * adjust socket timeouts */ 177 178#ifndef OPENSSL_NO_SCTP 179/* SCTP stuff */ 180#define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE 50 181#define BIO_CTRL_DGRAM_SCTP_ADD_AUTH_KEY 51 182#define BIO_CTRL_DGRAM_SCTP_NEXT_AUTH_KEY 52 183#define BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD 53 184#define BIO_CTRL_DGRAM_SCTP_GET_SNDINFO 60 185#define BIO_CTRL_DGRAM_SCTP_SET_SNDINFO 61 186#define BIO_CTRL_DGRAM_SCTP_GET_RCVINFO 62 187#define BIO_CTRL_DGRAM_SCTP_SET_RCVINFO 63 188#define BIO_CTRL_DGRAM_SCTP_GET_PRINFO 64 189#define BIO_CTRL_DGRAM_SCTP_SET_PRINFO 65 190#define BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN 70 191#endif 192 193/* modifiers */ 194#define BIO_FP_READ 0x02 195#define BIO_FP_WRITE 0x04 196#define BIO_FP_APPEND 0x08 197#define BIO_FP_TEXT 0x10 198 199#define BIO_FLAGS_READ 0x01 200#define BIO_FLAGS_WRITE 0x02 201#define BIO_FLAGS_IO_SPECIAL 0x04 202#define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL) 203#define BIO_FLAGS_SHOULD_RETRY 0x08 204#ifndef BIO_FLAGS_UPLINK 205/* "UPLINK" flag denotes file descriptors provided by application. 206 It defaults to 0, as most platforms don't require UPLINK interface. */ 207#define BIO_FLAGS_UPLINK 0 208#endif 209 210/* Used in BIO_gethostbyname() */ 211#define BIO_GHBN_CTRL_HITS 1 212#define BIO_GHBN_CTRL_MISSES 2 213#define BIO_GHBN_CTRL_CACHE_SIZE 3 214#define BIO_GHBN_CTRL_GET_ENTRY 4 215#define BIO_GHBN_CTRL_FLUSH 5 216 217/* Mostly used in the SSL BIO */ 218/* Not used anymore 219 * #define BIO_FLAGS_PROTOCOL_DELAYED_READ 0x10 220 * #define BIO_FLAGS_PROTOCOL_DELAYED_WRITE 0x20 221 * #define BIO_FLAGS_PROTOCOL_STARTUP 0x40 222 */ 223 224#define BIO_FLAGS_BASE64_NO_NL 0x100 225 226/* This is used with memory BIOs: it means we shouldn't free up or change the 227 * data in any way. 228 */ 229#define BIO_FLAGS_MEM_RDONLY 0x200 230 231typedef struct bio_st BIO; 232 233void BIO_set_flags(BIO *b, int flags); 234int BIO_test_flags(const BIO *b, int flags); 235void BIO_clear_flags(BIO *b, int flags); 236 237#define BIO_get_flags(b) BIO_test_flags(b, ~(0x0)) 238#define BIO_set_retry_special(b) \ 239 BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY)) 240#define BIO_set_retry_read(b) \ 241 BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY)) 242#define BIO_set_retry_write(b) \ 243 BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY)) 244 245/* These are normally used internally in BIOs */ 246#define BIO_clear_retry_flags(b) \ 247 BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY)) 248#define BIO_get_retry_flags(b) \ 249 BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY)) 250 251/* These should be used by the application to tell why we should retry */ 252#define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ) 253#define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE) 254#define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL) 255#define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS) 256#define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY) 257 258/* The next three are used in conjunction with the 259 * BIO_should_io_special() condition. After this returns true, 260 * BIO *BIO_get_retry_BIO(BIO *bio, int *reason); will walk the BIO 261 * stack and return the 'reason' for the special and the offending BIO. 262 * Given a BIO, BIO_get_retry_reason(bio) will return the code. */ 263/* Returned from the SSL bio when the certificate retrieval code had an error */ 264#define BIO_RR_SSL_X509_LOOKUP 0x01 265/* Returned from the connect BIO when a connect would have blocked */ 266#define BIO_RR_CONNECT 0x02 267/* Returned from the accept BIO when an accept would have blocked */ 268#define BIO_RR_ACCEPT 0x03 269/* Returned from the SSL bio when the channel id retrieval code cannot find the 270 * private key. */ 271#define BIO_RR_SSL_CHANNEL_ID_LOOKUP 0x04 272 273/* These are passed by the BIO callback */ 274#define BIO_CB_FREE 0x01 275#define BIO_CB_READ 0x02 276#define BIO_CB_WRITE 0x03 277#define BIO_CB_PUTS 0x04 278#define BIO_CB_GETS 0x05 279#define BIO_CB_CTRL 0x06 280 281/* The callback is called before and after the underling operation, 282 * The BIO_CB_RETURN flag indicates if it is after the call */ 283#define BIO_CB_RETURN 0x80 284#define BIO_CB_return(a) ((a)|BIO_CB_RETURN)) 285#define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN)) 286#define BIO_cb_post(a) ((a)&BIO_CB_RETURN) 287 288long (*BIO_get_callback(const BIO *b)) (struct bio_st *,int,const char *,int, long,long); 289void BIO_set_callback(BIO *b, 290 long (*callback)(struct bio_st *,int,const char *,int, long,long)); 291char *BIO_get_callback_arg(const BIO *b); 292void BIO_set_callback_arg(BIO *b, char *arg); 293 294const char * BIO_method_name(const BIO *b); 295int BIO_method_type(const BIO *b); 296 297typedef void bio_info_cb(struct bio_st *, int, const char *, int, long, long); 298 299typedef struct bio_method_st 300 { 301 int type; 302 const char *name; 303 int (*bwrite)(BIO *, const char *, int); 304 int (*bread)(BIO *, char *, int); 305 int (*bputs)(BIO *, const char *); 306 int (*bgets)(BIO *, char *, int); 307 long (*ctrl)(BIO *, int, long, void *); 308 int (*create)(BIO *); 309 int (*destroy)(BIO *); 310 long (*callback_ctrl)(BIO *, int, bio_info_cb *); 311 } BIO_METHOD; 312 313struct bio_st 314 { 315 BIO_METHOD *method; 316 /* bio, mode, argp, argi, argl, ret */ 317 long (*callback)(struct bio_st *,int,const char *,int, long,long); 318 char *cb_arg; /* first argument for the callback */ 319 320 int init; 321 int shutdown; 322 int flags; /* extra storage */ 323 int retry_reason; 324 int num; 325 void *ptr; 326 struct bio_st *next_bio; /* used by filter BIOs */ 327 struct bio_st *prev_bio; /* used by filter BIOs */ 328 int references; 329 unsigned long num_read; 330 unsigned long num_write; 331 332 CRYPTO_EX_DATA ex_data; 333 }; 334 335DECLARE_STACK_OF(BIO) 336 337typedef struct bio_f_buffer_ctx_struct 338 { 339 /* Buffers are setup like this: 340 * 341 * <---------------------- size -----------------------> 342 * +---------------------------------------------------+ 343 * | consumed | remaining | free space | 344 * +---------------------------------------------------+ 345 * <-- off --><------- len -------> 346 */ 347 348 /* BIO *bio; */ /* this is now in the BIO struct */ 349 int ibuf_size; /* how big is the input buffer */ 350 int obuf_size; /* how big is the output buffer */ 351 352 char *ibuf; /* the char array */ 353 int ibuf_len; /* how many bytes are in it */ 354 int ibuf_off; /* write/read offset */ 355 356 char *obuf; /* the char array */ 357 int obuf_len; /* how many bytes are in it */ 358 int obuf_off; /* write/read offset */ 359 } BIO_F_BUFFER_CTX; 360 361/* Prefix and suffix callback in ASN1 BIO */ 362typedef int asn1_ps_func(BIO *b, unsigned char **pbuf, int *plen, void *parg); 363 364#ifndef OPENSSL_NO_SCTP 365/* SCTP parameter structs */ 366struct bio_dgram_sctp_sndinfo 367 { 368 uint16_t snd_sid; 369 uint16_t snd_flags; 370 uint32_t snd_ppid; 371 uint32_t snd_context; 372 }; 373 374struct bio_dgram_sctp_rcvinfo 375 { 376 uint16_t rcv_sid; 377 uint16_t rcv_ssn; 378 uint16_t rcv_flags; 379 uint32_t rcv_ppid; 380 uint32_t rcv_tsn; 381 uint32_t rcv_cumtsn; 382 uint32_t rcv_context; 383 }; 384 385struct bio_dgram_sctp_prinfo 386 { 387 uint16_t pr_policy; 388 uint32_t pr_value; 389 }; 390#endif 391 392/* connect BIO stuff */ 393#define BIO_CONN_S_BEFORE 1 394#define BIO_CONN_S_GET_IP 2 395#define BIO_CONN_S_GET_PORT 3 396#define BIO_CONN_S_CREATE_SOCKET 4 397#define BIO_CONN_S_CONNECT 5 398#define BIO_CONN_S_OK 6 399#define BIO_CONN_S_BLOCKED_CONNECT 7 400#define BIO_CONN_S_NBIO 8 401/*#define BIO_CONN_get_param_hostname BIO_ctrl */ 402 403#define BIO_C_SET_CONNECT 100 404#define BIO_C_DO_STATE_MACHINE 101 405#define BIO_C_SET_NBIO 102 406#define BIO_C_SET_PROXY_PARAM 103 407#define BIO_C_SET_FD 104 408#define BIO_C_GET_FD 105 409#define BIO_C_SET_FILE_PTR 106 410#define BIO_C_GET_FILE_PTR 107 411#define BIO_C_SET_FILENAME 108 412#define BIO_C_SET_SSL 109 413#define BIO_C_GET_SSL 110 414#define BIO_C_SET_MD 111 415#define BIO_C_GET_MD 112 416#define BIO_C_GET_CIPHER_STATUS 113 417#define BIO_C_SET_BUF_MEM 114 418#define BIO_C_GET_BUF_MEM_PTR 115 419#define BIO_C_GET_BUFF_NUM_LINES 116 420#define BIO_C_SET_BUFF_SIZE 117 421#define BIO_C_SET_ACCEPT 118 422#define BIO_C_SSL_MODE 119 423#define BIO_C_GET_MD_CTX 120 424#define BIO_C_GET_PROXY_PARAM 121 425#define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */ 426#define BIO_C_GET_CONNECT 123 427#define BIO_C_GET_ACCEPT 124 428#define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125 429#define BIO_C_GET_SSL_NUM_RENEGOTIATES 126 430#define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127 431#define BIO_C_FILE_SEEK 128 432#define BIO_C_GET_CIPHER_CTX 129 433#define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/ 434#define BIO_C_SET_BIND_MODE 131 435#define BIO_C_GET_BIND_MODE 132 436#define BIO_C_FILE_TELL 133 437#define BIO_C_GET_SOCKS 134 438#define BIO_C_SET_SOCKS 135 439 440#define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */ 441#define BIO_C_GET_WRITE_BUF_SIZE 137 442#define BIO_C_MAKE_BIO_PAIR 138 443#define BIO_C_DESTROY_BIO_PAIR 139 444#define BIO_C_GET_WRITE_GUARANTEE 140 445#define BIO_C_GET_READ_REQUEST 141 446#define BIO_C_SHUTDOWN_WR 142 447#define BIO_C_NREAD0 143 448#define BIO_C_NREAD 144 449#define BIO_C_NWRITE0 145 450#define BIO_C_NWRITE 146 451#define BIO_C_RESET_READ_REQUEST 147 452#define BIO_C_SET_MD_CTX 148 453 454#define BIO_C_SET_PREFIX 149 455#define BIO_C_GET_PREFIX 150 456#define BIO_C_SET_SUFFIX 151 457#define BIO_C_GET_SUFFIX 152 458 459#define BIO_C_SET_EX_ARG 153 460#define BIO_C_GET_EX_ARG 154 461 462#define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg) 463#define BIO_get_app_data(s) BIO_get_ex_data(s,0) 464 465/* BIO_s_connect() and BIO_s_socks4a_connect() */ 466#define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name) 467#define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port) 468#define BIO_set_conn_ip(b,ip) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip) 469#define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port) 470#define BIO_get_conn_hostname(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0) 471#define BIO_get_conn_port(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1) 472#define BIO_get_conn_ip(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2) 473#define BIO_get_conn_int_port(b) BIO_int_ctrl(b,BIO_C_GET_CONNECT,3,0) 474 475 476#define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) 477 478/* BIO_s_accept_socket() */ 479#define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name) 480#define BIO_get_accept_port(b) BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0) 481/* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */ 482#define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?(void *)"a":NULL) 483#define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio) 484 485#define BIO_BIND_NORMAL 0 486#define BIO_BIND_REUSEADDR_IF_UNUSED 1 487#define BIO_BIND_REUSEADDR 2 488#define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL) 489#define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL) 490 491#define BIO_do_connect(b) BIO_do_handshake(b) 492#define BIO_do_accept(b) BIO_do_handshake(b) 493#define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL) 494 495/* BIO_s_proxy_client() */ 496#define BIO_set_url(b,url) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,0,(char *)(url)) 497#define BIO_set_proxies(b,p) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,1,(char *)(p)) 498/* BIO_set_nbio(b,n) */ 499#define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s)) 500/* BIO *BIO_get_filter_bio(BIO *bio); */ 501#define BIO_set_proxy_cb(b,cb) BIO_callback_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(void *(*cb)())) 502#define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk) 503#define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool) 504 505#define BIO_get_proxy_header(b,skp) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,0,(char *)skp) 506#define BIO_get_proxies(b,pxy_p) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,1,(char *)(pxy_p)) 507#define BIO_get_url(b,url) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,2,(char *)(url)) 508#define BIO_get_no_connect_return(b) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,5,NULL) 509 510#define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd) 511#define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c) 512 513#define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp) 514#define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp) 515 516#define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL) 517#define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL) 518 519/* name is cast to lose const, but might be better to route through a function 520 so we can do it safely */ 521#ifdef CONST_STRICT 522/* If you are wondering why this isn't defined, its because CONST_STRICT is 523 * purely a compile-time kludge to allow const to be checked. 524 */ 525int BIO_read_filename(BIO *b,const char *name); 526#else 527#define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 528 BIO_CLOSE|BIO_FP_READ,(char *)name) 529#endif 530#define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 531 BIO_CLOSE|BIO_FP_WRITE,name) 532#define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 533 BIO_CLOSE|BIO_FP_APPEND,name) 534#define BIO_rw_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 535 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name) 536 537/* WARNING WARNING, this ups the reference count on the read bio of the 538 * SSL structure. This is because the ssl read BIO is now pointed to by 539 * the next_bio field in the bio. So when you free the BIO, make sure 540 * you are doing a BIO_free_all() to catch the underlying BIO. */ 541#define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl) 542#define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp) 543#define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL) 544#define BIO_set_ssl_renegotiate_bytes(b,num) \ 545 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL); 546#define BIO_get_num_renegotiates(b) \ 547 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL); 548#define BIO_set_ssl_renegotiate_timeout(b,seconds) \ 549 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL); 550 551/* defined in evp.h */ 552/* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */ 553 554#define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp) 555#define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm) 556#define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp) 557#define BIO_set_mem_eof_return(b,v) \ 558 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL) 559 560/* For the BIO_f_buffer() type */ 561#define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL) 562#define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL) 563#define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0) 564#define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1) 565#define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf) 566 567/* Don't use the next one unless you know what you are doing :-) */ 568#define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret)) 569 570#define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL) 571#define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL) 572#define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL) 573#define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL) 574#define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL) 575#define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL) 576/* ...pending macros have inappropriate return type */ 577size_t BIO_ctrl_pending(BIO *b); 578size_t BIO_ctrl_wpending(BIO *b); 579#define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL) 580#define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \ 581 cbp) 582#define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb) 583 584/* For the BIO_f_buffer() type */ 585#define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL) 586 587/* For BIO_s_bio() */ 588#define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL) 589#define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL) 590#define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2) 591#define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL) 592#define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL) 593/* macros with inappropriate type -- but ...pending macros use int too: */ 594#define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL) 595#define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL) 596size_t BIO_ctrl_get_write_guarantee(BIO *b); 597size_t BIO_ctrl_get_read_request(BIO *b); 598int BIO_ctrl_reset_read_request(BIO *b); 599 600/* ctrl macros for dgram */ 601#define BIO_ctrl_dgram_connect(b,peer) \ 602 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)peer) 603#define BIO_ctrl_set_connected(b, state, peer) \ 604 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, state, (char *)peer) 605#define BIO_dgram_recv_timedout(b) \ 606 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL) 607#define BIO_dgram_send_timedout(b) \ 608 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL) 609#define BIO_dgram_get_peer(b,peer) \ 610 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)peer) 611#define BIO_dgram_set_peer(b,peer) \ 612 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)peer) 613 614/* These two aren't currently implemented */ 615/* int BIO_get_ex_num(BIO *bio); */ 616/* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */ 617int BIO_set_ex_data(BIO *bio,int idx,void *data); 618void *BIO_get_ex_data(BIO *bio,int idx); 619int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 620 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 621unsigned long BIO_number_read(BIO *bio); 622unsigned long BIO_number_written(BIO *bio); 623 624/* For BIO_f_asn1() */ 625int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix, 626 asn1_ps_func *prefix_free); 627int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix, 628 asn1_ps_func **pprefix_free); 629int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix, 630 asn1_ps_func *suffix_free); 631int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix, 632 asn1_ps_func **psuffix_free); 633 634# ifndef OPENSSL_NO_FP_API 635BIO_METHOD *BIO_s_file(void ); 636BIO *BIO_new_file(const char *filename, const char *mode); 637BIO *BIO_new_fp(FILE *stream, int close_flag); 638# define BIO_s_file_internal BIO_s_file 639# endif 640BIO * BIO_new(BIO_METHOD *type); 641int BIO_set(BIO *a,BIO_METHOD *type); 642int BIO_free(BIO *a); 643void BIO_vfree(BIO *a); 644int BIO_read(BIO *b, void *data, int len); 645int BIO_gets(BIO *bp,char *buf, int size); 646int BIO_write(BIO *b, const void *data, int len); 647int BIO_puts(BIO *bp,const char *buf); 648int BIO_indent(BIO *b,int indent,int max); 649long BIO_ctrl(BIO *bp,int cmd,long larg,void *parg); 650long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long)); 651char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg); 652long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg); 653BIO * BIO_push(BIO *b,BIO *append); 654BIO * BIO_pop(BIO *b); 655void BIO_free_all(BIO *a); 656BIO * BIO_find_type(BIO *b,int bio_type); 657BIO * BIO_next(BIO *b); 658BIO * BIO_get_retry_BIO(BIO *bio, int *reason); 659int BIO_get_retry_reason(BIO *bio); 660BIO * BIO_dup_chain(BIO *in); 661 662int BIO_nread0(BIO *bio, char **buf); 663int BIO_nread(BIO *bio, char **buf, int num); 664int BIO_nwrite0(BIO *bio, char **buf); 665int BIO_nwrite(BIO *bio, char **buf, int num); 666 667long BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi, 668 long argl,long ret); 669 670BIO_METHOD *BIO_s_mem(void); 671BIO *BIO_new_mem_buf(void *buf, int len); 672BIO_METHOD *BIO_s_socket(void); 673BIO_METHOD *BIO_s_connect(void); 674BIO_METHOD *BIO_s_accept(void); 675BIO_METHOD *BIO_s_fd(void); 676#ifndef OPENSSL_SYS_OS2 677BIO_METHOD *BIO_s_log(void); 678#endif 679BIO_METHOD *BIO_s_bio(void); 680BIO_METHOD *BIO_s_null(void); 681BIO_METHOD *BIO_f_null(void); 682BIO_METHOD *BIO_f_buffer(void); 683#ifdef OPENSSL_SYS_VMS 684BIO_METHOD *BIO_f_linebuffer(void); 685#endif 686BIO_METHOD *BIO_f_nbio_test(void); 687#ifndef OPENSSL_NO_DGRAM 688BIO_METHOD *BIO_s_datagram(void); 689#ifndef OPENSSL_NO_SCTP 690BIO_METHOD *BIO_s_datagram_sctp(void); 691#endif 692#endif 693 694/* BIO_METHOD *BIO_f_ber(void); */ 695 696int BIO_sock_should_retry(int i); 697int BIO_sock_non_fatal_error(int error); 698int BIO_dgram_non_fatal_error(int error); 699 700int BIO_fd_should_retry(int i); 701int BIO_fd_non_fatal_error(int error); 702int BIO_dump_cb(int (*cb)(const void *data, size_t len, void *u), 703 void *u, const char *s, int len); 704int BIO_dump_indent_cb(int (*cb)(const void *data, size_t len, void *u), 705 void *u, const char *s, int len, int indent); 706int BIO_dump(BIO *b,const char *bytes,int len); 707int BIO_dump_indent(BIO *b,const char *bytes,int len,int indent); 708#ifndef OPENSSL_NO_FP_API 709int BIO_dump_fp(FILE *fp, const char *s, int len); 710int BIO_dump_indent_fp(FILE *fp, const char *s, int len, int indent); 711#endif 712struct hostent *BIO_gethostbyname(const char *name); 713/* We might want a thread-safe interface too: 714 * struct hostent *BIO_gethostbyname_r(const char *name, 715 * struct hostent *result, void *buffer, size_t buflen); 716 * or something similar (caller allocates a struct hostent, 717 * pointed to by "result", and additional buffer space for the various 718 * substructures; if the buffer does not suffice, NULL is returned 719 * and an appropriate error code is set). 720 */ 721int BIO_sock_error(int sock); 722int BIO_socket_ioctl(int fd, long type, void *arg); 723int BIO_socket_nbio(int fd,int mode); 724int BIO_get_port(const char *str, unsigned short *port_ptr); 725int BIO_get_host_ip(const char *str, unsigned char *ip); 726int BIO_get_accept_socket(char *host_port,int mode); 727int BIO_accept(int sock,char **ip_port); 728int BIO_sock_init(void ); 729void BIO_sock_cleanup(void); 730int BIO_set_tcp_ndelay(int sock,int turn_on); 731 732BIO *BIO_new_socket(int sock, int close_flag); 733BIO *BIO_new_dgram(int fd, int close_flag); 734#ifndef OPENSSL_NO_SCTP 735BIO *BIO_new_dgram_sctp(int fd, int close_flag); 736int BIO_dgram_is_sctp(BIO *bio); 737int BIO_dgram_sctp_notification_cb(BIO *b, 738 void (*handle_notifications)(BIO *bio, void *context, void *buf), 739 void *context); 740int BIO_dgram_sctp_wait_for_dry(BIO *b); 741int BIO_dgram_sctp_msg_waiting(BIO *b); 742#endif 743BIO *BIO_new_fd(int fd, int close_flag); 744BIO *BIO_new_connect(char *host_port); 745BIO *BIO_new_accept(char *host_port); 746 747int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, 748 BIO **bio2, size_t writebuf2); 749/* If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints. 750 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. 751 * Size 0 uses default value. 752 */ 753 754void BIO_copy_next_retry(BIO *b); 755 756/*long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);*/ 757 758#ifdef __GNUC__ 759# define __bio_h__attr__ __attribute__ 760#else 761# define __bio_h__attr__(x) 762#endif 763int BIO_printf(BIO *bio, const char *format, ...) 764 __bio_h__attr__((__format__(__printf__,2,3))); 765int BIO_vprintf(BIO *bio, const char *format, va_list args) 766 __bio_h__attr__((__format__(__printf__,2,0))); 767int BIO_snprintf(char *buf, size_t n, const char *format, ...) 768 __bio_h__attr__((__format__(__printf__,3,4))); 769int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args) 770 __bio_h__attr__((__format__(__printf__,3,0))); 771#undef __bio_h__attr__ 772 773/* BEGIN ERROR CODES */ 774/* The following lines are auto generated by the script mkerr.pl. Any changes 775 * made after this point may be overwritten when the script is next run. 776 */ 777void ERR_load_BIO_strings(void); 778 779/* Error codes for the BIO functions. */ 780 781/* Function codes. */ 782#define BIO_F_ACPT_STATE 100 783#define BIO_F_BIO_ACCEPT 101 784#define BIO_F_BIO_BER_GET_HEADER 102 785#define BIO_F_BIO_CALLBACK_CTRL 131 786#define BIO_F_BIO_CTRL 103 787#define BIO_F_BIO_GETHOSTBYNAME 120 788#define BIO_F_BIO_GETS 104 789#define BIO_F_BIO_GET_ACCEPT_SOCKET 105 790#define BIO_F_BIO_GET_HOST_IP 106 791#define BIO_F_BIO_GET_PORT 107 792#define BIO_F_BIO_MAKE_PAIR 121 793#define BIO_F_BIO_NEW 108 794#define BIO_F_BIO_NEW_FILE 109 795#define BIO_F_BIO_NEW_MEM_BUF 126 796#define BIO_F_BIO_NREAD 123 797#define BIO_F_BIO_NREAD0 124 798#define BIO_F_BIO_NWRITE 125 799#define BIO_F_BIO_NWRITE0 122 800#define BIO_F_BIO_PUTS 110 801#define BIO_F_BIO_READ 111 802#define BIO_F_BIO_SOCK_INIT 112 803#define BIO_F_BIO_WRITE 113 804#define BIO_F_BUFFER_CTRL 114 805#define BIO_F_CONN_CTRL 127 806#define BIO_F_CONN_STATE 115 807#define BIO_F_DGRAM_SCTP_READ 132 808#define BIO_F_FILE_CTRL 116 809#define BIO_F_FILE_READ 130 810#define BIO_F_LINEBUFFER_CTRL 129 811#define BIO_F_MEM_READ 128 812#define BIO_F_MEM_WRITE 117 813#define BIO_F_SSL_NEW 118 814#define BIO_F_WSASTARTUP 119 815 816/* Reason codes. */ 817#define BIO_R_ACCEPT_ERROR 100 818#define BIO_R_BAD_FOPEN_MODE 101 819#define BIO_R_BAD_HOSTNAME_LOOKUP 102 820#define BIO_R_BROKEN_PIPE 124 821#define BIO_R_CONNECT_ERROR 103 822#define BIO_R_EOF_ON_MEMORY_BIO 127 823#define BIO_R_ERROR_SETTING_NBIO 104 824#define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET 105 825#define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET 106 826#define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET 107 827#define BIO_R_INVALID_ARGUMENT 125 828#define BIO_R_INVALID_IP_ADDRESS 108 829#define BIO_R_IN_USE 123 830#define BIO_R_KEEPALIVE 109 831#define BIO_R_NBIO_CONNECT_ERROR 110 832#define BIO_R_NO_ACCEPT_PORT_SPECIFIED 111 833#define BIO_R_NO_HOSTNAME_SPECIFIED 112 834#define BIO_R_NO_PORT_DEFINED 113 835#define BIO_R_NO_PORT_SPECIFIED 114 836#define BIO_R_NO_SUCH_FILE 128 837#define BIO_R_NULL_PARAMETER 115 838#define BIO_R_TAG_MISMATCH 116 839#define BIO_R_UNABLE_TO_BIND_SOCKET 117 840#define BIO_R_UNABLE_TO_CREATE_SOCKET 118 841#define BIO_R_UNABLE_TO_LISTEN_SOCKET 119 842#define BIO_R_UNINITIALIZED 120 843#define BIO_R_UNSUPPORTED_METHOD 121 844#define BIO_R_WRITE_TO_READ_ONLY_BIO 126 845#define BIO_R_WSASTARTUP 122 846 847#ifdef __cplusplus 848} 849#endif 850#endif 851