1*e7be843bSPierre Pronchery /*
2*e7be843bSPierre Pronchery * Copyright 2022-2023 The OpenSSL Project Authors. All Rights Reserved.
3*e7be843bSPierre Pronchery *
4*e7be843bSPierre Pronchery * Licensed under the Apache License 2.0 (the "License"). You may not use
5*e7be843bSPierre Pronchery * this file except in compliance with the License. You can obtain a copy
6*e7be843bSPierre Pronchery * in the file LICENSE in the source distribution or at
7*e7be843bSPierre Pronchery * https://www.openssl.org/source/license.html
8*e7be843bSPierre Pronchery */
9*e7be843bSPierre Pronchery
10*e7be843bSPierre Pronchery #ifndef OSSL_INTERNAL_PACKET_QUIC_H
11*e7be843bSPierre Pronchery # define OSSL_INTERNAL_PACKET_QUIC_H
12*e7be843bSPierre Pronchery # pragma once
13*e7be843bSPierre Pronchery
14*e7be843bSPierre Pronchery # include "internal/packet.h"
15*e7be843bSPierre Pronchery # include "internal/quic_vlint.h"
16*e7be843bSPierre Pronchery
17*e7be843bSPierre Pronchery # ifndef OPENSSL_NO_QUIC
18*e7be843bSPierre Pronchery /*
19*e7be843bSPierre Pronchery * Decodes a QUIC variable-length integer in |pkt| and stores the result in
20*e7be843bSPierre Pronchery * |data|.
21*e7be843bSPierre Pronchery */
PACKET_get_quic_vlint(PACKET * pkt,uint64_t * data)22*e7be843bSPierre Pronchery __owur static ossl_inline int PACKET_get_quic_vlint(PACKET *pkt,
23*e7be843bSPierre Pronchery uint64_t *data)
24*e7be843bSPierre Pronchery {
25*e7be843bSPierre Pronchery size_t enclen;
26*e7be843bSPierre Pronchery
27*e7be843bSPierre Pronchery if (PACKET_remaining(pkt) < 1)
28*e7be843bSPierre Pronchery return 0;
29*e7be843bSPierre Pronchery
30*e7be843bSPierre Pronchery enclen = ossl_quic_vlint_decode_len(*pkt->curr);
31*e7be843bSPierre Pronchery
32*e7be843bSPierre Pronchery if (PACKET_remaining(pkt) < enclen)
33*e7be843bSPierre Pronchery return 0;
34*e7be843bSPierre Pronchery
35*e7be843bSPierre Pronchery *data = ossl_quic_vlint_decode_unchecked(pkt->curr);
36*e7be843bSPierre Pronchery packet_forward(pkt, enclen);
37*e7be843bSPierre Pronchery return 1;
38*e7be843bSPierre Pronchery }
39*e7be843bSPierre Pronchery
40*e7be843bSPierre Pronchery /*
41*e7be843bSPierre Pronchery * Decodes a QUIC variable-length integer in |pkt| and stores the result in
42*e7be843bSPierre Pronchery * |data|. Unlike PACKET_get_quic_vlint, this does not advance the current
43*e7be843bSPierre Pronchery * position. If was_minimal is non-NULL, *was_minimal is set to 1 if the integer
44*e7be843bSPierre Pronchery * was encoded using the minimal possible number of bytes and 0 otherwise.
45*e7be843bSPierre Pronchery */
PACKET_peek_quic_vlint_ex(PACKET * pkt,uint64_t * data,int * was_minimal)46*e7be843bSPierre Pronchery __owur static ossl_inline int PACKET_peek_quic_vlint_ex(PACKET *pkt,
47*e7be843bSPierre Pronchery uint64_t *data,
48*e7be843bSPierre Pronchery int *was_minimal)
49*e7be843bSPierre Pronchery {
50*e7be843bSPierre Pronchery size_t enclen;
51*e7be843bSPierre Pronchery
52*e7be843bSPierre Pronchery if (PACKET_remaining(pkt) < 1)
53*e7be843bSPierre Pronchery return 0;
54*e7be843bSPierre Pronchery
55*e7be843bSPierre Pronchery enclen = ossl_quic_vlint_decode_len(*pkt->curr);
56*e7be843bSPierre Pronchery
57*e7be843bSPierre Pronchery if (PACKET_remaining(pkt) < enclen)
58*e7be843bSPierre Pronchery return 0;
59*e7be843bSPierre Pronchery
60*e7be843bSPierre Pronchery *data = ossl_quic_vlint_decode_unchecked(pkt->curr);
61*e7be843bSPierre Pronchery
62*e7be843bSPierre Pronchery if (was_minimal != NULL)
63*e7be843bSPierre Pronchery *was_minimal = (enclen == ossl_quic_vlint_encode_len(*data));
64*e7be843bSPierre Pronchery
65*e7be843bSPierre Pronchery return 1;
66*e7be843bSPierre Pronchery }
67*e7be843bSPierre Pronchery
PACKET_peek_quic_vlint(PACKET * pkt,uint64_t * data)68*e7be843bSPierre Pronchery __owur static ossl_inline int PACKET_peek_quic_vlint(PACKET *pkt,
69*e7be843bSPierre Pronchery uint64_t *data)
70*e7be843bSPierre Pronchery {
71*e7be843bSPierre Pronchery return PACKET_peek_quic_vlint_ex(pkt, data, NULL);
72*e7be843bSPierre Pronchery }
73*e7be843bSPierre Pronchery
74*e7be843bSPierre Pronchery /*
75*e7be843bSPierre Pronchery * Skips over a QUIC variable-length integer in |pkt| without decoding it.
76*e7be843bSPierre Pronchery */
PACKET_skip_quic_vlint(PACKET * pkt)77*e7be843bSPierre Pronchery __owur static ossl_inline int PACKET_skip_quic_vlint(PACKET *pkt)
78*e7be843bSPierre Pronchery {
79*e7be843bSPierre Pronchery size_t enclen;
80*e7be843bSPierre Pronchery
81*e7be843bSPierre Pronchery if (PACKET_remaining(pkt) < 1)
82*e7be843bSPierre Pronchery return 0;
83*e7be843bSPierre Pronchery
84*e7be843bSPierre Pronchery enclen = ossl_quic_vlint_decode_len(*pkt->curr);
85*e7be843bSPierre Pronchery
86*e7be843bSPierre Pronchery if (PACKET_remaining(pkt) < enclen)
87*e7be843bSPierre Pronchery return 0;
88*e7be843bSPierre Pronchery
89*e7be843bSPierre Pronchery packet_forward(pkt, enclen);
90*e7be843bSPierre Pronchery return 1;
91*e7be843bSPierre Pronchery }
92*e7be843bSPierre Pronchery
93*e7be843bSPierre Pronchery /*
94*e7be843bSPierre Pronchery * Reads a variable-length vector prefixed with a QUIC variable-length integer
95*e7be843bSPierre Pronchery * denoting the length, and stores the contents in |subpkt|. |pkt| can equal
96*e7be843bSPierre Pronchery * |subpkt|. Data is not copied: the |subpkt| packet will share its underlying
97*e7be843bSPierre Pronchery * buffer with the original |pkt|, so data wrapped by |pkt| must outlive the
98*e7be843bSPierre Pronchery * |subpkt|. Upon failure, the original |pkt| and |subpkt| are not modified.
99*e7be843bSPierre Pronchery */
PACKET_get_quic_length_prefixed(PACKET * pkt,PACKET * subpkt)100*e7be843bSPierre Pronchery __owur static ossl_inline int PACKET_get_quic_length_prefixed(PACKET *pkt,
101*e7be843bSPierre Pronchery PACKET *subpkt)
102*e7be843bSPierre Pronchery {
103*e7be843bSPierre Pronchery uint64_t length;
104*e7be843bSPierre Pronchery const unsigned char *data;
105*e7be843bSPierre Pronchery PACKET tmp = *pkt;
106*e7be843bSPierre Pronchery
107*e7be843bSPierre Pronchery if (!PACKET_get_quic_vlint(&tmp, &length) ||
108*e7be843bSPierre Pronchery length > SIZE_MAX ||
109*e7be843bSPierre Pronchery !PACKET_get_bytes(&tmp, &data, (size_t)length)) {
110*e7be843bSPierre Pronchery return 0;
111*e7be843bSPierre Pronchery }
112*e7be843bSPierre Pronchery
113*e7be843bSPierre Pronchery *pkt = tmp;
114*e7be843bSPierre Pronchery subpkt->curr = data;
115*e7be843bSPierre Pronchery subpkt->remaining = (size_t)length;
116*e7be843bSPierre Pronchery
117*e7be843bSPierre Pronchery return 1;
118*e7be843bSPierre Pronchery }
119*e7be843bSPierre Pronchery
120*e7be843bSPierre Pronchery /*
121*e7be843bSPierre Pronchery * Starts a QUIC sub-packet headed by a QUIC variable-length integer. A 4-byte
122*e7be843bSPierre Pronchery * representation is used.
123*e7be843bSPierre Pronchery */
124*e7be843bSPierre Pronchery __owur int WPACKET_start_quic_sub_packet(WPACKET *pkt);
125*e7be843bSPierre Pronchery
126*e7be843bSPierre Pronchery /*
127*e7be843bSPierre Pronchery * Starts a QUIC sub-packet headed by a QUIC variable-length integer. max_len
128*e7be843bSPierre Pronchery * specifies the upper bound for the sub-packet size at the time the sub-packet
129*e7be843bSPierre Pronchery * is closed, which determines the encoding size for the variable-length
130*e7be843bSPierre Pronchery * integer header. max_len can be a precise figure or a worst-case bound
131*e7be843bSPierre Pronchery * if a precise figure is not available.
132*e7be843bSPierre Pronchery */
133*e7be843bSPierre Pronchery __owur int WPACKET_start_quic_sub_packet_bound(WPACKET *pkt, size_t max_len);
134*e7be843bSPierre Pronchery
135*e7be843bSPierre Pronchery /*
136*e7be843bSPierre Pronchery * Allocates a QUIC sub-packet with exactly len bytes of payload, headed by a
137*e7be843bSPierre Pronchery * QUIC variable-length integer. The pointer to the payload buffer is output and
138*e7be843bSPierre Pronchery * must be filled by the caller. This function assures optimal selection of
139*e7be843bSPierre Pronchery * variable-length integer encoding length.
140*e7be843bSPierre Pronchery */
141*e7be843bSPierre Pronchery __owur int WPACKET_quic_sub_allocate_bytes(WPACKET *pkt, size_t len,
142*e7be843bSPierre Pronchery unsigned char **bytes);
143*e7be843bSPierre Pronchery
144*e7be843bSPierre Pronchery /*
145*e7be843bSPierre Pronchery * Write a QUIC variable-length integer to the packet.
146*e7be843bSPierre Pronchery */
147*e7be843bSPierre Pronchery __owur int WPACKET_quic_write_vlint(WPACKET *pkt, uint64_t v);
148*e7be843bSPierre Pronchery
149*e7be843bSPierre Pronchery # endif /* OPENSSL_NO_QUIC */
150*e7be843bSPierre Pronchery #endif /* OSSL_INTERNAL_PACKET_QUIC_H */
151