X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=ssl%2Fpacket_locl.h;h=48767b6728d40a0626c5ff198e3d2708ba729c2a;hp=b13aa5a5c0b924ba179594b737e36c4731bb6adb;hb=b3214008e42eba8e8d05b52f22b50570927962c7;hpb=b3e2272c59a5720467045e2ae62940fdb708ce76 diff --git a/ssl/packet_locl.h b/ssl/packet_locl.h index b13aa5a5c0..48767b6728 100644 --- a/ssl/packet_locl.h +++ b/ssl/packet_locl.h @@ -1,4 +1,3 @@ -/* ssl/packet_locl.h */ /* * Written by Matt Caswell for the OpenSSL project. */ @@ -62,7 +61,10 @@ # include # include # include -# include "e_os.h" +# include +# include + +# include "internal/numbers.h" # ifdef __cplusplus extern "C" { @@ -70,13 +72,13 @@ extern "C" { typedef struct { /* Pointer to where we are currently reading from */ - unsigned char *curr; + const unsigned char *curr; /* Number of bytes remaining */ size_t remaining; } PACKET; /* Internal unchecked shorthand; don't use outside this file. */ -static inline void packet_forward(PACKET *pkt, size_t len) +static ossl_inline void packet_forward(PACKET *pkt, size_t len) { pkt->curr += len; pkt->remaining -= len; @@ -85,7 +87,7 @@ static inline void packet_forward(PACKET *pkt, size_t len) /* * Returns the number of bytes remaining to be read in the PACKET */ -__owur static inline size_t PACKET_remaining(const PACKET *pkt) +static ossl_inline size_t PACKET_remaining(const PACKET *pkt) { return pkt->remaining; } @@ -93,10 +95,8 @@ __owur static inline size_t PACKET_remaining(const PACKET *pkt) /* * Returns a pointer to the PACKET's current position. * For use in non-PACKETized APIs. - * TODO(openssl-team): this should return 'const unsigned char*' but can't - * currently because legacy code passes 'unsigned char*'s around. */ -static inline unsigned char *PACKET_data(const PACKET *pkt) +static ossl_inline const unsigned char *PACKET_data(const PACKET *pkt) { return pkt->curr; } @@ -106,10 +106,12 @@ static inline unsigned char *PACKET_data(const PACKET *pkt) * copy of the data so |buf| must be present for the whole time that the PACKET * is being used. */ -static inline int PACKET_buf_init(PACKET *pkt, unsigned char *buf, size_t len) +__owur static ossl_inline int PACKET_buf_init(PACKET *pkt, + const unsigned char *buf, + size_t len) { /* Sanity check for negative values. */ - if (buf + len < buf) + if (len > (size_t)(SIZE_MAX / 2)) return 0; pkt->curr = buf; @@ -118,26 +120,38 @@ static inline int PACKET_buf_init(PACKET *pkt, unsigned char *buf, size_t len) } /* Initialize a PACKET to hold zero bytes. */ -static inline void PACKET_null_init(PACKET *pkt) +static ossl_inline void PACKET_null_init(PACKET *pkt) { pkt->curr = NULL; pkt->remaining = 0; } +/* + * Returns 1 if the packet has length |num| and its contents equal the |num| + * bytes read from |ptr|. Returns 0 otherwise (lengths or contents not equal). + * If lengths are equal, performs the comparison in constant time. + */ +__owur static ossl_inline int PACKET_equal(const PACKET *pkt, const void *ptr, + size_t num) +{ + if (PACKET_remaining(pkt) != num) + return 0; + return CRYPTO_memcmp(pkt->curr, ptr, num) == 0; +} + /* * Peek ahead and initialize |subpkt| with the next |len| bytes read from |pkt|. * Data is not copied: the |subpkt| packet will share its underlying buffer with * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|. */ -__owur static inline int PACKET_peek_sub_packet(const PACKET *pkt, - PACKET *subpkt, size_t len) +__owur static ossl_inline int PACKET_peek_sub_packet(const PACKET *pkt, + PACKET *subpkt, + size_t len) { if (PACKET_remaining(pkt) < len) return 0; - PACKET_buf_init(subpkt, pkt->curr, len); - - return 1; + return PACKET_buf_init(subpkt, pkt->curr, len); } /* @@ -145,8 +159,9 @@ __owur static inline int PACKET_peek_sub_packet(const PACKET *pkt, * copied: the |subpkt| packet will share its underlying buffer with the * original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|. */ -__owur static inline int PACKET_get_sub_packet(PACKET *pkt, PACKET *subpkt, - size_t len) +__owur static ossl_inline int PACKET_get_sub_packet(PACKET *pkt, + PACKET *subpkt, + size_t len) { if (!PACKET_peek_sub_packet(pkt, subpkt, len)) return 0; @@ -156,16 +171,17 @@ __owur static inline int PACKET_get_sub_packet(PACKET *pkt, PACKET *subpkt, return 1; } -/* Peek ahead at 2 bytes in network order from |pkt| and store the value in +/* + * Peek ahead at 2 bytes in network order from |pkt| and store the value in * |*data| */ -__owur static inline int PACKET_peek_net_2(const PACKET *pkt, - unsigned int *data) +__owur static ossl_inline int PACKET_peek_net_2(const PACKET *pkt, + unsigned int *data) { if (PACKET_remaining(pkt) < 2) return 0; - *data = ((unsigned int)(*pkt->curr)) << 8; + *data = ((unsigned int)(*pkt->curr)) << 8; *data |= *(pkt->curr + 1); return 1; @@ -173,7 +189,8 @@ __owur static inline int PACKET_peek_net_2(const PACKET *pkt, /* Equivalent of n2s */ /* Get 2 bytes in network order from |pkt| and store the value in |*data| */ -__owur static inline int PACKET_get_net_2(PACKET *pkt, unsigned int *data) +__owur static ossl_inline int PACKET_get_net_2(PACKET *pkt, + unsigned int *data) { if (!PACKET_peek_net_2(pkt, data)) return 0; @@ -183,17 +200,18 @@ __owur static inline int PACKET_get_net_2(PACKET *pkt, unsigned int *data) return 1; } -/* Peek ahead at 3 bytes in network order from |pkt| and store the value in +/* + * Peek ahead at 3 bytes in network order from |pkt| and store the value in * |*data| */ -__owur static inline int PACKET_peek_net_3(const PACKET *pkt, - unsigned long *data) +__owur static ossl_inline int PACKET_peek_net_3(const PACKET *pkt, + unsigned long *data) { if (PACKET_remaining(pkt) < 3) return 0; - *data = ((unsigned long)(*pkt->curr)) << 16; - *data |= ((unsigned long)(*(pkt->curr + 1))) << 8; + *data = ((unsigned long)(*pkt->curr)) << 16; + *data |= ((unsigned long)(*(pkt->curr + 1))) << 8; *data |= *(pkt->curr + 2); return 1; @@ -201,7 +219,8 @@ __owur static inline int PACKET_peek_net_3(const PACKET *pkt, /* Equivalent of n2l3 */ /* Get 3 bytes in network order from |pkt| and store the value in |*data| */ -__owur static inline int PACKET_get_net_3(PACKET *pkt, unsigned long *data) +__owur static ossl_inline int PACKET_get_net_3(PACKET *pkt, + unsigned long *data) { if (!PACKET_peek_net_3(pkt, data)) return 0; @@ -211,26 +230,28 @@ __owur static inline int PACKET_get_net_3(PACKET *pkt, unsigned long *data) return 1; } -/* Peek ahead at 4 bytes in network order from |pkt| and store the value in +/* + * Peek ahead at 4 bytes in network order from |pkt| and store the value in * |*data| */ -__owur static inline int PACKET_peek_net_4(const PACKET *pkt, - unsigned long *data) +__owur static ossl_inline int PACKET_peek_net_4(const PACKET *pkt, + unsigned long *data) { if (PACKET_remaining(pkt) < 4) return 0; - *data = ((unsigned long)(*pkt->curr)) << 24; + *data = ((unsigned long)(*pkt->curr)) << 24; *data |= ((unsigned long)(*(pkt->curr + 1))) << 16; - *data |= ((unsigned long)(*(pkt->curr + 2))) << 8; - *data |= *(pkt->curr+3); + *data |= ((unsigned long)(*(pkt->curr + 2))) << 8; + *data |= *(pkt->curr + 3); return 1; } /* Equivalent of n2l */ /* Get 4 bytes in network order from |pkt| and store the value in |*data| */ -__owur static inline int PACKET_get_net_4(PACKET *pkt, unsigned long *data) +__owur static ossl_inline int PACKET_get_net_4(PACKET *pkt, + unsigned long *data) { if (!PACKET_peek_net_4(pkt, data)) return 0; @@ -241,7 +262,8 @@ __owur static inline int PACKET_get_net_4(PACKET *pkt, unsigned long *data) } /* Peek ahead at 1 byte from |pkt| and store the value in |*data| */ -__owur static inline int PACKET_peek_1(const PACKET *pkt, unsigned int *data) +__owur static ossl_inline int PACKET_peek_1(const PACKET *pkt, + unsigned int *data) { if (!PACKET_remaining(pkt)) return 0; @@ -252,7 +274,7 @@ __owur static inline int PACKET_peek_1(const PACKET *pkt, unsigned int *data) } /* Get 1 byte from |pkt| and store the value in |*data| */ -__owur static inline int PACKET_get_1(PACKET *pkt, unsigned int *data) +__owur static ossl_inline int PACKET_get_1(PACKET *pkt, unsigned int *data) { if (!PACKET_peek_1(pkt, data)) return 0; @@ -266,13 +288,14 @@ __owur static inline int PACKET_get_1(PACKET *pkt, unsigned int *data) * Peek ahead at 4 bytes in reverse network order from |pkt| and store the value * in |*data| */ -__owur static inline int PACKET_peek_4(const PACKET *pkt, unsigned long *data) +__owur static ossl_inline int PACKET_peek_4(const PACKET *pkt, + unsigned long *data) { if (PACKET_remaining(pkt) < 4) return 0; - *data = *pkt->curr; - *data |= ((unsigned long)(*(pkt->curr + 1))) << 8; + *data = *pkt->curr; + *data |= ((unsigned long)(*(pkt->curr + 1))) << 8; *data |= ((unsigned long)(*(pkt->curr + 2))) << 16; *data |= ((unsigned long)(*(pkt->curr + 3))) << 24; @@ -284,7 +307,7 @@ __owur static inline int PACKET_peek_4(const PACKET *pkt, unsigned long *data) * Get 4 bytes in reverse network order from |pkt| and store the value in * |*data| */ -__owur static inline int PACKET_get_4(PACKET *pkt, unsigned long *data) +__owur static ossl_inline int PACKET_get_4(PACKET *pkt, unsigned long *data) { if (!PACKET_peek_4(pkt, data)) return 0; @@ -300,8 +323,9 @@ __owur static inline int PACKET_get_4(PACKET *pkt, unsigned long *data) * caller should not free this data directly (it will be freed when the * underlying buffer gets freed */ -__owur static inline int PACKET_peek_bytes(const PACKET *pkt, unsigned char **data, - size_t len) +__owur static ossl_inline int PACKET_peek_bytes(const PACKET *pkt, + const unsigned char **data, + size_t len) { if (PACKET_remaining(pkt) < len) return 0; @@ -317,8 +341,9 @@ __owur static inline int PACKET_peek_bytes(const PACKET *pkt, unsigned char **da * not free this data directly (it will be freed when the underlying buffer gets * freed */ -__owur static inline int PACKET_get_bytes(PACKET *pkt, unsigned char **data, - size_t len) +__owur static ossl_inline int PACKET_get_bytes(PACKET *pkt, + const unsigned char **data, + size_t len) { if (!PACKET_peek_bytes(pkt, data, len)) return 0; @@ -329,8 +354,9 @@ __owur static inline int PACKET_get_bytes(PACKET *pkt, unsigned char **data, } /* Peek ahead at |len| bytes from |pkt| and copy them to |data| */ -__owur static inline int PACKET_peek_copy_bytes(const PACKET *pkt, - unsigned char *data, size_t len) +__owur static ossl_inline int PACKET_peek_copy_bytes(const PACKET *pkt, + unsigned char *data, + size_t len) { if (PACKET_remaining(pkt) < len) return 0; @@ -344,8 +370,9 @@ __owur static inline int PACKET_peek_copy_bytes(const PACKET *pkt, * Read |len| bytes from |pkt| and copy them to |data|. * The caller is responsible for ensuring that |data| can hold |len| bytes. */ -__owur static inline int PACKET_copy_bytes(PACKET *pkt, unsigned char *data, - size_t len) +__owur static ossl_inline int PACKET_copy_bytes(PACKET *pkt, + unsigned char *data, + size_t len) { if (!PACKET_peek_copy_bytes(pkt, data, len)) return 0; @@ -355,6 +382,26 @@ __owur static inline int PACKET_copy_bytes(PACKET *pkt, unsigned char *data, return 1; } +/* + * Copy packet data to |dest|, and set |len| to the number of copied bytes. + * If the packet has more than |dest_len| bytes, nothing is copied. + * Returns 1 if the packet data fits in |dest_len| bytes, 0 otherwise. + * Does not forward PACKET position (because it is typically the last thing + * done with a given PACKET). + */ +__owur static ossl_inline int PACKET_copy_all(const PACKET *pkt, + unsigned char *dest, + size_t dest_len, size_t *len) +{ + if (PACKET_remaining(pkt) > dest_len) { + *len = 0; + return 0; + } + *len = pkt->remaining; + memcpy(dest, pkt->curr, pkt->remaining); + return 1; +} + /* * Copy |pkt| bytes to a newly allocated buffer and store a pointer to the * result in |*data|, and the length in |len|. @@ -364,8 +411,8 @@ __owur static inline int PACKET_copy_bytes(PACKET *pkt, unsigned char *data, * Does not forward PACKET position (because it is typically the last thing * done with a given PACKET). */ -__owur static inline int PACKET_memdup(const PACKET *pkt, unsigned char **data, - size_t *len) +__owur static ossl_inline int PACKET_memdup(const PACKET *pkt, + unsigned char **data, size_t *len) { size_t length; @@ -378,8 +425,7 @@ __owur static inline int PACKET_memdup(const PACKET *pkt, unsigned char **data, if (length == 0) return 1; - *data = BUF_memdup(pkt->curr, length); - + *data = OPENSSL_memdup(pkt->curr, length); if (*data == NULL) return 0; @@ -397,15 +443,17 @@ __owur static inline int PACKET_memdup(const PACKET *pkt, unsigned char **data, * Does not forward PACKET position (because it is typically the last thing done * with a given PACKET). */ -__owur static inline int PACKET_strndup(const PACKET *pkt, char **data) +__owur static ossl_inline int PACKET_strndup(const PACKET *pkt, char **data) { OPENSSL_free(*data); - *data = BUF_strndup((const char*)pkt->curr, PACKET_remaining(pkt)); + + /* This will succeed on an empty packet, unless pkt->curr == NULL. */ + *data = OPENSSL_strndup((const char *)pkt->curr, PACKET_remaining(pkt)); return (*data != NULL); } /* Move the current reading position forward |len| bytes */ -__owur static inline int PACKET_forward(PACKET *pkt, size_t len) +__owur static ossl_inline int PACKET_forward(PACKET *pkt, size_t len) { if (PACKET_remaining(pkt) < len) return 0; @@ -422,21 +470,22 @@ __owur static inline int PACKET_forward(PACKET *pkt, size_t len) * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|. * Upon failure, the original |pkt| and |subpkt| are not modified. */ -__owur static inline int PACKET_get_length_prefixed_1(PACKET *pkt, PACKET *subpkt) +__owur static ossl_inline int PACKET_get_length_prefixed_1(PACKET *pkt, + PACKET *subpkt) { - unsigned int length; - unsigned char *data; - PACKET tmp = *pkt; - if (!PACKET_get_1(&tmp, &length) || - !PACKET_get_bytes(&tmp, &data, (size_t)length)) { - return 0; - } - - *pkt = tmp; - subpkt->curr = data; - subpkt->remaining = length; - - return 1; + unsigned int length; + const unsigned char *data; + PACKET tmp = *pkt; + if (!PACKET_get_1(&tmp, &length) || + !PACKET_get_bytes(&tmp, &data, (size_t)length)) { + return 0; + } + + *pkt = tmp; + subpkt->curr = data; + subpkt->remaining = length; + + return 1; } /* @@ -446,21 +495,22 @@ __owur static inline int PACKET_get_length_prefixed_1(PACKET *pkt, PACKET *subpk * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|. * Upon failure, the original |pkt| and |subpkt| are not modified. */ -__owur static inline int PACKET_get_length_prefixed_2(PACKET *pkt, PACKET *subpkt) +__owur static ossl_inline int PACKET_get_length_prefixed_2(PACKET *pkt, + PACKET *subpkt) { - unsigned int length; - unsigned char *data; - PACKET tmp = *pkt; - if (!PACKET_get_net_2(&tmp, &length) || - !PACKET_get_bytes(&tmp, &data, (size_t)length)) { - return 0; - } - - *pkt = tmp; - subpkt->curr = data; - subpkt->remaining = length; - - return 1; + unsigned int length; + const unsigned char *data; + PACKET tmp = *pkt; + if (!PACKET_get_net_2(&tmp, &length) || + !PACKET_get_bytes(&tmp, &data, (size_t)length)) { + return 0; + } + + *pkt = tmp; + subpkt->curr = data; + subpkt->remaining = length; + + return 1; } /* @@ -470,24 +520,25 @@ __owur static inline int PACKET_get_length_prefixed_2(PACKET *pkt, PACKET *subpk * the original |pkt|, so data wrapped by |pkt| must outlive the |subpkt|. * Upon failure, the original |pkt| and |subpkt| are not modified. */ -__owur static inline int PACKET_get_length_prefixed_3(PACKET *pkt, PACKET *subpkt) +__owur static ossl_inline int PACKET_get_length_prefixed_3(PACKET *pkt, + PACKET *subpkt) { - unsigned long length; - unsigned char *data; - PACKET tmp = *pkt; - if (!PACKET_get_net_3(&tmp, &length) || - !PACKET_get_bytes(&tmp, &data, (size_t)length)) { - return 0; - } - - *pkt = tmp; - subpkt->curr = data; - subpkt->remaining = length; - - return 1; + unsigned long length; + const unsigned char *data; + PACKET tmp = *pkt; + if (!PACKET_get_net_3(&tmp, &length) || + !PACKET_get_bytes(&tmp, &data, (size_t)length)) { + return 0; + } + + *pkt = tmp; + subpkt->curr = data; + subpkt->remaining = length; + + return 1; } # ifdef __cplusplus } # endif -#endif /* HEADER_PACKET_LOCL_H */ +#endif /* HEADER_PACKET_LOCL_H */