UDIF: Universal Digital Identification Framework 1.0.0.0a (A1)
A quantum-secure cryptographic identification
certificate.h
Go to the documentation of this file.
1/* 2025 Quantum Resistant Cryptographic Solutions Corporation
2 * All Rights Reserved.
3 *
4 * NOTICE: This software and all accompanying materials are the exclusive
5 * property of Quantum Resistant Cryptographic Solutions Corporation (QRCS).
6 * The intellectual and technical concepts contained within this implementation
7 * are proprietary to QRCS and its authorized licensors and are protected under
8 * applicable U.S. and international copyright, patent, and trade secret laws.
9 *
10 * CRYPTOGRAPHIC STANDAARS:
11 * - This software includes implementations of cryptographic algorithms such as
12 * SHA3, AES, and others. These algorithms are public domain or standardized
13 * by organizations such as NIST and are NOT the property of QRCS.
14 * - However, all source code, optimizations, and implementations in this library
15 * are original works of QRCS and are protected under this license.
16 *
17 * RESTRICTIONS:
18 * - Redistribution, modification, or unauthorized distribution of this software,
19 * in whole or in part, is strictly prohibited.
20 * - This software is provided for non-commercial, educational, and research
21 * purposes only. Commercial use in any form is expressly forbidden.
22 * - Licensing and authorized distribution are solely at the discretion of QRCS.
23 * - Any use of this software implies acceptance of these restrictions.
24 *
25 * DISCLAIMER:
26 * This software is provided "as is," without warranty of any kind, express or
27 * implied, including but not limited to warranties of merchantability or fitness
28 * for a particular purpose. QRCS disclaims all liability for any direct, indirect,
29 * incidental, or consequential damages resulting from the use or misuse of this software.
30 *
31 * FULL LICENSE:
32 * This software is subject to the **Quantum Resistant Cryptographic Solutions
33 * Proprietary License (QRCS-PL)**. The complete license terms are included
34 * in the LICENSE.txt file distributed with this software.
35 *
36 * Written by: John G. Underhill
37 * Contact: contact@qrcscorp.ca
38 */
39
40#ifndef UDIF_CERTIFICATE_H
41#define UDIF_CERTIFICATE_H
42
43#include "udif.h"
44
96
97
98/* Function Prototypes */
99
108
117
124UDIF_EXPORT_API void udif_certificate_algorithm_encode(char* name, udif_configuration_sets conf);
125
137UDIF_EXPORT_API bool udif_certificate_child_are_equal(const udif_child_certificate* a, const udif_child_certificate* b);
138
148UDIF_EXPORT_API void udif_certificate_child_copy(udif_child_certificate* output, const udif_child_certificate* input);
149
162UDIF_EXPORT_API void udif_certificate_child_create(udif_child_certificate* child, const uint8_t* pubkey, const udif_certificate_expiration* expiration,
163 const char* issuer, udif_network_designations designation, const uint8_t* capability);
164
176UDIF_EXPORT_API bool udif_certificate_child_decode(udif_child_certificate* child, const char enck[UDIF_CHILD_CERTIFICATE_STRING_SIZE]);
177
186UDIF_EXPORT_API void udif_certificate_child_deserialize(udif_child_certificate* child, const uint8_t* input);
187
198UDIF_EXPORT_API size_t udif_certificate_child_encode(char enck[UDIF_CHILD_CERTIFICATE_STRING_SIZE], const udif_child_certificate* child);
199
207UDIF_EXPORT_API void udif_certificate_child_erase(udif_child_certificate* child);
208
220UDIF_EXPORT_API bool udif_certificate_child_file_to_struct(const char* fpath, udif_child_certificate* child);
221
231UDIF_EXPORT_API void udif_certificate_child_hash(uint8_t* output, const udif_child_certificate* child);
232
243UDIF_EXPORT_API bool udif_certificate_child_is_valid(const udif_child_certificate* child);
244
259UDIF_EXPORT_API bool udif_certificate_child_message_verify(uint8_t* message, size_t* msglen, const uint8_t* signature, size_t siglen, const udif_child_certificate* child);
260
267UDIF_EXPORT_API void udif_certificate_child_serialize(uint8_t* output, const udif_child_certificate* child);
268
283UDIF_EXPORT_API bool udif_certificate_signature_hash_verify(const uint8_t* signature, size_t siglen, const uint8_t* message, size_t msglen, const udif_child_certificate* lcert);
284
293UDIF_EXPORT_API bool udif_certificate_child_struct_to_file(const char* fpath, const udif_child_certificate* child);
294
303
312UDIF_EXPORT_API size_t udif_certificate_designation_encode(char* sdsg, udif_network_designations designation);
313
323UDIF_EXPORT_API void udif_certificate_expiration_set_days(udif_certificate_expiration* expiration, uint16_t start, uint16_t duration);
324
332UDIF_EXPORT_API void udif_certificate_expiration_set_seconds(udif_certificate_expiration* expiration, uint64_t start, uint64_t period);
333
341UDIF_EXPORT_API bool udif_certificate_expiration_time_verify(const udif_certificate_expiration* expiration);
342
356UDIF_EXPORT_API size_t udif_certificate_message_hash_sign(uint8_t* signature, const uint8_t* sigkey, const uint8_t* message, size_t msglen);
357
368UDIF_EXPORT_API bool udif_certificate_root_compare(const udif_root_certificate* a, const udif_root_certificate* b);
369
381UDIF_EXPORT_API void udif_certificate_root_create(udif_root_certificate* root, const uint8_t* pubkey, const udif_certificate_expiration* expiration, const char* issuer);
382
393UDIF_EXPORT_API bool udif_certificate_root_decode(udif_root_certificate* root, const char* enck);
394
401UDIF_EXPORT_API void udif_certificate_root_deserialize(udif_root_certificate* root, const uint8_t* input);
402
413UDIF_EXPORT_API size_t udif_certificate_root_encode(char* enck, const udif_root_certificate* root);
414
422UDIF_EXPORT_API void udif_certificate_root_erase(udif_root_certificate* root);
423
432UDIF_EXPORT_API bool udif_certificate_root_file_to_struct(const char* fpath, udif_root_certificate* root);
433
443UDIF_EXPORT_API void udif_certificate_root_hash(uint8_t* output, const udif_root_certificate* root);
444
451UDIF_EXPORT_API void udif_certificate_root_serialize(uint8_t* output, const udif_root_certificate* root);
452
465UDIF_EXPORT_API size_t udif_certificate_root_sign(udif_child_certificate* child, const udif_root_certificate* root, const uint8_t* rsigkey);
466
478UDIF_EXPORT_API bool udif_certificate_root_signature_verify(const udif_child_certificate* child, const udif_root_certificate* root);
479
488UDIF_EXPORT_API bool udif_certificate_root_struct_to_file(const char* fpath, const udif_root_certificate* root);
489
500UDIF_EXPORT_API bool udif_certificate_root_is_valid(const udif_root_certificate* root);
501
510UDIF_EXPORT_API void udif_certificate_signature_generate_keypair(udif_signature_keypair* keypair);
511
522UDIF_EXPORT_API size_t udif_certificate_signature_sign_message(uint8_t* signature, const uint8_t* message, size_t msglen, const uint8_t* prikey);
523
535UDIF_EXPORT_API bool udif_certificate_signature_verify_message(const uint8_t* message, size_t msglen, const uint8_t* signature, size_t siglen, const uint8_t* pubkey);
536
537#if defined(UDIF_DEBUG_TESTS_RUN)
549UDIF_EXPORT_API bool udif_certificate_functions_test(void);
550#endif
551
552#endif
UDIF_EXPORT_API void udif_certificate_signature_generate_keypair(udif_signature_keypair *keypair)
Generate and encode an asymmetric signature scheme keypair.
UDIF_EXPORT_API void udif_certificate_root_hash(uint8_t *output, const udif_root_certificate *root)
Compute the cryptographic hash of a root certificate.
UDIF_EXPORT_API bool udif_certificate_algorithm_enabled(udif_configuration_sets conf)
Test if the specified protocol-set is enabled on this system.
UDIF_EXPORT_API bool udif_certificate_child_is_valid(const udif_child_certificate *child)
Test a child certificate for a valid format and expiration.
UDIF_EXPORT_API bool udif_certificate_child_message_verify(uint8_t *message, size_t *msglen, const uint8_t *signature, size_t siglen, const udif_child_certificate *child)
Verify a message signature using a child certificate.
UDIF_EXPORT_API size_t udif_certificate_designation_encode(char *sdsg, udif_network_designations designation)
Encode the network-designation enumerator into a string.
UDIF_EXPORT_API void udif_certificate_root_serialize(uint8_t *output, const udif_root_certificate *root)
Serialize a root certificate into a contiguous byte array.
UDIF_EXPORT_API void udif_certificate_child_copy(udif_child_certificate *output, const udif_child_certificate *input)
Copy a child certificate structure.
UDIF_EXPORT_API void udif_certificate_root_create(udif_root_certificate *root, const uint8_t *pubkey, const udif_certificate_expiration *expiration, const char *issuer)
Create a root certificate.
UDIF_EXPORT_API bool udif_certificate_child_are_equal(const udif_child_certificate *a, const udif_child_certificate *b)
Compare two child certificates for equivalence.
UDIF_EXPORT_API void udif_certificate_root_erase(udif_root_certificate *root)
Delete (erase) a root certificate.
UDIF_EXPORT_API size_t udif_certificate_root_sign(udif_child_certificate *child, const udif_root_certificate *root, const uint8_t *rsigkey)
Sign a child certificate with the root certificate.
UDIF_EXPORT_API void udif_certificate_child_erase(udif_child_certificate *child)
Delete (erase) a child certificate.
UDIF_EXPORT_API size_t udif_certificate_child_encode(char enck[UDIF_CHILD_CERTIFICATE_STRING_SIZE], const udif_child_certificate *child)
Encode a public child certificate into a human-readable string.
UDIF_EXPORT_API bool udif_certificate_root_compare(const udif_root_certificate *a, const udif_root_certificate *b)
Compare two root certificates for equivalence.
UDIF_EXPORT_API size_t udif_certificate_root_encode(char *enck, const udif_root_certificate *root)
Encode a public root certificate into a human-readable string.
UDIF_EXPORT_API bool udif_certificate_root_struct_to_file(const char *fpath, const udif_root_certificate *root)
Write a root certificate structure to a file.
UDIF_EXPORT_API udif_configuration_sets udif_certificate_algorithm_decode(const char *name)
Decode the string algorithm-set number to the enumerated representation.
UDIF_EXPORT_API void udif_certificate_algorithm_encode(char *name, udif_configuration_sets conf)
Encode the protocol-set enumerator into its string form.
UDIF_EXPORT_API void udif_certificate_child_serialize(uint8_t *output, const udif_child_certificate *child)
Serialize a child certificate into a contiguous byte array.
UDIF_EXPORT_API void udif_certificate_child_hash(uint8_t *output, const udif_child_certificate *child)
Compute the cryptographic hash of a child certificate.
UDIF_EXPORT_API void udif_certificate_child_create(udif_child_certificate *child, const uint8_t *pubkey, const udif_certificate_expiration *expiration, const char *issuer, udif_network_designations designation, const uint8_t *capability)
Create a child certificate.
UDIF_EXPORT_API bool udif_certificate_expiration_time_verify(const udif_certificate_expiration *expiration)
Verify the expiration time against the current UTC time.
UDIF_EXPORT_API void udif_certificate_expiration_set_seconds(udif_certificate_expiration *expiration, uint64_t start, uint64_t period)
Set the expiration seconds on a certificate expiration structure.
UDIF_EXPORT_API void udif_certificate_child_deserialize(udif_child_certificate *child, const uint8_t *input)
Deserialize a child certificate from a byte array.
UDIF_EXPORT_API bool udif_certificate_child_struct_to_file(const char *fpath, const udif_child_certificate *child)
Write a child certificate structure to a file.
UDIF_EXPORT_API bool udif_certificate_root_is_valid(const udif_root_certificate *root)
Validate a root certificate.
UDIF_EXPORT_API bool udif_certificate_root_decode(udif_root_certificate *root, const char *enck)
Decode a root certificate string into a certificate structure.
UDIF_EXPORT_API size_t udif_certificate_signature_sign_message(uint8_t *signature, const uint8_t *message, size_t msglen, const uint8_t *prikey)
Sign a message using the asymmetric signature scheme.
UDIF_EXPORT_API bool udif_certificate_root_file_to_struct(const char *fpath, udif_root_certificate *root)
Copy a serialized root certificate from a file into a root certificate structure.
UDIF_EXPORT_API size_t udif_certificate_message_hash_sign(uint8_t *signature, const uint8_t *sigkey, const uint8_t *message, size_t msglen)
Hash a message and sign the hash.
UDIF_EXPORT_API bool udif_certificate_child_decode(udif_child_certificate *child, const char enck[UDIF_CHILD_CERTIFICATE_STRING_SIZE])
Decode a child certificate string into a certificate structure.
UDIF_EXPORT_API void udif_certificate_root_deserialize(udif_root_certificate *root, const uint8_t *input)
Deserialize a root certificate from a byte array.
UDIF_EXPORT_API bool udif_certificate_signature_verify_message(const uint8_t *message, size_t msglen, const uint8_t *signature, size_t siglen, const uint8_t *pubkey)
Verify a message signature using the asymmetric signature scheme.
UDIF_EXPORT_API bool udif_certificate_child_file_to_struct(const char *fpath, udif_child_certificate *child)
Copy a serialized certificate from a file into a child certificate structure.
UDIF_EXPORT_API bool udif_certificate_signature_hash_verify(const uint8_t *signature, size_t siglen, const uint8_t *message, size_t msglen, const udif_child_certificate *lcert)
Verify that a signature hash matches a computed message hash using a child certificate.
UDIF_EXPORT_API void udif_certificate_expiration_set_days(udif_certificate_expiration *expiration, uint16_t start, uint16_t duration)
Set the expiration days on a certificate expiration structure.
UDIF_EXPORT_API udif_network_designations udif_certificate_designation_decode(const char *sdsg)
Decode the network-designation string to its enumerated representation.
UDIF_EXPORT_API bool udif_certificate_root_signature_verify(const udif_child_certificate *child, const udif_root_certificate *root)
Verify a child certificate against a root certificate.
UDIF Common Definitions and Core Library Configuration.
udif_network_designations
The UDIF device designation.
Definition udif.h:1297
udif_configuration_sets
The UDIF algorithm configuration sets.
Definition udif.h:1274