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