crypto/bio/bio_lib.c

   1 /*
   2  * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #define OPENSSL_SUPPRESS_DEPRECATED
  11
  12 #include <stdio.h>
  13 #include <errno.h>
  14 #include <openssl/crypto.h>
  15 #include "bio_local.h"
  16
  17 /*
  18  * Helper macro for the callback to determine whether an operator expects a
  19  * len parameter or not
  20  */
  21 #define HAS_LEN_OPER(o) ((o) == BIO_CB_READ || (o) == BIO_CB_WRITE \
  22                          || (o) == BIO_CB_GETS)
  23
  24 #ifndef OPENSSL_NO_DEPRECATED_3_0
  25 # define HAS_CALLBACK(b) ((b)->callback != NULL || (b)->callback_ex != NULL)
  26 #else
  27 # define HAS_CALLBACK(b) ((b)->callback_ex != NULL)
  28 #endif
  29 /*
  30  * Helper function to work out whether to call the new style callback or the old
  31  * one, and translate between the two.
  32  *
  33  * This has a long return type for consistency with the old callback. Similarly
  34  * for the "long" used for "inret"
  35  */
  36 static long bio_call_callback(BIO *b, int oper, const char *argp, size_t len,
  37                               int argi, long argl, long inret,
  38                               size_t *processed)
  39 {
  40     long ret = inret;
  41 #ifndef OPENSSL_NO_DEPRECATED_3_0
  42     int bareoper;
  43
  44     if (b->callback_ex != NULL)
  45 #endif
  46         return b->callback_ex(b, oper, argp, len, argi, argl, inret, processed);
  47
  48 #ifndef OPENSSL_NO_DEPRECATED_3_0
  49     /* Strip off any BIO_CB_RETURN flag */
  50     bareoper = oper & ~BIO_CB_RETURN;
  51
  52     /*
  53      * We have an old style callback, so we will have to do nasty casts and
  54      * check for overflows.
  55      */
  56     if (HAS_LEN_OPER(bareoper)) {
  57         /* In this case |len| is set, and should be used instead of |argi| */
  58         if (len > INT_MAX)
  59             return -1;
  60
  61         argi = (int)len;
  62     }
  63
  64     if (inret > 0 && (oper & BIO_CB_RETURN) && bareoper != BIO_CB_CTRL) {
  65         if (*processed > INT_MAX)
  66             return -1;
  67         inret = *processed;
  68     }
  69
  70     ret = b->callback(b, oper, argp, argi, argl, inret);
  71
  72     if (ret > 0 && (oper & BIO_CB_RETURN) && bareoper != BIO_CB_CTRL) {
  73         *processed = (size_t)ret;
  74         ret = 1;
  75     }
  76 #endif
  77     return ret;
  78 }
  79
  80 BIO *BIO_new_ex(OSSL_LIB_CTX *libctx, const BIO_METHOD *method)
  81 {
  82     BIO *bio = OPENSSL_zalloc(sizeof(*bio));
  83
  84     if (bio == NULL) {
  85         ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE);
  86         return NULL;
  87     }
  88
  89     bio->libctx = libctx;
  90     bio->method = method;
  91     bio->shutdown = 1;
  92     bio->references = 1;
  93
  94     if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data))
  95         goto err;
  96
  97     bio->lock = CRYPTO_THREAD_lock_new();
  98     if (bio->lock == NULL) {
  99         ERR_raise(ERR_LIB_BIO, ERR_R_MALLOC_FAILURE);
 100         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data);
 101         goto err;
 102     }
 103
 104     if (method->create != NULL && !method->create(bio)) {
 105         ERR_raise(ERR_LIB_BIO, ERR_R_INIT_FAIL);
 106         CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data);
 107         CRYPTO_THREAD_lock_free(bio->lock);
 108         goto err;
 109     }
 110     if (method->create == NULL)
 111         bio->init = 1;
 112
 113     return bio;
 114
 115 err:
 116     OPENSSL_free(bio);
 117     return NULL;
 118 }
 119
 120 BIO *BIO_new(const BIO_METHOD *method)
 121 {
 122     return BIO_new_ex(NULL, method);
 123 }
 124
 125 int BIO_free(BIO *a)
 126 {
 127     int ret;
 128
 129     if (a == NULL)
 130         return 0;
 131
 132     if (CRYPTO_DOWN_REF(&a->references, &ret, a->lock) <= 0)
 133         return 0;
 134
 135     REF_PRINT_COUNT("BIO", a);
 136     if (ret > 0)
 137         return 1;
 138     REF_ASSERT_ISNT(ret < 0);
 139
 140     if (HAS_CALLBACK(a)) {
 141         ret = (int)bio_call_callback(a, BIO_CB_FREE, NULL, 0, 0, 0L, 1L, NULL);
 142         if (ret <= 0)
 143             return 0;
 144     }
 145
 146     if ((a->method != NULL) && (a->method->destroy != NULL))
 147         a->method->destroy(a);
 148
 149     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, a, &a->ex_data);
 150
 151     CRYPTO_THREAD_lock_free(a->lock);
 152
 153     OPENSSL_free(a);
 154
 155     return 1;
 156 }
 157
 158 void BIO_set_data(BIO *a, void *ptr)
 159 {
 160     a->ptr = ptr;
 161 }
 162
 163 void *BIO_get_data(BIO *a)
 164 {
 165     return a->ptr;
 166 }
 167
 168 void BIO_set_init(BIO *a, int init)
 169 {
 170     a->init = init;
 171 }
 172
 173 int BIO_get_init(BIO *a)
 174 {
 175     return a->init;
 176 }
 177
 178 void BIO_set_shutdown(BIO *a, int shut)
 179 {
 180     a->shutdown = shut;
 181 }
 182
 183 int BIO_get_shutdown(BIO *a)
 184 {
 185     return a->shutdown;
 186 }
 187
 188 void BIO_vfree(BIO *a)
 189 {
 190     BIO_free(a);
 191 }
 192
 193 int BIO_up_ref(BIO *a)
 194 {
 195     int i;
 196
 197     if (CRYPTO_UP_REF(&a->references, &i, a->lock) <= 0)
 198         return 0;
 199
 200     REF_PRINT_COUNT("BIO", a);
 201     REF_ASSERT_ISNT(i < 2);
 202     return i > 1;
 203 }
 204
 205 void BIO_clear_flags(BIO *b, int flags)
 206 {
 207     b->flags &= ~flags;
 208 }
 209
 210 int BIO_test_flags(const BIO *b, int flags)
 211 {
 212     return (b->flags & flags);
 213 }
 214
 215 void BIO_set_flags(BIO *b, int flags)
 216 {
 217     b->flags |= flags;
 218 }
 219
 220 #ifndef OPENSSL_NO_DEPRECATED_3_0
 221 BIO_callback_fn BIO_get_callback(const BIO *b)
 222 {
 223     return b->callback;
 224 }
 225
 226 void BIO_set_callback(BIO *b, BIO_callback_fn cb)
 227 {
 228     b->callback = cb;
 229 }
 230 #endif
 231
 232 BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b)
 233 {
 234     return b->callback_ex;
 235 }
 236
 237 void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex cb)
 238 {
 239     b->callback_ex = cb;
 240 }
 241
 242 void BIO_set_callback_arg(BIO *b, char *arg)
 243 {
 244     b->cb_arg = arg;
 245 }
 246
 247 char *BIO_get_callback_arg(const BIO *b)
 248 {
 249     return b->cb_arg;
 250 }
 251
 252 const char *BIO_method_name(const BIO *b)
 253 {
 254     return b->method->name;
 255 }
 256
 257 int BIO_method_type(const BIO *b)
 258 {
 259     return b->method->type;
 260 }
 261
 262 /*
 263  * This is essentially the same as BIO_read_ex() except that it allows
 264  * 0 or a negative value to indicate failure (retryable or not) in the return.
 265  * This is for compatibility with the old style BIO_read(), where existing code
 266  * may make assumptions about the return value that it might get.
 267  */
 268 static int bio_read_intern(BIO *b, void *data, size_t dlen, size_t *readbytes)
 269 {
 270     int ret;
 271
 272     if (b == NULL) {
 273         ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
 274         return -1;
 275     }
 276     if (b->method == NULL || b->method->bread == NULL) {
 277         ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
 278         return -2;
 279     }
 280
 281     if (HAS_CALLBACK(b) &&
 282         ((ret = (int)bio_call_callback(b, BIO_CB_READ, data, dlen, 0, 0L, 1L,
 283                                        NULL)) <= 0))
 284         return ret;
 285
 286     if (!b->init) {
 287         ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
 288         return -1;
 289     }
 290
 291     ret = b->method->bread(b, data, dlen, readbytes);
 292
 293     if (ret > 0)
 294         b->num_read += (uint64_t)*readbytes;
 295
 296     if (HAS_CALLBACK(b))
 297         ret = (int)bio_call_callback(b, BIO_CB_READ | BIO_CB_RETURN, data,
 298                                      dlen, 0, 0L, ret, readbytes);
 299
 300     /* Shouldn't happen */
 301     if (ret > 0 && *readbytes > dlen) {
 302         ERR_raise(ERR_LIB_BIO, ERR_R_INTERNAL_ERROR);
 303         return -1;
 304     }
 305
 306     return ret;
 307 }
 308
 309 int BIO_read(BIO *b, void *data, int dlen)
 310 {
 311     size_t readbytes;
 312     int ret;
 313
 314     if (dlen < 0)
 315         return 0;
 316
 317     ret = bio_read_intern(b, data, (size_t)dlen, &readbytes);
 318
 319     if (ret > 0) {
 320         /* *readbytes should always be <= dlen */
 321         ret = (int)readbytes;
 322     }
 323
 324     return ret;
 325 }
 326
 327 int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes)
 328 {
 329     return bio_read_intern(b, data, dlen, readbytes) > 0;
 330 }
 331
 332 static int bio_write_intern(BIO *b, const void *data, size_t dlen,
 333                             size_t *written)
 334 {
 335     size_t local_written;
 336     int ret;
 337
 338     if (written != NULL)
 339         *written = 0;
 340     /*
 341      * b == NULL is not an error but just means that zero bytes are written.
 342      * Do not raise an error here.
 343      */
 344     if (b == NULL)
 345         return 0;
 346
 347     if (b->method == NULL || b->method->bwrite == NULL) {
 348         ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
 349         return -2;
 350     }
 351
 352     if (HAS_CALLBACK(b) &&
 353         ((ret = (int)bio_call_callback(b, BIO_CB_WRITE, data, dlen, 0, 0L, 1L,
 354                                        NULL)) <= 0))
 355         return ret;
 356
 357     if (!b->init) {
 358         ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
 359         return -1;
 360     }
 361
 362     ret = b->method->bwrite(b, data, dlen, &local_written);
 363
 364     if (ret > 0)
 365         b->num_write += (uint64_t)local_written;
 366
 367     if (HAS_CALLBACK(b))
 368         ret = (int)bio_call_callback(b, BIO_CB_WRITE | BIO_CB_RETURN, data,
 369                                      dlen, 0, 0L, ret, &local_written);
 370
 371     if (written != NULL)
 372         *written = local_written;
 373     return ret;
 374 }
 375
 376 int BIO_write(BIO *b, const void *data, int dlen)
 377 {
 378     size_t written;
 379     int ret;
 380
 381     if (dlen <= 0)
 382         return 0;
 383
 384     ret = bio_write_intern(b, data, (size_t)dlen, &written);
 385
 386     if (ret > 0) {
 387         /* written should always be <= dlen */
 388         ret = (int)written;
 389     }
 390
 391     return ret;
 392 }
 393
 394 int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written)
 395 {
 396     return bio_write_intern(b, data, dlen, written) > 0
 397         || (b != NULL && dlen == 0); /* order is important for *written */
 398 }
 399
 400 int BIO_puts(BIO *b, const char *buf)
 401 {
 402     int ret;
 403     size_t written = 0;
 404
 405     if (b == NULL) {
 406         ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
 407         return -1;
 408     }
 409     if (b->method == NULL || b->method->bputs == NULL) {
 410         ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
 411         return -2;
 412     }
 413
 414     if (HAS_CALLBACK(b)) {
 415         ret = (int)bio_call_callback(b, BIO_CB_PUTS, buf, 0, 0, 0L, 1L, NULL);
 416         if (ret <= 0)
 417             return ret;
 418     }
 419
 420     if (!b->init) {
 421         ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
 422         return -1;
 423     }
 424
 425     ret = b->method->bputs(b, buf);
 426
 427     if (ret > 0) {
 428         b->num_write += (uint64_t)ret;
 429         written = ret;
 430         ret = 1;
 431     }
 432
 433     if (HAS_CALLBACK(b))
 434         ret = (int)bio_call_callback(b, BIO_CB_PUTS | BIO_CB_RETURN, buf, 0, 0,
 435                                      0L, ret, &written);
 436
 437     if (ret > 0) {
 438         if (written > INT_MAX) {
 439             ERR_raise(ERR_LIB_BIO, BIO_R_LENGTH_TOO_LONG);
 440             ret = -1;
 441         } else {
 442             ret = (int)written;
 443         }
 444     }
 445
 446     return ret;
 447 }
 448
 449 int BIO_gets(BIO *b, char *buf, int size)
 450 {
 451     int ret;
 452     size_t readbytes = 0;
 453
 454     if (b == NULL) {
 455         ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
 456         return -1;
 457     }
 458     if (b->method == NULL || b->method->bgets == NULL) {
 459         ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
 460         return -2;
 461     }
 462
 463     if (size < 0) {
 464         ERR_raise(ERR_LIB_BIO, BIO_R_INVALID_ARGUMENT);
 465         return -1;
 466     }
 467
 468     if (HAS_CALLBACK(b)) {
 469         ret = (int)bio_call_callback(b, BIO_CB_GETS, buf, size, 0, 0L, 1, NULL);
 470         if (ret <= 0)
 471             return ret;
 472     }
 473
 474     if (!b->init) {
 475         ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
 476         return -1;
 477     }
 478
 479     ret = b->method->bgets(b, buf, size);
 480
 481     if (ret > 0) {
 482         readbytes = ret;
 483         ret = 1;
 484     }
 485
 486     if (HAS_CALLBACK(b))
 487         ret = (int)bio_call_callback(b, BIO_CB_GETS | BIO_CB_RETURN, buf, size,
 488                                      0, 0L, ret, &readbytes);
 489
 490     if (ret > 0) {
 491         /* Shouldn't happen */
 492         if (readbytes > (size_t)size)
 493             ret = -1;
 494         else
 495             ret = (int)readbytes;
 496     }
 497
 498     return ret;
 499 }
 500
 501 int BIO_get_line(BIO *bio, char *buf, int size)
 502 {
 503     int ret = 0;
 504     char *ptr = buf;
 505
 506     if (buf == NULL) {
 507         ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
 508         return -1;
 509     }
 510     if (size <= 0) {
 511         ERR_raise(ERR_LIB_BIO, BIO_R_INVALID_ARGUMENT);
 512         return -1;
 513     }
 514     *buf = '\0';
 515
 516     if (bio == NULL) {
 517         ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
 518         return -1;
 519     }
 520     if (!bio->init) {
 521         ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
 522         return -1;
 523     }
 524
 525     while (size-- > 1 && (ret = BIO_read(bio, ptr, 1)) > 0)
 526         if (*ptr++ == '\n')
 527             break;
 528     *ptr = '\0';
 529     return ret > 0 || BIO_eof(bio) ? ptr - buf : ret;
 530 }
 531
 532 int BIO_indent(BIO *b, int indent, int max)
 533 {
 534     if (indent < 0)
 535         indent = 0;
 536     if (indent > max)
 537         indent = max;
 538     while (indent--)
 539         if (BIO_puts(b, " ") != 1)
 540             return 0;
 541     return 1;
 542 }
 543
 544 long BIO_int_ctrl(BIO *b, int cmd, long larg, int iarg)
 545 {
 546     int i;
 547
 548     i = iarg;
 549     return BIO_ctrl(b, cmd, larg, (char *)&i);
 550 }
 551
 552 void *BIO_ptr_ctrl(BIO *b, int cmd, long larg)
 553 {
 554     void *p = NULL;
 555
 556     if (BIO_ctrl(b, cmd, larg, (char *)&p) <= 0)
 557         return NULL;
 558     else
 559         return p;
 560 }
 561
 562 long BIO_ctrl(BIO *b, int cmd, long larg, void *parg)
 563 {
 564     long ret;
 565
 566     if (b == NULL)
 567         return -1;
 568     if (b->method == NULL || b->method->ctrl == NULL) {
 569         ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
 570         return -2;
 571     }
 572
 573     if (HAS_CALLBACK(b)) {
 574         ret = bio_call_callback(b, BIO_CB_CTRL, parg, 0, cmd, larg, 1L, NULL);
 575         if (ret <= 0)
 576             return ret;
 577     }
 578
 579     ret = b->method->ctrl(b, cmd, larg, parg);
 580
 581     if (HAS_CALLBACK(b))
 582         ret = bio_call_callback(b, BIO_CB_CTRL | BIO_CB_RETURN, parg, 0, cmd,
 583                                 larg, ret, NULL);
 584
 585     return ret;
 586 }
 587
 588 long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp)
 589 {
 590     long ret;
 591
 592     if (b == NULL)
 593         return -2;
 594     if (b->method == NULL || b->method->callback_ctrl == NULL
 595             || cmd != BIO_CTRL_SET_CALLBACK) {
 596         ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
 597         return -2;
 598     }
 599
 600     if (HAS_CALLBACK(b)) {
 601         ret = bio_call_callback(b, BIO_CB_CTRL, (void *)&fp, 0, cmd, 0, 1L,
 602                                 NULL);
 603         if (ret <= 0)
 604             return ret;
 605     }
 606
 607     ret = b->method->callback_ctrl(b, cmd, fp);
 608
 609     if (HAS_CALLBACK(b))
 610         ret = bio_call_callback(b, BIO_CB_CTRL | BIO_CB_RETURN, (void *)&fp, 0,
 611                                 cmd, 0, ret, NULL);
 612
 613     return ret;
 614 }
 615
 616 /*
 617  * It is unfortunate to duplicate in functions what the BIO_(w)pending macros
 618  * do; but those macros have inappropriate return type, and for interfacing
 619  * from other programming languages, C macros aren't much of a help anyway.
 620  */
 621 size_t BIO_ctrl_pending(BIO *bio)
 622 {
 623     return BIO_ctrl(bio, BIO_CTRL_PENDING, 0, NULL);
 624 }
 625
 626 size_t BIO_ctrl_wpending(BIO *bio)
 627 {
 628     return BIO_ctrl(bio, BIO_CTRL_WPENDING, 0, NULL);
 629 }
 630
 631 /* put the 'bio' on the end of b's list of operators */
 632 BIO *BIO_push(BIO *b, BIO *bio)
 633 {
 634     BIO *lb;
 635
 636     if (b == NULL)
 637         return bio;
 638     lb = b;
 639     while (lb->next_bio != NULL)
 640         lb = lb->next_bio;
 641     lb->next_bio = bio;
 642     if (bio != NULL)
 643         bio->prev_bio = lb;
 644     /* called to do internal processing */
 645     BIO_ctrl(b, BIO_CTRL_PUSH, 0, lb);
 646     return b;
 647 }
 648
 649 /* Remove the first and return the rest */
 650 BIO *BIO_pop(BIO *b)
 651 {
 652     BIO *ret;
 653
 654     if (b == NULL)
 655         return NULL;
 656     ret = b->next_bio;
 657
 658     BIO_ctrl(b, BIO_CTRL_POP, 0, b);
 659
 660     if (b->prev_bio != NULL)
 661         b->prev_bio->next_bio = b->next_bio;
 662     if (b->next_bio != NULL)
 663         b->next_bio->prev_bio = b->prev_bio;
 664
 665     b->next_bio = NULL;
 666     b->prev_bio = NULL;
 667     return ret;
 668 }
 669
 670 BIO *BIO_get_retry_BIO(BIO *bio, int *reason)
 671 {
 672     BIO *b, *last;
 673
 674     b = last = bio;
 675     for (;;) {
 676         if (!BIO_should_retry(b))
 677             break;
 678         last = b;
 679         b = b->next_bio;
 680         if (b == NULL)
 681             break;
 682     }
 683     if (reason != NULL)
 684         *reason = last->retry_reason;
 685     return last;
 686 }
 687
 688 int BIO_get_retry_reason(BIO *bio)
 689 {
 690     return bio->retry_reason;
 691 }
 692
 693 void BIO_set_retry_reason(BIO *bio, int reason)
 694 {
 695     bio->retry_reason = reason;
 696 }
 697
 698 BIO *BIO_find_type(BIO *bio, int type)
 699 {
 700     int mt, mask;
 701
 702     if (bio == NULL) {
 703         ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
 704         return NULL;
 705     }
 706     mask = type & 0xff;
 707     do {
 708         if (bio->method != NULL) {
 709             mt = bio->method->type;
 710
 711             if (!mask) {
 712                 if (mt & type)
 713                     return bio;
 714             } else if (mt == type) {
 715                 return bio;
 716             }
 717         }
 718         bio = bio->next_bio;
 719     } while (bio != NULL);
 720     return NULL;
 721 }
 722
 723 BIO *BIO_next(BIO *b)
 724 {
 725     if (b == NULL)
 726         return NULL;
 727     return b->next_bio;
 728 }
 729
 730 void BIO_set_next(BIO *b, BIO *next)
 731 {
 732     b->next_bio = next;
 733 }
 734
 735 void BIO_free_all(BIO *bio)
 736 {
 737     BIO *b;
 738     int ref;
 739
 740     while (bio != NULL) {
 741         b = bio;
 742         ref = b->references;
 743         bio = bio->next_bio;
 744         BIO_free(b);
 745         /* Since ref count > 1, don't free anyone else. */
 746         if (ref > 1)
 747             break;
 748     }
 749 }
 750
 751 BIO *BIO_dup_chain(BIO *in)
 752 {
 753     BIO *ret = NULL, *eoc = NULL, *bio, *new_bio;
 754
 755     for (bio = in; bio != NULL; bio = bio->next_bio) {
 756         if ((new_bio = BIO_new(bio->method)) == NULL)
 757             goto err;
 758 #ifndef OPENSSL_NO_DEPRECATED_3_0
 759         new_bio->callback = bio->callback;
 760 #endif
 761         new_bio->callback_ex = bio->callback_ex;
 762         new_bio->cb_arg = bio->cb_arg;
 763         new_bio->init = bio->init;
 764         new_bio->shutdown = bio->shutdown;
 765         new_bio->flags = bio->flags;
 766
 767         /* This will let SSL_s_sock() work with stdin/stdout */
 768         new_bio->num = bio->num;
 769
 770         if (!BIO_dup_state(bio, (char *)new_bio)) {
 771             BIO_free(new_bio);
 772             goto err;
 773         }
 774
 775         /* copy app data */
 776         if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_BIO, &new_bio->ex_data,
 777                                 &bio->ex_data)) {
 778             BIO_free(new_bio);
 779             goto err;
 780         }
 781
 782         if (ret == NULL) {
 783             eoc = new_bio;
 784             ret = eoc;
 785         } else {
 786             BIO_push(eoc, new_bio);
 787             eoc = new_bio;
 788         }
 789     }
 790     return ret;
 791  err:
 792     BIO_free_all(ret);
 793
 794     return NULL;
 795 }
 796
 797 void BIO_copy_next_retry(BIO *b)
 798 {
 799     BIO_set_flags(b, BIO_get_retry_flags(b->next_bio));
 800     b->retry_reason = b->next_bio->retry_reason;
 801 }
 802
 803 int BIO_set_ex_data(BIO *bio, int idx, void *data)
 804 {
 805     return CRYPTO_set_ex_data(&(bio->ex_data), idx, data);
 806 }
 807
 808 void *BIO_get_ex_data(const BIO *bio, int idx)
 809 {
 810     return CRYPTO_get_ex_data(&(bio->ex_data), idx);
 811 }
 812
 813 uint64_t BIO_number_read(BIO *bio)
 814 {
 815     if (bio)
 816         return bio->num_read;
 817     return 0;
 818 }
 819
 820 uint64_t BIO_number_written(BIO *bio)
 821 {
 822     if (bio)
 823         return bio->num_write;
 824     return 0;
 825 }
 826
 827 void bio_free_ex_data(BIO *bio)
 828 {
 829     CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data);
 830 }
 831
 832 void bio_cleanup(void)
 833 {
 834 #ifndef OPENSSL_NO_SOCK
 835     bio_sock_cleanup_int();
 836     CRYPTO_THREAD_lock_free(bio_lookup_lock);
 837     bio_lookup_lock = NULL;
 838 #endif
 839     CRYPTO_THREAD_lock_free(bio_type_lock);
 840     bio_type_lock = NULL;
 841 }
 842
 843 /* Internal variant of the below BIO_wait() not calling BIOerr() */
 844 static int bio_wait(BIO *bio, time_t max_time, unsigned int nap_milliseconds)
 845 {
 846 #ifndef OPENSSL_NO_SOCK
 847     int fd;
 848 #endif
 849     long sec_diff;
 850
 851     if (max_time == 0) /* no timeout */
 852         return 1;
 853
 854 #ifndef OPENSSL_NO_SOCK
 855     if (BIO_get_fd(bio, &fd) > 0 && fd < FD_SETSIZE)
 856         return BIO_socket_wait(fd, BIO_should_read(bio), max_time);
 857 #endif
 858     /* fall back to polling since no sockets are available */
 859
 860     sec_diff = (long)(max_time - time(NULL)); /* might overflow */
 861     if (sec_diff < 0)
 862         return 0; /* clearly timeout */
 863
 864     /* now take a nap at most the given number of milliseconds */
 865     if (sec_diff == 0) { /* we are below the 1 seconds resolution of max_time */
 866         if (nap_milliseconds > 1000)
 867             nap_milliseconds = 1000;
 868     } else { /* for sec_diff > 0, take min(sec_diff * 1000, nap_milliseconds) */
 869         if ((unsigned long)sec_diff * 1000 < nap_milliseconds)
 870             nap_milliseconds = (unsigned int)sec_diff * 1000;
 871     }
 872     ossl_sleep(nap_milliseconds);
 873     return 1;
 874 }
 875
 876 /*-
 877  * Wait on (typically socket-based) BIO at most until max_time.
 878  * Succeed immediately if max_time == 0.
 879  * If sockets are not available support polling: succeed after waiting at most
 880  * the number of nap_milliseconds in order to avoid a tight busy loop.
 881  * Call BIOerr(...) on timeout or error.
 882  * Returns -1 on error, 0 on timeout, and 1 on success.
 883  */
 884 int BIO_wait(BIO *bio, time_t max_time, unsigned int nap_milliseconds)
 885 {
 886     int rv = bio_wait(bio, max_time, nap_milliseconds);
 887
 888     if (rv <= 0)
 889         ERR_raise(ERR_LIB_BIO,
 890                   rv == 0 ? BIO_R_TRANSFER_TIMEOUT : BIO_R_TRANSFER_ERROR);
 891     return rv;
 892 }
 893
 894 /*
 895  * Connect via given BIO using BIO_do_connect() until success/timeout/error.
 896  * Parameter timeout == 0 means no timeout, < 0 means exactly one try.
 897  * For non-blocking and potentially even non-socket BIOs perform polling with
 898  * the given density: between polls sleep nap_milliseconds using BIO_wait()
 899  * in order to avoid a tight busy loop.
 900  * Returns -1 on error, 0 on timeout, and 1 on success.
 901  */
 902 int BIO_do_connect_retry(BIO *bio, int timeout, int nap_milliseconds)
 903 {
 904     int blocking = timeout <= 0;
 905     time_t max_time = timeout > 0 ? time(NULL) + timeout : 0;
 906     int rv;
 907
 908     if (bio == NULL) {
 909         ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
 910         return -1;
 911     }
 912
 913     if (nap_milliseconds < 0)
 914         nap_milliseconds = 100;
 915     BIO_set_nbio(bio, !blocking);
 916
 917  retry:
 918     ERR_set_mark();
 919     rv = BIO_do_connect(bio);
 920
 921     if (rv <= 0) { /* could be timeout or retryable error or fatal error */
 922         int err = ERR_peek_last_error();
 923         int reason = ERR_GET_REASON(err);
 924         int do_retry = BIO_should_retry(bio); /* may be 1 only if !blocking */
 925
 926         if (ERR_GET_LIB(err) == ERR_LIB_BIO) {
 927             switch (reason) {
 928             case ERR_R_SYS_LIB:
 929                 /*
 930                  * likely retryable system error occurred, which may be
 931                  * EAGAIN (resource temporarily unavailable) some 40 secs after
 932                  * calling getaddrinfo(): Temporary failure in name resolution
 933                  * or a premature ETIMEDOUT, some 30 seconds after connect()
 934                  */
 935             case BIO_R_CONNECT_ERROR:
 936             case BIO_R_NBIO_CONNECT_ERROR:
 937                 /* some likely retryable connection error occurred */
 938                 (void)BIO_reset(bio); /* often needed to avoid retry failure */
 939                 do_retry = 1;
 940                 break;
 941             default:
 942                 break;
 943             }
 944         }
 945         if (timeout >= 0 && do_retry) {
 946             ERR_pop_to_mark();
 947             /* will not actually wait if timeout == 0 (i.e., blocking BIO): */
 948             rv = bio_wait(bio, max_time, nap_milliseconds);
 949             if (rv > 0)
 950                 goto retry;
 951             ERR_raise(ERR_LIB_BIO,
 952                       rv == 0 ? BIO_R_CONNECT_TIMEOUT : BIO_R_CONNECT_ERROR);
 953         } else {
 954             ERR_clear_last_mark();
 955             rv = -1;
 956             if (err == 0) /* missing error queue entry */
 957                 /* workaround: general error */
 958                 ERR_raise(ERR_LIB_BIO, BIO_R_CONNECT_ERROR);
 959         }
 960     } else {
 961         ERR_clear_last_mark();
 962     }
 963
 964     return rv;
 965 }