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