encode.h

Go to the documentation of this file.

/* 2025-2026 Quantum Resistant Cryptographic Solutions Corporation
 * All Rights Reserved.
 *
 * NOTICE:
 * This software and all accompanying materials are the exclusive property of
 * Quantum Resistant Cryptographic Solutions Corporation (QRCS). The intellectual
 * and technical concepts contained herein are proprietary to QRCS and are
 * protected under applicable Canadian, U.S., and international copyright,
 * patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC ALGORITHMS AND IMPLEMENTATIONS:
 * - This software includes implementations of cryptographic primitives and
 *   algorithms that are standardized or in the public domain, such as AES
 *   and SHA-3, which are not proprietary to QRCS.
 * - This software also includes cryptographic primitives, constructions, and
 *   algorithms designed by QRCS, including but not limited to RCS, SCB, CSX, QMAC, and
 *   related components, which are proprietary to QRCS.
 * - All source code, implementations, protocol compositions, optimizations,
 *   parameter selections, and engineering work contained in this software are
 *   original works of QRCS and are protected under this license.
 *
 * LICENSE AND USE RESTRICTIONS:
 * - This software is licensed under the Quantum Resistant Cryptographic Solutions
 *   Public Research and Evaluation License (QRCS-PREL), 2025-2026.
 * - Permission is granted solely for non-commercial evaluation, academic research,
 *   cryptographic analysis, interoperability testing, and feasibility assessment.
 * - Commercial use, production deployment, commercial redistribution, or
 *   integration into products or services is strictly prohibited without a
 *   separate written license agreement executed with QRCS.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 *
 * EXPERIMENTAL CRYPTOGRAPHY NOTICE:
 * Portions of this software may include experimental, novel, or evolving
 * cryptographic designs. Use of this software is entirely at the user's risk.
 *
 * DISCLAIMER:
 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE, SECURITY, OR NON-INFRINGEMENT. QRCS DISCLAIMS ALL
 * LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING FROM THE USE OR MISUSE OF THIS SOFTWARE.
 *
 * FULL LICENSE:
 * This software is subject to the Quantum Resistant Cryptographic Solutions
 * Public Research and Evaluation License (QRCS-PREL), 2025-2026. The complete license terms
 * are provided in the accompanying LICENSE file or at https://www.qrcscorp.ca.
 *
 * Written by: John G. Underhill
 * Contact: contact@qrcscorp.ca
 */
 
#ifndef UDIF_ENCODE_H
#define UDIF_ENCODE_H
 
#include "udif.h"


//
//#define UDIF_TLV_CERT_SUITE_ID          1U
//#define UDIF_TLV_CERT_ROLE              2U
//#define UDIF_TLV_CERT_SERIAL            3U
//#define UDIF_TLV_CERT_ISSUER_SERIAL     4U
//#define UDIF_TLV_CERT_VALID_FROM        5U
//#define UDIF_TLV_CERT_VALID_TO          6U
//#define UDIF_TLV_CERT_PUBKEY            7U
//#define UDIF_TLV_CERT_POLICY_EPOCH      8U
//#define UDIF_TLV_CERT_CAP_BITMAP        9U
//#define UDIF_TLV_CERT_SIGNATURE         10U
//
//#define UDIF_TLV_CAP_VERBS              1U
//#define UDIF_TLV_CAP_SCOPES             2U
//#define UDIF_TLV_CAP_ISSUED_TO          3U
//#define UDIF_TLV_CAP_ISSUED_BY          4U
//#define UDIF_TLV_CAP_VALID_TO           5U
//#define UDIF_TLV_CAP_POLICY_EPOCH       6U
//#define UDIF_TLV_CAP_DIGEST             7U
//#define UDIF_TLV_CAP_TAG                8U
//
//#define UDIF_TLV_OBJ_SERIAL             1U
//#define UDIF_TLV_OBJ_TYPE_CODE          2U
//#define UDIF_TLV_OBJ_CREATOR_CERT       3U
//#define UDIF_TLV_OBJ_ATTR_ROOT          4U
//#define UDIF_TLV_OBJ_CURRENT_OWNER      5U
//#define UDIF_TLV_OBJ_CREATED_AT         6U
//#define UDIF_TLV_OBJ_UPDATED_AT         7U
//#define UDIF_TLV_OBJ_FLAGS              8U
//#define UDIF_TLV_OBJ_SIGNATURE          9U
//
//#define UDIF_TLV_ANCHOR_CHILD_SERIAL    1U
//#define UDIF_TLV_ANCHOR_SEQ             2U
//#define UDIF_TLV_ANCHOR_TIMESTAMP       3U
//#define UDIF_TLV_ANCHOR_REGROOT         4U
//#define UDIF_TLV_ANCHOR_TXROOT          5U
//#define UDIF_TLV_ANCHOR_MROOT           6U
//#define UDIF_TLV_ANCHOR_REG_COUNT       7U
//#define UDIF_TLV_ANCHOR_TX_COUNT        8U
//#define UDIF_TLV_ANCHOR_MEM_COUNT       9U
//#define UDIF_TLV_ANCHOR_SIGNATURE       10U
//
//#define UDIF_CERT_SUITE_ID_ENCODED_SIZE 3U
//#define UDIF_CERT_ROLE_ENCODED_SIZE 3U
//#define UDIF_CERT_SERIAL_ENCODED_SIZE 18U
//#define UDIF_CERT_VALID_FROM_ENCODED_SIZE 10U
//#define UDIF_CERT_VALID_TO_ENCODED_SIZE 10U
//#define UDIF_CERT_PUBLIC_KEY_ENCODED_SIZE (UDIF_ASYMMETRIC_VERIFICATION_KEY_SIZE + 2U)
//#define UDIF_CERT_POLICY_ENCODED_EPOCH 6U
//#define UDIF_CERT_CAP_BITMAP_ENCODED_EPOCH 10U
//
//#define UDIF_ENCODED_CERTIFICATE_SIZE (UDIF_CERT_SUITE_ID_ENCODED_SIZE + UDIF_CERT_ROLE_ENCODED_SIZE + UDIF_CERT_SERIAL_ENCODED_SIZE + \
//  UDIF_CERT_SERIAL_ENCODED_SIZE + UDIF_CERT_VALID_FROM_ENCODED_SIZE + UDIF_CERT_VALID_TO_ENCODED_SIZE + UDIF_CERT_PUBLIC_KEY_ENCODED_SIZE + \
//  UDIF_CERT_POLICY_ENCODED_EPOCH + UDIF_CERT_CAP_BITMAP_ENCODED_EPOCH)
//
//* \brief Encode a uvarint
//*
//* Encodes a 64-bit value as a minimal-length uvarint.
//*
//* \param output: The output buffer (max 9 bytes)
//* \param value: The value to encode
//*
//* \return The number of bytes written
//*/
//UDIF_EXPORT_API size_t udif_encode_uvarint(uint8_t* output, uint64_t value);
//
//* \brief Decode a uvarint
//*
//* Decodes a uvarint from the input buffer.
//*
//* \param value: Pointer to receive the decoded value
//* \param input: [const] The input buffer
//* \param inlen: The input buffer length
//*
//* \return The number of bytes consumed (0 on error)
//*/
//UDIF_EXPORT_API size_t udif_decode_uvarint(uint64_t* value, const uint8_t* input, size_t inlen);
//
//* \brief Encode a TLV field
//*
//* Encodes a single TLV field to the output buffer.
//*
//* \param output: The output buffer
//* \param outlen: The output buffer length
//* \param tag: The field tag
//* \param value: [const] The field value
//* \param vallen: The value length
//*
//* \return The number of bytes written (0 on error)
//*/
//UDIF_EXPORT_API size_t udif_encode_tlv(uint8_t* output, size_t outlen, uint64_t tag, const uint8_t* value, size_t vallen);
//
//* \brief Decode a TLV field
//*
//* Decodes a single TLV field from the input buffer.
//*
//* \param tag: Pointer to receive the tag
//* \param value: Pointer to receive value pointer (points into input)
//* \param vallen: Pointer to receive value length
//* \param input: [const] The input buffer
//* \param inlen: The input buffer length
//* \param consumed: Pointer to receive bytes consumed
//*
//* \return Returns true on success
//*/
//UDIF_EXPORT_API bool udif_decode_tlv(uint64_t* tag, const uint8_t** value, size_t* vallen, const uint8_t* input, size_t inlen, size_t* consumed);
//
//* \brief Encode a uint8 value as TLV
//*
//* \param output: The output buffer
//* \param outlen: The output buffer length
//* \param tag: The field tag
//* \param value: The uint8 value
//*
//* \return The number of bytes written
//*/
//UDIF_EXPORT_API size_t udif_encode_tlv_uint8(uint8_t* output, size_t outlen, uint64_t tag, uint8_t value);
//
//* \brief Encode a uint32 value as TLV
//*
//* \param output: The output buffer
//* \param outlen: The output buffer length
//* \param tag: The field tag
//* \param value: The uint32 value
//*
//* \return The number of bytes written
//*/
//UDIF_EXPORT_API size_t udif_encode_tlv_uint32(uint8_t* output, size_t outlen, uint64_t tag, uint32_t value);
//
//* \brief Encode a uint64 value as TLV
//*
//* \param output: The output buffer
//* \param outlen: The output buffer length
//* \param tag: The field tag
//* \param value: The uint64 value
//*
//* \return The number of bytes written
//*/
//UDIF_EXPORT_API size_t udif_encode_tlv_uint64(uint8_t* output, size_t outlen, uint64_t tag, uint64_t value);
//
//* \brief Decode a uint8 value from TLV
//*
//* \param value: Pointer to receive the value
//* \param input: [const] The input buffer
//* \param inlen: The input buffer length
//* \param expected_tag: The expected tag value
//*
//* \return Returns true on success
//*/
//UDIF_EXPORT_API bool udif_decode_tlv_uint8(uint8_t* value, const uint8_t* input, size_t inlen, uint64_t expected_tag);
//
//* \brief Decode a uint32 value from TLV
//*
//* \param value: Pointer to receive the value
//* \param input: [const] The input buffer
//* \param inlen: The input buffer length
//* \param expected_tag: The expected tag value
//*
//* \return Returns true on success
//*/
//UDIF_EXPORT_API bool udif_decode_tlv_uint32(uint32_t* value, const uint8_t* input, size_t inlen, uint64_t expected_tag);
//
//* \brief Decode a uint64 value from TLV
//*
//* \param value: Pointer to receive the value
//* \param input: [const] The input buffer
//* \param inlen: The input buffer length
//* \param expected_tag: The expected tag value
//*
//* \return Returns true on success
//*/
//UDIF_EXPORT_API bool udif_decode_tlv_uint64(uint64_t* value, const uint8_t* input, size_t inlen, uint64_t expected_tag);
 
#endif