QSC Post Quantum Cryptographic Library 1.3.0.0 (C1)
A post quantum secure library written in Ansi C
Loading...
Searching...
No Matches
tlscodec.h
1/* 2020-2026 Quantum Resistant Cryptographic Solutions Corporation
2 * All Rights Reserved.
3 *
4 * NOTICE:
5 * This software and all accompanying materials are the exclusive property of
6 * Quantum Resistant Cryptographic Solutions Corporation (QRCS). The intellectual
7 * and technical concepts contained herein are proprietary to QRCS and are
8 * protected under applicable Canadian, U.S., and international copyright,
9 * patent, and trade secret laws.
10 *
11 * CRYPTOGRAPHIC ALGORITHMS AND IMPLEMENTATIONS:
12 * - This software includes implementations of cryptographic primitives and
13 * algorithms that are standardized or in the public domain, such as AES
14 * and SHA-3, which are not proprietary to QRCS.
15 * - This software also includes cryptographic primitives, constructions, and
16 * algorithms designed by QRCS, including but not limited to RCS, SCB, CSX, QMAC, and
17 * related components, which are proprietary to QRCS.
18 * - All source code, implementations, protocol compositions, optimizations,
19 * parameter selections, and engineering work contained in this software are
20 * original works of QRCS and are protected under this license.
21 *
22 * LICENSE AND USE RESTRICTIONS:
23 * - This software is licensed under the Quantum Resistant Cryptographic Solutions
24 * Public Research and Evaluation License (QRCS-PREL), 2025-2026.
25 * - Permission is granted solely for non-commercial evaluation, academic research,
26 * cryptographic analysis, interoperability testing, and feasibility assessment.
27 * - Commercial use, production deployment, commercial redistribution, or
28 * integration into products or services is strictly prohibited without a
29 * separate written license agreement executed with QRCS.
30 * - Licensing and authorized distribution are solely at the discretion of QRCS.
31 *
32 * EXPERIMENTAL CRYPTOGRAPHY NOTICE:
33 * Portions of this software may include experimental, novel, or evolving
34 * cryptographic designs. Use of this software is entirely at the user's risk.
35 *
36 * DISCLAIMER:
37 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
38 * IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS
39 * FOR A PARTICULAR PURPOSE, SECURITY, OR NON-INFRINGEMENT. QRCS DISCLAIMS ALL
40 * LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
41 * ARISING FROM THE USE OR MISUSE OF THIS SOFTWARE.
42 *
43 * FULL LICENSE:
44 * This software is subject to the Quantum Resistant Cryptographic Solutions
45 * Public Research and Evaluation License (QRCS-PREL), 2025-2026. The complete license terms
46 * are provided in the accompanying LICENSE file or at https://www.qrcscorp.ca.
47 *
48 * Written by: John G. Underhill
49 * Contact: contact@qrcscorp.ca
50 */
51
52#ifndef QSC_TLS_CODEC_H
53#define QSC_TLS_CODEC_H
54
55#include "qsccommon.h"
56#include "tlserrors.h"
57
58QSC_CPLUSPLUS_ENABLED_START
59
64
75QSC_EXPORT_API qsc_tls_status qsc_tls_codec_write_u8(uint8_t* output, size_t outlen, size_t* offset, uint8_t value);
76
87QSC_EXPORT_API qsc_tls_status qsc_tls_codec_write_u16(uint8_t* output, size_t outlen, size_t* offset, uint16_t value);
88
99QSC_EXPORT_API qsc_tls_status qsc_tls_codec_write_u24(uint8_t* output, size_t outlen, size_t* offset, uint32_t value);
100
111QSC_EXPORT_API qsc_tls_status qsc_tls_codec_write_u32(uint8_t* output, size_t outlen, size_t* offset, uint32_t value);
112
124QSC_EXPORT_API qsc_tls_status qsc_tls_codec_write_bytes(uint8_t* output, size_t outlen, size_t* offset, const uint8_t* input, size_t inplen);
125
137QSC_EXPORT_API qsc_tls_status qsc_tls_codec_write_vector8(uint8_t* output, size_t outlen, size_t* offset, const uint8_t* input, size_t inplen);
138
150QSC_EXPORT_API qsc_tls_status qsc_tls_codec_write_vector16(uint8_t* output, size_t outlen, size_t* offset, const uint8_t* input, size_t inplen);
151
163QSC_EXPORT_API qsc_tls_status qsc_tls_codec_write_vector24(uint8_t* output, size_t outlen, size_t* offset, const uint8_t* input, size_t inplen);
164
175QSC_EXPORT_API qsc_tls_status qsc_tls_codec_read_u8(const uint8_t* input, size_t inplen, size_t* offset, uint8_t* value);
176
187QSC_EXPORT_API qsc_tls_status qsc_tls_codec_read_u16(const uint8_t* input, size_t inplen, size_t* offset, uint16_t* value);
188
199QSC_EXPORT_API qsc_tls_status qsc_tls_codec_read_u24(const uint8_t* input, size_t inplen, size_t* offset, uint32_t* value);
200
211QSC_EXPORT_API qsc_tls_status qsc_tls_codec_read_u32(const uint8_t* input, size_t inplen, size_t* offset, uint32_t* value);
212
224QSC_EXPORT_API qsc_tls_status qsc_tls_codec_read_bytes(const uint8_t* input, size_t inplen, size_t* offset, uint8_t* output, size_t outlen);
225
237QSC_EXPORT_API qsc_tls_status qsc_tls_codec_read_vector8_span(const uint8_t* input, size_t inplen, size_t* offset, const uint8_t** span, size_t* spanlen);
238
250QSC_EXPORT_API qsc_tls_status qsc_tls_codec_read_vector16_span(const uint8_t* input, size_t inplen, size_t* offset, const uint8_t** span, size_t* spanlen);
251
263QSC_EXPORT_API qsc_tls_status qsc_tls_codec_read_vector24_span(const uint8_t* input, size_t inplen, size_t* offset, const uint8_t** span, size_t* spanlen);
264
275QSC_EXPORT_API qsc_tls_status qsc_tls_codec_read_u64(const uint8_t* input, size_t inplen, size_t* offset, uint64_t* value);
276
293QSC_EXPORT_API qsc_tls_status qsc_tls_codec_vector_begin_u8(uint8_t* output, size_t outlen, size_t* offset, size_t* headerposition);
294
298QSC_EXPORT_API qsc_tls_status qsc_tls_codec_vector_begin_u16(uint8_t* output, size_t outlen, size_t* offset, size_t* headerposition);
299
303QSC_EXPORT_API qsc_tls_status qsc_tls_codec_vector_begin_u24(uint8_t* output, size_t outlen, size_t* offset, size_t* headerposition);
304
313QSC_EXPORT_API qsc_tls_status qsc_tls_codec_vector_end_u8(uint8_t* output, size_t outlen, const size_t* offset, size_t headerposition);
314
318QSC_EXPORT_API qsc_tls_status qsc_tls_codec_vector_end_u16(uint8_t* output, size_t outlen, const size_t* offset, size_t headerposition);
319
323QSC_EXPORT_API qsc_tls_status qsc_tls_codec_vector_end_u24(uint8_t* output, size_t outlen, const size_t* offset, size_t headerposition);
324
325QSC_CPLUSPLUS_ENABLED_END
326
327#endif
Contains common definitions for the Quantum Secure Cryptographic (QSC) library.
#define QSC_EXPORT_API
API export macro for Microsoft compilers when importing from a DLL.
Definition qsccommon.h:645
TLS status code definitions and diagnostic string conversion.
qsc_tls_status
Definition tlserrors.h:65