1 /* ssl/packet_locl.h */
3 * Written by Matt Caswell for the OpenSSL project.
5 /* ====================================================================
6 * Copyright (c) 2015 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * openssl-core@openssl.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
59 #ifndef HEADER_PACKET_LOCL_H
60 # define HEADER_PACKET_LOCL_H
63 # include <openssl/bn.h>
64 # include <openssl/buffer.h>
65 # include <openssl/crypto.h>
73 /* Pointer to where we are currently reading from */
75 /* Number of bytes remaining */
79 /* Internal unchecked shorthand; don't use outside this file. */
80 static inline void packet_forward(PACKET *pkt, size_t len)
83 pkt->remaining -= len;
87 * Returns the number of bytes remaining to be read in the PACKET
89 __owur static inline size_t PACKET_remaining(const PACKET *pkt)
91 return pkt->remaining;
95 * Returns a pointer to the PACKET's current position.
96 * For use in non-PACKETized APIs.
97 * TODO(openssl-team): this should return 'const unsigned char*' but can't
98 * currently because legacy code passes 'unsigned char*'s around.
100 static inline unsigned char *PACKET_data(const PACKET *pkt)
106 * Initialise a PACKET with |len| bytes held in |buf|. This does not make a
107 * copy of the data so |buf| must be present for the whole time that the PACKET
110 static inline int PACKET_buf_init(PACKET *pkt, unsigned char *buf, size_t len)
112 /* Sanity check for negative values. */
117 pkt->remaining = len;
121 /* Initialize a PACKET to hold zero bytes. */
122 static inline void PACKET_null_init(PACKET *pkt)
129 * Returns 1 if the packet has length |num| and its contents equal the |num|
130 * bytes read from |ptr|. Returns 0 otherwise (lengths or contents not equal).
131 * If lengths are equal, performs the comparison in constant time.
133 __owur static inline int PACKET_equal(const PACKET *pkt, const void *ptr,
135 if (PACKET_remaining(pkt) != num)
137 return CRYPTO_memcmp(pkt->curr, ptr, num) == 0;
141 * Peek ahead and initialize |subpkt| with the next |len| bytes read from |pkt|.
142 * Data is not copied: the |subpkt| packet will share its underlying buffer with
143 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
145 __owur static inline int PACKET_peek_sub_packet(const PACKET *pkt,
146 PACKET *subpkt, size_t len)
148 if (PACKET_remaining(pkt) < len)
151 PACKET_buf_init(subpkt, pkt->curr, len);
157 * Initialize |subpkt| with the next |len| bytes read from |pkt|. Data is not
158 * copied: the |subpkt| packet will share its underlying buffer with the
159 * original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
161 __owur static inline int PACKET_get_sub_packet(PACKET *pkt, PACKET *subpkt,
164 if (!PACKET_peek_sub_packet(pkt, subpkt, len))
167 packet_forward(pkt, len);
172 /* Peek ahead at 2 bytes in network order from |pkt| and store the value in
175 __owur static inline int PACKET_peek_net_2(const PACKET *pkt,
178 if (PACKET_remaining(pkt) < 2)
181 *data = ((unsigned int)(*pkt->curr)) << 8;
182 *data |= *(pkt->curr + 1);
187 /* Equivalent of n2s */
188 /* Get 2 bytes in network order from |pkt| and store the value in |*data| */
189 __owur static inline int PACKET_get_net_2(PACKET *pkt, unsigned int *data)
191 if (!PACKET_peek_net_2(pkt, data))
194 packet_forward(pkt, 2);
199 /* Peek ahead at 3 bytes in network order from |pkt| and store the value in
202 __owur static inline int PACKET_peek_net_3(const PACKET *pkt,
205 if (PACKET_remaining(pkt) < 3)
208 *data = ((unsigned long)(*pkt->curr)) << 16;
209 *data |= ((unsigned long)(*(pkt->curr + 1))) << 8;
210 *data |= *(pkt->curr + 2);
215 /* Equivalent of n2l3 */
216 /* Get 3 bytes in network order from |pkt| and store the value in |*data| */
217 __owur static inline int PACKET_get_net_3(PACKET *pkt, unsigned long *data)
219 if (!PACKET_peek_net_3(pkt, data))
222 packet_forward(pkt, 3);
227 /* Peek ahead at 4 bytes in network order from |pkt| and store the value in
230 __owur static inline int PACKET_peek_net_4(const PACKET *pkt,
233 if (PACKET_remaining(pkt) < 4)
236 *data = ((unsigned long)(*pkt->curr)) << 24;
237 *data |= ((unsigned long)(*(pkt->curr + 1))) << 16;
238 *data |= ((unsigned long)(*(pkt->curr + 2))) << 8;
239 *data |= *(pkt->curr+3);
244 /* Equivalent of n2l */
245 /* Get 4 bytes in network order from |pkt| and store the value in |*data| */
246 __owur static inline int PACKET_get_net_4(PACKET *pkt, unsigned long *data)
248 if (!PACKET_peek_net_4(pkt, data))
251 packet_forward(pkt, 4);
256 /* Peek ahead at 1 byte from |pkt| and store the value in |*data| */
257 __owur static inline int PACKET_peek_1(const PACKET *pkt, unsigned int *data)
259 if (!PACKET_remaining(pkt))
267 /* Get 1 byte from |pkt| and store the value in |*data| */
268 __owur static inline int PACKET_get_1(PACKET *pkt, unsigned int *data)
270 if (!PACKET_peek_1(pkt, data))
273 packet_forward(pkt, 1);
279 * Peek ahead at 4 bytes in reverse network order from |pkt| and store the value
282 __owur static inline int PACKET_peek_4(const PACKET *pkt, unsigned long *data)
284 if (PACKET_remaining(pkt) < 4)
288 *data |= ((unsigned long)(*(pkt->curr + 1))) << 8;
289 *data |= ((unsigned long)(*(pkt->curr + 2))) << 16;
290 *data |= ((unsigned long)(*(pkt->curr + 3))) << 24;
295 /* Equivalent of c2l */
297 * Get 4 bytes in reverse network order from |pkt| and store the value in
300 __owur static inline int PACKET_get_4(PACKET *pkt, unsigned long *data)
302 if (!PACKET_peek_4(pkt, data))
305 packet_forward(pkt, 4);
311 * Peek ahead at |len| bytes from the |pkt| and store a pointer to them in
312 * |*data|. This just points at the underlying buffer that |pkt| is using. The
313 * caller should not free this data directly (it will be freed when the
314 * underlying buffer gets freed
316 __owur static inline int PACKET_peek_bytes(const PACKET *pkt, unsigned char **data,
319 if (PACKET_remaining(pkt) < len)
328 * Read |len| bytes from the |pkt| and store a pointer to them in |*data|. This
329 * just points at the underlying buffer that |pkt| is using. The caller should
330 * not free this data directly (it will be freed when the underlying buffer gets
333 __owur static inline int PACKET_get_bytes(PACKET *pkt, unsigned char **data,
336 if (!PACKET_peek_bytes(pkt, data, len))
339 packet_forward(pkt, len);
344 /* Peek ahead at |len| bytes from |pkt| and copy them to |data| */
345 __owur static inline int PACKET_peek_copy_bytes(const PACKET *pkt,
346 unsigned char *data, size_t len)
348 if (PACKET_remaining(pkt) < len)
351 memcpy(data, pkt->curr, len);
357 * Read |len| bytes from |pkt| and copy them to |data|.
358 * The caller is responsible for ensuring that |data| can hold |len| bytes.
360 __owur static inline int PACKET_copy_bytes(PACKET *pkt, unsigned char *data,
363 if (!PACKET_peek_copy_bytes(pkt, data, len))
366 packet_forward(pkt, len);
372 * Copy packet data to |dest|, and set |len| to the number of copied bytes.
373 * If the packet has more than |dest_len| bytes, nothing is copied.
374 * Returns 1 if the packet data fits in |dest_len| bytes, 0 otherwise.
375 * Does not forward PACKET position (because it is typically the last thing
376 * done with a given PACKET).
378 __owur static inline int PACKET_copy_all(const PACKET *pkt, unsigned char *dest,
379 size_t dest_len, size_t *len) {
380 if (PACKET_remaining(pkt) > dest_len) {
384 *len = pkt->remaining;
385 memcpy(dest, pkt->curr, pkt->remaining);
390 * Copy |pkt| bytes to a newly allocated buffer and store a pointer to the
391 * result in |*data|, and the length in |len|.
392 * If |*data| is not NULL, the old data is OPENSSL_free'd.
393 * If the packet is empty, or malloc fails, |*data| will be set to NULL.
394 * Returns 1 if the malloc succeeds and 0 otherwise.
395 * Does not forward PACKET position (because it is typically the last thing
396 * done with a given PACKET).
398 __owur static inline int PACKET_memdup(const PACKET *pkt, unsigned char **data,
407 length = PACKET_remaining(pkt);
412 *data = BUF_memdup(pkt->curr, length);
422 * Read a C string from |pkt| and copy to a newly allocated, NUL-terminated
423 * buffer. Store a pointer to the result in |*data|.
424 * If |*data| is not NULL, the old data is OPENSSL_free'd.
425 * If the data in |pkt| does not contain a NUL-byte, the entire data is
426 * copied and NUL-terminated.
427 * Returns 1 if the malloc succeeds and 0 otherwise.
428 * Does not forward PACKET position (because it is typically the last thing done
429 * with a given PACKET).
431 __owur static inline int PACKET_strndup(const PACKET *pkt, char **data)
435 /* This will succeed on an empty packet, unless pkt->curr == NULL. */
436 *data = BUF_strndup((const char*)pkt->curr, PACKET_remaining(pkt));
437 return (*data != NULL);
440 /* Move the current reading position forward |len| bytes */
441 __owur static inline int PACKET_forward(PACKET *pkt, size_t len)
443 if (PACKET_remaining(pkt) < len)
446 packet_forward(pkt, len);
452 * Reads a variable-length vector prefixed with a one-byte length, and stores
453 * the contents in |subpkt|. |pkt| can equal |subpkt|.
454 * Data is not copied: the |subpkt| packet will share its underlying buffer with
455 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
456 * Upon failure, the original |pkt| and |subpkt| are not modified.
458 __owur static inline int PACKET_get_length_prefixed_1(PACKET *pkt, PACKET *subpkt)
463 if (!PACKET_get_1(&tmp, &length) ||
464 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
470 subpkt->remaining = length;
476 * Reads a variable-length vector prefixed with a two-byte length, and stores
477 * the contents in |subpkt|. |pkt| can equal |subpkt|.
478 * Data is not copied: the |subpkt| packet will share its underlying buffer with
479 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
480 * Upon failure, the original |pkt| and |subpkt| are not modified.
482 __owur static inline int PACKET_get_length_prefixed_2(PACKET *pkt, PACKET *subpkt)
487 if (!PACKET_get_net_2(&tmp, &length) ||
488 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
494 subpkt->remaining = length;
500 * Reads a variable-length vector prefixed with a three-byte length, and stores
501 * the contents in |subpkt|. |pkt| can equal |subpkt|.
502 * Data is not copied: the |subpkt| packet will share its underlying buffer with
503 * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|.
504 * Upon failure, the original |pkt| and |subpkt| are not modified.
506 __owur static inline int PACKET_get_length_prefixed_3(PACKET *pkt, PACKET *subpkt)
508 unsigned long length;
511 if (!PACKET_get_net_3(&tmp, &length) ||
512 !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
518 subpkt->remaining = length;
526 #endif /* HEADER_PACKET_LOCL_H */