2 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
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
10 #define OPENSSL_SUPPRESS_DEPRECATED
14 #include <openssl/crypto.h>
15 #include "internal/numbers.h"
16 #include "bio_local.h"
19 * Helper macro for the callback to determine whether an operator expects a
20 * len parameter or not
22 #define HAS_LEN_OPER(o) ((o) == BIO_CB_READ || (o) == BIO_CB_WRITE \
23 || (o) == BIO_CB_GETS)
25 #ifndef OPENSSL_NO_DEPRECATED_3_0
26 # define HAS_CALLBACK(b) ((b)->callback != NULL || (b)->callback_ex != NULL)
28 # define HAS_CALLBACK(b) ((b)->callback_ex != NULL)
31 * Helper function to work out whether to call the new style callback or the old
32 * one, and translate between the two.
34 * This has a long return type for consistency with the old callback. Similarly
35 * for the "long" used for "inret"
37 static long bio_call_callback(BIO *b, int oper, const char *argp, size_t len,
38 int argi, long argl, long inret,
42 #ifndef OPENSSL_NO_DEPRECATED_3_0
45 if (b->callback_ex != NULL)
47 return b->callback_ex(b, oper, argp, len, argi, argl, inret, processed);
49 #ifndef OPENSSL_NO_DEPRECATED_3_0
50 /* Strip off any BIO_CB_RETURN flag */
51 bareoper = oper & ~BIO_CB_RETURN;
54 * We have an old style callback, so we will have to do nasty casts and
55 * check for overflows.
57 if (HAS_LEN_OPER(bareoper)) {
58 /* In this case |len| is set, and should be used instead of |argi| */
65 if (inret > 0 && (oper & BIO_CB_RETURN) && bareoper != BIO_CB_CTRL) {
66 if (*processed > INT_MAX)
71 ret = b->callback(b, oper, argp, argi, argl, inret);
73 if (ret > 0 && (oper & BIO_CB_RETURN) && bareoper != BIO_CB_CTRL) {
74 *processed = (size_t)ret;
81 BIO *BIO_new_ex(OSSL_LIB_CTX *libctx, const BIO_METHOD *method)
83 BIO *bio = OPENSSL_zalloc(sizeof(*bio));
93 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data))
96 bio->lock = CRYPTO_THREAD_lock_new();
97 if (bio->lock == NULL) {
98 ERR_raise(ERR_LIB_BIO, ERR_R_CRYPTO_LIB);
99 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data);
103 if (method->create != NULL && !method->create(bio)) {
104 ERR_raise(ERR_LIB_BIO, ERR_R_INIT_FAIL);
105 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data);
106 CRYPTO_THREAD_lock_free(bio->lock);
109 if (method->create == NULL)
119 BIO *BIO_new(const BIO_METHOD *method)
121 return BIO_new_ex(NULL, method);
131 if (CRYPTO_DOWN_REF(&a->references, &ret, a->lock) <= 0)
134 REF_PRINT_COUNT("BIO", a);
137 REF_ASSERT_ISNT(ret < 0);
139 if (HAS_CALLBACK(a)) {
140 ret = (int)bio_call_callback(a, BIO_CB_FREE, NULL, 0, 0, 0L, 1L, NULL);
145 if ((a->method != NULL) && (a->method->destroy != NULL))
146 a->method->destroy(a);
148 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, a, &a->ex_data);
150 CRYPTO_THREAD_lock_free(a->lock);
157 void BIO_set_data(BIO *a, void *ptr)
162 void *BIO_get_data(BIO *a)
167 void BIO_set_init(BIO *a, int init)
172 int BIO_get_init(BIO *a)
177 void BIO_set_shutdown(BIO *a, int shut)
182 int BIO_get_shutdown(BIO *a)
187 void BIO_vfree(BIO *a)
192 int BIO_up_ref(BIO *a)
196 if (CRYPTO_UP_REF(&a->references, &i, a->lock) <= 0)
199 REF_PRINT_COUNT("BIO", a);
200 REF_ASSERT_ISNT(i < 2);
204 void BIO_clear_flags(BIO *b, int flags)
209 int BIO_test_flags(const BIO *b, int flags)
211 return (b->flags & flags);
214 void BIO_set_flags(BIO *b, int flags)
219 #ifndef OPENSSL_NO_DEPRECATED_3_0
220 BIO_callback_fn BIO_get_callback(const BIO *b)
225 void BIO_set_callback(BIO *b, BIO_callback_fn cb)
231 BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b)
233 return b->callback_ex;
236 void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex cb)
241 void BIO_set_callback_arg(BIO *b, char *arg)
246 char *BIO_get_callback_arg(const BIO *b)
251 const char *BIO_method_name(const BIO *b)
253 return b->method->name;
256 int BIO_method_type(const BIO *b)
258 return b->method->type;
262 * This is essentially the same as BIO_read_ex() except that it allows
263 * 0 or a negative value to indicate failure (retryable or not) in the return.
264 * This is for compatibility with the old style BIO_read(), where existing code
265 * may make assumptions about the return value that it might get.
267 static int bio_read_intern(BIO *b, void *data, size_t dlen, size_t *readbytes)
272 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
275 if (b->method == NULL || b->method->bread == NULL) {
276 ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
280 if (HAS_CALLBACK(b) &&
281 ((ret = (int)bio_call_callback(b, BIO_CB_READ, data, dlen, 0, 0L, 1L,
286 ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
290 ret = b->method->bread(b, data, dlen, readbytes);
293 b->num_read += (uint64_t)*readbytes;
296 ret = (int)bio_call_callback(b, BIO_CB_READ | BIO_CB_RETURN, data,
297 dlen, 0, 0L, ret, readbytes);
299 /* Shouldn't happen */
300 if (ret > 0 && *readbytes > dlen) {
301 ERR_raise(ERR_LIB_BIO, ERR_R_INTERNAL_ERROR);
308 int BIO_read(BIO *b, void *data, int dlen)
316 ret = bio_read_intern(b, data, (size_t)dlen, &readbytes);
319 /* *readbytes should always be <= dlen */
320 ret = (int)readbytes;
326 int BIO_read_ex(BIO *b, void *data, size_t dlen, size_t *readbytes)
328 return bio_read_intern(b, data, dlen, readbytes) > 0;
331 static int bio_write_intern(BIO *b, const void *data, size_t dlen,
334 size_t local_written;
340 * b == NULL is not an error but just means that zero bytes are written.
341 * Do not raise an error here.
346 if (b->method == NULL || b->method->bwrite == NULL) {
347 ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
351 if (HAS_CALLBACK(b) &&
352 ((ret = (int)bio_call_callback(b, BIO_CB_WRITE, data, dlen, 0, 0L, 1L,
357 ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
361 ret = b->method->bwrite(b, data, dlen, &local_written);
364 b->num_write += (uint64_t)local_written;
367 ret = (int)bio_call_callback(b, BIO_CB_WRITE | BIO_CB_RETURN, data,
368 dlen, 0, 0L, ret, &local_written);
371 *written = local_written;
375 int BIO_write(BIO *b, const void *data, int dlen)
383 ret = bio_write_intern(b, data, (size_t)dlen, &written);
386 /* written should always be <= dlen */
393 int BIO_write_ex(BIO *b, const void *data, size_t dlen, size_t *written)
395 return bio_write_intern(b, data, dlen, written) > 0
396 || (b != NULL && dlen == 0); /* order is important for *written */
399 int BIO_sendmmsg(BIO *b, BIO_MSG *msg,
400 size_t stride, size_t num_msg, uint64_t flags,
401 size_t *msgs_processed)
404 BIO_MMSG_CB_ARGS args;
408 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
412 if (b->method == NULL || b->method->bsendmmsg == NULL) {
414 ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
418 if (HAS_CALLBACK(b)) {
420 args.stride = stride;
421 args.num_msg = num_msg;
423 args.msgs_processed = msgs_processed;
425 ret = (size_t)bio_call_callback(b, BIO_CB_SENDMMSG, (void *)&args,
433 ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
437 ret = b->method->bsendmmsg(b, msg, stride, num_msg, flags, msgs_processed);
440 ret = (size_t)bio_call_callback(b, BIO_CB_SENDMMSG | BIO_CB_RETURN,
441 (void *)&args, ret, 0, 0, 0, NULL);
446 int BIO_recvmmsg(BIO *b, BIO_MSG *msg,
447 size_t stride, size_t num_msg, uint64_t flags,
448 size_t *msgs_processed)
451 BIO_MMSG_CB_ARGS args;
455 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
459 if (b->method == NULL || b->method->brecvmmsg == NULL) {
461 ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
465 if (HAS_CALLBACK(b)) {
467 args.stride = stride;
468 args.num_msg = num_msg;
470 args.msgs_processed = msgs_processed;
472 ret = bio_call_callback(b, BIO_CB_RECVMMSG, (void *)&args,
480 ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
484 ret = b->method->brecvmmsg(b, msg, stride, num_msg, flags, msgs_processed);
487 ret = (size_t)bio_call_callback(b, BIO_CB_RECVMMSG | BIO_CB_RETURN,
488 (void *)&args, ret, 0, 0, 0, NULL);
493 int BIO_get_rpoll_descriptor(BIO *b, BIO_POLL_DESCRIPTOR *desc)
495 return BIO_ctrl(b, BIO_CTRL_GET_RPOLL_DESCRIPTOR, 0, desc);
498 int BIO_get_wpoll_descriptor(BIO *b, BIO_POLL_DESCRIPTOR *desc)
500 return BIO_ctrl(b, BIO_CTRL_GET_WPOLL_DESCRIPTOR, 0, desc);
503 int BIO_puts(BIO *b, const char *buf)
509 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
512 if (b->method == NULL || b->method->bputs == NULL) {
513 ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
517 if (HAS_CALLBACK(b)) {
518 ret = (int)bio_call_callback(b, BIO_CB_PUTS, buf, 0, 0, 0L, 1L, NULL);
524 ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
528 ret = b->method->bputs(b, buf);
531 b->num_write += (uint64_t)ret;
537 ret = (int)bio_call_callback(b, BIO_CB_PUTS | BIO_CB_RETURN, buf, 0, 0,
541 if (written > INT_MAX) {
542 ERR_raise(ERR_LIB_BIO, BIO_R_LENGTH_TOO_LONG);
552 int BIO_gets(BIO *b, char *buf, int size)
555 size_t readbytes = 0;
558 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
561 if (b->method == NULL || b->method->bgets == NULL) {
562 ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
567 ERR_raise(ERR_LIB_BIO, BIO_R_INVALID_ARGUMENT);
571 if (HAS_CALLBACK(b)) {
572 ret = (int)bio_call_callback(b, BIO_CB_GETS, buf, size, 0, 0L, 1, NULL);
578 ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
582 ret = b->method->bgets(b, buf, size);
590 ret = (int)bio_call_callback(b, BIO_CB_GETS | BIO_CB_RETURN, buf, size,
591 0, 0L, ret, &readbytes);
594 /* Shouldn't happen */
595 if (readbytes > (size_t)size)
598 ret = (int)readbytes;
604 int BIO_get_line(BIO *bio, char *buf, int size)
610 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
614 ERR_raise(ERR_LIB_BIO, BIO_R_INVALID_ARGUMENT);
620 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
624 ERR_raise(ERR_LIB_BIO, BIO_R_UNINITIALIZED);
628 while (size-- > 1 && (ret = BIO_read(bio, ptr, 1)) > 0)
632 return ret > 0 || BIO_eof(bio) ? ptr - buf : ret;
635 int BIO_indent(BIO *b, int indent, int max)
642 if (BIO_puts(b, " ") != 1)
647 long BIO_int_ctrl(BIO *b, int cmd, long larg, int iarg)
652 return BIO_ctrl(b, cmd, larg, (char *)&i);
655 void *BIO_ptr_ctrl(BIO *b, int cmd, long larg)
659 if (BIO_ctrl(b, cmd, larg, (char *)&p) <= 0)
665 long BIO_ctrl(BIO *b, int cmd, long larg, void *parg)
671 if (b->method == NULL || b->method->ctrl == NULL) {
672 ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
676 if (HAS_CALLBACK(b)) {
677 ret = bio_call_callback(b, BIO_CB_CTRL, parg, 0, cmd, larg, 1L, NULL);
682 ret = b->method->ctrl(b, cmd, larg, parg);
685 ret = bio_call_callback(b, BIO_CB_CTRL | BIO_CB_RETURN, parg, 0, cmd,
691 long BIO_callback_ctrl(BIO *b, int cmd, BIO_info_cb *fp)
697 if (b->method == NULL || b->method->callback_ctrl == NULL
698 || cmd != BIO_CTRL_SET_CALLBACK) {
699 ERR_raise(ERR_LIB_BIO, BIO_R_UNSUPPORTED_METHOD);
703 if (HAS_CALLBACK(b)) {
704 ret = bio_call_callback(b, BIO_CB_CTRL, (void *)&fp, 0, cmd, 0, 1L,
710 ret = b->method->callback_ctrl(b, cmd, fp);
713 ret = bio_call_callback(b, BIO_CB_CTRL | BIO_CB_RETURN, (void *)&fp, 0,
720 * It is unfortunate to duplicate in functions what the BIO_(w)pending macros
721 * do; but those macros have inappropriate return type, and for interfacing
722 * from other programming languages, C macros aren't much of a help anyway.
724 size_t BIO_ctrl_pending(BIO *bio)
726 long ret = BIO_ctrl(bio, BIO_CTRL_PENDING, 0, NULL);
730 #if LONG_MAX > SIZE_MAX
737 size_t BIO_ctrl_wpending(BIO *bio)
739 long ret = BIO_ctrl(bio, BIO_CTRL_WPENDING, 0, NULL);
743 #if LONG_MAX > SIZE_MAX
750 /* put the 'bio' on the end of b's list of operators */
751 BIO *BIO_push(BIO *b, BIO *bio)
758 while (lb->next_bio != NULL)
763 /* called to do internal processing */
764 BIO_ctrl(b, BIO_CTRL_PUSH, 0, lb);
768 /* Remove the first and return the rest */
777 BIO_ctrl(b, BIO_CTRL_POP, 0, b);
779 if (b->prev_bio != NULL)
780 b->prev_bio->next_bio = b->next_bio;
781 if (b->next_bio != NULL)
782 b->next_bio->prev_bio = b->prev_bio;
789 BIO *BIO_get_retry_BIO(BIO *bio, int *reason)
795 if (!BIO_should_retry(b))
803 *reason = last->retry_reason;
807 int BIO_get_retry_reason(BIO *bio)
809 return bio->retry_reason;
812 void BIO_set_retry_reason(BIO *bio, int reason)
814 bio->retry_reason = reason;
817 BIO *BIO_find_type(BIO *bio, int type)
822 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
827 if (bio->method != NULL) {
828 mt = bio->method->type;
833 } else if (mt == type) {
838 } while (bio != NULL);
842 BIO *BIO_next(BIO *b)
849 void BIO_set_next(BIO *b, BIO *next)
854 void BIO_free_all(BIO *bio)
859 while (bio != NULL) {
864 /* Since ref count > 1, don't free anyone else. */
870 BIO *BIO_dup_chain(BIO *in)
872 BIO *ret = NULL, *eoc = NULL, *bio, *new_bio;
874 for (bio = in; bio != NULL; bio = bio->next_bio) {
875 if ((new_bio = BIO_new(bio->method)) == NULL)
877 #ifndef OPENSSL_NO_DEPRECATED_3_0
878 new_bio->callback = bio->callback;
880 new_bio->callback_ex = bio->callback_ex;
881 new_bio->cb_arg = bio->cb_arg;
882 new_bio->init = bio->init;
883 new_bio->shutdown = bio->shutdown;
884 new_bio->flags = bio->flags;
886 /* This will let SSL_s_sock() work with stdin/stdout */
887 new_bio->num = bio->num;
889 if (!BIO_dup_state(bio, (char *)new_bio)) {
895 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_BIO, &new_bio->ex_data,
905 BIO_push(eoc, new_bio);
916 void BIO_copy_next_retry(BIO *b)
918 BIO_set_flags(b, BIO_get_retry_flags(b->next_bio));
919 b->retry_reason = b->next_bio->retry_reason;
922 int BIO_set_ex_data(BIO *bio, int idx, void *data)
924 return CRYPTO_set_ex_data(&(bio->ex_data), idx, data);
927 void *BIO_get_ex_data(const BIO *bio, int idx)
929 return CRYPTO_get_ex_data(&(bio->ex_data), idx);
932 uint64_t BIO_number_read(BIO *bio)
935 return bio->num_read;
939 uint64_t BIO_number_written(BIO *bio)
942 return bio->num_write;
946 void bio_free_ex_data(BIO *bio)
948 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data);
951 void bio_cleanup(void)
953 #ifndef OPENSSL_NO_SOCK
954 bio_sock_cleanup_int();
955 CRYPTO_THREAD_lock_free(bio_lookup_lock);
956 bio_lookup_lock = NULL;
958 CRYPTO_THREAD_lock_free(bio_type_lock);
959 bio_type_lock = NULL;
962 /* Internal variant of the below BIO_wait() not calling ERR_raise(...) */
963 static int bio_wait(BIO *bio, time_t max_time, unsigned int nap_milliseconds)
965 #ifndef OPENSSL_NO_SOCK
970 if (max_time == 0) /* no timeout */
973 #ifndef OPENSSL_NO_SOCK
974 if (BIO_get_fd(bio, &fd) > 0 && fd < FD_SETSIZE)
975 return BIO_socket_wait(fd, BIO_should_read(bio), max_time);
977 /* fall back to polling since no sockets are available */
979 sec_diff = (long)(max_time - time(NULL)); /* might overflow */
981 return 0; /* clearly timeout */
983 /* now take a nap at most the given number of milliseconds */
984 if (sec_diff == 0) { /* we are below the 1 seconds resolution of max_time */
985 if (nap_milliseconds > 1000)
986 nap_milliseconds = 1000;
987 } else { /* for sec_diff > 0, take min(sec_diff * 1000, nap_milliseconds) */
988 if ((unsigned long)sec_diff * 1000 < nap_milliseconds)
989 nap_milliseconds = (unsigned int)sec_diff * 1000;
991 OSSL_sleep(nap_milliseconds);
996 * Wait on (typically socket-based) BIO at most until max_time.
997 * Succeed immediately if max_time == 0.
998 * If sockets are not available support polling: succeed after waiting at most
999 * the number of nap_milliseconds in order to avoid a tight busy loop.
1000 * Call ERR_raise(ERR_LIB_BIO, ...) on timeout or error.
1001 * Returns -1 on error, 0 on timeout, and 1 on success.
1003 int BIO_wait(BIO *bio, time_t max_time, unsigned int nap_milliseconds)
1005 int rv = bio_wait(bio, max_time, nap_milliseconds);
1008 ERR_raise(ERR_LIB_BIO,
1009 rv == 0 ? BIO_R_TRANSFER_TIMEOUT : BIO_R_TRANSFER_ERROR);
1014 * Connect via given BIO using BIO_do_connect() until success/timeout/error.
1015 * Parameter timeout == 0 means no timeout, < 0 means exactly one try.
1016 * For non-blocking and potentially even non-socket BIOs perform polling with
1017 * the given density: between polls sleep nap_milliseconds using BIO_wait()
1018 * in order to avoid a tight busy loop.
1019 * Returns -1 on error, 0 on timeout, and 1 on success.
1021 int BIO_do_connect_retry(BIO *bio, int timeout, int nap_milliseconds)
1023 int blocking = timeout <= 0;
1024 time_t max_time = timeout > 0 ? time(NULL) + timeout : 0;
1028 ERR_raise(ERR_LIB_BIO, ERR_R_PASSED_NULL_PARAMETER);
1032 if (nap_milliseconds < 0)
1033 nap_milliseconds = 100;
1034 BIO_set_nbio(bio, !blocking);
1038 rv = BIO_do_connect(bio);
1040 if (rv <= 0) { /* could be timeout or retryable error or fatal error */
1041 int err = ERR_peek_last_error();
1042 int reason = ERR_GET_REASON(err);
1043 int do_retry = BIO_should_retry(bio); /* may be 1 only if !blocking */
1045 if (ERR_GET_LIB(err) == ERR_LIB_BIO) {
1049 * likely retryable system error occurred, which may be
1050 * EAGAIN (resource temporarily unavailable) some 40 secs after
1051 * calling getaddrinfo(): Temporary failure in name resolution
1052 * or a premature ETIMEDOUT, some 30 seconds after connect()
1054 case BIO_R_CONNECT_ERROR:
1055 case BIO_R_NBIO_CONNECT_ERROR:
1056 /* some likely retryable connection error occurred */
1057 (void)BIO_reset(bio); /* often needed to avoid retry failure */
1064 if (timeout >= 0 && do_retry) {
1066 /* will not actually wait if timeout == 0 (i.e., blocking BIO): */
1067 rv = bio_wait(bio, max_time, nap_milliseconds);
1070 ERR_raise(ERR_LIB_BIO,
1071 rv == 0 ? BIO_R_CONNECT_TIMEOUT : BIO_R_CONNECT_ERROR);
1073 ERR_clear_last_mark();
1075 if (err == 0) /* missing error queue entry */
1076 /* workaround: general error */
1077 ERR_raise(ERR_LIB_BIO, BIO_R_CONNECT_ERROR);
1080 ERR_clear_last_mark();