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