2 * Written by Matt Caswell for the OpenSSL project.
4 /* ====================================================================
5 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. All advertising materials mentioning features or use of this
20 * software must display the following acknowledgment:
21 * "This product includes software developed by the OpenSSL Project
22 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
24 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25 * endorse or promote products derived from this software without
26 * prior written permission. For written permission, please contact
27 * openssl-core@openssl.org.
29 * 5. Products derived from this software may not be called "OpenSSL"
30 * nor may "OpenSSL" appear in their names without prior written
31 * permission of the OpenSSL Project.
33 * 6. Redistributions of any form whatsoever must retain the following
35 * "This product includes software developed by the OpenSSL Project
36 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
38 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49 * OF THE POSSIBILITY OF SUCH DAMAGE.
50 * ====================================================================
52 * This product includes cryptographic software written by Eric Young
53 * (eay@cryptsoft.com). This product includes software written by Tim
54 * Hudson (tjh@cryptsoft.com).
58 #ifndef HEADER_PACKET_LOCL_H
59 # define HEADER_PACKET_LOCL_H
62 # include <openssl/bn.h>
63 # include <openssl/buffer.h>
64 # include <openssl/crypto.h>
65 # include <openssl/e_os2.h>
67 # include "internal/numbers.h"
74 /* Pointer to where we are currently reading from */
76 /* Number of bytes remaining */
80 /* Internal unchecked shorthand; don't use outside this file. */
81 static ossl_inline void packet_forward(PACKET *pkt, size_t len)
84 pkt->remaining -= len;
88 * Returns the number of bytes remaining to be read in the PACKET
90 static ossl_inline size_t PACKET_remaining(const PACKET *pkt)
92 return pkt->remaining;
96 * Returns a pointer to the PACKET's current position.
97 * For use in non-PACKETized APIs.
98 * TODO(openssl-team): this should return 'const unsigned char*' but can't
99 * currently because legacy code passes 'unsigned char*'s around.
101 static ossl_inline unsigned char *PACKET_data(const PACKET *pkt)
107 * Initialise a PACKET with |len| bytes held in |buf|. This does not make a
108 * copy of the data so |buf| must be present for the whole time that the PACKET
111 __owur static ossl_inline int PACKET_buf_init(PACKET *pkt, unsigned char *buf,
114 /* Sanity check for negative values. */
115 if (len > (size_t)(SIZE_MAX / 2))
119 pkt->remaining = len;
123 /* Initialize a PACKET to hold zero bytes. */
124 static ossl_inline void PACKET_null_init(PACKET *pkt)
131 * Returns 1 if the packet has length |num| and its contents equal the |num|
132 * bytes read from |ptr|. Returns 0 otherwise (lengths or contents not equal).
133 * If lengths are equal, performs the comparison in constant time.
135 __owur static ossl_inline int PACKET_equal(const PACKET *pkt, const void *ptr,
138 if (PACKET_remaining(pkt) != num)
140 return CRYPTO_memcmp(pkt->curr, ptr, num) == 0;
144 * Peek ahead and initialize |subpkt| with the next |len| bytes read from |pkt|.
145 * Data is not copied: the |subpkt| packet will share its underlying buffer with
146 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
148 __owur static ossl_inline int PACKET_peek_sub_packet(const PACKET *pkt,
152 if (PACKET_remaining(pkt) < len)
155 return PACKET_buf_init(subpkt, pkt->curr, len);
159 * Initialize |subpkt| with the next |len| bytes read from |pkt|. Data is not
160 * copied: the |subpkt| packet will share its underlying buffer with the
161 * original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
163 __owur static ossl_inline int PACKET_get_sub_packet(PACKET *pkt,
167 if (!PACKET_peek_sub_packet(pkt, subpkt, len))
170 packet_forward(pkt, len);
176 * Peek ahead at 2 bytes in network order from |pkt| and store the value in
179 __owur static ossl_inline int PACKET_peek_net_2(const PACKET *pkt,
182 if (PACKET_remaining(pkt) < 2)
185 *data = ((unsigned int)(*pkt->curr)) << 8;
186 *data |= *(pkt->curr + 1);
191 /* Equivalent of n2s */
192 /* Get 2 bytes in network order from |pkt| and store the value in |*data| */
193 __owur static ossl_inline int PACKET_get_net_2(PACKET *pkt,
196 if (!PACKET_peek_net_2(pkt, data))
199 packet_forward(pkt, 2);
205 * Peek ahead at 3 bytes in network order from |pkt| and store the value in
208 __owur static ossl_inline int PACKET_peek_net_3(const PACKET *pkt,
211 if (PACKET_remaining(pkt) < 3)
214 *data = ((unsigned long)(*pkt->curr)) << 16;
215 *data |= ((unsigned long)(*(pkt->curr + 1))) << 8;
216 *data |= *(pkt->curr + 2);
221 /* Equivalent of n2l3 */
222 /* Get 3 bytes in network order from |pkt| and store the value in |*data| */
223 __owur static ossl_inline int PACKET_get_net_3(PACKET *pkt,
226 if (!PACKET_peek_net_3(pkt, data))
229 packet_forward(pkt, 3);
235 * Peek ahead at 4 bytes in network order from |pkt| and store the value in
238 __owur static ossl_inline int PACKET_peek_net_4(const PACKET *pkt,
241 if (PACKET_remaining(pkt) < 4)
244 *data = ((unsigned long)(*pkt->curr)) << 24;
245 *data |= ((unsigned long)(*(pkt->curr + 1))) << 16;
246 *data |= ((unsigned long)(*(pkt->curr + 2))) << 8;
247 *data |= *(pkt->curr + 3);
252 /* Equivalent of n2l */
253 /* Get 4 bytes in network order from |pkt| and store the value in |*data| */
254 __owur static ossl_inline int PACKET_get_net_4(PACKET *pkt,
257 if (!PACKET_peek_net_4(pkt, data))
260 packet_forward(pkt, 4);
265 /* Peek ahead at 1 byte from |pkt| and store the value in |*data| */
266 __owur static ossl_inline int PACKET_peek_1(const PACKET *pkt,
269 if (!PACKET_remaining(pkt))
277 /* Get 1 byte from |pkt| and store the value in |*data| */
278 __owur static ossl_inline int PACKET_get_1(PACKET *pkt, unsigned int *data)
280 if (!PACKET_peek_1(pkt, data))
283 packet_forward(pkt, 1);
289 * Peek ahead at 4 bytes in reverse network order from |pkt| and store the value
292 __owur static ossl_inline int PACKET_peek_4(const PACKET *pkt,
295 if (PACKET_remaining(pkt) < 4)
299 *data |= ((unsigned long)(*(pkt->curr + 1))) << 8;
300 *data |= ((unsigned long)(*(pkt->curr + 2))) << 16;
301 *data |= ((unsigned long)(*(pkt->curr + 3))) << 24;
306 /* Equivalent of c2l */
308 * Get 4 bytes in reverse network order from |pkt| and store the value in
311 __owur static ossl_inline int PACKET_get_4(PACKET *pkt, unsigned long *data)
313 if (!PACKET_peek_4(pkt, data))
316 packet_forward(pkt, 4);
322 * Peek ahead at |len| bytes from the |pkt| and store a pointer to them in
323 * |*data|. This just points at the underlying buffer that |pkt| is using. The
324 * caller should not free this data directly (it will be freed when the
325 * underlying buffer gets freed
327 __owur static ossl_inline int PACKET_peek_bytes(const PACKET *pkt,
328 unsigned char **data,
331 if (PACKET_remaining(pkt) < len)
340 * Read |len| bytes from the |pkt| and store a pointer to them in |*data|. This
341 * just points at the underlying buffer that |pkt| is using. The caller should
342 * not free this data directly (it will be freed when the underlying buffer gets
345 __owur static ossl_inline int PACKET_get_bytes(PACKET *pkt,
346 unsigned char **data,
349 if (!PACKET_peek_bytes(pkt, data, len))
352 packet_forward(pkt, len);
357 /* Peek ahead at |len| bytes from |pkt| and copy them to |data| */
358 __owur static ossl_inline int PACKET_peek_copy_bytes(const PACKET *pkt,
362 if (PACKET_remaining(pkt) < len)
365 memcpy(data, pkt->curr, len);
371 * Read |len| bytes from |pkt| and copy them to |data|.
372 * The caller is responsible for ensuring that |data| can hold |len| bytes.
374 __owur static ossl_inline int PACKET_copy_bytes(PACKET *pkt,
378 if (!PACKET_peek_copy_bytes(pkt, data, len))
381 packet_forward(pkt, len);
387 * Copy packet data to |dest|, and set |len| to the number of copied bytes.
388 * If the packet has more than |dest_len| bytes, nothing is copied.
389 * Returns 1 if the packet data fits in |dest_len| bytes, 0 otherwise.
390 * Does not forward PACKET position (because it is typically the last thing
391 * done with a given PACKET).
393 __owur static ossl_inline int PACKET_copy_all(const PACKET *pkt,
395 size_t dest_len, size_t *len)
397 if (PACKET_remaining(pkt) > dest_len) {
401 *len = pkt->remaining;
402 memcpy(dest, pkt->curr, pkt->remaining);
407 * Copy |pkt| bytes to a newly allocated buffer and store a pointer to the
408 * result in |*data|, and the length in |len|.
409 * If |*data| is not NULL, the old data is OPENSSL_free'd.
410 * If the packet is empty, or malloc fails, |*data| will be set to NULL.
411 * Returns 1 if the malloc succeeds and 0 otherwise.
412 * Does not forward PACKET position (because it is typically the last thing
413 * done with a given PACKET).
415 __owur static ossl_inline int PACKET_memdup(const PACKET *pkt,
416 unsigned char **data, size_t *len)
424 length = PACKET_remaining(pkt);
429 *data = OPENSSL_memdup(pkt->curr, length);
438 * Read a C string from |pkt| and copy to a newly allocated, NUL-terminated
439 * buffer. Store a pointer to the result in |*data|.
440 * If |*data| is not NULL, the old data is OPENSSL_free'd.
441 * If the data in |pkt| does not contain a NUL-byte, the entire data is
442 * copied and NUL-terminated.
443 * Returns 1 if the malloc succeeds and 0 otherwise.
444 * Does not forward PACKET position (because it is typically the last thing done
445 * with a given PACKET).
447 __owur static ossl_inline int PACKET_strndup(const PACKET *pkt, char **data)
451 /* This will succeed on an empty packet, unless pkt->curr == NULL. */
452 *data = OPENSSL_strndup((const char *)pkt->curr, PACKET_remaining(pkt));
453 return (*data != NULL);
456 /* Move the current reading position forward |len| bytes */
457 __owur static ossl_inline int PACKET_forward(PACKET *pkt, size_t len)
459 if (PACKET_remaining(pkt) < len)
462 packet_forward(pkt, len);
468 * Reads a variable-length vector prefixed with a one-byte length, and stores
469 * the contents in |subpkt|. |pkt| can equal |subpkt|.
470 * Data is not copied: the |subpkt| packet will share its underlying buffer with
471 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
472 * Upon failure, the original |pkt| and |subpkt| are not modified.
474 __owur static ossl_inline int PACKET_get_length_prefixed_1(PACKET *pkt,
480 if (!PACKET_get_1(&tmp, &length) ||
481 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
487 subpkt->remaining = length;
493 * Reads a variable-length vector prefixed with a two-byte length, and stores
494 * the contents in |subpkt|. |pkt| can equal |subpkt|.
495 * Data is not copied: the |subpkt| packet will share its underlying buffer with
496 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
497 * Upon failure, the original |pkt| and |subpkt| are not modified.
499 __owur static ossl_inline int PACKET_get_length_prefixed_2(PACKET *pkt,
505 if (!PACKET_get_net_2(&tmp, &length) ||
506 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
512 subpkt->remaining = length;
518 * Reads a variable-length vector prefixed with a three-byte length, and stores
519 * the contents in |subpkt|. |pkt| can equal |subpkt|.
520 * Data is not copied: the |subpkt| packet will share its underlying buffer with
521 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
522 * Upon failure, the original |pkt| and |subpkt| are not modified.
524 __owur static ossl_inline int PACKET_get_length_prefixed_3(PACKET *pkt,
527 unsigned long length;
530 if (!PACKET_get_net_3(&tmp, &length) ||
531 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
537 subpkt->remaining = length;
545 #endif /* HEADER_PACKET_LOCL_H */