2 * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (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
12 #include <openssl/crypto.h>
14 #include "internal/cryptlib.h"
16 BIO *BIO_new(const BIO_METHOD *method)
18 BIO *bio = OPENSSL_zalloc(sizeof(*bio));
21 BIOerr(BIO_F_BIO_NEW, ERR_R_MALLOC_FAILURE);
29 if (!CRYPTO_new_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data))
32 bio->lock = CRYPTO_THREAD_lock_new();
33 if (bio->lock == NULL) {
34 BIOerr(BIO_F_BIO_NEW, ERR_R_MALLOC_FAILURE);
35 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data);
39 if (method->create != NULL && !method->create(bio)) {
40 BIOerr(BIO_F_BIO_NEW, ERR_R_INIT_FAIL);
41 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data);
42 CRYPTO_THREAD_lock_free(bio->lock);
60 if (CRYPTO_atomic_add(&a->references, -1, &i, a->lock) <= 0)
63 REF_PRINT_COUNT("BIO", a);
66 REF_ASSERT_ISNT(i < 0);
67 if ((a->callback != NULL) &&
68 ((i = (int)a->callback(a, BIO_CB_FREE, NULL, 0, 0L, 1L)) <= 0))
71 if ((a->method != NULL) && (a->method->destroy != NULL))
72 a->method->destroy(a);
74 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, a, &a->ex_data);
76 CRYPTO_THREAD_lock_free(a->lock);
83 void BIO_set_data(BIO *a, void *ptr)
88 void *BIO_get_data(BIO *a)
93 void BIO_set_init(BIO *a, int init)
98 int BIO_get_init(BIO *a)
103 void BIO_set_shutdown(BIO *a, int shut)
108 int BIO_get_shutdown(BIO *a)
113 void BIO_vfree(BIO *a)
118 int BIO_up_ref(BIO *a)
122 if (CRYPTO_atomic_add(&a->references, 1, &i, a->lock) <= 0)
125 REF_PRINT_COUNT("BIO", a);
126 REF_ASSERT_ISNT(i < 2);
127 return ((i > 1) ? 1 : 0);
130 void BIO_clear_flags(BIO *b, int flags)
135 int BIO_test_flags(const BIO *b, int flags)
137 return (b->flags & flags);
140 void BIO_set_flags(BIO *b, int flags)
145 BIO_callback_fn BIO_get_callback(const BIO *b)
150 void BIO_set_callback(BIO *b, BIO_callback_fn cb)
155 BIO_callback_fn_ex BIO_get_callback_ex(const BIO *b)
157 return b->callback_ex;
160 void BIO_set_callback_ex(BIO *b, BIO_callback_fn_ex cb)
165 void BIO_set_callback_arg(BIO *b, char *arg)
170 char *BIO_get_callback_arg(const BIO *b)
175 const char *BIO_method_name(const BIO *b)
177 return b->method->name;
180 int BIO_method_type(const BIO *b)
182 return b->method->type;
185 static int bio_call_callback(BIO *b, int oper, const char *argp, size_t len,
186 int argi, long argl, int inret, size_t *processed,
192 if (b->callback_ex != NULL) {
193 return b->callback_ex(b, oper, argp, len, argi, argl, inret, processed,
197 /* Strip off the BIO_CB_RETURN flag */
198 bareoper = oper & ~BIO_CB_RETURN;
200 * We have an old style callback, so we will have to do nasty casts and
201 * check for overflows.
203 if (bareoper == BIO_CB_READ || bareoper == BIO_CB_WRITE
204 || bareoper == BIO_CB_GETS) {
205 /* In this case |len| is set, and should be used instead of |argi| */
211 if (inret && (oper & BIO_CB_RETURN)) {
212 if (*processed > INT_MAX)
218 ret = b->callback(b, oper, argp, argi, argl, inret);
219 if (bareoper == BIO_CB_CTRL)
222 if (ret > INT_MAX || ret < INT_MIN)
229 *processed = (size_t)ret;
236 int BIO_read(BIO *b, void *out, int outl)
244 ret = BIO_read_ex(b, out, (size_t)outl, &read);
247 /* *read should always be <= outl */
254 int BIO_read_ex(BIO *b, void *out, size_t outl, size_t *read)
258 if ((b == NULL) || (b->method == NULL) || (b->method->bread == NULL)) {
259 BIOerr(BIO_F_BIO_READ_EX, BIO_R_UNSUPPORTED_METHOD);
263 if ((b->callback != NULL || b->callback_ex != NULL) &&
264 ((ret = bio_call_callback(b, BIO_CB_READ, out, outl, 0, 0L, 1L, read,
269 BIOerr(BIO_F_BIO_READ_EX, BIO_R_UNINITIALIZED);
273 ret = b->method->bread(b, out, outl, read);
276 b->num_read += (uint64_t)*read;
278 if (b->callback != NULL || b->callback_ex != NULL)
279 ret = bio_call_callback(b, BIO_CB_READ | BIO_CB_RETURN, out, outl, 0,
280 0L, ret, read, NULL);
285 int BIO_write(BIO *b, const void *in, int inl)
293 ret = BIO_write_ex(b, in, (size_t)inl, &written);
296 /* *written should always be <= inl */
303 int BIO_write_ex(BIO *b, const void *in, size_t inl, size_t *written)
310 if ((b->method == NULL) || (b->method->bwrite == NULL)) {
311 BIOerr(BIO_F_BIO_WRITE_EX, BIO_R_UNSUPPORTED_METHOD);
315 if ((b->callback != NULL || b->callback_ex != NULL) &&
316 ((ret = bio_call_callback(b, BIO_CB_WRITE, in, inl, 0, 0L, 1L, written,
321 BIOerr(BIO_F_BIO_WRITE_EX, BIO_R_UNINITIALIZED);
325 ret = b->method->bwrite(b, in, inl, written);
328 b->num_write += (uint64_t)*written;
330 if (b->callback != NULL || b->callback_ex != NULL)
331 ret = bio_call_callback(b, BIO_CB_WRITE | BIO_CB_RETURN, in, inl, 0,
332 0L, ret, written, NULL);
337 int BIO_puts(BIO *b, const char *in)
340 long (*cb) (BIO *, int, const char *, int, long, long);
342 if ((b == NULL) || (b->method == NULL) || (b->method->bputs == NULL)) {
343 BIOerr(BIO_F_BIO_PUTS, BIO_R_UNSUPPORTED_METHOD);
349 if ((cb != NULL) && ((i = (int)cb(b, BIO_CB_PUTS, in, 0, 0L, 1L)) <= 0))
353 BIOerr(BIO_F_BIO_PUTS, BIO_R_UNINITIALIZED);
357 i = b->method->bputs(b, in);
360 b->num_write += (uint64_t)i;
363 i = (int)cb(b, BIO_CB_PUTS | BIO_CB_RETURN, in, 0, 0L, (long)i);
367 int BIO_gets(BIO *b, char *in, int inl)
370 long (*cb) (BIO *, int, const char *, int, long, long);
372 if ((b == NULL) || (b->method == NULL) || (b->method->bgets == NULL)) {
373 BIOerr(BIO_F_BIO_GETS, BIO_R_UNSUPPORTED_METHOD);
379 if ((cb != NULL) && ((i = (int)cb(b, BIO_CB_GETS, in, inl, 0L, 1L)) <= 0))
383 BIOerr(BIO_F_BIO_GETS, BIO_R_UNINITIALIZED);
387 i = b->method->bgets(b, in, inl);
390 i = (int)cb(b, BIO_CB_GETS | BIO_CB_RETURN, in, inl, 0L, (long)i);
394 int BIO_indent(BIO *b, int indent, int max)
401 if (BIO_puts(b, " ") != 1)
406 long BIO_int_ctrl(BIO *b, int cmd, long larg, int iarg)
411 return (BIO_ctrl(b, cmd, larg, (char *)&i));
414 void *BIO_ptr_ctrl(BIO *b, int cmd, long larg)
418 if (BIO_ctrl(b, cmd, larg, (char *)&p) <= 0)
424 long BIO_ctrl(BIO *b, int cmd, long larg, void *parg)
427 long (*cb) (BIO *, int, const char *, int, long, long);
432 if ((b->method == NULL) || (b->method->ctrl == NULL)) {
433 BIOerr(BIO_F_BIO_CTRL, BIO_R_UNSUPPORTED_METHOD);
440 ((ret = cb(b, BIO_CB_CTRL, parg, cmd, larg, 1L)) <= 0))
443 ret = b->method->ctrl(b, cmd, larg, parg);
446 ret = cb(b, BIO_CB_CTRL | BIO_CB_RETURN, parg, cmd, larg, ret);
450 long BIO_callback_ctrl(BIO *b, int cmd,
451 void (*fp) (struct bio_st *, int, const char *, int,
455 long (*cb) (BIO *, int, const char *, int, long, long);
460 if ((b->method == NULL) || (b->method->callback_ctrl == NULL)) {
461 BIOerr(BIO_F_BIO_CALLBACK_CTRL, BIO_R_UNSUPPORTED_METHOD);
468 ((ret = cb(b, BIO_CB_CTRL, (void *)&fp, cmd, 0, 1L)) <= 0))
471 ret = b->method->callback_ctrl(b, cmd, fp);
474 ret = cb(b, BIO_CB_CTRL | BIO_CB_RETURN, (void *)&fp, cmd, 0, ret);
479 * It is unfortunate to duplicate in functions what the BIO_(w)pending macros
480 * do; but those macros have inappropriate return type, and for interfacing
481 * from other programming languages, C macros aren't much of a help anyway.
483 size_t BIO_ctrl_pending(BIO *bio)
485 return BIO_ctrl(bio, BIO_CTRL_PENDING, 0, NULL);
488 size_t BIO_ctrl_wpending(BIO *bio)
490 return BIO_ctrl(bio, BIO_CTRL_WPENDING, 0, NULL);
493 /* put the 'bio' on the end of b's list of operators */
494 BIO *BIO_push(BIO *b, BIO *bio)
501 while (lb->next_bio != NULL)
506 /* called to do internal processing */
507 BIO_ctrl(b, BIO_CTRL_PUSH, 0, lb);
511 /* Remove the first and return the rest */
520 BIO_ctrl(b, BIO_CTRL_POP, 0, b);
522 if (b->prev_bio != NULL)
523 b->prev_bio->next_bio = b->next_bio;
524 if (b->next_bio != NULL)
525 b->next_bio->prev_bio = b->prev_bio;
532 BIO *BIO_get_retry_BIO(BIO *bio, int *reason)
538 if (!BIO_should_retry(b))
546 *reason = last->retry_reason;
550 int BIO_get_retry_reason(BIO *bio)
552 return (bio->retry_reason);
555 void BIO_set_retry_reason(BIO *bio, int reason)
557 bio->retry_reason = reason;
560 BIO *BIO_find_type(BIO *bio, int type)
568 if (bio->method != NULL) {
569 mt = bio->method->type;
574 } else if (mt == type)
578 } while (bio != NULL);
582 BIO *BIO_next(BIO *b)
589 void BIO_set_next(BIO *b, BIO *next)
594 void BIO_free_all(BIO *bio)
599 while (bio != NULL) {
604 /* Since ref count > 1, don't free anyone else. */
610 BIO *BIO_dup_chain(BIO *in)
612 BIO *ret = NULL, *eoc = NULL, *bio, *new_bio;
614 for (bio = in; bio != NULL; bio = bio->next_bio) {
615 if ((new_bio = BIO_new(bio->method)) == NULL)
617 new_bio->callback = bio->callback;
618 new_bio->cb_arg = bio->cb_arg;
619 new_bio->init = bio->init;
620 new_bio->shutdown = bio->shutdown;
621 new_bio->flags = bio->flags;
623 /* This will let SSL_s_sock() work with stdin/stdout */
624 new_bio->num = bio->num;
626 if (!BIO_dup_state(bio, (char *)new_bio)) {
632 if (!CRYPTO_dup_ex_data(CRYPTO_EX_INDEX_BIO, &new_bio->ex_data,
642 BIO_push(eoc, new_bio);
653 void BIO_copy_next_retry(BIO *b)
655 BIO_set_flags(b, BIO_get_retry_flags(b->next_bio));
656 b->retry_reason = b->next_bio->retry_reason;
659 int BIO_set_ex_data(BIO *bio, int idx, void *data)
661 return (CRYPTO_set_ex_data(&(bio->ex_data), idx, data));
664 void *BIO_get_ex_data(BIO *bio, int idx)
666 return (CRYPTO_get_ex_data(&(bio->ex_data), idx));
669 uint64_t BIO_number_read(BIO *bio)
672 return bio->num_read;
676 uint64_t BIO_number_written(BIO *bio)
679 return bio->num_write;
683 void bio_free_ex_data(BIO *bio)
685 CRYPTO_free_ex_data(CRYPTO_EX_INDEX_BIO, bio, &bio->ex_data);
688 void bio_cleanup(void)
690 #ifndef OPENSSL_NO_SOCK
691 bio_sock_cleanup_int();
692 CRYPTO_THREAD_lock_free(bio_lookup_lock);
693 bio_lookup_lock = NULL;
695 CRYPTO_THREAD_lock_free(bio_type_lock);
696 bio_type_lock = NULL;