-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathpicocert.h
More file actions
593 lines (511 loc) · 19.9 KB
/
Copy pathpicocert.h
File metadata and controls
593 lines (511 loc) · 19.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
#pragma once
#include <assert.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#define PICOCERT_HASH_SHA256_DIGEST_SIZE 32
#define PICOCERT_ECC_SIG_SIZE 64
#define PICOCERT_ECC_PUBKEY_SIZE_ECDSA_UNCOMPRESSED 64
// Attribute macros
#ifdef __GNUC__
#define PICOCERT_PACKED __attribute__((packed))
#else
#define PICOCERT_PACKED
#endif
// Maximum length for names (issuer and subject) in the certificate
#define PICOCERT_MAX_NAME_LEN (32)
// Maximum length for the public key in the certificate
#define PICOCERT_MAX_PUBKEY_LEN (65) // Uncompressed SEC1 encoding
// Maximum length for the signature in the certificate
#define PICOCERT_MAX_SIG_LEN (64)
// Maximum length for certificate chains (prevents DoS attacks)
#define PICOCERT_MAX_CHAIN_LEN (10)
// Current version of the picocert library
#define PICOCERT_CURRENT_VERSION 1
typedef uint8_t picocert_curve_t;
enum {
PICOCERT_P256 = 0,
};
typedef uint8_t picocert_hash_t;
enum {
PICOCERT_SHA256 = 0,
};
typedef enum {
PICOCERT_OK = 0,
PICOCERT_ERR_INVALID = 1,
PICOCERT_ERR_EXPIRED = 2,
PICOCERT_ERR_SIGNATURE = 3,
PICOCERT_ERR_ISSUER = 4,
PICOCERT_ERR_VERSION = 5,
PICOCERT_ERR_RESERVED = 6,
PICOCERT_ERR_NOT_SELF_SIGNED = 7,
PICOCERT_ERR_INVALID_FORMAT = 8,
PICOCERT_ERR_CONTEXT_NOT_INITIALIZED = 9,
PICOCERT_ERR_HASH_FAILED = 10,
PICOCERT_ERR_UNSUPPORTED_CURVE = 11,
PICOCERT_ERR_UNSUPPORTED_HASH = 12,
PICOCERT_ERR_INVALID_VALIDITY_PERIOD = 13,
PICOCERT_ERR_CHAIN_TOO_LONG = 14,
PICOCERT_ERR_UNTRUSTED_ROOT = 15,
PICOCERT_ERR_UNKNOWN = 255,
} picocert_err_t;
typedef struct {
uint8_t version;
char issuer[PICOCERT_MAX_NAME_LEN];
char subject[PICOCERT_MAX_NAME_LEN];
uint64_t valid_from; // Start of the validity period
uint64_t valid_to; // End of the validity period
picocert_curve_t curve;
picocert_hash_t hash;
uint32_t reserved; // Reserved for future use, should be zero
uint8_t public_key[PICOCERT_MAX_PUBKEY_LEN];
uint8_t signature[PICOCERT_MAX_SIG_LEN];
} PICOCERT_PACKED picocert_t;
/*
* A certificate chain, stored as a contiguous array of picocert_t structures
* in memory, ordered from leaf to root
*/
typedef picocert_t* picocert_chain_t;
// System time callback function type. Could be unix timestamps, but any
// monotonic counter is fine.
typedef uint64_t (*picocert_time_fn_t)(void);
// =============================================================================
// ENDIANNESS CONVERSION HELPERS
// =============================================================================
// On-wire format is little-endian for better embedded compatibility
static inline uint64_t picocert_le64_to_host(const uint8_t* bytes) {
return ((uint64_t)bytes[0]) | ((uint64_t)bytes[1] << 8) |
((uint64_t)bytes[2] << 16) | ((uint64_t)bytes[3] << 24) |
((uint64_t)bytes[4] << 32) | ((uint64_t)bytes[5] << 40) |
((uint64_t)bytes[6] << 48) | ((uint64_t)bytes[7] << 56);
}
static inline void picocert_host_to_le64(uint64_t value, uint8_t* bytes) {
bytes[0] = (uint8_t)(value & 0xFF);
bytes[1] = (uint8_t)((value >> 8) & 0xFF);
bytes[2] = (uint8_t)((value >> 16) & 0xFF);
bytes[3] = (uint8_t)((value >> 24) & 0xFF);
bytes[4] = (uint8_t)((value >> 32) & 0xFF);
bytes[5] = (uint8_t)((value >> 40) & 0xFF);
bytes[6] = (uint8_t)((value >> 48) & 0xFF);
bytes[7] = (uint8_t)((value >> 56) & 0xFF);
}
static inline uint32_t picocert_le32_to_host(const uint8_t* bytes) {
return ((uint32_t)bytes[0]) | ((uint32_t)bytes[1] << 8) |
((uint32_t)bytes[2] << 16) | ((uint32_t)bytes[3] << 24);
}
static inline void picocert_host_to_le32(uint32_t value, uint8_t* bytes) {
bytes[0] = (uint8_t)(value & 0xFF);
bytes[1] = (uint8_t)((value >> 8) & 0xFF);
bytes[2] = (uint8_t)((value >> 16) & 0xFF);
bytes[3] = (uint8_t)((value >> 24) & 0xFF);
}
// =============================================================================
// SAFE ACCESSORS FOR POTENTIALLY UNALIGNED FIELDS
// =============================================================================
static inline uint64_t picocert_get_valid_from(const picocert_t* cert) {
return picocert_le64_to_host((const uint8_t*)&cert->valid_from);
}
static inline void picocert_set_valid_from(picocert_t* cert, uint64_t value) {
picocert_host_to_le64(value, (uint8_t*)&cert->valid_from);
}
static inline uint64_t picocert_get_valid_to(const picocert_t* cert) {
return picocert_le64_to_host((const uint8_t*)&cert->valid_to);
}
static inline void picocert_set_valid_to(picocert_t* cert, uint64_t value) {
picocert_host_to_le64(value, (uint8_t*)&cert->valid_to);
}
static inline uint32_t picocert_get_reserved(const picocert_t* cert) {
return picocert_le32_to_host((const uint8_t*)&cert->reserved);
}
static inline void picocert_set_reserved(picocert_t* cert, uint32_t value) {
picocert_host_to_le32(value, (uint8_t*)&cert->reserved);
}
// =============================================================================
// CRYPTO FUNCTION POINTER TYPES
// =============================================================================
/**
* Hash function pointer type
* @param data Input data to hash
* @param data_len Length of input data
* @param digest Output buffer for hash (must be at least
* PICOCERT_HASH_SHA256_DIGEST_SIZE bytes)
* @param digest_len Size of output buffer
* @return true on success, false on failure
*/
typedef bool (*picocert_hash_fn_t)(const uint8_t* data, uint32_t data_len,
uint8_t* digest, uint32_t digest_len);
/**
* ECC signature verification function pointer type
* @param key Pointer to the public key data (X,Y coordinates)
* @param key_size Size of the public key data
* @param hash Hash to verify (PICOCERT_HASH_SHA256_DIGEST_SIZE bytes)
* @param hash_len Length of hash
* @param signature Signature to verify (PICOCERT_ECC_SIG_SIZE bytes)
* @return true if signature is valid, false otherwise
*/
typedef bool (*picocert_ecc_verify_fn_t)(const uint8_t* key, size_t key_size,
const uint8_t* hash, uint32_t hash_len,
const uint8_t* signature);
// =============================================================================
// LIBRARY CONTEXT
// =============================================================================
typedef struct {
picocert_hash_fn_t hash_fn;
picocert_ecc_verify_fn_t ecc_verify_fn;
picocert_time_fn_t time_fn;
} picocert_context_t;
// =============================================================================
// HELPER FUNCTIONS
// =============================================================================
/**
* Extract public key from certificate
* @param cert Certificate containing the public key
* @param key_out Output parameter for pointer to key (X,Y coordinates)
* @param key_size_out Output parameter for key size
* @return PICOCERT_OK on success, error code on failure
*/
static inline picocert_err_t picocert_cert_to_key(const picocert_t* cert,
const uint8_t** key_out,
size_t* key_size_out) {
if (!cert || !key_out || !key_size_out) {
return PICOCERT_ERR_INVALID;
}
// Validate SEC1 uncompressed format (must start with 0x04)
if (cert->public_key[0] != 0x04) {
return PICOCERT_ERR_INVALID_FORMAT;
}
// Extract X,Y coordinates
*key_out = &cert->public_key[1];
*key_size_out = PICOCERT_ECC_PUBKEY_SIZE_ECDSA_UNCOMPRESSED;
return PICOCERT_OK;
}
static picocert_err_t picocert_current_time(const picocert_context_t* ctx,
uint64_t* time_out) {
if (!ctx || !time_out) {
return PICOCERT_ERR_INVALID;
}
if (!ctx->time_fn) {
return PICOCERT_ERR_INVALID;
}
*time_out = ctx->time_fn();
return PICOCERT_OK;
}
static bool picocert_is_self_signed(const picocert_t* cert) {
return (memcmp(cert->issuer, cert->subject, PICOCERT_MAX_NAME_LEN) == 0);
}
// =============================================================================
// CORE IMPLEMENTATION
// =============================================================================
/**
* @brief Verify that a certificate was properly signed by its issuer
*
* This function verifies that the certificate's signature was created by
* signing all the certificate data (except the signature field itself) with the
* issuer's private key.
*
* @param ctx Library context
* @param cert Certificate to verify (contains the signature to check)
* @param issuer Issuer certificate (contains the public key to verify against)
* @return PICOCERT_OK if signature is valid, error code otherwise
*/
static picocert_err_t picocert_verify_cert_signature(
const picocert_context_t* ctx, const picocert_t* cert,
const picocert_t* issuer) {
if (!ctx || !cert || !issuer) {
return PICOCERT_ERR_INVALID;
}
if (!ctx->hash_fn || !ctx->ecc_verify_fn) {
return PICOCERT_ERR_CONTEXT_NOT_INITIALIZED;
}
// Extract the signable data from the certificate (everything except
// signature)
const uint32_t signable_data_size = offsetof(picocert_t, signature);
// Hash the signable certificate data
uint8_t digest[PICOCERT_HASH_SHA256_DIGEST_SIZE] = {0};
if (!ctx->hash_fn((const uint8_t*)cert, signable_data_size, digest,
sizeof(digest))) {
return PICOCERT_ERR_HASH_FAILED;
}
// Verify the signature using issuer's public key
const uint8_t* pubkey;
size_t pubkey_size;
picocert_err_t key_err = picocert_cert_to_key(issuer, &pubkey, &pubkey_size);
if (key_err != PICOCERT_OK) {
return key_err;
}
if (!ctx->ecc_verify_fn(pubkey, pubkey_size, digest, PICOCERT_HASH_SHA256_DIGEST_SIZE,
cert->signature)) {
return PICOCERT_ERR_SIGNATURE;
}
return PICOCERT_OK;
}
// =============================================================================
// PUBLIC API
// =============================================================================
/**
* Initialize a picocert context with crypto function pointers
* @param ctx Context to initialize
* @param hash_fn Function pointer for SHA-256 hashing
* @param ecc_verify_fn Function pointer for ECC signature verification
* @param time_fn Optional time callback function (can be NULL)
* @return PICOCERT_OK on success, error code on failure
*/
static picocert_err_t __attribute__((unused)) picocert_init_context(
picocert_context_t* ctx, picocert_hash_fn_t hash_fn,
picocert_ecc_verify_fn_t ecc_verify_fn, picocert_time_fn_t time_fn) {
if (!ctx) {
return PICOCERT_ERR_INVALID;
}
if (!hash_fn || !ecc_verify_fn) {
// Reset context state on invalid initialization
ctx->hash_fn = NULL;
ctx->ecc_verify_fn = NULL;
ctx->time_fn = NULL;
return PICOCERT_ERR_INVALID;
}
ctx->hash_fn = hash_fn;
ctx->ecc_verify_fn = ecc_verify_fn;
ctx->time_fn = time_fn;
return PICOCERT_OK;
}
/**
* @brief Validate a single certificate against its issuer
*
* This function performs comprehensive validation of a certificate including:
* - Version compatibility check
* - Cryptographic algorithm support (curve and hash)
* - Reserved field validation
* - Certificate signature verification (that issuer signed the subject)
* - Issuer/subject name consistency
* - Validity period consistency (valid_from <= valid_to)
* - Certificate validity period (not expired)
*
* @param ctx Library context (must be initialized)
* @param issuer Issuer certificate (contains public key to verify subject's
* signature)
* @param subject Subject certificate to validate
* @return PICOCERT_OK if certificate is valid, error code otherwise
*/
static picocert_err_t picocert_validate_cert(picocert_context_t* ctx,
const picocert_t* issuer,
const picocert_t* subject) {
if (!ctx || !issuer || !subject) {
return PICOCERT_ERR_INVALID;
}
// Version check
if (issuer->version != PICOCERT_CURRENT_VERSION ||
subject->version != PICOCERT_CURRENT_VERSION) {
return PICOCERT_ERR_VERSION;
}
// Validate curve - only P256 is currently supported
if (issuer->curve != PICOCERT_P256 || subject->curve != PICOCERT_P256) {
return PICOCERT_ERR_UNSUPPORTED_CURVE;
}
// Validate hash algorithm - only SHA256 is currently supported
if (issuer->hash != PICOCERT_SHA256 || subject->hash != PICOCERT_SHA256) {
return PICOCERT_ERR_UNSUPPORTED_HASH;
}
// Reserved fields must be zero
if (picocert_get_reserved(issuer) != 0 ||
picocert_get_reserved(subject) != 0) {
return PICOCERT_ERR_RESERVED;
}
// Ensure validity periods are logical (start <= end)
if (picocert_get_valid_from(subject) > picocert_get_valid_to(subject)) {
return PICOCERT_ERR_INVALID_VALIDITY_PERIOD;
}
if (picocert_get_valid_from(issuer) > picocert_get_valid_to(issuer)) {
return PICOCERT_ERR_INVALID_VALIDITY_PERIOD;
}
// Ensure the issuer signed the subject's certificate
picocert_err_t err = picocert_verify_cert_signature(ctx, subject, issuer);
if (err != PICOCERT_OK) {
return err;
}
// Ensure the names match
if (memcmp(issuer->subject, subject->issuer, PICOCERT_MAX_NAME_LEN) != 0) {
return PICOCERT_ERR_ISSUER;
}
// Ensure the certificate is not expired
uint64_t now;
picocert_err_t time_err = picocert_current_time(ctx, &now);
if (time_err != PICOCERT_OK) {
return time_err;
}
if (now < picocert_get_valid_from(subject) ||
now > picocert_get_valid_to(subject)) {
return PICOCERT_ERR_EXPIRED;
}
if (now < picocert_get_valid_from(issuer) ||
now > picocert_get_valid_to(issuer)) {
return PICOCERT_ERR_EXPIRED;
}
return PICOCERT_OK;
}
/**
* @brief Validate a complete certificate chain
*
* This function validates a certificate chain from leaf to root by:
* - Enforcing maximum chain length (PICOCERT_MAX_CHAIN_LEN)
* - Requiring the terminal certificate to match a trusted root
* - Validating each certificate in the chain against its issuer
* - Ensuring the root certificate is self-signed
* - Validating the root certificate against itself
*
* The chain should be ordered from leaf certificate (index 0) to root
* certificate (index chain_len-1). Each certificate must be signed by
* the next certificate in the chain.
*
* @param ctx Library context (must be initialized)
* @param cert_chain Array of certificates ordered from leaf to root
* @param chain_len Number of certificates in the chain (1 <= chain_len <=
* PICOCERT_MAX_CHAIN_LEN)
* @param trust_anchor Independently provisioned root certificate to trust
* @return PICOCERT_OK if entire chain is valid, error code otherwise
*/
static picocert_err_t picocert_validate_cert_chain(picocert_context_t* ctx,
const picocert_t* cert_chain,
const uint32_t chain_len,
const picocert_t* trust_anchor) {
if (!ctx || !cert_chain || chain_len == 0 || !trust_anchor) {
return PICOCERT_ERR_INVALID;
}
// Enforce maximum chain length to prevent DoS attacks
if (chain_len > PICOCERT_MAX_CHAIN_LEN) {
return PICOCERT_ERR_CHAIN_TOO_LONG;
}
const picocert_t* root = &cert_chain[chain_len - 1];
if (memcmp(root, trust_anchor, sizeof(*root)) != 0) {
return PICOCERT_ERR_UNTRUSTED_ROOT;
}
// Verify each certificate in the chain
for (uint32_t i = 0; i < chain_len - 1; i++) {
const picocert_t* subject = &cert_chain[i];
const picocert_t* issuer = &cert_chain[i + 1];
picocert_err_t err = picocert_validate_cert(ctx, issuer, subject);
if (err != PICOCERT_OK) {
return err;
}
}
// Ensure the root certificate is self-signed
if (!picocert_is_self_signed(root)) {
return PICOCERT_ERR_NOT_SELF_SIGNED;
}
if (picocert_validate_cert(ctx, root, root) != PICOCERT_OK) {
return PICOCERT_ERR_SIGNATURE;
}
return PICOCERT_OK;
}
/**
* @brief Verify a signature against a hash using a certificate's public key
*
* @param ctx Library context
* @param cert Certificate containing the public key to use for verification
* @param hash SHA-256 hash of the data that was signed
* @param signature ECDSA signature to verify against the hash
* @return PICOCERT_OK if signature is valid, error code otherwise
*/
static picocert_err_t __attribute__((unused)) picocert_verify_hash(
picocert_context_t* ctx, const picocert_t* cert,
const uint8_t hash[PICOCERT_HASH_SHA256_DIGEST_SIZE],
const uint8_t signature[PICOCERT_ECC_SIG_SIZE]) {
if (!ctx || !cert || !hash) {
return PICOCERT_ERR_INVALID;
}
if (!ctx->hash_fn || !ctx->ecc_verify_fn) {
return PICOCERT_ERR_CONTEXT_NOT_INITIALIZED;
}
// Verify the signature
const uint8_t* pubkey;
size_t pubkey_size;
picocert_err_t key_err = picocert_cert_to_key(cert, &pubkey, &pubkey_size);
if (key_err != PICOCERT_OK) {
return key_err;
}
if (!ctx->ecc_verify_fn(pubkey, pubkey_size, hash, PICOCERT_HASH_SHA256_DIGEST_SIZE,
signature)) {
return PICOCERT_ERR_SIGNATURE;
}
return PICOCERT_OK;
}
/**
* Verify if a SHA-256 hash has been signed by the public key in the leaf
* certificate and ensure the certificate chains back to a root certificate.
*
* @param ctx Library context
* @param cert_chain Pointer to an array of certificates (chain), ending with
* the root certificate
* @param chain_len Length of the certificate chain
* @param trust_anchor Independently provisioned root certificate to trust
* @param hash Pointer to the SHA-256 hash of the data to verify
* @param signature Pointer to the signature of the hash
* @return PICOCERT_OK if verification is successful and the chain is
* valid, otherwise an error code
*/
static picocert_err_t __attribute__((unused)) picocert_verify_hash_and_validate_chain(
picocert_context_t* ctx, const picocert_t* cert_chain,
const uint32_t chain_len, const picocert_t* trust_anchor,
const uint8_t hash[PICOCERT_HASH_SHA256_DIGEST_SIZE],
const uint8_t signature[PICOCERT_ECC_SIG_SIZE]) {
if (!ctx || !cert_chain || chain_len == 0 || !trust_anchor || !hash ||
!signature) {
return PICOCERT_ERR_INVALID;
}
picocert_err_t err =
picocert_validate_cert_chain(ctx, cert_chain, chain_len, trust_anchor);
if (err != PICOCERT_OK) {
return err;
}
// Verify the signature against the hash
const uint8_t* pubkey;
size_t pubkey_size;
picocert_err_t key_err =
picocert_cert_to_key(&cert_chain[0], &pubkey, &pubkey_size);
if (key_err != PICOCERT_OK) {
return key_err;
}
if (!ctx->ecc_verify_fn(pubkey, pubkey_size, hash, PICOCERT_HASH_SHA256_DIGEST_SIZE,
signature)) {
return PICOCERT_ERR_SIGNATURE;
}
return PICOCERT_OK;
}
static void picocert_print_key_bytes(const uint8_t* key,
const size_t key_size) {
for (size_t i = 0; i < key_size; i++) {
printf("%02x", key[i]);
if ((i + 1) % 32 == 0 && i + 1 < key_size) {
printf("\n ");
}
}
printf("\n");
}
/**
* @brief Print the contents of a certificate in a human-readable format.
*
* @param cert Pointer to the certificate to print
*/
static void __attribute__((unused)) picocert_print_cert(const picocert_t* cert) {
if (!cert) {
return;
}
printf("Certificate:\n");
printf(" Version: %u\n", cert->version);
printf(" Issuer: %.*s\n", PICOCERT_MAX_NAME_LEN, cert->issuer);
printf(" Subject: %.*s\n", PICOCERT_MAX_NAME_LEN, cert->subject);
printf(" Valid From: %llu\n",
(unsigned long long)picocert_get_valid_from(cert));
printf(" Valid To: %llu\n", (unsigned long long)picocert_get_valid_to(cert));
printf(" Curve: %u\n", cert->curve);
printf(" Hash: %u\n", cert->hash);
printf(" Reserved: %lu\n", (unsigned long)picocert_get_reserved(cert));
printf("Public Key:\n ");
picocert_print_key_bytes(
cert->public_key + 1,
sizeof(cert->public_key) -
1); // Skip the first byte for uncompressed key format
printf("Signature:\n ");
picocert_print_key_bytes(cert->signature, sizeof(cert->signature));
}