utils.h

/* 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_UTILS_H
#define HKDS_UTILS_H
 
#include "common.h"
#include <time.h>
#if defined(SYSTEM_OS_WINDOWS)
#   include <Windows.h>
#   if defined(SYSTEM_COMPILER_MSC)
#       pragma comment(lib, "advapi32.lib")
#   endif
#else
#   include <sys/types.h>
#   include <sys/stat.h>
#   include <errno.h>
#   include <fcntl.h>
#   include <limits.h>
#   include <stdlib.h>
#   include <stdio.h>
#   include <sys/types.h>
#   include <unistd.h>
#   if !defined(O_NOCTTY)
#       define O_NOCTTY 0
#   endif
#endif
 
#if defined(__OpenBSD__) || defined(__CloudABI__) || defined(__wasi__)
#   define HAVE_SAFE_ARC4RANDOM
#endif


#define UTILS_TOKEN_NOT_FOUND -1

#define UTILS_STRING_MAX_LEN 4096

#define UTILS_CPUIDEX_SERIAL_SIZE 12

#if defined(SYSTEM_OS_APPLE) && defined(SYSTEM_COMPILER_GCC)
#   define UTILS_CPUIDEX_VENDOR_SIZE 32
#else
#   define UTILS_CPUIDEX_VENDOR_SIZE 12
#endif

typedef enum utils_cpu_maker
{
    hkds_cpuid_unknown = 0,                  
    hkds_cpuid_amd = 1,                      
    hkds_cpuid_intel = 2,                    
    hkds_cpuid_via = 3,                      
    hkds_cpuid_hygion = 4,                   
} utils_cpu_maker;

HKDS_EXPORT_API typedef struct utils_cpu_features
{
    bool adx;                                    
    bool aesni;                                    
    bool pcmul;                                
 
    bool armv7;                                 
    bool neon;                                  
    bool sha256;                                
    bool sha512;                                
    bool sha3;                                  
 
    bool avx;                                
    bool avx2;                                  
    bool avx512f;                            
    bool hyperthread;                        
    bool rdrand;                              
    bool rdtcsp;                              
 
    uint32_t cacheline;                        
    uint32_t cores;                            
    uint32_t cpus;                              
    uint32_t freqbase;                          
    uint32_t freqmax;                        
    uint32_t freqref;                        
    uint32_t l1cache;                        
    uint32_t l1cacheline;                    
    uint32_t l2associative;                    
    uint32_t l2cache;                        
    char serial[UTILS_CPUIDEX_SERIAL_SIZE];       
    char vendor[UTILS_CPUIDEX_VENDOR_SIZE];       
    utils_cpu_maker cputype;                 
} utils_cpu_features;

#define UTILS_SEED_MAX 1024000
 
/* pseudo-random generation */

HKDS_EXPORT_API bool utils_seed_generate(uint8_t* output, size_t length);
 
/* cpuid */

HKDS_EXPORT_API bool utils_cpu_features_set(utils_cpu_features* const features);
 
/* console functions */

HKDS_EXPORT_API void utils_hex_to_bin(const char* hexstr, uint8_t* output, size_t length);

HKDS_EXPORT_API void utils_print_safe(const char* input);

HKDS_EXPORT_API void utils_print_line(const char* input);
 
/* timer functions */

HKDS_EXPORT_API uint64_t utils_stopwatch_start();

HKDS_EXPORT_API uint64_t utils_stopwatch_elapsed(uint64_t start);
 
/* string functions */

HKDS_EXPORT_API int64_t utils_find_string(const char* source, const char* token);

HKDS_EXPORT_API bool utils_string_contains(const char* source, const char* token);

HKDS_EXPORT_API size_t utils_string_size(const char* source);

HKDS_EXPORT_API void utils_string_to_lowercase(char* source);
 
/* memory functions */

HKDS_EXPORT_API void utils_memory_clear(void* output, size_t length);

HKDS_EXPORT_API void utils_memory_aligned_free(void* block);

HKDS_EXPORT_API void* utils_memory_aligned_alloc(int32_t align, size_t length);

HKDS_EXPORT_API bool utils_memory_are_equal(const uint8_t* a, const uint8_t* b, size_t length);

HKDS_EXPORT_API bool utils_memory_are_equal_128(const uint8_t* a, const uint8_t* b);

HKDS_EXPORT_API bool utils_memory_are_equal_256(const uint8_t* a, const uint8_t* b);

HKDS_EXPORT_API bool utils_memory_are_equal_512(const uint8_t* a, const uint8_t* b);

HKDS_EXPORT_API void utils_memory_copy(void* output, const void* input, size_t length);

HKDS_EXPORT_API void utils_memory_xor(uint8_t* output, const uint8_t* input, size_t length);
 
/* integer functions */
HKDS_EXPORT_API uint32_t utils_integer_be8to32(const uint8_t* input);

HKDS_EXPORT_API void utils_integer_be32to8(uint8_t* output, uint32_t value);

HKDS_EXPORT_API uint64_t utils_integer_le8to64(const uint8_t* input);

HKDS_EXPORT_API void utils_integer_le64to8(uint8_t* output, uint64_t value);

HKDS_EXPORT_API void utils_integer_be8increment(uint8_t* output, size_t otplen);

HKDS_EXPORT_API uint64_t utils_integer_rotl64(uint64_t value, size_t shift);

HKDS_EXPORT_API int32_t utils_integer_verify(const uint8_t* a, const uint8_t* b, size_t length);
 
#endif