hkds_config.h

Go to the documentation of this file.

/* 2025 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 within this implementation 
 * are proprietary to QRCS and its authorized licensors and are protected under 
 * applicable U.S. and international copyright, patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC STANDARDS:
 * - This software includes implementations of cryptographic algorithms such as 
 *   SHA3, AES, and others. These algorithms are public domain or standardized 
 *   by organizations such as NIST and are NOT the property of QRCS.
 * - However, all source code, optimizations, and implementations in this library 
 *   are original works of QRCS and are protected under this license.
 *
 * RESTRICTIONS:
 * - Redistribution, modification, or unauthorized distribution of this software, 
 *   in whole or in part, is strictly prohibited.
 * - This software is provided for non-commercial, educational, and research 
 *   purposes only. Commercial use in any form is expressly forbidden.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 * - Any use of this software implies acceptance of these restrictions.
 *
 * DISCLAIMER:
 * This software is provided "as is," without warranty of any kind, express or 
 * implied, including but not limited to warranties of merchantability or fitness 
 * for a particular purpose. QRCS disclaims all liability for any direct, indirect, 
 * incidental, or consequential damages resulting from the use or misuse of this software.
 *
 * FULL LICENSE:
 * This software is subject to the **Quantum Resistant Cryptographic Solutions 
 * Proprietary License (QRCS-PL)**. The complete license terms are included 
 * in the LICENSE.txt file distributed with this software.
 *
 * Written by: John G. Underhill
 * Contact: john.underhill@protonmail.com
 */
 
#ifndef HKDS_CONFIG_H
#define HKDS_CONFIG_H
 
#include "common.h"

 
/*** Enumerations ***/

typedef enum hkds_packet_type
{
    packet_token_request         = 0x01,    
    packet_token_response        = 0x02,    
    packet_message_request       = 0x03,    
    packet_message_response      = 0x04,    
    packet_administrative_message= 0x05,    
    packet_error_message         = 0x06     
} hkds_packet_type;

typedef enum hkds_protocol_id
{
    protocol_shake_128 = 0x09,    
    protocol_shake_256 = 0x0A,    
    protocol_shake_512 = 0x0B     
} hkds_protocol_id;

typedef enum hkds_error_type
{
    error_general_failure       = 0x1F,    
    error_connection_aborted    = 0x21,    
    error_disconnected          = 0x22,    
    error_connection_refused    = 0x23,    
    error_invalid_format        = 0x24,    
    error_retries_exceeded      = 0x25,    
    error_connection_failure    = 0x26,    
    error_unkown_failure        = 0xFF     
} hkds_error_type;

typedef enum hkds_message_type
{
    message_synchronize_token      = 0x01,   
    message_reinitialized_token    = 0x02,   
    message_token_requests_exceeded= 0x03,   
    message_remote_reset           = 0x04,   
    message_diagnostic             = 0x05,   
    message_reserved1              = 0x06,   
    message_reserved2              = 0x07,   
    message_reserved3              = 0x08    
} hkds_message_type;
 
/*** Modifiable Values ***/

//#define HKDS_KECCAK_DOUBLE_ROUNDS

//#define HKDS_KECCAK_HALF_ROUNDS

//#define HKDS_SHAKE_128

#define HKDS_SHAKE_256

//#define HKDS_SHAKE_512

#define HKDS_CACHE_MULTIPLIER 4
 
/*** Static Values (Do Not Change) ***/

#define HKDS_ADMIN_SIZE 2

#define HKDS_AUTHENTICATION_KMAC 0x11

#define HKDS_AUTHENTICATION_NONE 0x10

#define HKDS_AUTHENTICATION_SHA3 0x12

#define HKDS_PARALLEL_DEPTH 8

#define HKDS_CACHX8_DEPTH 8

#define HKDS_CACHX64_SIZE 64

#define HKDS_CTOK_SIZE 23

#define HKDS_DID_SIZE 12

#define HKDS_ERROR_SIZE 16

#define HKDS_HEADER_SIZE 4

#define HKDS_KID_SIZE 4

#define HKDS_KSN_SIZE 16

#define HKDS_MESSAGE_SIZE 16

#define HKDS_NAME_SIZE 7

#define HKDS_TAG_SIZE 16

#define HKDS_TKC_SIZE 4

#define HKDS_TMS_SIZE (HKDS_KSN_SIZE + HKDS_NAME_SIZE)
 
#if defined(HKDS_SHAKE_128)

#   define HKDS_BDK_SIZE 16

#   define HKDS_EDK_SIZE 16

#   define HKDS_ETOK_SIZE 32

#   define HKDS_PRF_RATE 168

#   define HKDS_PROTOCOL_TYPE protocol_shake_128

#   define HKDS_STK_SIZE 16

static const uint8_t hkds_formal_name[HKDS_NAME_SIZE] = { 0x48, 0x4B, 0x44, 0x53, 0x31, 0x32, 0x38 };

static const uint8_t hkds_mac_name[HKDS_NAME_SIZE] = { 0x75, 0x4B, 0x77, 0x65, 0x31, 0x32, 0x38 };
 
#elif defined(HKDS_SHAKE_256)

#   define HKDS_BDK_SIZE 32

#   define HKDS_EDK_SIZE 32

#   define HKDS_ETOK_SIZE 48

#   define HKDS_PRF_RATE 136

#   define HKDS_PROTOCOL_TYPE protocol_shake_256

#   define HKDS_STK_SIZE 32

static const uint8_t hkds_formal_name[HKDS_NAME_SIZE] = { 0x48, 0x4B, 0x44, 0x53, 0x32, 0x35, 0x36 };

static const uint8_t hkds_mac_name[HKDS_NAME_SIZE] = { 0x75, 0x4B, 0x77, 0x65, 0x32, 0x35, 0x36 };
 
#elif defined(HKDS_SHAKE_512)

#   define HKDS_BDK_SIZE 64

#   define HKDS_EDK_SIZE 64

#   define HKDS_ETOK_SIZE 80

#   define HKDS_PRF_RATE 72

#   define HKDS_PROTOCOL_TYPE protocol_shake_512

#   define HKDS_STK_SIZE 64

static const uint8_t hkds_formal_name[HKDS_NAME_SIZE] = { 0x48, 0x4B, 0x44, 0x53, 0x35, 0x31, 0x32 };

static const uint8_t hkds_mac_name[HKDS_NAME_SIZE] = { 0x75, 0x4B, 0x77, 0x65, 0x35, 0x31, 0x32 };
 
#endif

#define HKDS_CACHE_SIZE ((HKDS_CACHE_MULTIPLIER * HKDS_PRF_RATE) / HKDS_MESSAGE_SIZE)

#define HKDS_CLIENT_MESSAGE_REQUEST_SIZE (HKDS_HEADER_SIZE + HKDS_KSN_SIZE + HKDS_MESSAGE_SIZE + HKDS_TAG_SIZE)

#define HKDS_CLIENT_TOKEN_REQUEST_SIZE (HKDS_HEADER_SIZE + HKDS_KSN_SIZE)

#define HKDS_SERVER_MESSAGE_RESPONSE_SIZE (HKDS_HEADER_SIZE + HKDS_MESSAGE_SIZE)

#define HKDS_SERVER_TOKEN_RESPONSE_SIZE (HKDS_HEADER_SIZE + HKDS_ETOK_SIZE)

#define HKDS_ADMIN_MESSAGE_SIZE (HKDS_HEADER_SIZE + HKDS_ADMIN_SIZE)

#define HKDS_ERROR_MESSAGE_SIZE (HKDS_HEADER_SIZE + HKDS_ERROR_SIZE)
 
/*** Packet Headers ***/

typedef struct
{
    hkds_packet_type flag;      
    hkds_protocol_id protocol;  
    uint8_t sequence;           
    uint8_t length;             
} hkds_packet_header;

typedef struct
{
    hkds_packet_header header;         
    uint8_t ksn[HKDS_KSN_SIZE];         
    uint8_t message[HKDS_MESSAGE_SIZE];  
    uint8_t tag[HKDS_TAG_SIZE];          
} hkds_client_message_request;

typedef struct
{
    hkds_packet_header header;         
    uint8_t ksn[HKDS_KSN_SIZE];         
} hkds_client_token_request;

typedef struct
{
    hkds_packet_header header;         
    uint8_t message[HKDS_MESSAGE_SIZE];  
} hkds_server_message_response;

typedef struct
{
    hkds_packet_header header;         
    uint8_t etok[HKDS_ETOK_SIZE];        
} hkds_server_token_response;

typedef struct
{
    hkds_packet_header header;         
    uint8_t message[HKDS_ADMIN_SIZE];    
} hkds_administrative_message;

typedef struct
{
    hkds_packet_header header;         
    uint8_t message[HKDS_ERROR_SIZE];    
} hkds_error_message;
 
 
#endif