2 * Copyright 2015-2016 The OpenSSL Project Authors. All Rights Reserved.
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
10 #ifndef HEADER_PACKET_LOCL_H
11 # define HEADER_PACKET_LOCL_H
14 # include <openssl/bn.h>
15 # include <openssl/buffer.h>
16 # include <openssl/crypto.h>
17 # include <openssl/e_os2.h>
19 # include "internal/numbers.h"
26 /* Pointer to where we are currently reading from */
27 const unsigned char *curr;
28 /* Number of bytes remaining */
32 /* Internal unchecked shorthand; don't use outside this file. */
33 static ossl_inline void packet_forward(PACKET *pkt, size_t len)
36 pkt->remaining -= len;
40 * Returns the number of bytes remaining to be read in the PACKET
42 static ossl_inline size_t PACKET_remaining(const PACKET *pkt)
44 return pkt->remaining;
48 * Returns a pointer to the first byte after the packet data.
49 * Useful for integrating with non-PACKET parsing code.
50 * Specifically, we use PACKET_end() to verify that a d2i_... call
51 * has consumed the entire packet contents.
53 static ossl_inline const unsigned char *PACKET_end(const PACKET *pkt)
55 return pkt->curr + pkt->remaining;
59 * Returns a pointer to the PACKET's current position.
60 * For use in non-PACKETized APIs.
62 static ossl_inline const unsigned char *PACKET_data(const PACKET *pkt)
68 * Initialise a PACKET with |len| bytes held in |buf|. This does not make a
69 * copy of the data so |buf| must be present for the whole time that the PACKET
72 __owur static ossl_inline int PACKET_buf_init(PACKET *pkt,
73 const unsigned char *buf,
76 /* Sanity check for negative values. */
77 if (len > (size_t)(SIZE_MAX / 2))
85 /* Initialize a PACKET to hold zero bytes. */
86 static ossl_inline void PACKET_null_init(PACKET *pkt)
93 * Returns 1 if the packet has length |num| and its contents equal the |num|
94 * bytes read from |ptr|. Returns 0 otherwise (lengths or contents not equal).
95 * If lengths are equal, performs the comparison in constant time.
97 __owur static ossl_inline int PACKET_equal(const PACKET *pkt, const void *ptr,
100 if (PACKET_remaining(pkt) != num)
102 return CRYPTO_memcmp(pkt->curr, ptr, num) == 0;
106 * Peek ahead and initialize |subpkt| with the next |len| bytes read from |pkt|.
107 * Data is not copied: the |subpkt| packet will share its underlying buffer with
108 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
110 __owur static ossl_inline int PACKET_peek_sub_packet(const PACKET *pkt,
111 PACKET *subpkt, size_t len)
113 if (PACKET_remaining(pkt) < len)
116 return PACKET_buf_init(subpkt, pkt->curr, len);
120 * Initialize |subpkt| with the next |len| bytes read from |pkt|. Data is not
121 * copied: the |subpkt| packet will share its underlying buffer with the
122 * original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
124 __owur static ossl_inline int PACKET_get_sub_packet(PACKET *pkt,
125 PACKET *subpkt, size_t len)
127 if (!PACKET_peek_sub_packet(pkt, subpkt, len))
130 packet_forward(pkt, len);
136 * Peek ahead at 2 bytes in network order from |pkt| and store the value in
139 __owur static ossl_inline int PACKET_peek_net_2(const PACKET *pkt,
142 if (PACKET_remaining(pkt) < 2)
145 *data = ((unsigned int)(*pkt->curr)) << 8;
146 *data |= *(pkt->curr + 1);
151 /* Equivalent of n2s */
152 /* Get 2 bytes in network order from |pkt| and store the value in |*data| */
153 __owur static ossl_inline int PACKET_get_net_2(PACKET *pkt, unsigned int *data)
155 if (!PACKET_peek_net_2(pkt, data))
158 packet_forward(pkt, 2);
164 * Peek ahead at 3 bytes in network order from |pkt| and store the value in
167 __owur static ossl_inline int PACKET_peek_net_3(const PACKET *pkt,
170 if (PACKET_remaining(pkt) < 3)
173 *data = ((unsigned long)(*pkt->curr)) << 16;
174 *data |= ((unsigned long)(*(pkt->curr + 1))) << 8;
175 *data |= *(pkt->curr + 2);
180 /* Equivalent of n2l3 */
181 /* Get 3 bytes in network order from |pkt| and store the value in |*data| */
182 __owur static ossl_inline int PACKET_get_net_3(PACKET *pkt, unsigned long *data)
184 if (!PACKET_peek_net_3(pkt, data))
187 packet_forward(pkt, 3);
193 * Peek ahead at 4 bytes in network order from |pkt| and store the value in
196 __owur static ossl_inline int PACKET_peek_net_4(const PACKET *pkt,
199 if (PACKET_remaining(pkt) < 4)
202 *data = ((unsigned long)(*pkt->curr)) << 24;
203 *data |= ((unsigned long)(*(pkt->curr + 1))) << 16;
204 *data |= ((unsigned long)(*(pkt->curr + 2))) << 8;
205 *data |= *(pkt->curr + 3);
210 /* Equivalent of n2l */
211 /* Get 4 bytes in network order from |pkt| and store the value in |*data| */
212 __owur static ossl_inline int PACKET_get_net_4(PACKET *pkt, unsigned long *data)
214 if (!PACKET_peek_net_4(pkt, data))
217 packet_forward(pkt, 4);
222 /* Peek ahead at 1 byte from |pkt| and store the value in |*data| */
223 __owur static ossl_inline int PACKET_peek_1(const PACKET *pkt,
226 if (!PACKET_remaining(pkt))
234 /* Get 1 byte from |pkt| and store the value in |*data| */
235 __owur static ossl_inline int PACKET_get_1(PACKET *pkt, unsigned int *data)
237 if (!PACKET_peek_1(pkt, data))
240 packet_forward(pkt, 1);
246 * Peek ahead at 4 bytes in reverse network order from |pkt| and store the value
249 __owur static ossl_inline int PACKET_peek_4(const PACKET *pkt,
252 if (PACKET_remaining(pkt) < 4)
256 *data |= ((unsigned long)(*(pkt->curr + 1))) << 8;
257 *data |= ((unsigned long)(*(pkt->curr + 2))) << 16;
258 *data |= ((unsigned long)(*(pkt->curr + 3))) << 24;
263 /* Equivalent of c2l */
265 * Get 4 bytes in reverse network order from |pkt| and store the value in
268 __owur static ossl_inline int PACKET_get_4(PACKET *pkt, unsigned long *data)
270 if (!PACKET_peek_4(pkt, data))
273 packet_forward(pkt, 4);
279 * Peek ahead at |len| bytes from the |pkt| and store a pointer to them in
280 * |*data|. This just points at the underlying buffer that |pkt| is using. The
281 * caller should not free this data directly (it will be freed when the
282 * underlying buffer gets freed
284 __owur static ossl_inline int PACKET_peek_bytes(const PACKET *pkt,
285 const unsigned char **data,
288 if (PACKET_remaining(pkt) < len)
297 * Read |len| bytes from the |pkt| and store a pointer to them in |*data|. This
298 * just points at the underlying buffer that |pkt| is using. The caller should
299 * not free this data directly (it will be freed when the underlying buffer gets
302 __owur static ossl_inline int PACKET_get_bytes(PACKET *pkt,
303 const unsigned char **data,
306 if (!PACKET_peek_bytes(pkt, data, len))
309 packet_forward(pkt, len);
314 /* Peek ahead at |len| bytes from |pkt| and copy them to |data| */
315 __owur static ossl_inline int PACKET_peek_copy_bytes(const PACKET *pkt,
319 if (PACKET_remaining(pkt) < len)
322 memcpy(data, pkt->curr, len);
328 * Read |len| bytes from |pkt| and copy them to |data|.
329 * The caller is responsible for ensuring that |data| can hold |len| bytes.
331 __owur static ossl_inline int PACKET_copy_bytes(PACKET *pkt,
332 unsigned char *data, size_t len)
334 if (!PACKET_peek_copy_bytes(pkt, data, len))
337 packet_forward(pkt, len);
343 * Copy packet data to |dest|, and set |len| to the number of copied bytes.
344 * If the packet has more than |dest_len| bytes, nothing is copied.
345 * Returns 1 if the packet data fits in |dest_len| bytes, 0 otherwise.
346 * Does not forward PACKET position (because it is typically the last thing
347 * done with a given PACKET).
349 __owur static ossl_inline int PACKET_copy_all(const PACKET *pkt,
351 size_t dest_len, size_t *len)
353 if (PACKET_remaining(pkt) > dest_len) {
357 *len = pkt->remaining;
358 memcpy(dest, pkt->curr, pkt->remaining);
363 * Copy |pkt| bytes to a newly allocated buffer and store a pointer to the
364 * result in |*data|, and the length in |len|.
365 * If |*data| is not NULL, the old data is OPENSSL_free'd.
366 * If the packet is empty, or malloc fails, |*data| will be set to NULL.
367 * Returns 1 if the malloc succeeds and 0 otherwise.
368 * Does not forward PACKET position (because it is typically the last thing
369 * done with a given PACKET).
371 __owur static ossl_inline int PACKET_memdup(const PACKET *pkt,
372 unsigned char **data, size_t *len)
380 length = PACKET_remaining(pkt);
385 *data = OPENSSL_memdup(pkt->curr, length);
394 * Read a C string from |pkt| and copy to a newly allocated, NUL-terminated
395 * buffer. Store a pointer to the result in |*data|.
396 * If |*data| is not NULL, the old data is OPENSSL_free'd.
397 * If the data in |pkt| does not contain a NUL-byte, the entire data is
398 * copied and NUL-terminated.
399 * Returns 1 if the malloc succeeds and 0 otherwise.
400 * Does not forward PACKET position (because it is typically the last thing done
401 * with a given PACKET).
403 __owur static ossl_inline int PACKET_strndup(const PACKET *pkt, char **data)
407 /* This will succeed on an empty packet, unless pkt->curr == NULL. */
408 *data = OPENSSL_strndup((const char *)pkt->curr, PACKET_remaining(pkt));
409 return (*data != NULL);
412 /* Returns 1 if |pkt| contains at least one 0-byte, 0 otherwise. */
413 static ossl_inline int PACKET_contains_zero_byte(const PACKET *pkt)
415 return memchr(pkt->curr, 0, pkt->remaining) != NULL;
418 /* Move the current reading position forward |len| bytes */
419 __owur static ossl_inline int PACKET_forward(PACKET *pkt, size_t len)
421 if (PACKET_remaining(pkt) < len)
424 packet_forward(pkt, len);
430 * Reads a variable-length vector prefixed with a one-byte length, and stores
431 * the contents in |subpkt|. |pkt| can equal |subpkt|.
432 * Data is not copied: the |subpkt| packet will share its underlying buffer with
433 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
434 * Upon failure, the original |pkt| and |subpkt| are not modified.
436 __owur static ossl_inline int PACKET_get_length_prefixed_1(PACKET *pkt,
440 const unsigned char *data;
442 if (!PACKET_get_1(&tmp, &length) ||
443 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
449 subpkt->remaining = length;
455 * Like PACKET_get_length_prefixed_1, but additionally, fails when there are
456 * leftover bytes in |pkt|.
458 __owur static ossl_inline int PACKET_as_length_prefixed_1(PACKET *pkt,
462 const unsigned char *data;
464 if (!PACKET_get_1(&tmp, &length) ||
465 !PACKET_get_bytes(&tmp, &data, (size_t)length) ||
466 PACKET_remaining(&tmp) != 0) {
472 subpkt->remaining = length;
478 * Reads a variable-length vector prefixed with a two-byte length, and stores
479 * the contents in |subpkt|. |pkt| can equal |subpkt|.
480 * Data is not copied: the |subpkt| packet will share its underlying buffer with
481 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
482 * Upon failure, the original |pkt| and |subpkt| are not modified.
484 __owur static ossl_inline int PACKET_get_length_prefixed_2(PACKET *pkt,
488 const unsigned char *data;
491 if (!PACKET_get_net_2(&tmp, &length) ||
492 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
498 subpkt->remaining = length;
504 * Like PACKET_get_length_prefixed_2, but additionally, fails when there are
505 * leftover bytes in |pkt|.
507 __owur static ossl_inline int PACKET_as_length_prefixed_2(PACKET *pkt,
511 const unsigned char *data;
514 if (!PACKET_get_net_2(&tmp, &length) ||
515 !PACKET_get_bytes(&tmp, &data, (size_t)length) ||
516 PACKET_remaining(&tmp) != 0) {
522 subpkt->remaining = length;
528 * Reads a variable-length vector prefixed with a three-byte length, and stores
529 * the contents in |subpkt|. |pkt| can equal |subpkt|.
530 * Data is not copied: the |subpkt| packet will share its underlying buffer with
531 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
532 * Upon failure, the original |pkt| and |subpkt| are not modified.
534 __owur static ossl_inline int PACKET_get_length_prefixed_3(PACKET *pkt,
537 unsigned long length;
538 const unsigned char *data;
540 if (!PACKET_get_net_3(&tmp, &length) ||
541 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
547 subpkt->remaining = length;
555 #endif /* HEADER_PACKET_LOCL_H */