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 */
75 const unsigned char *curr;
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.
99 static ossl_inline const unsigned char *PACKET_data(const PACKET *pkt)
105 * Initialise a PACKET with |len| bytes held in |buf|. This does not make a
106 * copy of the data so |buf| must be present for the whole time that the PACKET
109 __owur static ossl_inline int PACKET_buf_init(PACKET *pkt,
110 const unsigned char *buf,
113 /* Sanity check for negative values. */
114 if (len > (size_t)(SIZE_MAX / 2))
118 pkt->remaining = len;
122 /* Initialize a PACKET to hold zero bytes. */
123 static ossl_inline void PACKET_null_init(PACKET *pkt)
130 * Returns 1 if the packet has length |num| and its contents equal the |num|
131 * bytes read from |ptr|. Returns 0 otherwise (lengths or contents not equal).
132 * If lengths are equal, performs the comparison in constant time.
134 __owur static ossl_inline int PACKET_equal(const PACKET *pkt, const void *ptr,
137 if (PACKET_remaining(pkt) != num)
139 return CRYPTO_memcmp(pkt->curr, ptr, num) == 0;
143 * Peek ahead and initialize |subpkt| with the next |len| bytes read from |pkt|.
144 * Data is not copied: the |subpkt| packet will share its underlying buffer with
145 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
147 __owur static ossl_inline int PACKET_peek_sub_packet(const PACKET *pkt,
151 if (PACKET_remaining(pkt) < len)
154 return PACKET_buf_init(subpkt, pkt->curr, len);
158 * Initialize |subpkt| with the next |len| bytes read from |pkt|. Data is not
159 * copied: the |subpkt| packet will share its underlying buffer with the
160 * original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
162 __owur static ossl_inline int PACKET_get_sub_packet(PACKET *pkt,
166 if (!PACKET_peek_sub_packet(pkt, subpkt, len))
169 packet_forward(pkt, len);
175 * Peek ahead at 2 bytes in network order from |pkt| and store the value in
178 __owur static ossl_inline int PACKET_peek_net_2(const PACKET *pkt,
181 if (PACKET_remaining(pkt) < 2)
184 *data = ((unsigned int)(*pkt->curr)) << 8;
185 *data |= *(pkt->curr + 1);
190 /* Equivalent of n2s */
191 /* Get 2 bytes in network order from |pkt| and store the value in |*data| */
192 __owur static ossl_inline int PACKET_get_net_2(PACKET *pkt,
195 if (!PACKET_peek_net_2(pkt, data))
198 packet_forward(pkt, 2);
204 * Peek ahead at 3 bytes in network order from |pkt| and store the value in
207 __owur static ossl_inline int PACKET_peek_net_3(const PACKET *pkt,
210 if (PACKET_remaining(pkt) < 3)
213 *data = ((unsigned long)(*pkt->curr)) << 16;
214 *data |= ((unsigned long)(*(pkt->curr + 1))) << 8;
215 *data |= *(pkt->curr + 2);
220 /* Equivalent of n2l3 */
221 /* Get 3 bytes in network order from |pkt| and store the value in |*data| */
222 __owur static ossl_inline int PACKET_get_net_3(PACKET *pkt,
225 if (!PACKET_peek_net_3(pkt, data))
228 packet_forward(pkt, 3);
234 * Peek ahead at 4 bytes in network order from |pkt| and store the value in
237 __owur static ossl_inline int PACKET_peek_net_4(const PACKET *pkt,
240 if (PACKET_remaining(pkt) < 4)
243 *data = ((unsigned long)(*pkt->curr)) << 24;
244 *data |= ((unsigned long)(*(pkt->curr + 1))) << 16;
245 *data |= ((unsigned long)(*(pkt->curr + 2))) << 8;
246 *data |= *(pkt->curr + 3);
251 /* Equivalent of n2l */
252 /* Get 4 bytes in network order from |pkt| and store the value in |*data| */
253 __owur static ossl_inline int PACKET_get_net_4(PACKET *pkt,
256 if (!PACKET_peek_net_4(pkt, data))
259 packet_forward(pkt, 4);
264 /* Peek ahead at 1 byte from |pkt| and store the value in |*data| */
265 __owur static ossl_inline int PACKET_peek_1(const PACKET *pkt,
268 if (!PACKET_remaining(pkt))
276 /* Get 1 byte from |pkt| and store the value in |*data| */
277 __owur static ossl_inline int PACKET_get_1(PACKET *pkt, unsigned int *data)
279 if (!PACKET_peek_1(pkt, data))
282 packet_forward(pkt, 1);
288 * Peek ahead at 4 bytes in reverse network order from |pkt| and store the value
291 __owur static ossl_inline int PACKET_peek_4(const PACKET *pkt,
294 if (PACKET_remaining(pkt) < 4)
298 *data |= ((unsigned long)(*(pkt->curr + 1))) << 8;
299 *data |= ((unsigned long)(*(pkt->curr + 2))) << 16;
300 *data |= ((unsigned long)(*(pkt->curr + 3))) << 24;
305 /* Equivalent of c2l */
307 * Get 4 bytes in reverse network order from |pkt| and store the value in
310 __owur static ossl_inline int PACKET_get_4(PACKET *pkt, unsigned long *data)
312 if (!PACKET_peek_4(pkt, data))
315 packet_forward(pkt, 4);
321 * Peek ahead at |len| bytes from the |pkt| and store a pointer to them in
322 * |*data|. This just points at the underlying buffer that |pkt| is using. The
323 * caller should not free this data directly (it will be freed when the
324 * underlying buffer gets freed
326 __owur static ossl_inline int PACKET_peek_bytes(const PACKET *pkt,
327 const unsigned char **data,
330 if (PACKET_remaining(pkt) < len)
339 * Read |len| bytes from the |pkt| and store a pointer to them in |*data|. This
340 * just points at the underlying buffer that |pkt| is using. The caller should
341 * not free this data directly (it will be freed when the underlying buffer gets
344 __owur static ossl_inline int PACKET_get_bytes(PACKET *pkt,
345 const unsigned char **data,
348 if (!PACKET_peek_bytes(pkt, data, len))
351 packet_forward(pkt, len);
356 /* Peek ahead at |len| bytes from |pkt| and copy them to |data| */
357 __owur static ossl_inline int PACKET_peek_copy_bytes(const PACKET *pkt,
361 if (PACKET_remaining(pkt) < len)
364 memcpy(data, pkt->curr, len);
370 * Read |len| bytes from |pkt| and copy them to |data|.
371 * The caller is responsible for ensuring that |data| can hold |len| bytes.
373 __owur static ossl_inline int PACKET_copy_bytes(PACKET *pkt,
377 if (!PACKET_peek_copy_bytes(pkt, data, len))
380 packet_forward(pkt, len);
386 * Copy packet data to |dest|, and set |len| to the number of copied bytes.
387 * If the packet has more than |dest_len| bytes, nothing is copied.
388 * Returns 1 if the packet data fits in |dest_len| bytes, 0 otherwise.
389 * Does not forward PACKET position (because it is typically the last thing
390 * done with a given PACKET).
392 __owur static ossl_inline int PACKET_copy_all(const PACKET *pkt,
394 size_t dest_len, size_t *len)
396 if (PACKET_remaining(pkt) > dest_len) {
400 *len = pkt->remaining;
401 memcpy(dest, pkt->curr, pkt->remaining);
406 * Copy |pkt| bytes to a newly allocated buffer and store a pointer to the
407 * result in |*data|, and the length in |len|.
408 * If |*data| is not NULL, the old data is OPENSSL_free'd.
409 * If the packet is empty, or malloc fails, |*data| will be set to NULL.
410 * Returns 1 if the malloc succeeds and 0 otherwise.
411 * Does not forward PACKET position (because it is typically the last thing
412 * done with a given PACKET).
414 __owur static ossl_inline int PACKET_memdup(const PACKET *pkt,
415 unsigned char **data, size_t *len)
423 length = PACKET_remaining(pkt);
428 *data = OPENSSL_memdup(pkt->curr, length);
437 * Read a C string from |pkt| and copy to a newly allocated, NUL-terminated
438 * buffer. Store a pointer to the result in |*data|.
439 * If |*data| is not NULL, the old data is OPENSSL_free'd.
440 * If the data in |pkt| does not contain a NUL-byte, the entire data is
441 * copied and NUL-terminated.
442 * Returns 1 if the malloc succeeds and 0 otherwise.
443 * Does not forward PACKET position (because it is typically the last thing done
444 * with a given PACKET).
446 __owur static ossl_inline int PACKET_strndup(const PACKET *pkt, char **data)
450 /* This will succeed on an empty packet, unless pkt->curr == NULL. */
451 *data = OPENSSL_strndup((const char *)pkt->curr, PACKET_remaining(pkt));
452 return (*data != NULL);
455 /* Move the current reading position forward |len| bytes */
456 __owur static ossl_inline int PACKET_forward(PACKET *pkt, size_t len)
458 if (PACKET_remaining(pkt) < len)
461 packet_forward(pkt, len);
467 * Reads a variable-length vector prefixed with a one-byte length, and stores
468 * the contents in |subpkt|. |pkt| can equal |subpkt|.
469 * Data is not copied: the |subpkt| packet will share its underlying buffer with
470 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
471 * Upon failure, the original |pkt| and |subpkt| are not modified.
473 __owur static ossl_inline int PACKET_get_length_prefixed_1(PACKET *pkt,
477 const unsigned char *data;
479 if (!PACKET_get_1(&tmp, &length) ||
480 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
486 subpkt->remaining = length;
492 * Reads a variable-length vector prefixed with a two-byte length, and stores
493 * the contents in |subpkt|. |pkt| can equal |subpkt|.
494 * Data is not copied: the |subpkt| packet will share its underlying buffer with
495 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
496 * Upon failure, the original |pkt| and |subpkt| are not modified.
498 __owur static ossl_inline int PACKET_get_length_prefixed_2(PACKET *pkt,
502 const unsigned char *data;
504 if (!PACKET_get_net_2(&tmp, &length) ||
505 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
511 subpkt->remaining = length;
517 * Reads a variable-length vector prefixed with a three-byte length, and stores
518 * the contents in |subpkt|. |pkt| can equal |subpkt|.
519 * Data is not copied: the |subpkt| packet will share its underlying buffer with
520 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
521 * Upon failure, the original |pkt| and |subpkt| are not modified.
523 __owur static ossl_inline int PACKET_get_length_prefixed_3(PACKET *pkt,
526 unsigned long length;
527 const unsigned char *data;
529 if (!PACKET_get_net_3(&tmp, &length) ||
530 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
536 subpkt->remaining = length;
544 #endif /* HEADER_PACKET_LOCL_H */