diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:30:55 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-28 07:30:55 +0000 |
commit | 17e81f2cd1843f01838245eae7b5ed5edf83d6be (patch) | |
tree | a0f685dff11ce5a2dc546a7b46a48bae5d1c0140 /tests/ngtcp2_test_helper.h | |
parent | Initial commit. (diff) | |
download | ngtcp2-upstream/0.12.1+dfsg.tar.xz ngtcp2-upstream/0.12.1+dfsg.zip |
Adding upstream version 0.12.1+dfsg.upstream/0.12.1+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | tests/ngtcp2_test_helper.h | 191 |
1 files changed, 191 insertions, 0 deletions
diff --git a/tests/ngtcp2_test_helper.h b/tests/ngtcp2_test_helper.h new file mode 100644 index 0000000..894cdf3 --- /dev/null +++ b/tests/ngtcp2_test_helper.h @@ -0,0 +1,191 @@ +/* + * ngtcp2 + * + * Copyright (c) 2017 ngtcp2 contributors + * + * 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 NGTCP2_TEST_HELPER_H +#define NGTCP2_TEST_HELPER_H + +#ifdef HAVE_CONFIG_H +# include <config.h> +#endif /* HAVE_CONFIG_H */ + +#include <ngtcp2/ngtcp2.h> + +#include "ngtcp2_conn.h" + +/* + * strsize macro returns the length of string literal |S|. + */ +#define strsize(S) (sizeof(S) - 1) + +/* + * NGTCP2_APP_ERRxx is an application error code solely used in test + * code. + */ +#define NGTCP2_APP_ERR01 0xff01u +#define NGTCP2_APP_ERR02 0xff02u + +/* + * NGTCP2_FAKE_AEAD_OVERHEAD is AEAD overhead used in unit tests. + * Because we use the same encryption/decryption function for both + * handshake and post handshake packets, we have to use AEAD overhead + * used in handshake packets. + */ +#define NGTCP2_FAKE_AEAD_OVERHEAD NGTCP2_INITIAL_AEAD_OVERHEAD + +/* NGTCP2_FAKE_HP_MASK is a header protection mask used in unit + tests. */ +#define NGTCP2_FAKE_HP_MASK "\x00\x00\x00\x00\x00" + +/* + * ngtcp2_t_encode_stream_frame encodes STREAM frame into |out| with + * the given parameters. If NGTCP2_STREAM_LEN_BIT is set in |flags|, + * |datalen| is encoded as Data Length, otherwise it is not written. + * To set FIN bit in wire format, set NGTCP2_STREAM_FIN_BIT in + * |flags|. This function expects that |out| has enough length to + * store entire STREAM frame, excluding the Stream Data. + * + * This function returns the number of bytes written to |out|. + */ +size_t ngtcp2_t_encode_stream_frame(uint8_t *out, uint8_t flags, + uint64_t stream_id, uint64_t offset, + uint16_t datalen); + +/* + * ngtcp2_t_encode_ack_frame encodes ACK frame into |out| with the + * given parameters. Currently, this function encodes 1 ACK Block + * Section. ACK Delay field is always 0. + * + * This function returns the number of bytes written to |out|. + */ +size_t ngtcp2_t_encode_ack_frame(uint8_t *out, uint64_t largest_ack, + uint64_t first_ack_blklen, uint64_t gap, + uint64_t ack_blklen); + +/* + * write_pkt_flags writes a QUIC packet containing frames pointed by + * |fr| of length |frlen| in |out| whose capacity is |outlen|. This + * function returns the number of bytes written. + */ +size_t write_pkt_flags(uint8_t *out, size_t outlen, uint8_t flags, + const ngtcp2_cid *dcid, int64_t pkt_num, + ngtcp2_frame *fr, size_t frlen, ngtcp2_crypto_km *ckm); + +/* + * write_pkt is write_pkt_flags with flag = NGTCP2_PKT_FLAG_NONE. + */ +size_t write_pkt(uint8_t *out, size_t outlen, const ngtcp2_cid *dcid, + int64_t pkt_num, ngtcp2_frame *fr, size_t frlen, + ngtcp2_crypto_km *ckm); + +/* + * write_handshake_pkt writes a QUIC Initial packet containing |frlen| + * frames pointed by |fr| into |out| whose capacity is |outlen|. This + * function returns the number of bytes written. + */ +size_t write_initial_pkt(uint8_t *out, size_t outlen, const ngtcp2_cid *dcid, + const ngtcp2_cid *scid, int64_t pkt_num, + uint32_t version, const uint8_t *token, + size_t tokenlen, ngtcp2_frame *fr, size_t frlen, + ngtcp2_crypto_km *ckm); + +/* + * write_handshake_pkt writes a QUIC Handshake packet containing + * |frlen| frames pointed by |fr| into |out| whose capacity is + * |outlen|. This function returns the number of bytes written. + */ +size_t write_handshake_pkt(uint8_t *out, size_t outlen, const ngtcp2_cid *dcid, + const ngtcp2_cid *scid, int64_t pkt_num, + uint32_t version, ngtcp2_frame *fr, size_t frlen, + ngtcp2_crypto_km *ckm); + +/* + * write_0rtt_pkt writes a QUIC 0RTT packet containing |frlen| frames + * pointed by |fr| into |out| whose capacity is |outlen|. This + * function returns the number of bytes written. + */ +size_t write_0rtt_pkt(uint8_t *out, size_t outlen, const ngtcp2_cid *dcid, + const ngtcp2_cid *scid, int64_t pkt_num, uint32_t version, + ngtcp2_frame *fr, size_t frlen, ngtcp2_crypto_km *ckm); + +/* + * open_stream opens new stream denoted by |stream_id|. + */ +ngtcp2_strm *open_stream(ngtcp2_conn *conn, int64_t stream_id); + +/* + * rtb_entry_length returns the length of elements pointed by |ent| + * list. + */ +size_t rtb_entry_length(const ngtcp2_rtb_entry *ent); + +void scid_init(ngtcp2_cid *cid); +void dcid_init(ngtcp2_cid *cid); +void rcid_init(ngtcp2_cid *cid); + +/* + * read_pkt_payloadlen reads long header payload length field from + * |pkt|. + */ +uint64_t read_pkt_payloadlen(const uint8_t *pkt, const ngtcp2_cid *dcid, + const ngtcp2_cid *scid); + +/* + * write_pkt_payloadlen writes long header payload length field into + * |pkt|. + */ +void write_pkt_payloadlen(uint8_t *pkt, const ngtcp2_cid *dcid, + const ngtcp2_cid *scid, uint64_t payloadlen); + +/* + * pkt_decode_hd_long decodes long packet header from |pkt| of length + * |pktlen|. This function assumes that header protection has been + * decrypted. + */ +ngtcp2_ssize pkt_decode_hd_long(ngtcp2_pkt_hd *dest, const uint8_t *pkt, + size_t pktlen); + +/* + * pkt_decode_hd_short decodes long packet header from |pkt| of length + * |pktlen|. This function assumes that header protection has been + * decrypted. + */ +ngtcp2_ssize pkt_decode_hd_short(ngtcp2_pkt_hd *dest, const uint8_t *pkt, + size_t pktlen, size_t dcidlen); + +/* + * pkt_decode_hd_short_mask decodes long packet header from |pkt| of + * length |pktlen|. NGTCP2_FAKE_HP_MASK is used to decrypt header + * protection. + */ +ngtcp2_ssize pkt_decode_hd_short_mask(ngtcp2_pkt_hd *dest, const uint8_t *pkt, + size_t pktlen, size_t dcidlen); + +/* + * path_init initializes |path| with the given arguments. They form + * IPv4 addresses. + */ +void path_init(ngtcp2_path_storage *path, uint32_t local_addr, + uint16_t local_port, uint32_t remote_addr, uint16_t remote_port); + +#endif /* NGTCP2_TEST_HELPER_H */ |