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