// Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) All rights reserved. // SPDX-License-Identifier: Apache-2.0 #include #include #include #include #include #include #include "../internal.h" typedef struct bio_buf_mem_st { struct buf_mem_st *buf; /* allocated buffer */ size_t read_off; /* read pointer offset from current buffer position */ } BIO_BUF_MEM; BIO *BIO_new_mem_buf(const void *buf, ossl_ssize_t len) { BIO *ret; BUF_MEM *b; BIO_BUF_MEM *bbm; const size_t size = (len < 0) ? strlen((char *)buf) : (size_t)len; if (!buf && len != 0) { OPENSSL_PUT_ERROR(BIO, BIO_R_NULL_PARAMETER); return NULL; } ret = BIO_new(BIO_s_mem()); if (ret == NULL) { return NULL; } bbm = (BIO_BUF_MEM *)ret->ptr; b = bbm->buf; // BIO_FLAGS_MEM_RDONLY ensures |b->data| is not written to. b->data = (void *)buf; b->length = size; b->max = size; ret->flags |= BIO_FLAGS_MEM_RDONLY; // |num| is used to store the value that this BIO will return when it runs // out of data. If it's negative then the retry flags will also be set. Since // this is static data, retrying wont help ret->num = 0; return ret; } static int mem_new(BIO *bio) { BIO_BUF_MEM *bbm = OPENSSL_zalloc(sizeof(*bbm)); if (bbm == NULL) { return 0; } bbm->buf = BUF_MEM_new(); if (bbm->buf == NULL) { OPENSSL_free(bbm); return 0; } // |shutdown| is used to store the close flag: whether the BIO has ownership // of the BUF_MEM. bbm->read_off = 0; bio->shutdown = 1; bio->init = 1; bio->num = -1; bio->ptr = (char *)bbm; return 1; } static int mem_buf_free(BIO *bio) { if (bio == NULL) { return 0; } if (!bio->shutdown || !bio->init || bio->ptr == NULL) { return 1; } BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)bio->ptr; BUF_MEM *b = bbm->buf; if (bio->flags & BIO_FLAGS_MEM_RDONLY) { b->data = NULL; } BUF_MEM_free(b); return 1; } static int mem_free(BIO *bio) { if (bio == NULL) { return 0; } BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)bio->ptr; if (!mem_buf_free(bio)) { return 0; } bio->ptr = NULL; OPENSSL_free(bbm); return 1; } static void mem_buf_sync(BIO *bio) { if (bio->init != 0 && bio->ptr != NULL) { BIO_BUF_MEM *bbm = (BIO_BUF_MEM *) bio->ptr; BUF_MEM *b = bbm->buf; if (b->data != NULL) { if (bio->flags & BIO_FLAGS_MEM_RDONLY) { b->data += bbm->read_off; } else { OPENSSL_memmove(b->data, &b->data[bbm->read_off], b->length); } bbm->read_off = 0; } } } static int mem_read(BIO *bio, char *out, int outl) { BIO_clear_retry_flags(bio); if (outl <= 0) { return 0; } BIO_BUF_MEM *bbm = (BIO_BUF_MEM *) bio->ptr; BUF_MEM *b = bbm->buf; int ret = outl; if ((size_t)ret > b->length) { ret = (int)b->length; } if (ret > 0) { OPENSSL_memcpy(out, &b->data[bbm->read_off], ret); b->length -= ret; bbm->read_off += ret; } else if (b->length == 0) { ret = bio->num; if (ret != 0) { BIO_set_retry_read(bio); } } return ret; } static int mem_write(BIO *bio, const char *in, int inl) { BIO_clear_retry_flags(bio); if (inl <= 0) { return 0; // Successfully write zero bytes. } if (bio->flags & BIO_FLAGS_MEM_RDONLY) { OPENSSL_PUT_ERROR(BIO, BIO_R_WRITE_TO_READ_ONLY_BIO); return -1; } BIO_BUF_MEM *bbm = (BIO_BUF_MEM *) bio->ptr; BUF_MEM *b = bbm->buf; mem_buf_sync(bio); if (!BUF_MEM_append(b, in, inl)) { return -1; } return inl; } static int mem_gets(BIO *bio, char *buf, int size) { BIO_clear_retry_flags(bio); if (size <= 0) { return 0; } // The buffer size includes space for the trailing NUL, so we can read at most // one fewer byte. BIO_BUF_MEM *bbm = (BIO_BUF_MEM *) bio->ptr; BUF_MEM *b = bbm->buf; int ret = size - 1; if ((size_t)ret > b->length) { ret = (int)b->length; } // Stop at the first newline. if (b->data != NULL) { char *readp = &b->data[bbm->read_off]; const char *newline = OPENSSL_memchr(readp, '\n', ret); if (newline != NULL) { ret = (int)(newline - readp + 1); } } ret = mem_read(bio, buf, ret); if (ret >= 0) { buf[ret] = '\0'; } return ret; } static long mem_ctrl(BIO *bio, int cmd, long num, void *ptr) { long ret = 1; BIO_BUF_MEM *bbm = (BIO_BUF_MEM *) bio->ptr; BUF_MEM *b = bbm->buf; switch (cmd) { case BIO_CTRL_RESET: if (b->data != NULL) { // For read only case reset to the start again if (bio->flags & BIO_FLAGS_MEM_RDONLY) { b->data -= b->max - b->length - bbm->read_off; b->length = b->max; } else { OPENSSL_cleanse(b->data, b->max); b->length = 0; } bbm->read_off = 0; } break; case BIO_C_FILE_SEEK: if (num < 0 || (size_t)num > b->max) { ret = -1; break; } if (bio->flags & BIO_FLAGS_MEM_RDONLY) { b->data -= b->max - b->length - bbm->read_off; b->length = b->max - num; } else { if ((size_t)num > bbm->read_off + b->length) { ret = -1; break; } b->length = (b->length + bbm->read_off) - num; } bbm->read_off = num; ret = num; break; case BIO_CTRL_EOF: ret = (long)(b->length == 0); break; case BIO_C_SET_BUF_MEM_EOF_RETURN: bio->num = (int)num; break; case BIO_CTRL_INFO: ret = (long)b->length; if (ptr != NULL) { char **pptr = ptr; *pptr = (b->data != NULL) ? &b->data[bbm->read_off] : NULL; } break; case BIO_C_SET_BUF_MEM: mem_free(bio); bio->shutdown = (int)num; bio->ptr = ptr; break; case BIO_C_GET_BUF_MEM_PTR: if (ptr != NULL) { mem_buf_sync(bio); BUF_MEM **pptr = ptr; *pptr = b; } break; case BIO_CTRL_GET_CLOSE: ret = (long)bio->shutdown; break; case BIO_CTRL_SET_CLOSE: bio->shutdown = (int)num; break; case BIO_CTRL_WPENDING: ret = 0L; break; case BIO_CTRL_PENDING: ret = (long)b->length; break; case BIO_CTRL_FLUSH: ret = 1; break; default: ret = 0; break; } return ret; } static const BIO_METHOD mem_method = { BIO_TYPE_MEM, "memory buffer", mem_write, mem_read, NULL /* puts */, mem_gets, mem_ctrl, mem_new, mem_free, NULL /* callback_ctrl */, }; const BIO_METHOD *BIO_s_mem(void) { return &mem_method; } int BIO_mem_contents(const BIO *bio, const uint8_t **out_contents, size_t *out_len) { if (!bio || bio->method != &mem_method) { return 0; } BIO_BUF_MEM *bbm = (BIO_BUF_MEM *) bio->ptr; const BUF_MEM *b = bbm->buf; mem_buf_sync((BIO *)bio); if (out_contents != NULL) { *out_contents = (uint8_t *)b->data; } if(out_len) { *out_len = b->length; } return 1; } int BIO_get_mem_ptr(BIO *bio, BUF_MEM **out) { return (int)BIO_ctrl(bio, BIO_C_GET_BUF_MEM_PTR, 0, out); } int BIO_set_mem_buf(BIO *bio, BUF_MEM *b, int take_ownership) { return (int)BIO_ctrl(bio, BIO_C_SET_BUF_MEM, take_ownership, b); } int BIO_set_mem_eof_return(BIO *bio, int eof_value) { return (int)BIO_ctrl(bio, BIO_C_SET_BUF_MEM_EOF_RETURN, eof_value, NULL); } const BIO_METHOD *BIO_s_secmem(void) { return BIO_s_mem(); }