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