Blame crypto/bio/bss_mem.c

Packit c4476c
/*
Packit c4476c
 * Copyright 1995-2019 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
 *
Packit c4476c
 * Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
 * this file except in compliance with the License.  You can obtain a copy
Packit c4476c
 * in the file LICENSE in the source distribution or at
Packit c4476c
 * https://www.openssl.org/source/license.html
Packit c4476c
 */
Packit c4476c
Packit c4476c
#include <stdio.h>
Packit c4476c
#include <errno.h>
Packit c4476c
#include "bio_local.h"
Packit c4476c
#include "internal/cryptlib.h"
Packit c4476c
Packit c4476c
static int mem_write(BIO *h, const char *buf, int num);
Packit c4476c
static int mem_read(BIO *h, char *buf, int size);
Packit c4476c
static int mem_puts(BIO *h, const char *str);
Packit c4476c
static int mem_gets(BIO *h, char *str, int size);
Packit c4476c
static long mem_ctrl(BIO *h, int cmd, long arg1, void *arg2);
Packit c4476c
static int mem_new(BIO *h);
Packit c4476c
static int secmem_new(BIO *h);
Packit c4476c
static int mem_free(BIO *data);
Packit c4476c
static int mem_buf_free(BIO *data);
Packit c4476c
static int mem_buf_sync(BIO *h);
Packit c4476c
Packit c4476c
static const BIO_METHOD mem_method = {
Packit c4476c
    BIO_TYPE_MEM,
Packit c4476c
    "memory buffer",
Packit c4476c
    /* TODO: Convert to new style write function */
Packit c4476c
    bwrite_conv,
Packit c4476c
    mem_write,
Packit c4476c
    /* TODO: Convert to new style read function */
Packit c4476c
    bread_conv,
Packit c4476c
    mem_read,
Packit c4476c
    mem_puts,
Packit c4476c
    mem_gets,
Packit c4476c
    mem_ctrl,
Packit c4476c
    mem_new,
Packit c4476c
    mem_free,
Packit c4476c
    NULL,                      /* mem_callback_ctrl */
Packit c4476c
};
Packit c4476c
Packit c4476c
static const BIO_METHOD secmem_method = {
Packit c4476c
    BIO_TYPE_MEM,
Packit c4476c
    "secure memory buffer",
Packit c4476c
    /* TODO: Convert to new style write function */
Packit c4476c
    bwrite_conv,
Packit c4476c
    mem_write,
Packit c4476c
    /* TODO: Convert to new style read function */
Packit c4476c
    bread_conv,
Packit c4476c
    mem_read,
Packit c4476c
    mem_puts,
Packit c4476c
    mem_gets,
Packit c4476c
    mem_ctrl,
Packit c4476c
    secmem_new,
Packit c4476c
    mem_free,
Packit c4476c
    NULL,                      /* mem_callback_ctrl */
Packit c4476c
};
Packit c4476c
Packit c4476c
/*
Packit c4476c
 * BIO memory stores buffer and read pointer
Packit c4476c
 * however the roles are different for read only BIOs.
Packit c4476c
 * In that case the readp just stores the original state
Packit c4476c
 * to be used for reset.
Packit c4476c
 */
Packit c4476c
typedef struct bio_buf_mem_st {
Packit c4476c
    struct buf_mem_st *buf;   /* allocated buffer */
Packit c4476c
    struct buf_mem_st *readp; /* read pointer */
Packit c4476c
} BIO_BUF_MEM;
Packit c4476c
Packit c4476c
/*
Packit c4476c
 * bio->num is used to hold the value to return on 'empty', if it is 0,
Packit c4476c
 * should_retry is not set
Packit c4476c
 */
Packit c4476c
Packit c4476c
const BIO_METHOD *BIO_s_mem(void)
Packit c4476c
{
Packit c4476c
    return &mem_method;
Packit c4476c
}
Packit c4476c
Packit c4476c
const BIO_METHOD *BIO_s_secmem(void)
Packit c4476c
{
Packit c4476c
    return(&secmem_method);
Packit c4476c
}
Packit c4476c
Packit c4476c
BIO *BIO_new_mem_buf(const void *buf, int len)
Packit c4476c
{
Packit c4476c
    BIO *ret;
Packit c4476c
    BUF_MEM *b;
Packit c4476c
    BIO_BUF_MEM *bb;
Packit c4476c
    size_t sz;
Packit c4476c
Packit c4476c
    if (buf == NULL) {
Packit c4476c
        BIOerr(BIO_F_BIO_NEW_MEM_BUF, BIO_R_NULL_PARAMETER);
Packit c4476c
        return NULL;
Packit c4476c
    }
Packit c4476c
    sz = (len < 0) ? strlen(buf) : (size_t)len;
Packit c4476c
    if ((ret = BIO_new(BIO_s_mem())) == NULL)
Packit c4476c
        return NULL;
Packit c4476c
    bb = (BIO_BUF_MEM *)ret->ptr;
Packit c4476c
    b = bb->buf;
Packit c4476c
    /* Cast away const and trust in the MEM_RDONLY flag. */
Packit c4476c
    b->data = (void *)buf;
Packit c4476c
    b->length = sz;
Packit c4476c
    b->max = sz;
Packit c4476c
    *bb->readp = *bb->buf;
Packit c4476c
    ret->flags |= BIO_FLAGS_MEM_RDONLY;
Packit c4476c
    /* Since this is static data retrying won't help */
Packit c4476c
    ret->num = 0;
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int mem_init(BIO *bi, unsigned long flags)
Packit c4476c
{
Packit c4476c
    BIO_BUF_MEM *bb = OPENSSL_zalloc(sizeof(*bb));
Packit c4476c
Packit c4476c
    if (bb == NULL)
Packit c4476c
        return 0;
Packit c4476c
    if ((bb->buf = BUF_MEM_new_ex(flags)) == NULL) {
Packit c4476c
        OPENSSL_free(bb);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    if ((bb->readp = OPENSSL_zalloc(sizeof(*bb->readp))) == NULL) {
Packit c4476c
        BUF_MEM_free(bb->buf);
Packit c4476c
        OPENSSL_free(bb);
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    *bb->readp = *bb->buf;
Packit c4476c
    bi->shutdown = 1;
Packit c4476c
    bi->init = 1;
Packit c4476c
    bi->num = -1;
Packit c4476c
    bi->ptr = (char *)bb;
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int mem_new(BIO *bi)
Packit c4476c
{
Packit c4476c
    return mem_init(bi, 0L);
Packit c4476c
}
Packit c4476c
Packit c4476c
static int secmem_new(BIO *bi)
Packit c4476c
{
Packit c4476c
    return mem_init(bi, BUF_MEM_FLAG_SECURE);
Packit c4476c
}
Packit c4476c
Packit c4476c
static int mem_free(BIO *a)
Packit c4476c
{
Packit c4476c
    BIO_BUF_MEM *bb;
Packit c4476c
Packit c4476c
    if (a == NULL)
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    bb = (BIO_BUF_MEM *)a->ptr;
Packit c4476c
    if (!mem_buf_free(a))
Packit c4476c
        return 0;
Packit c4476c
    OPENSSL_free(bb->readp);
Packit c4476c
    OPENSSL_free(bb);
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int mem_buf_free(BIO *a)
Packit c4476c
{
Packit c4476c
    if (a == NULL)
Packit c4476c
        return 0;
Packit c4476c
Packit c4476c
    if (a->shutdown && a->init && a->ptr != NULL) {
Packit c4476c
        BIO_BUF_MEM *bb = (BIO_BUF_MEM *)a->ptr;
Packit c4476c
        BUF_MEM *b = bb->buf;
Packit c4476c
Packit c4476c
        if (a->flags & BIO_FLAGS_MEM_RDONLY)
Packit c4476c
            b->data = NULL;
Packit c4476c
        BUF_MEM_free(b);
Packit c4476c
    }
Packit c4476c
    return 1;
Packit c4476c
}
Packit c4476c
Packit c4476c
/*
Packit c4476c
 * Reallocate memory buffer if read pointer differs
Packit c4476c
 */
Packit c4476c
static int mem_buf_sync(BIO *b)
Packit c4476c
{
Packit c4476c
    if (b != NULL && b->init != 0 && b->ptr != NULL) {
Packit c4476c
        BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
Packit c4476c
Packit c4476c
        if (bbm->readp->data != bbm->buf->data) {
Packit c4476c
            memmove(bbm->buf->data, bbm->readp->data, bbm->readp->length);
Packit c4476c
            bbm->buf->length = bbm->readp->length;
Packit c4476c
            bbm->readp->data = bbm->buf->data;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
    return 0;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int mem_read(BIO *b, char *out, int outl)
Packit c4476c
{
Packit c4476c
    int ret = -1;
Packit c4476c
    BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
Packit c4476c
    BUF_MEM *bm = bbm->readp;
Packit c4476c
Packit c4476c
    if (b->flags & BIO_FLAGS_MEM_RDONLY)
Packit c4476c
        bm = bbm->buf;
Packit c4476c
    BIO_clear_retry_flags(b);
Packit c4476c
    ret = (outl >= 0 && (size_t)outl > bm->length) ? (int)bm->length : outl;
Packit c4476c
    if ((out != NULL) && (ret > 0)) {
Packit c4476c
        memcpy(out, bm->data, ret);
Packit c4476c
        bm->length -= ret;
Packit c4476c
        bm->max -= ret;
Packit c4476c
        bm->data += ret;
Packit c4476c
    } else if (bm->length == 0) {
Packit c4476c
        ret = b->num;
Packit c4476c
        if (ret != 0)
Packit c4476c
            BIO_set_retry_read(b);
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int mem_write(BIO *b, const char *in, int inl)
Packit c4476c
{
Packit c4476c
    int ret = -1;
Packit c4476c
    int blen;
Packit c4476c
    BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
Packit c4476c
Packit c4476c
    if (in == NULL) {
Packit c4476c
        BIOerr(BIO_F_MEM_WRITE, BIO_R_NULL_PARAMETER);
Packit c4476c
        goto end;
Packit c4476c
    }
Packit c4476c
    if (b->flags & BIO_FLAGS_MEM_RDONLY) {
Packit c4476c
        BIOerr(BIO_F_MEM_WRITE, BIO_R_WRITE_TO_READ_ONLY_BIO);
Packit c4476c
        goto end;
Packit c4476c
    }
Packit c4476c
    BIO_clear_retry_flags(b);
Packit c4476c
    if (inl == 0)
Packit c4476c
        return 0;
Packit c4476c
    blen = bbm->readp->length;
Packit c4476c
    mem_buf_sync(b);
Packit c4476c
    if (BUF_MEM_grow_clean(bbm->buf, blen + inl) == 0)
Packit c4476c
        goto end;
Packit c4476c
    memcpy(bbm->buf->data + blen, in, inl);
Packit c4476c
    *bbm->readp = *bbm->buf;
Packit c4476c
    ret = inl;
Packit c4476c
 end:
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static long mem_ctrl(BIO *b, int cmd, long num, void *ptr)
Packit c4476c
{
Packit c4476c
    long ret = 1;
Packit c4476c
    char **pptr;
Packit c4476c
    BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)b->ptr;
Packit c4476c
    BUF_MEM *bm;
Packit c4476c
Packit c4476c
    if (b->flags & BIO_FLAGS_MEM_RDONLY)
Packit c4476c
        bm = bbm->buf;
Packit c4476c
    else
Packit c4476c
        bm = bbm->readp;
Packit c4476c
Packit c4476c
    switch (cmd) {
Packit c4476c
    case BIO_CTRL_RESET:
Packit c4476c
        bm = bbm->buf;
Packit c4476c
        if (bm->data != NULL) {
Packit c4476c
            if (!(b->flags & BIO_FLAGS_MEM_RDONLY)) {
Packit c4476c
                if (!(b->flags & BIO_FLAGS_NONCLEAR_RST)) {
Packit c4476c
                    memset(bm->data, 0, bm->max);
Packit c4476c
                    bm->length = 0;
Packit c4476c
                }
Packit c4476c
                *bbm->readp = *bbm->buf;
Packit c4476c
            } else {
Packit c4476c
                /* For read only case just reset to the start again */
Packit c4476c
                *bbm->buf = *bbm->readp;
Packit c4476c
            }
Packit c4476c
        }
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_EOF:
Packit c4476c
        ret = (long)(bm->length == 0);
Packit c4476c
        break;
Packit c4476c
    case BIO_C_SET_BUF_MEM_EOF_RETURN:
Packit c4476c
        b->num = (int)num;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_INFO:
Packit c4476c
        ret = (long)bm->length;
Packit c4476c
        if (ptr != NULL) {
Packit c4476c
            pptr = (char **)ptr;
Packit c4476c
            *pptr = (char *)&(bm->data[0]);
Packit c4476c
        }
Packit c4476c
        break;
Packit c4476c
    case BIO_C_SET_BUF_MEM:
Packit c4476c
        mem_buf_free(b);
Packit c4476c
        b->shutdown = (int)num;
Packit c4476c
        bbm->buf = ptr;
Packit c4476c
        *bbm->readp = *bbm->buf;
Packit c4476c
        break;
Packit c4476c
    case BIO_C_GET_BUF_MEM_PTR:
Packit c4476c
        if (ptr != NULL) {
Packit c4476c
            if (!(b->flags & BIO_FLAGS_MEM_RDONLY))
Packit c4476c
                mem_buf_sync(b);
Packit c4476c
            bm = bbm->buf;
Packit c4476c
            pptr = (char **)ptr;
Packit c4476c
            *pptr = (char *)bm;
Packit c4476c
        }
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_GET_CLOSE:
Packit c4476c
        ret = (long)b->shutdown;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_SET_CLOSE:
Packit c4476c
        b->shutdown = (int)num;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_WPENDING:
Packit c4476c
        ret = 0L;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_PENDING:
Packit c4476c
        ret = (long)bm->length;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_DUP:
Packit c4476c
    case BIO_CTRL_FLUSH:
Packit c4476c
        ret = 1;
Packit c4476c
        break;
Packit c4476c
    case BIO_CTRL_PUSH:
Packit c4476c
    case BIO_CTRL_POP:
Packit c4476c
    default:
Packit c4476c
        ret = 0;
Packit c4476c
        break;
Packit c4476c
    }
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int mem_gets(BIO *bp, char *buf, int size)
Packit c4476c
{
Packit c4476c
    int i, j;
Packit c4476c
    int ret = -1;
Packit c4476c
    char *p;
Packit c4476c
    BIO_BUF_MEM *bbm = (BIO_BUF_MEM *)bp->ptr;
Packit c4476c
    BUF_MEM *bm = bbm->readp;
Packit c4476c
Packit c4476c
    if (bp->flags & BIO_FLAGS_MEM_RDONLY)
Packit c4476c
        bm = bbm->buf;
Packit c4476c
    BIO_clear_retry_flags(bp);
Packit c4476c
    j = bm->length;
Packit c4476c
    if ((size - 1) < j)
Packit c4476c
        j = size - 1;
Packit c4476c
    if (j <= 0) {
Packit c4476c
        *buf = '\0';
Packit c4476c
        return 0;
Packit c4476c
    }
Packit c4476c
    p = bm->data;
Packit c4476c
    for (i = 0; i < j; i++) {
Packit c4476c
        if (p[i] == '\n') {
Packit c4476c
            i++;
Packit c4476c
            break;
Packit c4476c
        }
Packit c4476c
    }
Packit c4476c
Packit c4476c
    /*
Packit c4476c
     * i is now the max num of bytes to copy, either j or up to
Packit c4476c
     * and including the first newline
Packit c4476c
     */
Packit c4476c
Packit c4476c
    i = mem_read(bp, buf, i);
Packit c4476c
    if (i > 0)
Packit c4476c
        buf[i] = '\0';
Packit c4476c
    ret = i;
Packit c4476c
    return ret;
Packit c4476c
}
Packit c4476c
Packit c4476c
static int mem_puts(BIO *bp, const char *str)
Packit c4476c
{
Packit c4476c
    int n, ret;
Packit c4476c
Packit c4476c
    n = strlen(str);
Packit c4476c
    ret = mem_write(bp, str, n);
Packit c4476c
    /* memory semantics is that it will always work */
Packit c4476c
    return ret;
Packit c4476c
}