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 72 extern "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_ASN1 (22|0x0200) /* filter */ 99 #define BIO_TYPE_COMP (23|0x0200) /* filter */ 100 101 #define BIO_TYPE_DESCRIPTOR 0x0100 /* socket, fd, connect or accept */ 102 #define BIO_TYPE_FILTER 0x0200 103 #define BIO_TYPE_SOURCE_SINK 0x0400 104 105 /* BIO_FILENAME_READ|BIO_CLOSE to open or close on free. 106 * BIO_set_fp(in,stdin,BIO_NOCLOSE); */ 107 #define BIO_NOCLOSE 0x00 108 #define BIO_CLOSE 0x01 109 110 /* These are used in the following macros and are passed to 111 * BIO_ctrl() */ 112 #define BIO_CTRL_RESET 1 /* opt - rewind/zero etc */ 113 #define BIO_CTRL_EOF 2 /* opt - are we at the eof */ 114 #define BIO_CTRL_INFO 3 /* opt - extra tit-bits */ 115 #define BIO_CTRL_SET 4 /* man - set the 'IO' type */ 116 #define BIO_CTRL_GET 5 /* man - get the 'IO' type */ 117 #define BIO_CTRL_PUSH 6 /* opt - internal, used to signify change */ 118 #define BIO_CTRL_POP 7 /* opt - internal, used to signify change */ 119 #define BIO_CTRL_GET_CLOSE 8 /* man - set the 'close' on free */ 120 #define BIO_CTRL_SET_CLOSE 9 /* man - set the 'close' on free */ 121 #define BIO_CTRL_PENDING 10 /* opt - is their more data buffered */ 122 #define BIO_CTRL_FLUSH 11 /* opt - 'flush' buffered output */ 123 #define BIO_CTRL_DUP 12 /* man - extra stuff for 'duped' BIO */ 124 #define BIO_CTRL_WPENDING 13 /* opt - number of bytes still to write */ 125 /* callback is int cb(BIO *bio,state,ret); */ 126 #define BIO_CTRL_SET_CALLBACK 14 /* opt - set callback function */ 127 #define BIO_CTRL_GET_CALLBACK 15 /* opt - set callback function */ 128 129 #define BIO_CTRL_SET_FILENAME 30 /* BIO_s_file special */ 130 131 /* dgram BIO stuff */ 132 #define BIO_CTRL_DGRAM_CONNECT 31 /* BIO dgram special */ 133 #define BIO_CTRL_DGRAM_SET_CONNECTED 32 /* allow for an externally 134 * connected socket to be 135 * passed in */ 136 #define BIO_CTRL_DGRAM_SET_RECV_TIMEOUT 33 /* setsockopt, essentially */ 137 #define BIO_CTRL_DGRAM_GET_RECV_TIMEOUT 34 /* getsockopt, essentially */ 138 #define BIO_CTRL_DGRAM_SET_SEND_TIMEOUT 35 /* setsockopt, essentially */ 139 #define BIO_CTRL_DGRAM_GET_SEND_TIMEOUT 36 /* getsockopt, essentially */ 140 141 #define BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP 37 /* flag whether the last */ 142 #define BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP 38 /* I/O operation tiemd out */ 143 144 /* #ifdef IP_MTU_DISCOVER */ 145 #define BIO_CTRL_DGRAM_MTU_DISCOVER 39 /* set DF bit on egress packets */ 146 /* #endif */ 147 148 #define BIO_CTRL_DGRAM_QUERY_MTU 40 /* as kernel for current MTU */ 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 204 typedef struct bio_st BIO; 205 206 void BIO_set_flags(BIO *b, int flags); 207 int BIO_test_flags(const BIO *b, int flags); 208 void 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 258 long (*BIO_get_callback(const BIO *b)) (struct bio_st *,int,const char *,int, long,long); 259 void BIO_set_callback(BIO *b, 260 long (*callback)(struct bio_st *,int,const char *,int, long,long)); 261 char *BIO_get_callback_arg(const BIO *b); 262 void BIO_set_callback_arg(BIO *b, char *arg); 263 264 const char * BIO_method_name(const BIO *b); 265 int BIO_method_type(const BIO *b); 266 267 typedef void bio_info_cb(struct bio_st *, int, const char *, int, long, long); 268 269 typedef struct bio_method_st 270 { 271 int type; 272 const char *name; 273 int (*bwrite)(BIO *, const char *, int); 274 int (*bread)(BIO *, char *, int); 275 int (*bputs)(BIO *, const char *); 276 int (*bgets)(BIO *, char *, int); 277 long (*ctrl)(BIO *, int, long, void *); 278 int (*create)(BIO *); 279 int (*destroy)(BIO *); 280 long (*callback_ctrl)(BIO *, int, bio_info_cb *); 281 } BIO_METHOD; 282 283 struct bio_st 284 { 285 BIO_METHOD *method; 286 /* bio, mode, argp, argi, argl, ret */ 287 long (*callback)(struct bio_st *,int,const char *,int, long,long); 288 char *cb_arg; /* first argument for the callback */ 289 290 int init; 291 int shutdown; 292 int flags; /* extra storage */ 293 int retry_reason; 294 int num; 295 void *ptr; 296 struct bio_st *next_bio; /* used by filter BIOs */ 297 struct bio_st *prev_bio; /* used by filter BIOs */ 298 int references; 299 unsigned long num_read; 300 unsigned long num_write; 301 302 CRYPTO_EX_DATA ex_data; 303 }; 304 305 DECLARE_STACK_OF(BIO) 306 307 typedef struct bio_f_buffer_ctx_struct 308 { 309 /* Buffers are setup like this: 310 * 311 * <---------------------- size -----------------------> 312 * +---------------------------------------------------+ 313 * | consumed | remaining | free space | 314 * +---------------------------------------------------+ 315 * <-- off --><------- len -------> 316 */ 317 318 /* BIO *bio; */ /* this is now in the BIO struct */ 319 int ibuf_size; /* how big is the input buffer */ 320 int obuf_size; /* how big is the output buffer */ 321 322 char *ibuf; /* the char array */ 323 int ibuf_len; /* how many bytes are in it */ 324 int ibuf_off; /* write/read offset */ 325 326 char *obuf; /* the char array */ 327 int obuf_len; /* how many bytes are in it */ 328 int obuf_off; /* write/read offset */ 329 } BIO_F_BUFFER_CTX; 330 331 /* Prefix and suffix callback in ASN1 BIO */ 332 typedef int asn1_ps_func(BIO *b, unsigned char **pbuf, int *plen, void *parg); 333 334 /* connect BIO stuff */ 335 #define BIO_CONN_S_BEFORE 1 336 #define BIO_CONN_S_GET_IP 2 337 #define BIO_CONN_S_GET_PORT 3 338 #define BIO_CONN_S_CREATE_SOCKET 4 339 #define BIO_CONN_S_CONNECT 5 340 #define BIO_CONN_S_OK 6 341 #define BIO_CONN_S_BLOCKED_CONNECT 7 342 #define BIO_CONN_S_NBIO 8 343 /*#define BIO_CONN_get_param_hostname BIO_ctrl */ 344 345 #define BIO_C_SET_CONNECT 100 346 #define BIO_C_DO_STATE_MACHINE 101 347 #define BIO_C_SET_NBIO 102 348 #define BIO_C_SET_PROXY_PARAM 103 349 #define BIO_C_SET_FD 104 350 #define BIO_C_GET_FD 105 351 #define BIO_C_SET_FILE_PTR 106 352 #define BIO_C_GET_FILE_PTR 107 353 #define BIO_C_SET_FILENAME 108 354 #define BIO_C_SET_SSL 109 355 #define BIO_C_GET_SSL 110 356 #define BIO_C_SET_MD 111 357 #define BIO_C_GET_MD 112 358 #define BIO_C_GET_CIPHER_STATUS 113 359 #define BIO_C_SET_BUF_MEM 114 360 #define BIO_C_GET_BUF_MEM_PTR 115 361 #define BIO_C_GET_BUFF_NUM_LINES 116 362 #define BIO_C_SET_BUFF_SIZE 117 363 #define BIO_C_SET_ACCEPT 118 364 #define BIO_C_SSL_MODE 119 365 #define BIO_C_GET_MD_CTX 120 366 #define BIO_C_GET_PROXY_PARAM 121 367 #define BIO_C_SET_BUFF_READ_DATA 122 /* data to read first */ 368 #define BIO_C_GET_CONNECT 123 369 #define BIO_C_GET_ACCEPT 124 370 #define BIO_C_SET_SSL_RENEGOTIATE_BYTES 125 371 #define BIO_C_GET_SSL_NUM_RENEGOTIATES 126 372 #define BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT 127 373 #define BIO_C_FILE_SEEK 128 374 #define BIO_C_GET_CIPHER_CTX 129 375 #define BIO_C_SET_BUF_MEM_EOF_RETURN 130/*return end of input value*/ 376 #define BIO_C_SET_BIND_MODE 131 377 #define BIO_C_GET_BIND_MODE 132 378 #define BIO_C_FILE_TELL 133 379 #define BIO_C_GET_SOCKS 134 380 #define BIO_C_SET_SOCKS 135 381 382 #define BIO_C_SET_WRITE_BUF_SIZE 136/* for BIO_s_bio */ 383 #define BIO_C_GET_WRITE_BUF_SIZE 137 384 #define BIO_C_MAKE_BIO_PAIR 138 385 #define BIO_C_DESTROY_BIO_PAIR 139 386 #define BIO_C_GET_WRITE_GUARANTEE 140 387 #define BIO_C_GET_READ_REQUEST 141 388 #define BIO_C_SHUTDOWN_WR 142 389 #define BIO_C_NREAD0 143 390 #define BIO_C_NREAD 144 391 #define BIO_C_NWRITE0 145 392 #define BIO_C_NWRITE 146 393 #define BIO_C_RESET_READ_REQUEST 147 394 #define BIO_C_SET_MD_CTX 148 395 396 #define BIO_C_SET_PREFIX 149 397 #define BIO_C_GET_PREFIX 150 398 #define BIO_C_SET_SUFFIX 151 399 #define BIO_C_GET_SUFFIX 152 400 401 #define BIO_C_SET_EX_ARG 153 402 #define BIO_C_GET_EX_ARG 154 403 404 #define BIO_set_app_data(s,arg) BIO_set_ex_data(s,0,arg) 405 #define BIO_get_app_data(s) BIO_get_ex_data(s,0) 406 407 /* BIO_s_connect() and BIO_s_socks4a_connect() */ 408 #define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name) 409 #define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port) 410 #define BIO_set_conn_ip(b,ip) BIO_ctrl(b,BIO_C_SET_CONNECT,2,(char *)ip) 411 #define BIO_set_conn_int_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,3,(char *)port) 412 #define BIO_get_conn_hostname(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,0) 413 #define BIO_get_conn_port(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,1) 414 #define BIO_get_conn_ip(b) BIO_ptr_ctrl(b,BIO_C_GET_CONNECT,2) 415 #define BIO_get_conn_int_port(b) BIO_int_ctrl(b,BIO_C_GET_CONNECT,3,0) 416 417 418 #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) 419 420 /* BIO_s_accept_socket() */ 421 #define BIO_set_accept_port(b,name) BIO_ctrl(b,BIO_C_SET_ACCEPT,0,(char *)name) 422 #define BIO_get_accept_port(b) BIO_ptr_ctrl(b,BIO_C_GET_ACCEPT,0) 423 /* #define BIO_set_nbio(b,n) BIO_ctrl(b,BIO_C_SET_NBIO,(n),NULL) */ 424 #define BIO_set_nbio_accept(b,n) BIO_ctrl(b,BIO_C_SET_ACCEPT,1,(n)?(void *)"a":NULL) 425 #define BIO_set_accept_bios(b,bio) BIO_ctrl(b,BIO_C_SET_ACCEPT,2,(char *)bio) 426 427 #define BIO_BIND_NORMAL 0 428 #define BIO_BIND_REUSEADDR_IF_UNUSED 1 429 #define BIO_BIND_REUSEADDR 2 430 #define BIO_set_bind_mode(b,mode) BIO_ctrl(b,BIO_C_SET_BIND_MODE,mode,NULL) 431 #define BIO_get_bind_mode(b,mode) BIO_ctrl(b,BIO_C_GET_BIND_MODE,0,NULL) 432 433 #define BIO_do_connect(b) BIO_do_handshake(b) 434 #define BIO_do_accept(b) BIO_do_handshake(b) 435 #define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL) 436 437 /* BIO_s_proxy_client() */ 438 #define BIO_set_url(b,url) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,0,(char *)(url)) 439 #define BIO_set_proxies(b,p) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,1,(char *)(p)) 440 /* BIO_set_nbio(b,n) */ 441 #define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s)) 442 /* BIO *BIO_get_filter_bio(BIO *bio); */ 443 #define BIO_set_proxy_cb(b,cb) BIO_callback_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(void *(*cb)())) 444 #define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk) 445 #define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool) 446 447 #define BIO_get_proxy_header(b,skp) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,0,(char *)skp) 448 #define BIO_get_proxies(b,pxy_p) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,1,(char *)(pxy_p)) 449 #define BIO_get_url(b,url) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,2,(char *)(url)) 450 #define BIO_get_no_connect_return(b) BIO_ctrl(b,BIO_C_GET_PROXY_PARAM,5,NULL) 451 452 #define BIO_set_fd(b,fd,c) BIO_int_ctrl(b,BIO_C_SET_FD,c,fd) 453 #define BIO_get_fd(b,c) BIO_ctrl(b,BIO_C_GET_FD,0,(char *)c) 454 455 #define BIO_set_fp(b,fp,c) BIO_ctrl(b,BIO_C_SET_FILE_PTR,c,(char *)fp) 456 #define BIO_get_fp(b,fpp) BIO_ctrl(b,BIO_C_GET_FILE_PTR,0,(char *)fpp) 457 458 #define BIO_seek(b,ofs) (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL) 459 #define BIO_tell(b) (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL) 460 461 /* name is cast to lose const, but might be better to route through a function 462 so we can do it safely */ 463 #ifdef CONST_STRICT 464 /* If you are wondering why this isn't defined, its because CONST_STRICT is 465 * purely a compile-time kludge to allow const to be checked. 466 */ 467 int BIO_read_filename(BIO *b,const char *name); 468 #else 469 #define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 470 BIO_CLOSE|BIO_FP_READ,(char *)name) 471 #endif 472 #define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 473 BIO_CLOSE|BIO_FP_WRITE,name) 474 #define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 475 BIO_CLOSE|BIO_FP_APPEND,name) 476 #define BIO_rw_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \ 477 BIO_CLOSE|BIO_FP_READ|BIO_FP_WRITE,name) 478 479 /* WARNING WARNING, this ups the reference count on the read bio of the 480 * SSL structure. This is because the ssl read BIO is now pointed to by 481 * the next_bio field in the bio. So when you free the BIO, make sure 482 * you are doing a BIO_free_all() to catch the underlying BIO. */ 483 #define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl) 484 #define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp) 485 #define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL) 486 #define BIO_set_ssl_renegotiate_bytes(b,num) \ 487 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL); 488 #define BIO_get_num_renegotiates(b) \ 489 BIO_ctrl(b,BIO_C_GET_SSL_NUM_RENEGOTIATES,0,NULL); 490 #define BIO_set_ssl_renegotiate_timeout(b,seconds) \ 491 BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL); 492 493 /* defined in evp.h */ 494 /* #define BIO_set_md(b,md) BIO_ctrl(b,BIO_C_SET_MD,1,(char *)md) */ 495 496 #define BIO_get_mem_data(b,pp) BIO_ctrl(b,BIO_CTRL_INFO,0,(char *)pp) 497 #define BIO_set_mem_buf(b,bm,c) BIO_ctrl(b,BIO_C_SET_BUF_MEM,c,(char *)bm) 498 #define BIO_get_mem_ptr(b,pp) BIO_ctrl(b,BIO_C_GET_BUF_MEM_PTR,0,(char *)pp) 499 #define BIO_set_mem_eof_return(b,v) \ 500 BIO_ctrl(b,BIO_C_SET_BUF_MEM_EOF_RETURN,v,NULL) 501 502 /* For the BIO_f_buffer() type */ 503 #define BIO_get_buffer_num_lines(b) BIO_ctrl(b,BIO_C_GET_BUFF_NUM_LINES,0,NULL) 504 #define BIO_set_buffer_size(b,size) BIO_ctrl(b,BIO_C_SET_BUFF_SIZE,size,NULL) 505 #define BIO_set_read_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,0) 506 #define BIO_set_write_buffer_size(b,size) BIO_int_ctrl(b,BIO_C_SET_BUFF_SIZE,size,1) 507 #define BIO_set_buffer_read_data(b,buf,num) BIO_ctrl(b,BIO_C_SET_BUFF_READ_DATA,num,buf) 508 509 /* Don't use the next one unless you know what you are doing :-) */ 510 #define BIO_dup_state(b,ret) BIO_ctrl(b,BIO_CTRL_DUP,0,(char *)(ret)) 511 512 #define BIO_reset(b) (int)BIO_ctrl(b,BIO_CTRL_RESET,0,NULL) 513 #define BIO_eof(b) (int)BIO_ctrl(b,BIO_CTRL_EOF,0,NULL) 514 #define BIO_set_close(b,c) (int)BIO_ctrl(b,BIO_CTRL_SET_CLOSE,(c),NULL) 515 #define BIO_get_close(b) (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL) 516 #define BIO_pending(b) (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL) 517 #define BIO_wpending(b) (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL) 518 /* ...pending macros have inappropriate return type */ 519 size_t BIO_ctrl_pending(BIO *b); 520 size_t BIO_ctrl_wpending(BIO *b); 521 #define BIO_flush(b) (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL) 522 #define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0, \ 523 cbp) 524 #define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,cb) 525 526 /* For the BIO_f_buffer() type */ 527 #define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL) 528 529 /* For BIO_s_bio() */ 530 #define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL) 531 #define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL) 532 #define BIO_make_bio_pair(b1,b2) (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2) 533 #define BIO_destroy_bio_pair(b) (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL) 534 #define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 0, NULL) 535 /* macros with inappropriate type -- but ...pending macros use int too: */ 536 #define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL) 537 #define BIO_get_read_request(b) (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL) 538 size_t BIO_ctrl_get_write_guarantee(BIO *b); 539 size_t BIO_ctrl_get_read_request(BIO *b); 540 int BIO_ctrl_reset_read_request(BIO *b); 541 542 /* ctrl macros for dgram */ 543 #define BIO_ctrl_dgram_connect(b,peer) \ 544 (int)BIO_ctrl(b,BIO_CTRL_DGRAM_CONNECT,0, (char *)peer) 545 #define BIO_ctrl_set_connected(b, state, peer) \ 546 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_CONNECTED, state, (char *)peer) 547 #define BIO_dgram_recv_timedout(b) \ 548 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_RECV_TIMER_EXP, 0, NULL) 549 #define BIO_dgram_send_timedout(b) \ 550 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_SEND_TIMER_EXP, 0, NULL) 551 #define BIO_dgram_get_peer(b,peer) \ 552 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_GET_PEER, 0, (char *)peer) 553 #define BIO_dgram_set_peer(b,peer) \ 554 (int)BIO_ctrl(b, BIO_CTRL_DGRAM_SET_PEER, 0, (char *)peer) 555 556 /* These two aren't currently implemented */ 557 /* int BIO_get_ex_num(BIO *bio); */ 558 /* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */ 559 int BIO_set_ex_data(BIO *bio,int idx,void *data); 560 void *BIO_get_ex_data(BIO *bio,int idx); 561 int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 562 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 563 unsigned long BIO_number_read(BIO *bio); 564 unsigned long BIO_number_written(BIO *bio); 565 566 /* For BIO_f_asn1() */ 567 int BIO_asn1_set_prefix(BIO *b, asn1_ps_func *prefix, 568 asn1_ps_func *prefix_free); 569 int BIO_asn1_get_prefix(BIO *b, asn1_ps_func **pprefix, 570 asn1_ps_func **pprefix_free); 571 int BIO_asn1_set_suffix(BIO *b, asn1_ps_func *suffix, 572 asn1_ps_func *suffix_free); 573 int BIO_asn1_get_suffix(BIO *b, asn1_ps_func **psuffix, 574 asn1_ps_func **psuffix_free); 575 576 # ifndef OPENSSL_NO_FP_API 577 BIO_METHOD *BIO_s_file(void ); 578 BIO *BIO_new_file(const char *filename, const char *mode); 579 BIO *BIO_new_fp(FILE *stream, int close_flag); 580 # define BIO_s_file_internal BIO_s_file 581 # endif 582 BIO * BIO_new(BIO_METHOD *type); 583 int BIO_set(BIO *a,BIO_METHOD *type); 584 int BIO_free(BIO *a); 585 void BIO_vfree(BIO *a); 586 int BIO_read(BIO *b, void *data, int len); 587 int BIO_gets(BIO *bp,char *buf, int size); 588 int BIO_write(BIO *b, const void *data, int len); 589 int BIO_puts(BIO *bp,const char *buf); 590 int BIO_indent(BIO *b,int indent,int max); 591 long BIO_ctrl(BIO *bp,int cmd,long larg,void *parg); 592 long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long)); 593 char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg); 594 long BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg); 595 BIO * BIO_push(BIO *b,BIO *append); 596 BIO * BIO_pop(BIO *b); 597 void BIO_free_all(BIO *a); 598 BIO * BIO_find_type(BIO *b,int bio_type); 599 BIO * BIO_next(BIO *b); 600 BIO * BIO_get_retry_BIO(BIO *bio, int *reason); 601 int BIO_get_retry_reason(BIO *bio); 602 BIO * BIO_dup_chain(BIO *in); 603 604 int BIO_nread0(BIO *bio, char **buf); 605 int BIO_nread(BIO *bio, char **buf, int num); 606 int BIO_nwrite0(BIO *bio, char **buf); 607 int BIO_nwrite(BIO *bio, char **buf, int num); 608 609 long BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi, 610 long argl,long ret); 611 612 BIO_METHOD *BIO_s_mem(void); 613 BIO *BIO_new_mem_buf(void *buf, int len); 614 BIO_METHOD *BIO_s_socket(void); 615 BIO_METHOD *BIO_s_connect(void); 616 BIO_METHOD *BIO_s_accept(void); 617 BIO_METHOD *BIO_s_fd(void); 618 #ifndef OPENSSL_SYS_OS2 619 BIO_METHOD *BIO_s_log(void); 620 #endif 621 BIO_METHOD *BIO_s_bio(void); 622 BIO_METHOD *BIO_s_null(void); 623 BIO_METHOD *BIO_f_null(void); 624 BIO_METHOD *BIO_f_buffer(void); 625 #ifdef OPENSSL_SYS_VMS 626 BIO_METHOD *BIO_f_linebuffer(void); 627 #endif 628 BIO_METHOD *BIO_f_nbio_test(void); 629 #ifndef OPENSSL_NO_DGRAM 630 BIO_METHOD *BIO_s_datagram(void); 631 #endif 632 633 /* BIO_METHOD *BIO_f_ber(void); */ 634 635 int BIO_sock_should_retry(int i); 636 int BIO_sock_non_fatal_error(int error); 637 int BIO_dgram_non_fatal_error(int error); 638 639 int BIO_fd_should_retry(int i); 640 int BIO_fd_non_fatal_error(int error); 641 int BIO_dump_cb(int (*cb)(const void *data, size_t len, void *u), 642 void *u, const char *s, int len); 643 int BIO_dump_indent_cb(int (*cb)(const void *data, size_t len, void *u), 644 void *u, const char *s, int len, int indent); 645 int BIO_dump(BIO *b,const char *bytes,int len); 646 int BIO_dump_indent(BIO *b,const char *bytes,int len,int indent); 647 #ifndef OPENSSL_NO_FP_API 648 int BIO_dump_fp(FILE *fp, const char *s, int len); 649 int BIO_dump_indent_fp(FILE *fp, const char *s, int len, int indent); 650 #endif 651 struct hostent *BIO_gethostbyname(const char *name); 652 /* We might want a thread-safe interface too: 653 * struct hostent *BIO_gethostbyname_r(const char *name, 654 * struct hostent *result, void *buffer, size_t buflen); 655 * or something similar (caller allocates a struct hostent, 656 * pointed to by "result", and additional buffer space for the various 657 * substructures; if the buffer does not suffice, NULL is returned 658 * and an appropriate error code is set). 659 */ 660 int BIO_sock_error(int sock); 661 int BIO_socket_ioctl(int fd, long type, void *arg); 662 int BIO_socket_nbio(int fd,int mode); 663 int BIO_get_port(const char *str, unsigned short *port_ptr); 664 int BIO_get_host_ip(const char *str, unsigned char *ip); 665 int BIO_get_accept_socket(char *host_port,int mode); 666 int BIO_accept(int sock,char **ip_port); 667 int BIO_sock_init(void ); 668 void BIO_sock_cleanup(void); 669 int BIO_set_tcp_ndelay(int sock,int turn_on); 670 671 BIO *BIO_new_socket(int sock, int close_flag); 672 BIO *BIO_new_dgram(int fd, int close_flag); 673 BIO *BIO_new_fd(int fd, int close_flag); 674 BIO *BIO_new_connect(char *host_port); 675 BIO *BIO_new_accept(char *host_port); 676 677 int BIO_new_bio_pair(BIO **bio1, size_t writebuf1, 678 BIO **bio2, size_t writebuf2); 679 /* If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints. 680 * Otherwise returns 0 and sets *bio1 and *bio2 to NULL. 681 * Size 0 uses default value. 682 */ 683 684 void BIO_copy_next_retry(BIO *b); 685 686 /*long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);*/ 687 688 #ifdef __GNUC__ 689 # define __bio_h__attr__ __attribute__ 690 #else 691 # define __bio_h__attr__(x) 692 #endif 693 int BIO_printf(BIO *bio, const char *format, ...) 694 __bio_h__attr__((__format__(__printf__,2,3))); 695 int BIO_vprintf(BIO *bio, const char *format, va_list args) 696 __bio_h__attr__((__format__(__printf__,2,0))); 697 int BIO_snprintf(char *buf, size_t n, const char *format, ...) 698 __bio_h__attr__((__format__(__printf__,3,4))); 699 int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args) 700 __bio_h__attr__((__format__(__printf__,3,0))); 701 #undef __bio_h__attr__ 702 703 /* BEGIN ERROR CODES */ 704 /* The following lines are auto generated by the script mkerr.pl. Any changes 705 * made after this point may be overwritten when the script is next run. 706 */ 707 void ERR_load_BIO_strings(void); 708 709 /* Error codes for the BIO functions. */ 710 711 /* Function codes. */ 712 #define BIO_F_ACPT_STATE 100 713 #define BIO_F_BIO_ACCEPT 101 714 #define BIO_F_BIO_BER_GET_HEADER 102 715 #define BIO_F_BIO_CALLBACK_CTRL 131 716 #define BIO_F_BIO_CTRL 103 717 #define BIO_F_BIO_GETHOSTBYNAME 120 718 #define BIO_F_BIO_GETS 104 719 #define BIO_F_BIO_GET_ACCEPT_SOCKET 105 720 #define BIO_F_BIO_GET_HOST_IP 106 721 #define BIO_F_BIO_GET_PORT 107 722 #define BIO_F_BIO_MAKE_PAIR 121 723 #define BIO_F_BIO_NEW 108 724 #define BIO_F_BIO_NEW_FILE 109 725 #define BIO_F_BIO_NEW_MEM_BUF 126 726 #define BIO_F_BIO_NREAD 123 727 #define BIO_F_BIO_NREAD0 124 728 #define BIO_F_BIO_NWRITE 125 729 #define BIO_F_BIO_NWRITE0 122 730 #define BIO_F_BIO_PUTS 110 731 #define BIO_F_BIO_READ 111 732 #define BIO_F_BIO_SOCK_INIT 112 733 #define BIO_F_BIO_WRITE 113 734 #define BIO_F_BUFFER_CTRL 114 735 #define BIO_F_CONN_CTRL 127 736 #define BIO_F_CONN_STATE 115 737 #define BIO_F_FILE_CTRL 116 738 #define BIO_F_FILE_READ 130 739 #define BIO_F_LINEBUFFER_CTRL 129 740 #define BIO_F_MEM_READ 128 741 #define BIO_F_MEM_WRITE 117 742 #define BIO_F_SSL_NEW 118 743 #define BIO_F_WSASTARTUP 119 744 745 /* Reason codes. */ 746 #define BIO_R_ACCEPT_ERROR 100 747 #define BIO_R_BAD_FOPEN_MODE 101 748 #define BIO_R_BAD_HOSTNAME_LOOKUP 102 749 #define BIO_R_BROKEN_PIPE 124 750 #define BIO_R_CONNECT_ERROR 103 751 #define BIO_R_EOF_ON_MEMORY_BIO 127 752 #define BIO_R_ERROR_SETTING_NBIO 104 753 #define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET 105 754 #define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET 106 755 #define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET 107 756 #define BIO_R_INVALID_ARGUMENT 125 757 #define BIO_R_INVALID_IP_ADDRESS 108 758 #define BIO_R_IN_USE 123 759 #define BIO_R_KEEPALIVE 109 760 #define BIO_R_NBIO_CONNECT_ERROR 110 761 #define BIO_R_NO_ACCEPT_PORT_SPECIFIED 111 762 #define BIO_R_NO_HOSTNAME_SPECIFIED 112 763 #define BIO_R_NO_PORT_DEFINED 113 764 #define BIO_R_NO_PORT_SPECIFIED 114 765 #define BIO_R_NO_SUCH_FILE 128 766 #define BIO_R_NULL_PARAMETER 115 767 #define BIO_R_TAG_MISMATCH 116 768 #define BIO_R_UNABLE_TO_BIND_SOCKET 117 769 #define BIO_R_UNABLE_TO_CREATE_SOCKET 118 770 #define BIO_R_UNABLE_TO_LISTEN_SOCKET 119 771 #define BIO_R_UNINITIALIZED 120 772 #define BIO_R_UNSUPPORTED_METHOD 121 773 #define BIO_R_WRITE_TO_READ_ONLY_BIO 126 774 #define BIO_R_WSASTARTUP 122 775 776 #ifdef __cplusplus 777 } 778 #endif 779 #endif 780