UDIF: Universal Digital Identification Framework 1.0.0.0a (A1)
A quantum-secure cryptographic identification
crypto.h
Go to the documentation of this file.
1/* 2025-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 UDIF_CRYPTO_H
53#define UDIF_CRYPTO_H
54
55#include "udifcommon.h"
56#include "udif.h"
57
91
96#define UDIF_CRYPTO_PHASH_CPU_COST 4U
97
102#define UDIF_CRYPTO_PHASH_MEMORY_COST 1U
103
114UDIF_EXPORT_API bool udif_crypto_decrypt_stream(uint8_t* output, const uint8_t* seed, const uint8_t* input, size_t length);
115
124UDIF_EXPORT_API void udif_crypto_encrypt_stream(uint8_t* output, const uint8_t* seed, const uint8_t* input, size_t length);
125
139UDIF_EXPORT_API void udif_crypto_generate_application_keychain(uint8_t* seed, size_t seedlen, const char* password, size_t passlen, const char* username, size_t userlen);
140
150UDIF_EXPORT_API void udif_crypto_generate_application_salt(uint8_t* output, size_t outlen);
151
161UDIF_EXPORT_API void udif_crypto_generate_hash_code(uint8_t* output, const uint8_t* message, size_t msglen);
162
175UDIF_EXPORT_API void udif_crypto_generate_mac_code(uint8_t* output, size_t outlen, const uint8_t* message, size_t msglen, const uint8_t* key, size_t keylen);
176
189UDIF_EXPORT_API void udif_crypto_hash_password(uint8_t* output, size_t outlen, const uint8_t* username, size_t userlen, const uint8_t* password, size_t passlen);
190
202UDIF_EXPORT_API bool udif_crypto_password_minimum_check(const char* password, size_t passlen);
203
218UDIF_EXPORT_API bool udif_crypto_password_verify(const uint8_t* username, size_t userlen, const uint8_t* password, size_t passlen, const uint8_t* hash, size_t hashlen);
219
230
239UDIF_EXPORT_API void udif_crypto_secure_memory_deallocate(uint8_t* block, size_t length);
240
241#endif
UDIF_EXPORT_API void udif_crypto_generate_hash_code(uint8_t *output, const uint8_t *message, size_t msglen)
Hash a message and write the resulting hash to an output array.
Definition crypto.c:143
UDIF_EXPORT_API void udif_crypto_generate_application_salt(uint8_t *output, size_t outlen)
Generate a user-unique application salt from OS sources.
Definition crypto.c:123
UDIF_EXPORT_API bool udif_crypto_password_verify(const uint8_t *username, size_t userlen, const uint8_t *password, size_t passlen, const uint8_t *hash, size_t hashlen)
Verify a password against a stored hash.
Definition crypto.c:237
UDIF_EXPORT_API void udif_crypto_hash_password(uint8_t *output, size_t outlen, const uint8_t *username, size_t userlen, const uint8_t *password, size_t passlen)
Hash a password and user name.
Definition crypto.c:170
UDIF_EXPORT_API void udif_crypto_secure_memory_deallocate(uint8_t *block, size_t length)
Release an allocated block of secure memory.
Definition crypto.c:31
UDIF_EXPORT_API void udif_crypto_generate_application_keychain(uint8_t *seed, size_t seedlen, const char *password, size_t passlen, const char *username, size_t userlen)
Generate a secure application key chain.
Definition crypto.c:44
UDIF_EXPORT_API bool udif_crypto_decrypt_stream(uint8_t *output, const uint8_t *seed, const uint8_t *input, size_t length)
Decrypt a stream of bytes.
Definition crypto.c:69
UDIF_EXPORT_API bool udif_crypto_password_minimum_check(const char *password, size_t passlen)
Check a password for a minimum secure threshold.
Definition crypto.c:188
UDIF_EXPORT_API void udif_crypto_generate_mac_code(uint8_t *output, size_t outlen, const uint8_t *message, size_t msglen, const uint8_t *key, size_t keylen)
Compute a MAC (Message Authentication Code) for a message.
Definition crypto.c:155
UDIF_EXPORT_API uint8_t * udif_crypto_secure_memory_allocate(size_t length)
Allocate a block of secure memory.
Definition crypto.c:10
UDIF_EXPORT_API void udif_crypto_encrypt_stream(uint8_t *output, const uint8_t *seed, const uint8_t *input, size_t length)
Encrypt a stream of bytes.
Definition crypto.c:99
UDIF Common Definitions and Protocol Configuration.
UDIF common definitions and constants.
#define UDIF_EXPORT_API
The api export prefix.
Definition udifcommon.h:103