ssl/packet.c

   1 /*
   2  * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   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
   8  */
   9
  10 #include <assert.h>
  11 #include "packet_locl.h"
  12
  13 #define DEFAULT_BUF_SIZE    256
  14
  15 int WPACKET_allocate_bytes(WPACKET *pkt, size_t len, unsigned char **allocbytes)
  16 {
  17     /* Internal API, so should not fail */
  18     assert(pkt->subs != NULL && len != 0);
  19     if (pkt->subs == NULL || len == 0)
  20         return 0;
  21
  22     if (pkt->maxsize - pkt->written < len)
  23         return 0;
  24
  25     if (pkt->buf->length - pkt->written < len) {
  26         size_t newlen;
  27         size_t reflen;
  28
  29         reflen = (len > pkt->buf->length) ? len : pkt->buf->length;
  30
  31         if (reflen > SIZE_MAX / 2) {
  32             newlen = SIZE_MAX;
  33         } else {
  34             newlen = reflen * 2;
  35             if (newlen < DEFAULT_BUF_SIZE)
  36                 newlen = DEFAULT_BUF_SIZE;
  37         }
  38         if (BUF_MEM_grow(pkt->buf, newlen) == 0)
  39             return 0;
  40     }
  41     *allocbytes = (unsigned char *)pkt->buf->data + pkt->curr;
  42     pkt->written += len;
  43     pkt->curr += len;
  44
  45     return 1;
  46 }
  47
  48 int WPACKET_sub_allocate_bytes__(WPACKET *pkt, size_t len,
  49                                  unsigned char **allocbytes, size_t lenbytes)
  50 {
  51     if (!WPACKET_start_sub_packet_len__(pkt, lenbytes)
  52             || !WPACKET_allocate_bytes(pkt, len, allocbytes)
  53             || !WPACKET_close(pkt))
  54         return 0;
  55
  56     return 1;
  57 }
  58
  59 static size_t maxmaxsize(size_t lenbytes)
  60 {
  61     if (lenbytes >= sizeof(size_t) || lenbytes == 0)
  62         return SIZE_MAX;
  63
  64     return ((size_t)1 << (lenbytes * 8)) - 1 + lenbytes;
  65 }
  66
  67 int WPACKET_init_len(WPACKET *pkt, BUF_MEM *buf, size_t lenbytes)
  68 {
  69     unsigned char *lenchars;
  70
  71     /* Internal API, so should not fail */
  72     assert(buf != NULL);
  73     if (buf == NULL)
  74         return 0;
  75
  76     pkt->buf = buf;
  77     pkt->curr = 0;
  78     pkt->written = 0;
  79     pkt->maxsize = maxmaxsize(lenbytes);
  80
  81     pkt->subs = OPENSSL_zalloc(sizeof(*pkt->subs));
  82     if (pkt->subs == NULL)
  83         return 0;
  84
  85     if (lenbytes == 0)
  86         return 1;
  87
  88     pkt->subs->pwritten = lenbytes;
  89     pkt->subs->lenbytes = lenbytes;
  90
  91     if (!WPACKET_allocate_bytes(pkt, lenbytes, &lenchars)) {
  92         OPENSSL_free(pkt->subs);
  93         pkt->subs = NULL;
  94         return 0;
  95     }
  96     pkt->subs->packet_len = lenchars - (unsigned char *)pkt->buf->data;
  97
  98     return 1;
  99 }
 100
 101 int WPACKET_init(WPACKET *pkt, BUF_MEM *buf)
 102 {
 103     return WPACKET_init_len(pkt, buf, 0);
 104 }
 105
 106 int WPACKET_set_flags(WPACKET *pkt, unsigned int flags)
 107 {
 108     /* Internal API, so should not fail */
 109     assert(pkt->subs != NULL);
 110     if (pkt->subs == NULL)
 111         return 0;
 112
 113     pkt->subs->flags = flags;
 114
 115     return 1;
 116 }
 117
 118 /* Store the |value| of length |len| at location |data| */
 119 static int put_value(unsigned char *data, size_t value, size_t len)
 120 {
 121     for (data += len - 1; len > 0; len--) {
 122         *data = (unsigned char)(value & 0xff);
 123         data--;
 124         value >>= 8;
 125     }
 126
 127     /* Check whether we could fit the value in the assigned number of bytes */
 128     if (value > 0)
 129         return 0;
 130
 131     return 1;
 132 }
 133
 134
 135 /*
 136  * Internal helper function used by WPACKET_close() and WPACKET_finish() to
 137  * close a sub-packet and write out its length if necessary.
 138  */
 139 static int wpacket_intern_close(WPACKET *pkt)
 140 {
 141     WPACKET_SUB *sub = pkt->subs;
 142     size_t packlen = pkt->written - sub->pwritten;
 143
 144     if (packlen == 0
 145             && (sub->flags & WPACKET_FLAGS_NON_ZERO_LENGTH) != 0)
 146         return 0;
 147
 148     if (packlen == 0
 149             && sub->flags & WPACKET_FLAGS_ABANDON_ON_ZERO_LENGTH) {
 150         /* Deallocate any bytes allocated for the length of the WPACKET */
 151         if ((pkt->curr - sub->lenbytes) == sub->packet_len) {
 152             pkt->written -= sub->lenbytes;
 153             pkt->curr -= sub->lenbytes;
 154         }
 155
 156         /* Don't write out the packet length */
 157         sub->packet_len = 0;
 158         sub->lenbytes = 0;
 159     }
 160
 161     /* Write out the WPACKET length if needed */
 162     if (sub->lenbytes > 0
 163                 && !put_value((unsigned char *)&pkt->buf->data[sub->packet_len],
 164                               packlen, sub->lenbytes))
 165             return 0;
 166
 167     pkt->subs = sub->parent;
 168     OPENSSL_free(sub);
 169
 170     return 1;
 171 }
 172
 173 int WPACKET_close(WPACKET *pkt)
 174 {
 175     /*
 176      * Internal API, so should not fail - but we do negative testing of this
 177      * so no assert (otherwise the tests fail)
 178      */
 179     if (pkt->subs == NULL || pkt->subs->parent == NULL)
 180         return 0;
 181
 182     return wpacket_intern_close(pkt);
 183 }
 184
 185 int WPACKET_finish(WPACKET *pkt)
 186 {
 187     int ret;
 188
 189     /*
 190      * Internal API, so should not fail - but we do negative testing of this
 191      * so no assert (otherwise the tests fail)
 192      */
 193     if (pkt->subs == NULL || pkt->subs->parent != NULL)
 194         return 0;
 195
 196     ret = wpacket_intern_close(pkt);
 197     if (ret) {
 198         OPENSSL_free(pkt->subs);
 199         pkt->subs = NULL;
 200     }
 201
 202     return ret;
 203 }
 204
 205 int WPACKET_start_sub_packet_len__(WPACKET *pkt, size_t lenbytes)
 206 {
 207     WPACKET_SUB *sub;
 208     unsigned char *lenchars;
 209
 210     /* Internal API, so should not fail */
 211     assert(pkt->subs != NULL);
 212     if (pkt->subs == NULL)
 213         return 0;
 214
 215     sub = OPENSSL_zalloc(sizeof(*sub));
 216     if (sub == NULL)
 217         return 0;
 218
 219     sub->parent = pkt->subs;
 220     pkt->subs = sub;
 221     sub->pwritten = pkt->written + lenbytes;
 222     sub->lenbytes = lenbytes;
 223
 224     if (lenbytes == 0) {
 225         sub->packet_len = 0;
 226         return 1;
 227     }
 228
 229     if (!WPACKET_allocate_bytes(pkt, lenbytes, &lenchars))
 230         return 0;
 231     /* Convert to an offset in case the underlying BUF_MEM gets realloc'd */
 232     sub->packet_len = lenchars - (unsigned char *)pkt->buf->data;
 233
 234     return 1;
 235 }
 236
 237 int WPACKET_start_sub_packet(WPACKET *pkt)
 238 {
 239     return WPACKET_start_sub_packet_len__(pkt, 0);
 240 }
 241
 242 int WPACKET_put_bytes__(WPACKET *pkt, unsigned int val, size_t size)
 243 {
 244     unsigned char *data;
 245
 246     /* Internal API, so should not fail */
 247     assert(size <= sizeof(unsigned int));
 248
 249     if (size > sizeof(unsigned int)
 250             || !WPACKET_allocate_bytes(pkt, size, &data)
 251             || !put_value(data, val, size))
 252         return 0;
 253
 254     return 1;
 255 }
 256
 257 int WPACKET_set_max_size(WPACKET *pkt, size_t maxsize)
 258 {
 259     WPACKET_SUB *sub;
 260     size_t lenbytes;
 261
 262     /* Internal API, so should not fail */
 263     assert(pkt->subs != NULL);
 264     if (pkt->subs == NULL)
 265         return 0;
 266
 267     /* Find the WPACKET_SUB for the top level */
 268     for (sub = pkt->subs; sub->parent != NULL; sub = sub->parent)
 269         continue;
 270
 271     lenbytes = sub->lenbytes;
 272     if (lenbytes == 0)
 273         lenbytes = sizeof(pkt->maxsize);
 274
 275     if (maxmaxsize(lenbytes) < maxsize || maxsize < pkt->written)
 276         return 0;
 277
 278     pkt->maxsize = maxsize;
 279
 280     return 1;
 281 }
 282
 283 int WPACKET_memcpy(WPACKET *pkt, const void *src, size_t len)
 284 {
 285     unsigned char *dest;
 286
 287     if (len == 0)
 288         return 1;
 289
 290     if (!WPACKET_allocate_bytes(pkt, len, &dest))
 291         return 0;
 292
 293     memcpy(dest, src, len);
 294
 295     return 1;
 296 }
 297
 298 int WPACKET_sub_memcpy__(WPACKET *pkt, const void *src, size_t len,
 299                          size_t lenbytes)
 300 {
 301     if (!WPACKET_start_sub_packet_len__(pkt, lenbytes)
 302             || !WPACKET_memcpy(pkt, src, len)
 303             || !WPACKET_close(pkt))
 304         return 0;
 305
 306     return 1;
 307 }
 308
 309 int WPACKET_get_total_written(WPACKET *pkt, size_t *written)
 310 {
 311     /* Internal API, so should not fail */
 312     assert(written != NULL);
 313     if (written == NULL)
 314         return 0;
 315
 316     *written = pkt->written;
 317
 318     return 1;
 319 }
 320
 321 int WPACKET_get_length(WPACKET *pkt, size_t *len)
 322 {
 323     /* Internal API, so should not fail */
 324     assert(pkt->subs != NULL && len != NULL);
 325     if (pkt->subs == NULL || len == NULL)
 326         return 0;
 327
 328     *len = pkt->written - pkt->subs->pwritten;
 329
 330     return 1;
 331 }
 332
 333 void WPACKET_cleanup(WPACKET *pkt)
 334 {
 335     WPACKET_SUB *sub, *parent;
 336
 337     for (sub = pkt->subs; sub != NULL; sub = parent) {
 338         parent = sub->parent;
 339         OPENSSL_free(sub);
 340     }
 341     pkt->subs = NULL;
 342 }