Blame ssl/packet.c

Packit Service 084de1
/*
Packit Service 084de1
 * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
 *
Packit Service 084de1
 * Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
 * this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
 * in the file LICENSE in the source distribution or at
Packit Service 084de1
 * https://www.openssl.org/source/license.html
Packit Service 084de1
 */
Packit Service 084de1
Packit Service 084de1
#include "internal/cryptlib.h"
Packit Service 084de1
#include "packet_local.h"
Packit Service 084de1
#include <openssl/sslerr.h>
Packit Service 084de1
Packit Service 084de1
#define DEFAULT_BUF_SIZE    256
Packit Service 084de1
Packit Service 084de1
int WPACKET_allocate_bytes(WPACKET *pkt, size_t len, unsigned char **allocbytes)
Packit Service 084de1
{
Packit Service 084de1
    if (!WPACKET_reserve_bytes(pkt, len, allocbytes))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    pkt->written += len;
Packit Service 084de1
    pkt->curr += len;
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_sub_allocate_bytes__(WPACKET *pkt, size_t len,
Packit Service 084de1
                                 unsigned char **allocbytes, size_t lenbytes)
Packit Service 084de1
{
Packit Service 084de1
    if (!WPACKET_start_sub_packet_len__(pkt, lenbytes)
Packit Service 084de1
            || !WPACKET_allocate_bytes(pkt, len, allocbytes)
Packit Service 084de1
            || !WPACKET_close(pkt))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
#define GETBUF(p)   (((p)->staticbuf != NULL) \
Packit Service 084de1
                     ? (p)->staticbuf : (unsigned char *)(p)->buf->data)
Packit Service 084de1
Packit Service 084de1
int WPACKET_reserve_bytes(WPACKET *pkt, size_t len, unsigned char **allocbytes)
Packit Service 084de1
{
Packit Service 084de1
    /* Internal API, so should not fail */
Packit Service 084de1
    if (!ossl_assert(pkt->subs != NULL && len != 0))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    if (pkt->maxsize - pkt->written < len)
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    if (pkt->staticbuf == NULL && (pkt->buf->length - pkt->written < len)) {
Packit Service 084de1
        size_t newlen;
Packit Service 084de1
        size_t reflen;
Packit Service 084de1
Packit Service 084de1
        reflen = (len > pkt->buf->length) ? len : pkt->buf->length;
Packit Service 084de1
Packit Service 084de1
        if (reflen > SIZE_MAX / 2) {
Packit Service 084de1
            newlen = SIZE_MAX;
Packit Service 084de1
        } else {
Packit Service 084de1
            newlen = reflen * 2;
Packit Service 084de1
            if (newlen < DEFAULT_BUF_SIZE)
Packit Service 084de1
                newlen = DEFAULT_BUF_SIZE;
Packit Service 084de1
        }
Packit Service 084de1
        if (BUF_MEM_grow(pkt->buf, newlen) == 0)
Packit Service 084de1
            return 0;
Packit Service 084de1
    }
Packit Service 084de1
    if (allocbytes != NULL)
Packit Service 084de1
        *allocbytes = WPACKET_get_curr(pkt);
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_sub_reserve_bytes__(WPACKET *pkt, size_t len,
Packit Service 084de1
                                unsigned char **allocbytes, size_t lenbytes)
Packit Service 084de1
{
Packit Service 084de1
    if (!WPACKET_reserve_bytes(pkt, lenbytes + len, allocbytes))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    *allocbytes += lenbytes;
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
static size_t maxmaxsize(size_t lenbytes)
Packit Service 084de1
{
Packit Service 084de1
    if (lenbytes >= sizeof(size_t) || lenbytes == 0)
Packit Service 084de1
        return SIZE_MAX;
Packit Service 084de1
Packit Service 084de1
    return ((size_t)1 << (lenbytes * 8)) - 1 + lenbytes;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
static int wpacket_intern_init_len(WPACKET *pkt, size_t lenbytes)
Packit Service 084de1
{
Packit Service 084de1
    unsigned char *lenchars;
Packit Service 084de1
Packit Service 084de1
    pkt->curr = 0;
Packit Service 084de1
    pkt->written = 0;
Packit Service 084de1
Packit Service 084de1
    if ((pkt->subs = OPENSSL_zalloc(sizeof(*pkt->subs))) == NULL) {
Packit Service 084de1
        SSLerr(SSL_F_WPACKET_INTERN_INIT_LEN, ERR_R_MALLOC_FAILURE);
Packit Service 084de1
        return 0;
Packit Service 084de1
    }
Packit Service 084de1
Packit Service 084de1
    if (lenbytes == 0)
Packit Service 084de1
        return 1;
Packit Service 084de1
Packit Service 084de1
    pkt->subs->pwritten = lenbytes;
Packit Service 084de1
    pkt->subs->lenbytes = lenbytes;
Packit Service 084de1
Packit Service 084de1
    if (!WPACKET_allocate_bytes(pkt, lenbytes, &lenchars)) {
Packit Service 084de1
        OPENSSL_free(pkt->subs);
Packit Service 084de1
        pkt->subs = NULL;
Packit Service 084de1
        return 0;
Packit Service 084de1
    }
Packit Service 084de1
    pkt->subs->packet_len = lenchars - GETBUF(pkt);
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_init_static_len(WPACKET *pkt, unsigned char *buf, size_t len,
Packit Service 084de1
                            size_t lenbytes)
Packit Service 084de1
{
Packit Service 084de1
    size_t max = maxmaxsize(lenbytes);
Packit Service 084de1
Packit Service 084de1
    /* Internal API, so should not fail */
Packit Service 084de1
    if (!ossl_assert(buf != NULL && len > 0))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    pkt->staticbuf = buf;
Packit Service 084de1
    pkt->buf = NULL;
Packit Service 084de1
    pkt->maxsize = (max < len) ? max : len;
Packit Service 084de1
Packit Service 084de1
    return wpacket_intern_init_len(pkt, lenbytes);
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_init_len(WPACKET *pkt, BUF_MEM *buf, size_t lenbytes)
Packit Service 084de1
{
Packit Service 084de1
    /* Internal API, so should not fail */
Packit Service 084de1
    if (!ossl_assert(buf != NULL))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    pkt->staticbuf = NULL;
Packit Service 084de1
    pkt->buf = buf;
Packit Service 084de1
    pkt->maxsize = maxmaxsize(lenbytes);
Packit Service 084de1
Packit Service 084de1
    return wpacket_intern_init_len(pkt, lenbytes);
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_init(WPACKET *pkt, BUF_MEM *buf)
Packit Service 084de1
{
Packit Service 084de1
    return WPACKET_init_len(pkt, buf, 0);
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_set_flags(WPACKET *pkt, unsigned int flags)
Packit Service 084de1
{
Packit Service 084de1
    /* Internal API, so should not fail */
Packit Service 084de1
    if (!ossl_assert(pkt->subs != NULL))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    pkt->subs->flags = flags;
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
/* Store the |value| of length |len| at location |data| */
Packit Service 084de1
static int put_value(unsigned char *data, size_t value, size_t len)
Packit Service 084de1
{
Packit Service 084de1
    for (data += len - 1; len > 0; len--) {
Packit Service 084de1
        *data = (unsigned char)(value & 0xff);
Packit Service 084de1
        data--;
Packit Service 084de1
        value >>= 8;
Packit Service 084de1
    }
Packit Service 084de1
Packit Service 084de1
    /* Check whether we could fit the value in the assigned number of bytes */
Packit Service 084de1
    if (value > 0)
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
Packit Service 084de1
/*
Packit Service 084de1
 * Internal helper function used by WPACKET_close(), WPACKET_finish() and
Packit Service 084de1
 * WPACKET_fill_lengths() to close a sub-packet and write out its length if
Packit Service 084de1
 * necessary. If |doclose| is 0 then it goes through the motions of closing
Packit Service 084de1
 * (i.e. it fills in all the lengths), but doesn't actually close anything.
Packit Service 084de1
 */
Packit Service 084de1
static int wpacket_intern_close(WPACKET *pkt, WPACKET_SUB *sub, int doclose)
Packit Service 084de1
{
Packit Service 084de1
    size_t packlen = pkt->written - sub->pwritten;
Packit Service 084de1
Packit Service 084de1
    if (packlen == 0
Packit Service 084de1
            && (sub->flags & WPACKET_FLAGS_NON_ZERO_LENGTH) != 0)
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    if (packlen == 0
Packit Service 084de1
            && sub->flags & WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH) {
Packit Service 084de1
        /* We can't handle this case. Return an error */
Packit Service 084de1
        if (!doclose)
Packit Service 084de1
            return 0;
Packit Service 084de1
Packit Service 084de1
        /* Deallocate any bytes allocated for the length of the WPACKET */
Packit Service 084de1
        if ((pkt->curr - sub->lenbytes) == sub->packet_len) {
Packit Service 084de1
            pkt->written -= sub->lenbytes;
Packit Service 084de1
            pkt->curr -= sub->lenbytes;
Packit Service 084de1
        }
Packit Service 084de1
Packit Service 084de1
        /* Don't write out the packet length */
Packit Service 084de1
        sub->packet_len = 0;
Packit Service 084de1
        sub->lenbytes = 0;
Packit Service 084de1
    }
Packit Service 084de1
Packit Service 084de1
    /* Write out the WPACKET length if needed */
Packit Service 084de1
    if (sub->lenbytes > 0
Packit Service 084de1
                && !put_value(&GETBUF(pkt)[sub->packet_len], packlen,
Packit Service 084de1
                              sub->lenbytes))
Packit Service 084de1
            return 0;
Packit Service 084de1
Packit Service 084de1
    if (doclose) {
Packit Service 084de1
        pkt->subs = sub->parent;
Packit Service 084de1
        OPENSSL_free(sub);
Packit Service 084de1
    }
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_fill_lengths(WPACKET *pkt)
Packit Service 084de1
{
Packit Service 084de1
    WPACKET_SUB *sub;
Packit Service 084de1
Packit Service 084de1
    if (!ossl_assert(pkt->subs != NULL))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    for (sub = pkt->subs; sub != NULL; sub = sub->parent) {
Packit Service 084de1
        if (!wpacket_intern_close(pkt, sub, 0))
Packit Service 084de1
            return 0;
Packit Service 084de1
    }
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_close(WPACKET *pkt)
Packit Service 084de1
{
Packit Service 084de1
    /*
Packit Service 084de1
     * Internal API, so should not fail - but we do negative testing of this
Packit Service 084de1
     * so no assert (otherwise the tests fail)
Packit Service 084de1
     */
Packit Service 084de1
    if (pkt->subs == NULL || pkt->subs->parent == NULL)
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    return wpacket_intern_close(pkt, pkt->subs, 1);
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_finish(WPACKET *pkt)
Packit Service 084de1
{
Packit Service 084de1
    int ret;
Packit Service 084de1
Packit Service 084de1
    /*
Packit Service 084de1
     * Internal API, so should not fail - but we do negative testing of this
Packit Service 084de1
     * so no assert (otherwise the tests fail)
Packit Service 084de1
     */
Packit Service 084de1
    if (pkt->subs == NULL || pkt->subs->parent != NULL)
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    ret = wpacket_intern_close(pkt, pkt->subs, 1);
Packit Service 084de1
    if (ret) {
Packit Service 084de1
        OPENSSL_free(pkt->subs);
Packit Service 084de1
        pkt->subs = NULL;
Packit Service 084de1
    }
Packit Service 084de1
Packit Service 084de1
    return ret;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_start_sub_packet_len__(WPACKET *pkt, size_t lenbytes)
Packit Service 084de1
{
Packit Service 084de1
    WPACKET_SUB *sub;
Packit Service 084de1
    unsigned char *lenchars;
Packit Service 084de1
Packit Service 084de1
    /* Internal API, so should not fail */
Packit Service 084de1
    if (!ossl_assert(pkt->subs != NULL))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    if ((sub = OPENSSL_zalloc(sizeof(*sub))) == NULL) {
Packit Service 084de1
        SSLerr(SSL_F_WPACKET_START_SUB_PACKET_LEN__, ERR_R_MALLOC_FAILURE);
Packit Service 084de1
        return 0;
Packit Service 084de1
    }
Packit Service 084de1
Packit Service 084de1
    sub->parent = pkt->subs;
Packit Service 084de1
    pkt->subs = sub;
Packit Service 084de1
    sub->pwritten = pkt->written + lenbytes;
Packit Service 084de1
    sub->lenbytes = lenbytes;
Packit Service 084de1
Packit Service 084de1
    if (lenbytes == 0) {
Packit Service 084de1
        sub->packet_len = 0;
Packit Service 084de1
        return 1;
Packit Service 084de1
    }
Packit Service 084de1
Packit Service 084de1
    if (!WPACKET_allocate_bytes(pkt, lenbytes, &lenchars))
Packit Service 084de1
        return 0;
Packit Service 084de1
    /* Convert to an offset in case the underlying BUF_MEM gets realloc'd */
Packit Service 084de1
    sub->packet_len = lenchars - GETBUF(pkt);
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_start_sub_packet(WPACKET *pkt)
Packit Service 084de1
{
Packit Service 084de1
    return WPACKET_start_sub_packet_len__(pkt, 0);
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_put_bytes__(WPACKET *pkt, unsigned int val, size_t size)
Packit Service 084de1
{
Packit Service 084de1
    unsigned char *data;
Packit Service 084de1
Packit Service 084de1
    /* Internal API, so should not fail */
Packit Service 084de1
    if (!ossl_assert(size <= sizeof(unsigned int))
Packit Service 084de1
            || !WPACKET_allocate_bytes(pkt, size, &data)
Packit Service 084de1
            || !put_value(data, val, size))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_set_max_size(WPACKET *pkt, size_t maxsize)
Packit Service 084de1
{
Packit Service 084de1
    WPACKET_SUB *sub;
Packit Service 084de1
    size_t lenbytes;
Packit Service 084de1
Packit Service 084de1
    /* Internal API, so should not fail */
Packit Service 084de1
    if (!ossl_assert(pkt->subs != NULL))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    /* Find the WPACKET_SUB for the top level */
Packit Service 084de1
    for (sub = pkt->subs; sub->parent != NULL; sub = sub->parent)
Packit Service 084de1
        continue;
Packit Service 084de1
Packit Service 084de1
    lenbytes = sub->lenbytes;
Packit Service 084de1
    if (lenbytes == 0)
Packit Service 084de1
        lenbytes = sizeof(pkt->maxsize);
Packit Service 084de1
Packit Service 084de1
    if (maxmaxsize(lenbytes) < maxsize || maxsize < pkt->written)
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    pkt->maxsize = maxsize;
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_memset(WPACKET *pkt, int ch, size_t len)
Packit Service 084de1
{
Packit Service 084de1
    unsigned char *dest;
Packit Service 084de1
Packit Service 084de1
    if (len == 0)
Packit Service 084de1
        return 1;
Packit Service 084de1
Packit Service 084de1
    if (!WPACKET_allocate_bytes(pkt, len, &dest))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    memset(dest, ch, len);
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_memcpy(WPACKET *pkt, const void *src, size_t len)
Packit Service 084de1
{
Packit Service 084de1
    unsigned char *dest;
Packit Service 084de1
Packit Service 084de1
    if (len == 0)
Packit Service 084de1
        return 1;
Packit Service 084de1
Packit Service 084de1
    if (!WPACKET_allocate_bytes(pkt, len, &dest))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    memcpy(dest, src, len);
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_sub_memcpy__(WPACKET *pkt, const void *src, size_t len,
Packit Service 084de1
                         size_t lenbytes)
Packit Service 084de1
{
Packit Service 084de1
    if (!WPACKET_start_sub_packet_len__(pkt, lenbytes)
Packit Service 084de1
            || !WPACKET_memcpy(pkt, src, len)
Packit Service 084de1
            || !WPACKET_close(pkt))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_get_total_written(WPACKET *pkt, size_t *written)
Packit Service 084de1
{
Packit Service 084de1
    /* Internal API, so should not fail */
Packit Service 084de1
    if (!ossl_assert(written != NULL))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    *written = pkt->written;
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
int WPACKET_get_length(WPACKET *pkt, size_t *len)
Packit Service 084de1
{
Packit Service 084de1
    /* Internal API, so should not fail */
Packit Service 084de1
    if (!ossl_assert(pkt->subs != NULL && len != NULL))
Packit Service 084de1
        return 0;
Packit Service 084de1
Packit Service 084de1
    *len = pkt->written - pkt->subs->pwritten;
Packit Service 084de1
Packit Service 084de1
    return 1;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
unsigned char *WPACKET_get_curr(WPACKET *pkt)
Packit Service 084de1
{
Packit Service 084de1
    return GETBUF(pkt) + pkt->curr;
Packit Service 084de1
}
Packit Service 084de1
Packit Service 084de1
void WPACKET_cleanup(WPACKET *pkt)
Packit Service 084de1
{
Packit Service 084de1
    WPACKET_SUB *sub, *parent;
Packit Service 084de1
Packit Service 084de1
    for (sub = pkt->subs; sub != NULL; sub = parent) {
Packit Service 084de1
        parent = sub->parent;
Packit Service 084de1
        OPENSSL_free(sub);
Packit Service 084de1
    }
Packit Service 084de1
    pkt->subs = NULL;
Packit Service 084de1
}