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