Update documentation regarding required output buffer memory size
[openssl.git] / ssl / packet.c
index e75193d..26cf1eb 100644 (file)
@@ -1,48 +1,80 @@
 /*
- * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
+ * Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
  *
- * Licensed under the OpenSSL license (the "License").  You may not use
+ * Licensed under the Apache License 2.0 (the "License").  You may not use
  * this file except in compliance with the License.  You can obtain a copy
  * in the file LICENSE in the source distribution or at
  * https://www.openssl.org/source/license.html
  */
 
+#include "internal/cryptlib.h"
 #include "packet_locl.h"
+#include <openssl/sslerr.h>
 
 #define DEFAULT_BUF_SIZE    256
 
 int WPACKET_allocate_bytes(WPACKET *pkt, size_t len, unsigned char **allocbytes)
 {
-    if (pkt->subs == NULL || len == 0)
+    if (!WPACKET_reserve_bytes(pkt, len, allocbytes))
+        return 0;
+
+    pkt->written += len;
+    pkt->curr += len;
+    return 1;
+}
+
+int WPACKET_sub_allocate_bytes__(WPACKET *pkt, size_t len,
+                                 unsigned char **allocbytes, size_t lenbytes)
+{
+    if (!WPACKET_start_sub_packet_len__(pkt, lenbytes)
+            || !WPACKET_allocate_bytes(pkt, len, allocbytes)
+            || !WPACKET_close(pkt))
+        return 0;
+
+    return 1;
+}
+
+#define GETBUF(p)   (((p)->staticbuf != NULL) \
+                     ? (p)->staticbuf : (unsigned char *)(p)->buf->data)
+
+int WPACKET_reserve_bytes(WPACKET *pkt, size_t len, unsigned char **allocbytes)
+{
+    /* Internal API, so should not fail */
+    if (!ossl_assert(pkt->subs != NULL && len != 0))
         return 0;
 
     if (pkt->maxsize - pkt->written < len)
         return 0;
 
-    if (pkt->buf->length - pkt->written < len) {
+    if (pkt->staticbuf == NULL && (pkt->buf->length - pkt->written < len)) {
         size_t newlen;
+        size_t reflen;
+
+        reflen = (len > pkt->buf->length) ? len : pkt->buf->length;
 
-        if (pkt->buf->length > SIZE_MAX / 2) {
+        if (reflen > SIZE_MAX / 2) {
             newlen = SIZE_MAX;
         } else {
-            if (pkt->buf->length == 0)
+            newlen = reflen * 2;
+            if (newlen < DEFAULT_BUF_SIZE)
                 newlen = DEFAULT_BUF_SIZE;
-            else
-                newlen = pkt->buf->length * 2;
         }
         if (BUF_MEM_grow(pkt->buf, newlen) == 0)
             return 0;
-        if (pkt->curr == NULL) {
-            /*
-             * Can happen if initialised with a BUF_MEM that hasn't been
-             * pre-allocated.
-             */
-            pkt->curr = (unsigned char *)pkt->buf->data;
-        }
     }
-    pkt->written += len;
-    *allocbytes = pkt->curr;
-    pkt->curr += len;
+    if (allocbytes != NULL)
+        *allocbytes = WPACKET_get_curr(pkt);
+
+    return 1;
+}
+
+int WPACKET_sub_reserve_bytes__(WPACKET *pkt, size_t len,
+                                unsigned char **allocbytes, size_t lenbytes)
+{
+    if (!WPACKET_reserve_bytes(pkt, lenbytes + len, allocbytes))
+        return 0;
+
+    *allocbytes += lenbytes;
 
     return 1;
 }
@@ -51,24 +83,21 @@ static size_t maxmaxsize(size_t lenbytes)
 {
     if (lenbytes >= sizeof(size_t) || lenbytes == 0)
         return SIZE_MAX;
-    else
-        return ((size_t)1 << (lenbytes * 8)) - 1 + lenbytes;
+
+    return ((size_t)1 << (lenbytes * 8)) - 1 + lenbytes;
 }
 
-int WPACKET_init_len(WPACKET *pkt, BUF_MEM *buf, size_t lenbytes)
+static int wpacket_intern_init_len(WPACKET *pkt, size_t lenbytes)
 {
-    /* Sanity check */
-    if (buf == NULL)
-        return 0;
+    unsigned char *lenchars;
 
-    pkt->buf = buf;
-    pkt->curr = (unsigned char *)buf->data;
+    pkt->curr = 0;
     pkt->written = 0;
-    pkt->maxsize = maxmaxsize(lenbytes);
 
-    pkt->subs = OPENSSL_zalloc(sizeof(*pkt->subs));
-    if (pkt->subs == NULL)
+    if ((pkt->subs = OPENSSL_zalloc(sizeof(*pkt->subs))) == NULL) {
+        SSLerr(SSL_F_WPACKET_INTERN_INIT_LEN, ERR_R_MALLOC_FAILURE);
         return 0;
+    }
 
     if (lenbytes == 0)
         return 1;
@@ -76,42 +105,54 @@ int WPACKET_init_len(WPACKET *pkt, BUF_MEM *buf, size_t lenbytes)
     pkt->subs->pwritten = lenbytes;
     pkt->subs->lenbytes = lenbytes;
 
-    if (!WPACKET_allocate_bytes(pkt, lenbytes, &(pkt->subs->packet_len))) {
+    if (!WPACKET_allocate_bytes(pkt, lenbytes, &lenchars)) {
         OPENSSL_free(pkt->subs);
         pkt->subs = NULL;
         return 0;
     }
+    pkt->subs->packet_len = lenchars - GETBUF(pkt);
 
     return 1;
 }
 
-int WPACKET_init(WPACKET *pkt, BUF_MEM *buf)
+int WPACKET_init_static_len(WPACKET *pkt, unsigned char *buf, size_t len,
+                            size_t lenbytes)
 {
-    return WPACKET_init_len(pkt, buf, 0);
+    size_t max = maxmaxsize(lenbytes);
+
+    /* Internal API, so should not fail */
+    if (!ossl_assert(buf != NULL && len > 0))
+        return 0;
+
+    pkt->staticbuf = buf;
+    pkt->buf = NULL;
+    pkt->maxsize = (max < len) ? max : len;
+
+    return wpacket_intern_init_len(pkt, lenbytes);
 }
 
-int WPACKET_set_packet_len(WPACKET *pkt, unsigned char *packet_len,
-                           size_t lenbytes)
+int WPACKET_init_len(WPACKET *pkt, BUF_MEM *buf, size_t lenbytes)
 {
-    size_t maxmax;
-
-    /* We only allow this to be set once */
-    if (pkt->subs == NULL || pkt->subs->lenbytes != 0)
+    /* Internal API, so should not fail */
+    if (!ossl_assert(buf != NULL))
         return 0;
 
-    pkt->subs->lenbytes = lenbytes;
-    pkt->subs->packet_len = packet_len;
+    pkt->staticbuf = NULL;
+    pkt->buf = buf;
+    pkt->maxsize = maxmaxsize(lenbytes);
 
-    maxmax = maxmaxsize(lenbytes);
-    if (pkt->maxsize > maxmax)
-        pkt->maxsize = maxmax;
+    return wpacket_intern_init_len(pkt, lenbytes);
+}
 
-    return 1;
+int WPACKET_init(WPACKET *pkt, BUF_MEM *buf)
+{
+    return WPACKET_init_len(pkt, buf, 0);
 }
 
 int WPACKET_set_flags(WPACKET *pkt, unsigned int flags)
 {
-    if (pkt->subs == NULL)
+    /* Internal API, so should not fail */
+    if (!ossl_assert(pkt->subs != NULL))
         return 0;
 
     pkt->subs->flags = flags;
@@ -119,23 +160,43 @@ int WPACKET_set_flags(WPACKET *pkt, unsigned int flags)
     return 1;
 }
 
+/* Store the |value| of length |len| at location |data| */
+static int put_value(unsigned char *data, size_t value, size_t len)
+{
+    for (data += len - 1; len > 0; len--) {
+        *data = (unsigned char)(value & 0xff);
+        data--;
+        value >>= 8;
+    }
+
+    /* Check whether we could fit the value in the assigned number of bytes */
+    if (value > 0)
+        return 0;
+
+    return 1;
+}
+
 
 /*
- * Internal helper function used by WPACKET_close() and WPACKET_finish() to
- * close a sub-packet and write out its length if necessary.
+ * Internal helper function used by WPACKET_close(), WPACKET_finish() and
+ * WPACKET_fill_lengths() to close a sub-packet and write out its length if
+ * necessary. If |doclose| is 0 then it goes through the motions of closing
+ * (i.e. it fills in all the lengths), but doesn't actually close anything.
  */
-static int wpacket_intern_close(WPACKET *pkt)
+static int wpacket_intern_close(WPACKET *pkt, WPACKET_SUB *sub, int doclose)
 {
-    size_t packlen;
-    WPACKET_SUB *sub = pkt->subs;
+    size_t packlen = pkt->written - sub->pwritten;
 
-    packlen = pkt->written - sub->pwritten;
     if (packlen == 0
-            && sub->flags & OPENSSL_WPACKET_FLAGS_NON_ZERO_LENGTH)
+            && (sub->flags & WPACKET_FLAGS_NON_ZERO_LENGTH) != 0)
         return 0;
 
     if (packlen == 0
-            && sub->flags & OPENSSL_WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH) {
+            && sub->flags & WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH) {
+        /* We can't handle this case. Return an error */
+        if (!doclose)
+            return 0;
+
         /* Deallocate any bytes allocated for the length of the WPACKET */
         if ((pkt->curr - sub->lenbytes) == sub->packet_len) {
             pkt->written -= sub->lenbytes;
@@ -143,68 +204,84 @@ static int wpacket_intern_close(WPACKET *pkt)
         }
 
         /* Don't write out the packet length */
-        sub->packet_len = NULL;
+        sub->packet_len = 0;
+        sub->lenbytes = 0;
     }
 
     /* Write out the WPACKET length if needed */
-    if (sub->packet_len != NULL) {
-        size_t lenbytes;
+    if (sub->lenbytes > 0
+                && !put_value(&GETBUF(pkt)[sub->packet_len], packlen,
+                              sub->lenbytes))
+            return 0;
 
-        lenbytes = sub->lenbytes;
+    if (doclose) {
+        pkt->subs = sub->parent;
+        OPENSSL_free(sub);
+    }
 
-        for (; lenbytes > 0; lenbytes--) {
-            sub->packet_len[lenbytes - 1]
-                = (unsigned char)(packlen & 0xff);
-            packlen >>= 8;
-        }
-        if (packlen > 0) {
-            /*
-             * We've extended beyond the max allowed for the number of len bytes
-             */
+    return 1;
+}
+
+int WPACKET_fill_lengths(WPACKET *pkt)
+{
+    WPACKET_SUB *sub;
+
+    if (!ossl_assert(pkt->subs != NULL))
+        return 0;
+
+    for (sub = pkt->subs; sub != NULL; sub = sub->parent) {
+        if (!wpacket_intern_close(pkt, sub, 0))
             return 0;
-        }
     }
 
-    pkt->subs = sub->parent;
-    OPENSSL_free(sub);
-
     return 1;
 }
 
 int WPACKET_close(WPACKET *pkt)
 {
+    /*
+     * Internal API, so should not fail - but we do negative testing of this
+     * so no assert (otherwise the tests fail)
+     */
     if (pkt->subs == NULL || pkt->subs->parent == NULL)
         return 0;
 
-    return wpacket_intern_close(pkt);
+    return wpacket_intern_close(pkt, pkt->subs, 1);
 }
 
 int WPACKET_finish(WPACKET *pkt)
 {
     int ret;
 
+    /*
+     * Internal API, so should not fail - but we do negative testing of this
+     * so no assert (otherwise the tests fail)
+     */
     if (pkt->subs == NULL || pkt->subs->parent != NULL)
         return 0;
 
-    ret = wpacket_intern_close(pkt);
-
+    ret = wpacket_intern_close(pkt, pkt->subs, 1);
     if (ret) {
         OPENSSL_free(pkt->subs);
         pkt->subs = NULL;
     }
+
     return ret;
 }
 
-int WPACKET_start_sub_packet_len(WPACKET *pkt, size_t lenbytes)
+int WPACKET_start_sub_packet_len__(WPACKET *pkt, size_t lenbytes)
 {
     WPACKET_SUB *sub;
+    unsigned char *lenchars;
 
-    if (pkt->subs == NULL)
+    /* Internal API, so should not fail */
+    if (!ossl_assert(pkt->subs != NULL))
         return 0;
 
-    sub = OPENSSL_zalloc(sizeof(*sub));
-    if (sub == NULL)
+    if ((sub = OPENSSL_zalloc(sizeof(*sub))) == NULL) {
+        SSLerr(SSL_F_WPACKET_START_SUB_PACKET_LEN__, ERR_R_MALLOC_FAILURE);
         return 0;
+    }
 
     sub->parent = pkt->subs;
     pkt->subs = sub;
@@ -212,39 +289,31 @@ int WPACKET_start_sub_packet_len(WPACKET *pkt, size_t lenbytes)
     sub->lenbytes = lenbytes;
 
     if (lenbytes == 0) {
-        sub->packet_len = NULL;
+        sub->packet_len = 0;
         return 1;
     }
 
-    if (!WPACKET_allocate_bytes(pkt, lenbytes, &sub->packet_len)) {
+    if (!WPACKET_allocate_bytes(pkt, lenbytes, &lenchars))
         return 0;
-    }
+    /* Convert to an offset in case the underlying BUF_MEM gets realloc'd */
+    sub->packet_len = lenchars - GETBUF(pkt);
 
     return 1;
 }
 
 int WPACKET_start_sub_packet(WPACKET *pkt)
 {
-    return WPACKET_start_sub_packet_len(pkt, 0);
+    return WPACKET_start_sub_packet_len__(pkt, 0);
 }
 
-int WPACKET_put_bytes(WPACKET *pkt, unsigned int val, size_t bytes)
+int WPACKET_put_bytes__(WPACKET *pkt, unsigned int val, size_t size)
 {
     unsigned char *data;
 
-    if (bytes > sizeof(unsigned int)
-            || !WPACKET_allocate_bytes(pkt, bytes, &data))
-        return 0;
-
-    data += bytes - 1;
-    for (; bytes > 0; bytes--) {
-        *data = (unsigned char)(val & 0xff);
-        data--;
-        val >>= 8;
-    }
-
-    /* Check whether we could fit the value in the assigned number of bytes */
-    if (val > 0)
+    /* Internal API, so should not fail */
+    if (!ossl_assert(size <= sizeof(unsigned int))
+            || !WPACKET_allocate_bytes(pkt, size, &data)
+            || !put_value(data, val, size))
         return 0;
 
     return 1;
@@ -255,11 +324,13 @@ int WPACKET_set_max_size(WPACKET *pkt, size_t maxsize)
     WPACKET_SUB *sub;
     size_t lenbytes;
 
-    if (pkt->subs == NULL)
+    /* Internal API, so should not fail */
+    if (!ossl_assert(pkt->subs != NULL))
         return 0;
 
     /* Find the WPACKET_SUB for the top level */
-    for (sub = pkt->subs; sub->parent != NULL; sub = sub->parent);
+    for (sub = pkt->subs; sub->parent != NULL; sub = sub->parent)
+        continue;
 
     lenbytes = sub->lenbytes;
     if (lenbytes == 0)
@@ -273,6 +344,21 @@ int WPACKET_set_max_size(WPACKET *pkt, size_t maxsize)
     return 1;
 }
 
+int WPACKET_memset(WPACKET *pkt, int ch, size_t len)
+{
+    unsigned char *dest;
+
+    if (len == 0)
+        return 1;
+
+    if (!WPACKET_allocate_bytes(pkt, len, &dest))
+        return 0;
+
+    memset(dest, ch, len);
+
+    return 1;
+}
+
 int WPACKET_memcpy(WPACKET *pkt, const void *src, size_t len)
 {
     unsigned char *dest;
@@ -288,9 +374,10 @@ int WPACKET_memcpy(WPACKET *pkt, const void *src, size_t len)
     return 1;
 }
 
-int WPACKET_sub_memcpy(WPACKET *pkt, const void *src, size_t len, size_t lenbytes)
+int WPACKET_sub_memcpy__(WPACKET *pkt, const void *src, size_t len,
+                         size_t lenbytes)
 {
-    if (!WPACKET_start_sub_packet_len(pkt, lenbytes)
+    if (!WPACKET_start_sub_packet_len__(pkt, lenbytes)
             || !WPACKET_memcpy(pkt, src, len)
             || !WPACKET_close(pkt))
         return 0;
@@ -300,7 +387,8 @@ int WPACKET_sub_memcpy(WPACKET *pkt, const void *src, size_t len, size_t lenbyte
 
 int WPACKET_get_total_written(WPACKET *pkt, size_t *written)
 {
-    if (written == NULL)
+    /* Internal API, so should not fail */
+    if (!ossl_assert(written != NULL))
         return 0;
 
     *written = pkt->written;
@@ -310,7 +398,8 @@ int WPACKET_get_total_written(WPACKET *pkt, size_t *written)
 
 int WPACKET_get_length(WPACKET *pkt, size_t *len)
 {
-    if (pkt->subs == NULL || len == NULL)
+    /* Internal API, so should not fail */
+    if (!ossl_assert(pkt->subs != NULL && len != NULL))
         return 0;
 
     *len = pkt->written - pkt->subs->pwritten;
@@ -318,6 +407,11 @@ int WPACKET_get_length(WPACKET *pkt, size_t *len)
     return 1;
 }
 
+unsigned char *WPACKET_get_curr(WPACKET *pkt)
+{
+    return GETBUF(pkt) + pkt->curr;
+}
+
 void WPACKET_cleanup(WPACKET *pkt)
 {
     WPACKET_SUB *sub, *parent;