/src/h2o/deps/quicly/include/quicly/cid.h

Source
/*
 * Copyright (c) 2020 Fastly, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */
#ifndef quicly_cid_h
#define quicly_cid_h

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <string.h>
#include "picotls.h"
#include "quicly/constants.h"

/**
 * Guard value. We would never send path_id of this value.
 */
#define QUICLY_MAX_PATH_ID UINT8_MAX

typedef struct st_quicly_cid_t {
    uint8_t cid[QUICLY_MAX_CID_LEN_V1];
    uint8_t len;
} quicly_cid_t;

/**
 * The structure of CID issued by quicly.
 *
 * Authentication of the CID can be done by validating if server_id and thread_id contain correct values.
 */
typedef struct st_quicly_cid_plaintext_t {
    /**
     * the internal "connection ID" unique to each connection (rather than QUIC's CID being unique to each path)
     */
    uint32_t master_id;
    /**
     * path ID of the connection; we issue up to 255 CIDs per connection (see QUICLY_MAX_PATH_ID)
     */
    uint32_t path_id : 8;
    /**
     * for intra-node routing
     */
    uint32_t thread_id : 24;
    /**
     * for inter-node routing; available only when using a 16-byte cipher to encrypt CIDs, otherwise set to zero.
     */
    uint64_t node_id;
} quicly_cid_plaintext_t;

/**
 * A CID used for indicating that a CID is invalid. Both .node_id and .thread_id are set to their maximum. Therefore, mappings must
 * refrain from using those values.
 */
extern quicly_cid_plaintext_t quicly_cid_plaintext_invalid;

/**
 * CID encryption
 */
typedef struct st_quicly_cid_encryptor_t {
    /**
     * encrypts CID and optionally generates a stateless reset token
     */
    void (*encrypt_cid)(struct st_quicly_cid_encryptor_t *self, quicly_cid_t *encrypted, void *stateless_reset_token,
                        const quicly_cid_plaintext_t *plaintext);
    /**
     * decrypts a CID
     * @param plaintext  if successful, the decoded CID will be written
     * @param encrypt    the encrypted CID
     * @param len        length of the encrypted CID when the packet is a long header packet, or 0 if it is a short header packet
     * @return           length of the CID if successful, or SIZE_MAX if failed
     */
    size_t (*decrypt_cid)(struct st_quicly_cid_encryptor_t *self, quicly_cid_plaintext_t *plaintext, const void *encrypted,
                          size_t len);
    /**
     * generates a stateless reset token (returns if generated)
     */
    int (*generate_stateless_reset_token)(struct st_quicly_cid_encryptor_t *self, void *token, const void *cid);
} quicly_cid_encryptor_t;

static void quicly_set_cid(quicly_cid_t *dest, ptls_iovec_t src);
static int quicly_cid_is_equal(const quicly_cid_t *cid, ptls_iovec_t vec);

/* inline functions */

inline int quicly_cid_is_equal(const quicly_cid_t *cid, ptls_iovec_t vec)
{
    return cid->len == vec.len && memcmp(cid->cid, vec.base, vec.len) == 0;
}

inline void quicly_set_cid(quicly_cid_t *dest, ptls_iovec_t src)
{
    assert(src.len <= sizeof(dest->cid));
    memcpy(dest->cid, src.base, src.len);
    dest->len = src.len;
}

#ifdef __cplusplus
}
#endif

#endif

Line	Count	Source
1		/*
2		* Copyright (c) 2020 Fastly, Inc.
3		*
4		* Permission is hereby granted, free of charge, to any person obtaining a copy
5		* of this software and associated documentation files (the "Software"), to
6		* deal in the Software without restriction, including without limitation the
7		* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8		* sell copies of the Software, and to permit persons to whom the Software is
9		* furnished to do so, subject to the following conditions:
10		*
11		* The above copyright notice and this permission notice shall be included in
12		* all copies or substantial portions of the Software.
13		*
14		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19		* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
20		* IN THE SOFTWARE.
21		*/
22		#ifndef quicly_cid_h
23		#define quicly_cid_h
24
25		#ifdef __cplusplus
26		extern "C" {
27		#endif
28
29		#include <stdint.h>
30		#include <string.h>
31		#include "picotls.h"
32		#include "quicly/constants.h"
33
34		/**
35		* Guard value. We would never send path_id of this value.
36		*/
37	0	#define QUICLY_MAX_PATH_ID UINT8_MAX
38
39		typedef struct st_quicly_cid_t {
40		uint8_t cid[QUICLY_MAX_CID_LEN_V1];
41		uint8_t len;
42		} quicly_cid_t;
43
44		/**
45		* The structure of CID issued by quicly.
46		*
47		* Authentication of the CID can be done by validating if server_id and thread_id contain correct values.
48		*/
49		typedef struct st_quicly_cid_plaintext_t {
50		/**
51		* the internal "connection ID" unique to each connection (rather than QUIC's CID being unique to each path)
52		*/
53		uint32_t master_id;
54		/**
55		* path ID of the connection; we issue up to 255 CIDs per connection (see QUICLY_MAX_PATH_ID)
56		*/
57		uint32_t path_id : 8;
58		/**
59		* for intra-node routing
60		*/
61		uint32_t thread_id : 24;
62		/**
63		* for inter-node routing; available only when using a 16-byte cipher to encrypt CIDs, otherwise set to zero.
64		*/
65		uint64_t node_id;
66		} quicly_cid_plaintext_t;
67
68		/**
69		* A CID used for indicating that a CID is invalid. Both .node_id and .thread_id are set to their maximum. Therefore, mappings must
70		* refrain from using those values.
71		*/
72		extern quicly_cid_plaintext_t quicly_cid_plaintext_invalid;
73
74		/**
75		* CID encryption
76		*/
77		typedef struct st_quicly_cid_encryptor_t {
78		/**
79		* encrypts CID and optionally generates a stateless reset token
80		*/
81		void (encrypt_cid)(struct st_quicly_cid_encryptor_t self, quicly_cid_t encrypted, void stateless_reset_token,
82		const quicly_cid_plaintext_t *plaintext);
83		/**
84		* decrypts a CID
85		* @param plaintext if successful, the decoded CID will be written
86		* @param encrypt the encrypted CID
87		* @param len length of the encrypted CID when the packet is a long header packet, or 0 if it is a short header packet
88		* @return length of the CID if successful, or SIZE_MAX if failed
89		*/
90		size_t (decrypt_cid)(struct st_quicly_cid_encryptor_t self, quicly_cid_plaintext_t plaintext, const void encrypted,
91		size_t len);
92		/**
93		* generates a stateless reset token (returns if generated)
94		*/
95		int (generate_stateless_reset_token)(struct st_quicly_cid_encryptor_t self, void token, const void cid);
96		} quicly_cid_encryptor_t;
97
98		static void quicly_set_cid(quicly_cid_t *dest, ptls_iovec_t src);
99		static int quicly_cid_is_equal(const quicly_cid_t *cid, ptls_iovec_t vec);
100
101		/* inline functions */
102
103		inline int quicly_cid_is_equal(const quicly_cid_t *cid, ptls_iovec_t vec)
104	0	{
105	0	return cid->len == vec.len && memcmp(cid->cid, vec.base, vec.len) == 0;
106	0	} Unexecuted instantiation: driver.cc:quicly_cid_is_equal(st_quicly_cid_t const, st_ptls_iovec_t) Unexecuted instantiation: driver_common.cc:quicly_cid_is_equal(st_quicly_cid_t const, st_ptls_iovec_t) Unexecuted instantiation: socket.c:quicly_cid_is_equal Unexecuted instantiation: config.c:quicly_cid_is_equal Unexecuted instantiation: configurator.c:quicly_cid_is_equal Unexecuted instantiation: context.c:quicly_cid_is_equal Unexecuted instantiation: headers.c:quicly_cid_is_equal Unexecuted instantiation: request.c:quicly_cid_is_equal Unexecuted instantiation: util.c:quicly_cid_is_equal Unexecuted instantiation: access_log.c:quicly_cid_is_equal Unexecuted instantiation: file.c:quicly_cid_is_equal Unexecuted instantiation: mimemap.c:quicly_cid_is_equal Unexecuted instantiation: proxy.c:quicly_cid_is_equal Unexecuted instantiation: http1.c:quicly_cid_is_equal Unexecuted instantiation: connection.c:quicly_cid_is_equal Unexecuted instantiation: scheduler.c:quicly_cid_is_equal Unexecuted instantiation: stream.c:quicly_cid_is_equal Unexecuted instantiation: http2_debug_state.c:quicly_cid_is_equal Unexecuted instantiation: common.c:quicly_cid_is_equal Unexecuted instantiation: server.c:quicly_cid_is_equal Unexecuted instantiation: cc-reno.c:quicly_cid_is_equal Unexecuted instantiation: defaults.c:quicly_cid_is_equal Unexecuted instantiation: quicly.c:quicly_cid_is_equal Unexecuted instantiation: remote_cid.c:quicly_cid_is_equal Unexecuted instantiation: streambuf.c:quicly_cid_is_equal Unexecuted instantiation: http3client.c:quicly_cid_is_equal Unexecuted instantiation: httpclient.c:quicly_cid_is_equal Unexecuted instantiation: absprio.c:quicly_cid_is_equal Unexecuted instantiation: logconf.c:quicly_cid_is_equal Unexecuted instantiation: compress.c:quicly_cid_is_equal Unexecuted instantiation: gzip.c:quicly_cid_is_equal Unexecuted instantiation: headers_util.c:quicly_cid_is_equal Unexecuted instantiation: frame.c:quicly_cid_is_equal Unexecuted instantiation: qpack.c:quicly_cid_is_equal Unexecuted instantiation: cc-cubic.c:quicly_cid_is_equal Unexecuted instantiation: cc-pico.c:quicly_cid_is_equal Unexecuted instantiation: local_cid.c:quicly_cid_is_equal Unexecuted instantiation: http1client.c:quicly_cid_is_equal Unexecuted instantiation: http2client.c:quicly_cid_is_equal Unexecuted instantiation: pipe_sender.c:quicly_cid_is_equal Unexecuted instantiation: driver_url.cc:quicly_cid_is_equal(st_quicly_cid_t const, st_ptls_iovec_t) Unexecuted instantiation: driver_h3.cc:quicly_cid_is_equal(st_quicly_cid_t const, st_ptls_iovec_t) Unexecuted instantiation: quicly_mock.c:quicly_cid_is_equal Unexecuted instantiation: errordoc.c:quicly_cid_is_equal Unexecuted instantiation: expires.c:quicly_cid_is_equal Unexecuted instantiation: fastcgi.c:quicly_cid_is_equal Unexecuted instantiation: h2olog.c:quicly_cid_is_equal Unexecuted instantiation: connect.c:quicly_cid_is_equal Unexecuted instantiation: redirect.c:quicly_cid_is_equal Unexecuted instantiation: reproxy.c:quicly_cid_is_equal Unexecuted instantiation: throttle_resp.c:quicly_cid_is_equal Unexecuted instantiation: self_trace.c:quicly_cid_is_equal Unexecuted instantiation: server_timing.c:quicly_cid_is_equal Unexecuted instantiation: status.c:quicly_cid_is_equal Unexecuted instantiation: events.c:quicly_cid_is_equal Unexecuted instantiation: memory.c:quicly_cid_is_equal Unexecuted instantiation: requests.c:quicly_cid_is_equal Unexecuted instantiation: ssl.c:quicly_cid_is_equal Unexecuted instantiation: durations.c:quicly_cid_is_equal Unexecuted instantiation: brotli.c:quicly_cid_is_equal
107
108		inline void quicly_set_cid(quicly_cid_t *dest, ptls_iovec_t src)
109	0	{
110	0	assert(src.len <= sizeof(dest->cid));
111	0	memcpy(dest->cid, src.base, src.len);
112	0	dest->len = src.len;
113	0	} Unexecuted instantiation: driver.cc:quicly_set_cid(st_quicly_cid_t, st_ptls_iovec_t) Unexecuted instantiation: driver_common.cc:quicly_set_cid(st_quicly_cid_t, st_ptls_iovec_t) Unexecuted instantiation: socket.c:quicly_set_cid Unexecuted instantiation: config.c:quicly_set_cid Unexecuted instantiation: configurator.c:quicly_set_cid Unexecuted instantiation: context.c:quicly_set_cid Unexecuted instantiation: headers.c:quicly_set_cid Unexecuted instantiation: request.c:quicly_set_cid Unexecuted instantiation: util.c:quicly_set_cid Unexecuted instantiation: access_log.c:quicly_set_cid Unexecuted instantiation: file.c:quicly_set_cid Unexecuted instantiation: mimemap.c:quicly_set_cid Unexecuted instantiation: proxy.c:quicly_set_cid Unexecuted instantiation: http1.c:quicly_set_cid Unexecuted instantiation: connection.c:quicly_set_cid Unexecuted instantiation: scheduler.c:quicly_set_cid Unexecuted instantiation: stream.c:quicly_set_cid Unexecuted instantiation: http2_debug_state.c:quicly_set_cid Unexecuted instantiation: common.c:quicly_set_cid Unexecuted instantiation: server.c:quicly_set_cid Unexecuted instantiation: cc-reno.c:quicly_set_cid Unexecuted instantiation: defaults.c:quicly_set_cid Unexecuted instantiation: quicly.c:quicly_set_cid Unexecuted instantiation: remote_cid.c:quicly_set_cid Unexecuted instantiation: streambuf.c:quicly_set_cid Unexecuted instantiation: http3client.c:quicly_set_cid Unexecuted instantiation: httpclient.c:quicly_set_cid Unexecuted instantiation: absprio.c:quicly_set_cid Unexecuted instantiation: logconf.c:quicly_set_cid Unexecuted instantiation: compress.c:quicly_set_cid Unexecuted instantiation: gzip.c:quicly_set_cid Unexecuted instantiation: headers_util.c:quicly_set_cid Unexecuted instantiation: frame.c:quicly_set_cid Unexecuted instantiation: qpack.c:quicly_set_cid Unexecuted instantiation: cc-cubic.c:quicly_set_cid Unexecuted instantiation: cc-pico.c:quicly_set_cid Unexecuted instantiation: local_cid.c:quicly_set_cid Unexecuted instantiation: http1client.c:quicly_set_cid Unexecuted instantiation: http2client.c:quicly_set_cid Unexecuted instantiation: pipe_sender.c:quicly_set_cid Unexecuted instantiation: driver_url.cc:quicly_set_cid(st_quicly_cid_t, st_ptls_iovec_t) Unexecuted instantiation: driver_h3.cc:quicly_set_cid(st_quicly_cid_t, st_ptls_iovec_t) Unexecuted instantiation: quicly_mock.c:quicly_set_cid Unexecuted instantiation: errordoc.c:quicly_set_cid Unexecuted instantiation: expires.c:quicly_set_cid Unexecuted instantiation: fastcgi.c:quicly_set_cid Unexecuted instantiation: h2olog.c:quicly_set_cid Unexecuted instantiation: connect.c:quicly_set_cid Unexecuted instantiation: redirect.c:quicly_set_cid Unexecuted instantiation: reproxy.c:quicly_set_cid Unexecuted instantiation: throttle_resp.c:quicly_set_cid Unexecuted instantiation: self_trace.c:quicly_set_cid Unexecuted instantiation: server_timing.c:quicly_set_cid Unexecuted instantiation: status.c:quicly_set_cid Unexecuted instantiation: events.c:quicly_set_cid Unexecuted instantiation: memory.c:quicly_set_cid Unexecuted instantiation: requests.c:quicly_set_cid Unexecuted instantiation: ssl.c:quicly_set_cid Unexecuted instantiation: durations.c:quicly_set_cid Unexecuted instantiation: brotli.c:quicly_set_cid
114
115		#ifdef __cplusplus
116		}
117		#endif
118
119		#endif

Coverage Report

Created: 2026-06-07 06:36