bio.h revision 279264
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#define BIO_CTRL_DGRAM_GET_MTU_OVERHEAD 49 179 180#ifndef OPENSSL_NO_SCTP 181/* SCTP stuff */ 182#define BIO_CTRL_DGRAM_SCTP_SET_IN_HANDSHAKE 50 183#define BIO_CTRL_DGRAM_SCTP_ADD_AUTH_KEY 51 184#define BIO_CTRL_DGRAM_SCTP_NEXT_AUTH_KEY 52 185#define BIO_CTRL_DGRAM_SCTP_AUTH_CCS_RCVD 53 186#define BIO_CTRL_DGRAM_SCTP_GET_SNDINFO 60 187#define BIO_CTRL_DGRAM_SCTP_SET_SNDINFO 61 188#define BIO_CTRL_DGRAM_SCTP_GET_RCVINFO 62 189#define BIO_CTRL_DGRAM_SCTP_SET_RCVINFO 63 190#define BIO_CTRL_DGRAM_SCTP_GET_PRINFO 64 191#define BIO_CTRL_DGRAM_SCTP_SET_PRINFO 65 192#define BIO_CTRL_DGRAM_SCTP_SAVE_SHUTDOWN 70 193#endif 194 195/* modifiers */ 196#define BIO_FP_READ 0x02 197#define BIO_FP_WRITE 0x04 198#define BIO_FP_APPEND 0x08 199#define BIO_FP_TEXT 0x10 200 201#define BIO_FLAGS_READ 0x01 202#define BIO_FLAGS_WRITE 0x02 203#define BIO_FLAGS_IO_SPECIAL 0x04 204#define BIO_FLAGS_RWS (BIO_FLAGS_READ|BIO_FLAGS_WRITE|BIO_FLAGS_IO_SPECIAL) 205#define BIO_FLAGS_SHOULD_RETRY 0x08 206#ifndef BIO_FLAGS_UPLINK 207/* "UPLINK" flag denotes file descriptors provided by application. 208 It defaults to 0, as most platforms don't require UPLINK interface. */ 209#define BIO_FLAGS_UPLINK 0 210#endif 211 212/* Used in BIO_gethostbyname() */ 213#define BIO_GHBN_CTRL_HITS 1 214#define BIO_GHBN_CTRL_MISSES 2 215#define BIO_GHBN_CTRL_CACHE_SIZE 3 216#define BIO_GHBN_CTRL_GET_ENTRY 4 217#define BIO_GHBN_CTRL_FLUSH 5 218 219/* Mostly used in the SSL BIO */ 220/* Not used anymore 221 * #define BIO_FLAGS_PROTOCOL_DELAYED_READ 0x10 222 * #define BIO_FLAGS_PROTOCOL_DELAYED_WRITE 0x20 223 * #define BIO_FLAGS_PROTOCOL_STARTUP 0x40 224 */ 225 226#define BIO_FLAGS_BASE64_NO_NL 0x100 227 228/* This is used with memory BIOs: it means we shouldn't free up or change the 229 * data in any way. 230 */ 231#define BIO_FLAGS_MEM_RDONLY 0x200 232 233typedef struct bio_st BIO; 234 235void BIO_set_flags(BIO *b, int flags); 236int BIO_test_flags(const BIO *b, int flags); 237void BIO_clear_flags(BIO *b, int flags); 238 239#define BIO_get_flags(b) BIO_test_flags(b, ~(0x0)) 240#define BIO_set_retry_special(b) \ 241 BIO_set_flags(b, (BIO_FLAGS_IO_SPECIAL|BIO_FLAGS_SHOULD_RETRY)) 242#define BIO_set_retry_read(b) \ 243 BIO_set_flags(b, (BIO_FLAGS_READ|BIO_FLAGS_SHOULD_RETRY)) 244#define BIO_set_retry_write(b) \ 245 BIO_set_flags(b, (BIO_FLAGS_WRITE|BIO_FLAGS_SHOULD_RETRY)) 246 247/* These are normally used internally in BIOs */ 248#define BIO_clear_retry_flags(b) \ 249 BIO_clear_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY)) 250#define BIO_get_retry_flags(b) \ 251 BIO_test_flags(b, (BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY)) 252 253/* These should be used by the application to tell why we should retry */ 254#define BIO_should_read(a) BIO_test_flags(a, BIO_FLAGS_READ) 255#define BIO_should_write(a) BIO_test_flags(a, BIO_FLAGS_WRITE) 256#define BIO_should_io_special(a) BIO_test_flags(a, BIO_FLAGS_IO_SPECIAL) 257#define BIO_retry_type(a) BIO_test_flags(a, BIO_FLAGS_RWS) 258#define BIO_should_retry(a) BIO_test_flags(a, BIO_FLAGS_SHOULD_RETRY) 259 260/* The next three are used in conjunction with the 261 * BIO_should_io_special() condition. After this returns true, 262 * BIO *BIO_get_retry_BIO(BIO *bio, int *reason); will walk the BIO 263 * stack and return the 'reason' for the special and the offending BIO. 264 * Given a BIO, BIO_get_retry_reason(bio) will return the code. */ 265/* Returned from the SSL bio when the certificate retrieval code had an error */ 266#define BIO_RR_SSL_X509_LOOKUP 0x01 267/* Returned from the connect BIO when a connect would have blocked */ 268#define BIO_RR_CONNECT 0x02 269/* Returned from the accept BIO when an accept would have blocked */ 270#define BIO_RR_ACCEPT 0x03 271 272/* These are passed by the BIO callback */ 273#define BIO_CB_FREE 0x01 274#define BIO_CB_READ 0x02 275#define BIO_CB_WRITE 0x03 276#define BIO_CB_PUTS 0x04 277#define BIO_CB_GETS 0x05 278#define BIO_CB_CTRL 0x06 279 280/* The callback is called before and after the underling operation, 281 * The BIO_CB_RETURN flag indicates if it is after the call */ 282#define BIO_CB_RETURN 0x80 283#define BIO_CB_return(a) ((a)|BIO_CB_RETURN)) 284#define BIO_cb_pre(a) (!((a)&BIO_CB_RETURN)) 285#define BIO_cb_post(a) ((a)&BIO_CB_RETURN) 286 287long (*BIO_get_callback(const BIO *b)) (struct bio_st *,int,const char *,int, long,long); 288void BIO_set_callback(BIO *b, 289 long (*callback)(struct bio_st *,int,const char *,int, long,long)); 290char *BIO_get_callback_arg(const BIO *b); 291void BIO_set_callback_arg(BIO *b, char *arg); 292 293const char * BIO_method_name(const BIO *b); 294int BIO_method_type(const BIO *b); 295 296typedef void bio_info_cb(struct bio_st *, int, const char *, int, long, long); 297 298typedef struct bio_method_st 299 { 300 int type; 301 const char *name; 302 int (*bwrite)(BIO *, const char *, int); 303 int (*bread)(BIO *, char *, int); 304 int (*bputs)(BIO *, const char *); 305 int (*bgets)(BIO *, char *, int); 306 long (*ctrl)(BIO *, int, long, void *); 307 int (*create)(BIO *); 308 int (*destroy)(BIO *); 309 long (*callback_ctrl)(BIO *, int, bio_info_cb *); 310 } BIO_METHOD; 311 312struct bio_st 313 { 314 BIO_METHOD *method; 315 /* bio, mode, argp, argi, argl, ret */ 316 long (*callback)(struct bio_st *,int,const char *,int, long,long); 317 char *cb_arg; /* first argument for the callback */ 318 319 int init; 320 int shutdown; 321 int flags; /* extra storage */ 322 int retry_reason; 323 int num; 324 void *ptr; 325 struct bio_st *next_bio; /* used by filter BIOs */ 326 struct bio_st *prev_bio; /* used by filter BIOs */ 327 int references; 328 unsigned long num_read; 329 unsigned long num_write; 330 331 CRYPTO_EX_DATA ex_data; 332 }; 333 334DECLARE_STACK_OF(BIO) 335 336typedef struct bio_f_buffer_ctx_struct 337 { 338 /* Buffers are setup like this: 339 * 340 * <---------------------- size -----------------------> 341 * +---------------------------------------------------+ 342 * | consumed | remaining | free space | 343 * +---------------------------------------------------+ 344 * <-- off --><------- len -------> 345 */ 346 347 /* BIO *bio; */ /* this is now in the BIO struct */ 348 int ibuf_size; /* how big is the input buffer */ 349 int obuf_size; /* how big is the output buffer */ 350 351 char *ibuf; /* the char array */ 352 int ibuf_len; /* how many bytes are in it */ 353 int ibuf_off; /* write/read offset */ 354 355 char *obuf; /* the char array */ 356 int obuf_len; /* how many bytes are in it */ 357 int obuf_off; /* write/read offset */ 358 } BIO_F_BUFFER_CTX; 359 360/* Prefix and suffix callback in ASN1 BIO */ 361typedef int asn1_ps_func(BIO *b, unsigned char **pbuf, int *plen, void *parg); 362 363#ifndef OPENSSL_NO_SCTP 364/* SCTP parameter structs */ 365struct bio_dgram_sctp_sndinfo 366 { 367 uint16_t snd_sid; 368 uint16_t snd_flags; 369 uint32_t snd_ppid; 370 uint32_t snd_context; 371 }; 372 373struct bio_dgram_sctp_rcvinfo 374 { 375 uint16_t rcv_sid; 376 uint16_t rcv_ssn; 377 uint16_t rcv_flags; 378 uint32_t rcv_ppid; 379 uint32_t rcv_tsn; 380 uint32_t rcv_cumtsn; 381 uint32_t rcv_context; 382 }; 383 384struct bio_dgram_sctp_prinfo 385 { 386 uint16_t pr_policy; 387 uint32_t pr_value; 388 }; 389#endif 390 391/* connect BIO stuff */ 392#define BIO_CONN_S_BEFORE 1 393#define BIO_CONN_S_GET_IP 2 394#define BIO_CONN_S_GET_PORT 3 395#define BIO_CONN_S_CREATE_SOCKET 4 396#define BIO_CONN_S_CONNECT 5 397#define BIO_CONN_S_OK 6 398#define BIO_CONN_S_BLOCKED_CONNECT 7 399#define BIO_CONN_S_NBIO 8 400/*#define BIO_CONN_get_param_hostname BIO_ctrl */ 401 402#define BIO_C_SET_CONNECT 100 403#define BIO_C_DO_STATE_MACHINE 101 404#define BIO_C_SET_NBIO 102 405#define BIO_C_SET_PROXY_PARAM 103 406#define BIO_C_SET_FD 104 407#define BIO_C_GET_FD 105 408#define BIO_C_SET_FILE_PTR 106 409#define BIO_C_GET_FILE_PTR 107 410#define BIO_C_SET_FILENAME 108 411#define BIO_C_SET_SSL 109 412#define BIO_C_GET_SSL 110 413#define BIO_C_SET_MD 111 414#define BIO_C_GET_MD 112 415#define BIO_C_GET_CIPHER_STATUS 113 416#define BIO_C_SET_BUF_MEM 114 417#define BIO_C_GET_BUF_MEM_PTR 115 418#define BIO_C_GET_BUFF_NUM_LINES 116 419#define BIO_C_SET_BUFF_SIZE 117 420#define BIO_C_SET_ACCEPT 118 421#define BIO_C_SSL_MODE 119 422#define BIO_C_GET_MD_CTX 120 423#define BIO_C_GET_PROXY_PARAM 121 424#define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */ 425#define BIO_C_GET_CONNECT 123 426#define BIO_C_GET_ACCEPT 124 427#define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125 428#define BIO_C_GET_SSL_NUM_RENEGOTIATES 126 429#define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127 430#define BIO_C_FILE_SEEK 128 431#define BIO_C_GET_CIPHER_CTX 129 432#define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/ 433#define BIO_C_SET_BIND_MODE 131 434#define BIO_C_GET_BIND_MODE 132 435#define BIO_C_FILE_TELL 133 436#define BIO_C_GET_SOCKS 134 437#define BIO_C_SET_SOCKS 135 438 439#define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */ 440#define BIO_C_GET_WRITE_BUF_SIZE 137 441#define BIO_C_MAKE_BIO_PAIR 138 442#define BIO_C_DESTROY_BIO_PAIR 139 443#define BIO_C_GET_WRITE_GUARANTEE 140 444#define BIO_C_GET_READ_REQUEST 141 445#define BIO_C_SHUTDOWN_WR 142 446#define BIO_C_NREAD0 143 447#define BIO_C_NREAD 144 448#define BIO_C_NWRITE0 145 449#define BIO_C_NWRITE 146 450#define BIO_C_RESET_READ_REQUEST 147 451#define BIO_C_SET_MD_CTX 148 452 453#define BIO_C_SET_PREFIX 149 454#define BIO_C_GET_PREFIX 150 455#define BIO_C_SET_SUFFIX 151 456#define BIO_C_GET_SUFFIX 152 457 458#define BIO_C_SET_EX_ARG 153 459#define BIO_C_GET_EX_ARG 154 460 461#define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg) 462#define BIO_get_app_data(s) BIO_get_ex_data(s,0) 463 464/* BIO_s_connect() and BIO_s_socks4a_connect() */ 465#define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name) 466#define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port) 467#define BIO_set_conn_ip(b,ip) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip) 468#define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port) 469#define BIO_get_conn_hostname(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0) 470#define BIO_get_conn_port(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1) 471#define BIO_get_conn_ip(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2) 472#define BIO_get_conn_int_port(b) BIO_int_ctrl(b,BIO_C_GET_CONNECT,3,0) 473 474 475#define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) 476 477/* BIO_s_accept_socket() */ 478#define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name) 479#define BIO_get_accept_port(b) BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0) 480/* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */ 481#define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?(void *)"a":NULL) 482#define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio) 483 484#define BIO_BIND_NORMAL 0 485#define BIO_BIND_REUSEADDR_IF_UNUSED 1 486#define BIO_BIND_REUSEADDR 2 487#define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL) 488#define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL) 489 490#define BIO_do_connect(b) BIO_do_handshake(b) 491#define BIO_do_accept(b) BIO_do_handshake(b) 492#define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL) 493 494/* BIO_s_proxy_client() */ 495#define BIO_set_url(b,url) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,0,(char *)(url)) 496#define BIO_set_proxies(b,p) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,1,(char *)(p)) 497/* BIO_set_nbio(b,n) */ 498#define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s)) 499/* BIO *BIO_get_filter_bio(BIO *bio); */ 500#define BIO_set_proxy_cb(b,cb) BIO_callback_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(void *(*cb)())) 501#define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk) 502#define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool) 503 504#define BIO_get_proxy_header(b,skp) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,0,(char *)skp) 505#define BIO_get_proxies(b,pxy_p) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,1,(char *)(pxy_p)) 506#define BIO_get_url(b,url) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,2,(char *)(url)) 507#define BIO_get_no_connect_return(b) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,5,NULL) 508 509#define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd) 510#define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c) 511 512#define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp) 513#define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp) 514 515#define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL) 516#define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL) 517 518/* name is cast to lose const, but might be better to route through a function 519 so we can do it safely */ 520#ifdef CONST_STRICT 521/* If you are wondering why this isn't defined, its because CONST_STRICT is 522 * purely a compile-time kludge to allow const to be checked. 523 */ 524int BIO_read_filename(BIO *b,const char *name); 525#else 526#define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 527 BIO_CLOSE|BIO_FP_READ,(char *)name) 528#endif 529#define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 530 BIO_CLOSE|BIO_FP_WRITE,name) 531#define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 532 BIO_CLOSE|BIO_FP_APPEND,name) 533#define BIO_rw_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 534 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name) 535 536/* WARNING WARNING, this ups the reference count on the read bio of the 537 * SSL structure. This is because the ssl read BIO is now pointed to by 538 * the next_bio field in the bio. So when you free the BIO, make sure 539 * you are doing a BIO_free_all() to catch the underlying BIO. */ 540#define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl) 541#define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp) 542#define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL) 543#define BIO_set_ssl_renegotiate_bytes(b,num) \ 544 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL); 545#define BIO_get_num_renegotiates(b) \ 546 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL); 547#define BIO_set_ssl_renegotiate_timeout(b,seconds) \ 548 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL); 549 550/* defined in evp.h */ 551/* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */ 552 553#define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp) 554#define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm) 555#define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp) 556#define BIO_set_mem_eof_return(b,v) \ 557 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL) 558 559/* For the BIO_f_buffer() type */ 560#define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL) 561#define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL) 562#define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0) 563#define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1) 564#define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf) 565 566/* Don't use the next one unless you know what you are doing :-) */ 567#define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret)) 568 569#define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL) 570#define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL) 571#define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL) 572#define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL) 573#define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL) 574#define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL) 575/* ...pending macros have inappropriate return type */ 576size_t BIO_ctrl_pending(BIO *b); 577size_t BIO_ctrl_wpending(BIO *b); 578#define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL) 579#define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \ 580 cbp) 581#define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb) 582 583/* For the BIO_f_buffer() type */ 584#define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL) 585 586/* For BIO_s_bio() */ 587#define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL) 588#define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL) 589#define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2) 590#define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL) 591#define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL) 592/* macros with inappropriate type -- but ...pending macros use int too: */ 593#define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL) 594#define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL) 595size_t BIO_ctrl_get_write_guarantee(BIO *b); 596size_t BIO_ctrl_get_read_request(BIO *b); 597int BIO_ctrl_reset_read_request(BIO *b); 598 599/* ctrl macros for dgram */ 600#define BIO_ctrl_dgram_connect(b,peer) \ 601 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)peer) 602#define BIO_ctrl_set_connected(b, state, peer) \ 603 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, state, (char *)peer) 604#define BIO_dgram_recv_timedout(b) \ 605 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL) 606#define BIO_dgram_send_timedout(b) \ 607 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL) 608#define BIO_dgram_get_peer(b,peer) \ 609 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)peer) 610#define BIO_dgram_set_peer(b,peer) \ 611 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)peer) 612#define BIO_dgram_get_mtu_overhead(b) \ 613 (unsigned int)BIO_ctrl((b), BIO_CTRL_DGRAM_GET_MTU_OVERHEAD, 0, NULL) 614 615/* These two aren't currently implemented */ 616/* int BIO_get_ex_num(BIO *bio); */ 617/* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */ 618int BIO_set_ex_data(BIO *bio,int idx,void *data); 619void *BIO_get_ex_data(BIO *bio,int idx); 620int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 621 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 622unsigned long BIO_number_read(BIO *bio); 623unsigned long BIO_number_written(BIO *bio); 624 625/* For BIO_f_asn1() */ 626int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix, 627 asn1_ps_func *prefix_free); 628int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix, 629 asn1_ps_func **pprefix_free); 630int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix, 631 asn1_ps_func *suffix_free); 632int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix, 633 asn1_ps_func **psuffix_free); 634 635# ifndef OPENSSL_NO_FP_API 636BIO_METHOD *BIO_s_file(void ); 637BIO *BIO_new_file(const char *filename, const char *mode); 638BIO *BIO_new_fp(FILE *stream, int close_flag); 639# define BIO_s_file_internal BIO_s_file 640# endif 641BIO * BIO_new(BIO_METHOD *type); 642int BIO_set(BIO *a,BIO_METHOD *type); 643int BIO_free(BIO *a); 644void BIO_vfree(BIO *a); 645int BIO_read(BIO *b, void *data, int len); 646int BIO_gets(BIO *bp,char *buf, int size); 647int BIO_write(BIO *b, const void *data, int len); 648int BIO_puts(BIO *bp,const char *buf); 649int BIO_indent(BIO *b,int indent,int max); 650long BIO_ctrl(BIO *bp,int cmd,long larg,void *parg); 651long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long)); 652char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg); 653long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg); 654BIO * BIO_push(BIO *b,BIO *append); 655BIO * BIO_pop(BIO *b); 656void BIO_free_all(BIO *a); 657BIO * BIO_find_type(BIO *b,int bio_type); 658BIO * BIO_next(BIO *b); 659BIO * BIO_get_retry_BIO(BIO *bio, int *reason); 660int BIO_get_retry_reason(BIO *bio); 661BIO * BIO_dup_chain(BIO *in); 662 663int BIO_nread0(BIO *bio, char **buf); 664int BIO_nread(BIO *bio, char **buf, int num); 665int BIO_nwrite0(BIO *bio, char **buf); 666int BIO_nwrite(BIO *bio, char **buf, int num); 667 668long BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi, 669 long argl,long ret); 670 671BIO_METHOD *BIO_s_mem(void); 672BIO *BIO_new_mem_buf(void *buf, int len); 673BIO_METHOD *BIO_s_socket(void); 674BIO_METHOD *BIO_s_connect(void); 675BIO_METHOD *BIO_s_accept(void); 676BIO_METHOD *BIO_s_fd(void); 677#ifndef OPENSSL_SYS_OS2 678BIO_METHOD *BIO_s_log(void); 679#endif 680BIO_METHOD *BIO_s_bio(void); 681BIO_METHOD *BIO_s_null(void); 682BIO_METHOD *BIO_f_null(void); 683BIO_METHOD *BIO_f_buffer(void); 684#ifdef OPENSSL_SYS_VMS 685BIO_METHOD *BIO_f_linebuffer(void); 686#endif 687BIO_METHOD *BIO_f_nbio_test(void); 688#ifndef OPENSSL_NO_DGRAM 689BIO_METHOD *BIO_s_datagram(void); 690#ifndef OPENSSL_NO_SCTP 691BIO_METHOD *BIO_s_datagram_sctp(void); 692#endif 693#endif 694 695/* BIO_METHOD *BIO_f_ber(void); */ 696 697int BIO_sock_should_retry(int i); 698int BIO_sock_non_fatal_error(int error); 699int BIO_dgram_non_fatal_error(int error); 700 701int BIO_fd_should_retry(int i); 702int BIO_fd_non_fatal_error(int error); 703int BIO_dump_cb(int (*cb)(const void *data, size_t len, void *u), 704 void *u, const char *s, int len); 705int BIO_dump_indent_cb(int (*cb)(const void *data, size_t len, void *u), 706 void *u, const char *s, int len, int indent); 707int BIO_dump(BIO *b,const char *bytes,int len); 708int BIO_dump_indent(BIO *b,const char *bytes,int len,int indent); 709#ifndef OPENSSL_NO_FP_API 710int BIO_dump_fp(FILE *fp, const char *s, int len); 711int BIO_dump_indent_fp(FILE *fp, const char *s, int len, int indent); 712#endif 713struct hostent *BIO_gethostbyname(const char *name); 714/* We might want a thread-safe interface too: 715 * struct hostent *BIO_gethostbyname_r(const char *name, 716 * struct hostent *result, void *buffer, size_t buflen); 717 * or something similar (caller allocates a struct hostent, 718 * pointed to by "result", and additional buffer space for the various 719 * substructures; if the buffer does not suffice, NULL is returned 720 * and an appropriate error code is set). 721 */ 722int BIO_sock_error(int sock); 723int BIO_socket_ioctl(int fd, long type, void *arg); 724int BIO_socket_nbio(int fd,int mode); 725int BIO_get_port(const char *str, unsigned short *port_ptr); 726int BIO_get_host_ip(const char *str, unsigned char *ip); 727int BIO_get_accept_socket(char *host_port,int mode); 728int BIO_accept(int sock,char **ip_port); 729int BIO_sock_init(void ); 730void BIO_sock_cleanup(void); 731int BIO_set_tcp_ndelay(int sock,int turn_on); 732 733BIO *BIO_new_socket(int sock, int close_flag); 734BIO *BIO_new_dgram(int fd, int close_flag); 735#ifndef OPENSSL_NO_SCTP 736BIO *BIO_new_dgram_sctp(int fd, int close_flag); 737int BIO_dgram_is_sctp(BIO *bio); 738int BIO_dgram_sctp_notification_cb(BIO *b, 739 void (*handle_notifications)(BIO *bio, void *context, void *buf), 740 void *context); 741int BIO_dgram_sctp_wait_for_dry(BIO *b); 742int BIO_dgram_sctp_msg_waiting(BIO *b); 743#endif 744BIO *BIO_new_fd(int fd, int close_flag); 745BIO *BIO_new_connect(char *host_port); 746BIO *BIO_new_accept(char *host_port); 747 748int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, 749 BIO **bio2, size_t writebuf2); 750/* If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints. 751 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. 752 * Size 0 uses default value. 753 */ 754 755void BIO_copy_next_retry(BIO *b); 756 757/*long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);*/ 758 759#ifdef __GNUC__ 760# define __bio_h__attr__ __attribute__ 761#else 762# define __bio_h__attr__(x) 763#endif 764int BIO_printf(BIO *bio, const char *format, ...) 765 __bio_h__attr__((__format__(__printf__,2,3))); 766int BIO_vprintf(BIO *bio, const char *format, va_list args) 767 __bio_h__attr__((__format__(__printf__,2,0))); 768int BIO_snprintf(char *buf, size_t n, const char *format, ...) 769 __bio_h__attr__((__format__(__printf__,3,4))); 770int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args) 771 __bio_h__attr__((__format__(__printf__,3,0))); 772#undef __bio_h__attr__ 773 774/* BEGIN ERROR CODES */ 775/* The following lines are auto generated by the script mkerr.pl. Any changes 776 * made after this point may be overwritten when the script is next run. 777 */ 778void ERR_load_BIO_strings(void); 779 780/* Error codes for the BIO functions. */ 781 782/* Function codes. */ 783#define BIO_F_ACPT_STATE 100 784#define BIO_F_BIO_ACCEPT 101 785#define BIO_F_BIO_BER_GET_HEADER 102 786#define BIO_F_BIO_CALLBACK_CTRL 131 787#define BIO_F_BIO_CTRL 103 788#define BIO_F_BIO_GETHOSTBYNAME 120 789#define BIO_F_BIO_GETS 104 790#define BIO_F_BIO_GET_ACCEPT_SOCKET 105 791#define BIO_F_BIO_GET_HOST_IP 106 792#define BIO_F_BIO_GET_PORT 107 793#define BIO_F_BIO_MAKE_PAIR 121 794#define BIO_F_BIO_NEW 108 795#define BIO_F_BIO_NEW_FILE 109 796#define BIO_F_BIO_NEW_MEM_BUF 126 797#define BIO_F_BIO_NREAD 123 798#define BIO_F_BIO_NREAD0 124 799#define BIO_F_BIO_NWRITE 125 800#define BIO_F_BIO_NWRITE0 122 801#define BIO_F_BIO_PUTS 110 802#define BIO_F_BIO_READ 111 803#define BIO_F_BIO_SOCK_INIT 112 804#define BIO_F_BIO_WRITE 113 805#define BIO_F_BUFFER_CTRL 114 806#define BIO_F_CONN_CTRL 127 807#define BIO_F_CONN_STATE 115 808#define BIO_F_DGRAM_SCTP_READ 132 809#define BIO_F_FILE_CTRL 116 810#define BIO_F_FILE_READ 130 811#define BIO_F_LINEBUFFER_CTRL 129 812#define BIO_F_MEM_READ 128 813#define BIO_F_MEM_WRITE 117 814#define BIO_F_SSL_NEW 118 815#define BIO_F_WSASTARTUP 119 816 817/* Reason codes. */ 818#define BIO_R_ACCEPT_ERROR 100 819#define BIO_R_BAD_FOPEN_MODE 101 820#define BIO_R_BAD_HOSTNAME_LOOKUP 102 821#define BIO_R_BROKEN_PIPE 124 822#define BIO_R_CONNECT_ERROR 103 823#define BIO_R_EOF_ON_MEMORY_BIO 127 824#define BIO_R_ERROR_SETTING_NBIO 104 825#define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET 105 826#define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET 106 827#define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET 107 828#define BIO_R_INVALID_ARGUMENT 125 829#define BIO_R_INVALID_IP_ADDRESS 108 830#define BIO_R_IN_USE 123 831#define BIO_R_KEEPALIVE 109 832#define BIO_R_NBIO_CONNECT_ERROR 110 833#define BIO_R_NO_ACCEPT_PORT_SPECIFIED 111 834#define BIO_R_NO_HOSTNAME_SPECIFIED 112 835#define BIO_R_NO_PORT_DEFINED 113 836#define BIO_R_NO_PORT_SPECIFIED 114 837#define BIO_R_NO_SUCH_FILE 128 838#define BIO_R_NULL_PARAMETER 115 839#define BIO_R_TAG_MISMATCH 116 840#define BIO_R_UNABLE_TO_BIND_SOCKET 117 841#define BIO_R_UNABLE_TO_CREATE_SOCKET 118 842#define BIO_R_UNABLE_TO_LISTEN_SOCKET 119 843#define BIO_R_UNINITIALIZED 120 844#define BIO_R_UNSUPPORTED_METHOD 121 845#define BIO_R_WRITE_TO_READ_ONLY_BIO 126 846#define BIO_R_WSASTARTUP 122 847 848#ifdef __cplusplus 849} 850#endif 851#endif 852