-
Notifications
You must be signed in to change notification settings - Fork 970
Expand file tree
/
Copy pathwc_pkcs11.c
More file actions
6667 lines (6141 loc) · 232 KB
/
wc_pkcs11.c
File metadata and controls
6667 lines (6141 loc) · 232 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
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* wc_pkcs11.c
*
* Copyright (C) 2006-2026 wolfSSL Inc.
*
* This file is part of wolfSSL.
*
* wolfSSL is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* wolfSSL is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1335, USA
*/
#include <wolfssl/wolfcrypt/libwolfssl_sources.h>
#ifdef HAVE_PKCS11
#ifndef HAVE_PKCS11_STATIC
#include <dlfcn.h>
#endif
#include <wolfssl/wolfcrypt/wc_pkcs11.h>
#include <wolfssl/wolfcrypt/asn.h>
#ifndef NO_RSA
#include <wolfssl/wolfcrypt/rsa.h>
#endif
#ifdef NO_INLINE
#include <wolfssl/wolfcrypt/misc.h>
#else
#define WOLFSSL_MISC_INCLUDED
#include <wolfcrypt/src/misc.c>
#endif
#ifndef WOLFSSL_HAVE_ECC_KEY_GET_PRIV
/* FIPS build has replaced ecc.h. */
#define wc_ecc_key_get_priv(key) (&((key)->k))
#define WOLFSSL_HAVE_ECC_KEY_GET_PRIV
#endif
#if defined(NO_PKCS11_RSA) && !defined(NO_RSA)
#define NO_RSA
#endif
#if defined(NO_PKCS11_ECC) && defined(HAVE_ECC)
#undef HAVE_ECC
#endif
#if defined(NO_PKCS11_AES) && !defined(NO_AES)
#define NO_AES
#endif
#if defined(NO_PKCS11_AESGCM) && defined(HAVE_AESGCM)
#undef HAVE_AESGCM
#endif
#if defined(NO_PKCS11_AESCBC) && defined(HAVE_AES_CBC)
#undef HAVE_AES_CBC
#endif
#if defined(NO_PKCS11_HMAC) && !defined(NO_HMAC)
#define NO_HMAC
#endif
#if defined(NO_PKCS11_RNG) && !defined(WC_NO_RNG)
#define WC_NO_RNG
#endif
#if defined(NO_PKCS11_MLDSA) && defined(HAVE_DILITHIUM)
#undef HAVE_DILITHIUM
#endif
#if defined(WOLFSSL_HAVE_MLKEM) && defined(WOLFSSL_WC_MLKEM)
#define HAVE_PKCS11_MLKEM
#endif
#if defined(NO_PKCS11_MLKEM) && defined(HAVE_PKCS11_MLKEM)
#undef HAVE_PKCS11_MLKEM
#endif
#if (defined(HAVE_ECC) && !defined(NO_PKCS11_ECDH)) || \
defined(HAVE_PKCS11_MLKEM)
/* Pointer to false required for templates. */
static CK_BBOOL ckFalse = CK_FALSE;
#endif
#if !defined(NO_RSA) || defined(HAVE_ECC) || (!defined(NO_AES) && \
(defined(HAVE_AESGCM) || defined(HAVE_AES_CBC))) || \
!defined(NO_HMAC) || defined(HAVE_DILITHIUM) || \
defined(HAVE_PKCS11_MLKEM)
/* Pointer to true required for templates. */
static CK_BBOOL ckTrue = CK_TRUE;
#endif
#ifndef NO_RSA
/* Pointer to RSA key type required for templates. */
static CK_KEY_TYPE rsaKeyType = CKK_RSA;
#endif
#ifdef HAVE_ECC
/* Pointer to EC key type required for templates. */
static CK_KEY_TYPE ecKeyType = CKK_EC;
#endif
#if defined(HAVE_PKCS11_MLKEM)
/* Pointer to ML-KEM key type required for templates. */
static CK_KEY_TYPE mlkemKeyType = CKK_ML_KEM;
#endif
#if defined(HAVE_DILITHIUM)
/* Pointer to ML-DSA key type required for templates. */
static CK_KEY_TYPE mldsaKeyType = CKK_ML_DSA;
#endif
#if !defined(NO_RSA) || defined(HAVE_ECC) || defined(HAVE_DILITHIUM) || \
defined(HAVE_PKCS11_MLKEM)
/* Pointer to public key class required for templates. */
static CK_OBJECT_CLASS pubKeyClass = CKO_PUBLIC_KEY;
/* Pointer to private key class required for templates. */
static CK_OBJECT_CLASS privKeyClass = CKO_PRIVATE_KEY;
#endif
#if (!defined(NO_AES) && (defined(HAVE_AESGCM) || defined(HAVE_AES_CBC))) || \
!defined(NO_HMAC) || (defined(HAVE_ECC) && !defined(NO_PKCS11_ECDH)) || \
defined(HAVE_PKCS11_MLKEM)
/* Pointer to secret key class required for templates. */
static CK_OBJECT_CLASS secretKeyClass = CKO_SECRET_KEY;
#endif
#if (!defined(NO_AES) && (defined(WOLFSSL_AES_COUNTER)))
/* AES CTR parameter structure for PKCS#11. */
typedef struct CK_AES_CTR_PARAMS {
CK_ULONG ulCounterBits;
CK_BYTE cb[WC_AES_BLOCK_SIZE];
} CK_AES_CTR_PARAMS;
#endif
#if !defined(NO_CERTS)
static CK_OBJECT_CLASS certClass = CKO_CERTIFICATE;
#endif
#ifdef WOLFSSL_DEBUG_PKCS11
/* Enable logging of PKCS#11 calls and return value. */
#define PKCS11_RV(op, rv) pkcs11_rv(op, rv)
/* Enable logging of PKCS#11 calls and value. */
#define PKCS11_VAL(op, val) pkcs11_val(op, val)
/* Enable logging of PKCS#11 template. */
#define PKCS11_DUMP_TEMPLATE(name, templ, cnt) \
pkcs11_dump_template(name, templ, cnt)
/* Enable logging of PKCS#11 mechanism info. */
#define PKCS11_DUMP_MECHANSIM(name, mechanism) \
pkcs11_dump_mechanism(name, mechanism)
/* Formats of template items - used to instruct how to log information. */
enum PKCS11_TYPE_FORMATS {
PKCS11_FMT_BOOLEAN,
PKCS11_FMT_CLASS,
PKCS11_FMT_KEY_TYPE,
PKCS11_FMT_STRING,
PKCS11_FMT_NUMBER,
PKCS11_FMT_DATA,
PKCS11_FMT_POINTER
};
/* Information for logging a template item. */
static struct PKCS11_TYPE_STR {
/** Attribute type in template. */
CK_ATTRIBUTE_TYPE type;
/** String to log corresponding to attribute type. */
const char* str;
/** Format of data associated with template item. */
int format;
} typeStr[] = {
{ CKA_CLASS, "CKA_CLASS", PKCS11_FMT_CLASS },
{ CKA_TOKEN, "CKA_TOKEN", PKCS11_FMT_BOOLEAN },
{ CKA_PRIVATE, "CKA_PRIVATE", PKCS11_FMT_BOOLEAN },
{ CKA_LABEL, "CKA_LABEL", PKCS11_FMT_STRING },
{ CKA_VALUE, "CKA_VALUE", PKCS11_FMT_DATA },
{ CKA_OBJECT_ID, "CKA_OBJECT_ID", PKCS11_FMT_POINTER },
{ CKA_KEY_TYPE, "CKA_KEY_TYPE", PKCS11_FMT_KEY_TYPE },
{ CKA_ID, "CKA_ID", PKCS11_FMT_DATA },
{ CKA_SENSITIVE, "CKA_SENSITIVE", PKCS11_FMT_BOOLEAN },
{ CKA_ENCRYPT, "CKA_ENCRYPT", PKCS11_FMT_BOOLEAN },
{ CKA_DECRYPT, "CKA_DECRYPT", PKCS11_FMT_BOOLEAN },
{ CKA_SIGN, "CKA_SIGN", PKCS11_FMT_BOOLEAN },
{ CKA_VERIFY, "CKA_VERIFY", PKCS11_FMT_BOOLEAN },
{ CKA_DERIVE, "CKA_DERIVE", PKCS11_FMT_BOOLEAN },
{ CKA_MODULUS_BITS, "CKA_MODULUS_BITS", PKCS11_FMT_NUMBER },
{ CKA_MODULUS, "CKA_MODULUS", PKCS11_FMT_DATA },
{ CKA_PUBLIC_EXPONENT, "CKA_PUBLIC_EXPONENT", PKCS11_FMT_DATA },
{ CKA_PRIVATE_EXPONENT, "CKA_PRIVATE_EXPONENT", PKCS11_FMT_DATA },
{ CKA_PRIME_1, "CKA_PRIME_1", PKCS11_FMT_DATA },
{ CKA_PRIME_2, "CKA_PRIME_2", PKCS11_FMT_DATA },
{ CKA_EXPONENT_1, "CKA_EXPONENT_1", PKCS11_FMT_DATA },
{ CKA_EXPONENT_2, "CKA_EXPONENT_2", PKCS11_FMT_DATA },
{ CKA_VALUE_LEN, "CKA_VALUE_LEN", PKCS11_FMT_NUMBER },
{ CKA_COEFFICIENT, "CKA_COEFFICIENT", PKCS11_FMT_DATA },
{ CKA_EXTRACTABLE, "CKA_EXTRACTABLE", PKCS11_FMT_BOOLEAN },
{ CKA_EC_PARAMS, "CKA_EC_PARAMS", PKCS11_FMT_DATA },
{ CKA_EC_POINT, "CKA_EC_POINT", PKCS11_FMT_DATA },
{ CKA_ENCAPSULATE, "CKA_ENCAPSULATE", PKCS11_FMT_BOOLEAN },
{ CKA_DECAPSULATE, "CKA_DECAPSULATE", PKCS11_FMT_BOOLEAN },
{ CKA_PARAMETER_SET, "CKA_PARAMETER_SET", PKCS11_FMT_NUMBER },
};
/* Count of known attribute types for logging. */
#define PKCS11_TYPE_STR_CNT ((int)(sizeof(typeStr) / sizeof(*typeStr)))
/*
* Dump/log the PKCS #11 template.
*
* This is only for debugging purposes. Only the values needed are recognised.
*
* @param [in] name PKCS #11 template name.
* @param [in] templ PKCS #11 template to dump.
* @param [in] cnt Count of template entries.
*/
static void pkcs11_dump_template(const char* name, CK_ATTRIBUTE* templ,
CK_ULONG cnt)
{
CK_ULONG i;
int j;
char line[80];
char type[25];
int format;
CK_KEY_TYPE keyType;
CK_OBJECT_CLASS keyClass;
WOLFSSL_MSG(name);
for (i = 0; i < cnt; i++) {
format = PKCS11_FMT_POINTER;
for (j = 0; j < PKCS11_TYPE_STR_CNT; j++) {
if (templ[i].type == typeStr[j].type) {
XSNPRINTF(type, sizeof(type), "%s", typeStr[j].str);
format = typeStr[j].format;
break;
}
}
if (j == PKCS11_TYPE_STR_CNT) {
XSNPRINTF(type, sizeof(type), "%08lxUL", templ[i].type);
}
switch (format) {
case PKCS11_FMT_BOOLEAN:
#if !defined(NO_RSA) || defined(HAVE_ECC) || (!defined(NO_AES) && \
(defined(HAVE_AESGCM) || defined(HAVE_AES_CBC))) || !defined(NO_HMAC)
if (templ[i].pValue == &ckTrue) {
XSNPRINTF(line, sizeof(line), "%25s: TRUE", type);
WOLFSSL_MSG(line);
}
else
#endif
#if defined(HAVE_ECC) && !defined(NO_PKCS11_ECDH)
if (templ[i].pValue == &ckFalse) {
XSNPRINTF(line, sizeof(line), "%25s: FALSE", type);
WOLFSSL_MSG(line);
}
else
#endif
{
XSNPRINTF(line, sizeof(line), "%25s: INVALID (%p)", type,
templ[i].pValue);
WOLFSSL_MSG(line);
}
break;
case PKCS11_FMT_CLASS:
keyClass = *(CK_OBJECT_CLASS*)templ[i].pValue;
if (keyClass == CKO_PUBLIC_KEY) {
XSNPRINTF(line, sizeof(line), "%25s: PUBLIC", type);
WOLFSSL_MSG(line);
}
else if (keyClass == CKO_PRIVATE_KEY) {
XSNPRINTF(line, sizeof(line), "%25s: PRIVATE", type);
WOLFSSL_MSG(line);
}
else if (keyClass == CKO_SECRET_KEY) {
XSNPRINTF(line, sizeof(line), "%25s: SECRET", type);
WOLFSSL_MSG(line);
}
else if (keyClass == CKO_CERTIFICATE) {
XSNPRINTF(line, sizeof(line), "%25s: CERTIFICATE", type);
WOLFSSL_MSG(line);
}
else
{
XSNPRINTF(line, sizeof(line), "%25s: UNKNOWN (%p)", type,
templ[i].pValue);
WOLFSSL_MSG(line);
}
break;
case PKCS11_FMT_KEY_TYPE:
keyType = *(CK_KEY_TYPE*)templ[i].pValue;
switch (keyType) {
case CKK_RSA:
XSNPRINTF(line, sizeof(line), "%25s: RSA", type);
break;
case CKK_DH:
XSNPRINTF(line, sizeof(line), "%25s: DH", type);
break;
case CKK_EC:
XSNPRINTF(line, sizeof(line), "%25s: EC", type);
break;
case CKK_GENERIC_SECRET:
XSNPRINTF(line, sizeof(line), "%25s: GENERIC_SECRET", type);
break;
case CKK_AES:
XSNPRINTF(line, sizeof(line), "%25s: AES", type);
break;
case CKK_MD5_HMAC:
XSNPRINTF(line, sizeof(line), "%25s: MD5_HMAC", type);
break;
case CKK_SHA_1_HMAC:
XSNPRINTF(line, sizeof(line), "%25s: SHA_1_HMAC", type);
break;
case CKK_SHA256_HMAC:
XSNPRINTF(line, sizeof(line), "%25s: SHA256_HMAC", type);
break;
case CKK_SHA384_HMAC:
XSNPRINTF(line, sizeof(line), "%25s: SHA384_HMAC", type);
break;
case CKK_SHA512_HMAC:
XSNPRINTF(line, sizeof(line), "%25s: SHA512_HMAC", type);
break;
case CKK_SHA224_HMAC:
XSNPRINTF(line, sizeof(line), "%25s: SHA224_HMAC", type);
break;
case CKK_ML_DSA:
XSNPRINTF(line, sizeof(line), "%25s: ML_DSA", type);
break;
case CKK_ML_KEM:
XSNPRINTF(line, sizeof(line), "%25s: ML_KEM", type);
break;
default:
XSNPRINTF(line, sizeof(line), "%25s: UNKNOWN (%08lx)", type,
keyType);
break;
}
WOLFSSL_MSG(line);
break;
case PKCS11_FMT_STRING:
XSNPRINTF(line, sizeof(line), "%25s: %s", type,
(char*)templ[i].pValue);
WOLFSSL_MSG(line);
break;
case PKCS11_FMT_NUMBER:
if (templ[i].ulValueLen <= 1) {
XSNPRINTF(line, sizeof(line), "%25s: 0x%02x (%d)", type,
*(byte*)templ[i].pValue, *(byte*)templ[i].pValue);
}
else if (templ[i].ulValueLen <= 2) {
XSNPRINTF(line, sizeof(line), "%25s: 0x%04x (%d)", type,
*(word16*)templ[i].pValue, *(word16*)templ[i].pValue);
}
else if (templ[i].ulValueLen <= 4) {
XSNPRINTF(line, sizeof(line), "%25s: 0x%08x (%d)", type,
*(word32*)templ[i].pValue, *(word32*)templ[i].pValue);
}
else if (templ[i].ulValueLen <= 8) {
XSNPRINTF(line, sizeof(line), "%25s: 0x%016lx (%ld)", type,
*(word64*)templ[i].pValue, *(word64*)templ[i].pValue);
}
else {
XSNPRINTF(line, sizeof(line), "%25s: INVALID (%ld)", type,
templ[i].ulValueLen);
}
WOLFSSL_MSG(line);
break;
case PKCS11_FMT_DATA:
if (templ[i].ulValueLen == CK_UNAVAILABLE_INFORMATION) {
XSNPRINTF(line, sizeof(line), "%25s: unavailable", type);
WOLFSSL_MSG(line);
break;
}
XSNPRINTF(line, sizeof(line), "%25s: %ld", type,
templ[i].ulValueLen);
WOLFSSL_MSG(line);
if (templ[i].pValue == NULL) {
XSNPRINTF(line, sizeof(line), "%27s(nil)", "");
WOLFSSL_MSG(line);
break;
}
XSNPRINTF(line, sizeof(line), "%27s", "");
for (j = 0; j < (int)templ[i].ulValueLen && j < 80; j++) {
char hex[6];
XSNPRINTF(hex, sizeof(hex), "0x%02x,",
((byte*)templ[i].pValue)[j]);
XSTRNCAT(line, hex, sizeof(line) - XSTRLEN(line) - 1);
if ((j % 8) == 7) {
WOLFSSL_MSG(line);
XSNPRINTF(line, sizeof(line), "%27s", "");
}
}
if (j == (int)templ[i].ulValueLen) {
if ((j % 8) != 0) {
WOLFSSL_MSG(line);
}
}
else if (j < (int)templ[i].ulValueLen) {
XSNPRINTF(line, sizeof(line), "%27s...", "");
WOLFSSL_MSG(line);
}
break;
case PKCS11_FMT_POINTER:
XSNPRINTF(line, sizeof(line), "%25s: %p %ld", type, templ[i].pValue,
templ[i].ulValueLen);
WOLFSSL_MSG(line);
break;
}
}
}
/* Information for logging a mechanism */
static struct PKCS11_MECHANISM_STR {
/** Mechanism. */
CK_MECHANISM_TYPE mech;
/** String to log corresponding mechanism. */
const char* str;
} mechStr[] = {
{ CKM_RSA_PKCS_KEY_PAIR_GEN, "CKM_RSA_PKCS_KEY_PAIR_GEN" },
{ CKM_RSA_X_509, "CKM_RSA_X_509" },
{ CKM_DH_PKCS_KEY_PAIR_GEN, "CKM_DH_PKCS_KEY_PAIR_GEN" },
{ CKM_DH_PKCS_DERIVE, "CKM_DH_PKCS_DERIVE" },
{ CKM_MD5_HMAC, "CKM_MD5_HMAC" },
{ CKM_SHA_1_HMAC, "CKM_SHA_1_HMAC" },
{ CKM_SHA256_HMAC, "CKM_SHA256_HMAC" },
{ CKM_SHA224_HMAC, "CKM_SHA224_HMAC" },
{ CKM_SHA384_HMAC, "CKM_SHA384_HMAC" },
{ CKM_SHA512_HMAC, "CKM_SHA512_HMAC" },
{ CKM_GENERIC_SECRET_KEY_GEN, "CKM_GENERIC_SECRET_KEY_GEN" },
{ CKM_EC_KEY_PAIR_GEN, "CKM_EC_KEY_PAIR_GEN" },
{ CKM_ECDSA, "CKM_ECDSA" },
{ CKM_ECDH1_DERIVE, "CKM_ECDH1_DERIVE" },
{ CKM_ECDH1_COFACTOR_DERIVE, "CKM_ECDH1_COFACTOR_DERIVE" },
{ CKM_AES_KEY_GEN, "CKM_AES_KEY_GEN" },
{ CKM_AES_CBC, "CKM_AES_CBC" },
{ CKM_AES_GCM, "CKM_AES_GCM" },
{ CKM_ML_KEM_KEY_PAIR_GEN, "CKM_ML_KEM_KEY_PAIR_GEN" },
{ CKM_ML_KEM, "CKM_ML_KEM" },
{ CKM_ML_DSA_KEY_PAIR_GEN, "CKM_ML_DSA_KEY_PAIR_GEN" },
{ CKM_ML_DSA, "CKM_ML_DSA" },
{ CKM_HASH_ML_DSA, "CKM_HASH_ML_DSA" },
};
/* Count of known mechanism for logging. */
#define PKCS11_MECH_STR_CNT ((int)(sizeof(mechStr) / sizeof(*mechStr)))
/*
* Dump/log the PKCS #11 mechanism.
*
* This is only for debugging purposes. Only the values needed are recognised.
*
* @param [in] op PKCS #11 operation that was attempted.
* @param [in] mech PKCS #11 mechanism to dump.
*/
static void pkcs11_dump_mechanism(const char* op, CK_MECHANISM_TYPE mech)
{
char line[80];
const char *mechName = NULL;
int i;
for (i = 0; i < PKCS11_MECH_STR_CNT; i++) {
if (mech == mechStr[i].mech) {
mechName = mechStr[i].str;
break;
}
}
if (i == PKCS11_MECH_STR_CNT) {
mechName = "UNKNOWN";
}
XSNPRINTF(line, 80, "%s: %s", op, mechName);
WOLFSSL_MSG(line);
}
/*
* Log a PKCS #11 return value with the name of function called.
*
* This is only for debugging purposes. Only the values needed are recognized.
*
* @param [in] op PKCS #11 operation that was attempted.
* @param [in] rv PKCS #11 return value.
*/
static void pkcs11_rv(const char* op, CK_RV rv)
{
char line[80];
if (rv == CKR_OK) {
XSNPRINTF(line, 80, "%s: OK", op);
}
else if (rv == CKR_MECHANISM_INVALID) {
XSNPRINTF(line, 80, "%s: MECHANISM_INVALID", op);
}
else if (rv == CKR_SIGNATURE_INVALID) {
XSNPRINTF(line, 80, "%s: SIGNATURE_INVALID", op);
}
else {
XSNPRINTF(line, 80, "%s: %08lxUL (FAILED)", op, rv);
}
WOLFSSL_MSG(line);
}
/*
* Log a value from a PKCS #11 operation.
*
* This is only for debugging purposes.
*
* @param [in] op PKCS #11 operation that was attempted.
* @param [in] val Value to log.
*/
static void pkcs11_val(const char* op, CK_ULONG val)
{
char line[80];
XSNPRINTF(line, 80, "%s: %ld", op, val);
WOLFSSL_MSG(line);
}
#else
/* Disable logging of PKCS#11 calls and return value. */
#define PKCS11_RV(op, ev) WC_DO_NOTHING
/* Disable logging of PKCS#11 calls and value. */
#define PKCS11_VAL(op, val) WC_DO_NOTHING
/* Disable logging of PKCS#11 template. */
#define PKCS11_DUMP_TEMPLATE(name, templ, cnt) WC_DO_NOTHING
/* Disable logging of PKCS#11 mechanism info. */
#define PKCS11_DUMP_MECHANSIM(name, mechanism) WC_DO_NOTHING
#endif
/**
* Load library, get function list and initialize PKCS#11.
*
* @param [in] dev Device object.
* @param [in] library Library name including path.
* @param [in] heap Heap hint.
* @return BAD_FUNC_ARG when dev or library are NULL pointers.
* @return BAD_PATH_ERROR when dynamic library cannot be opened.
* @return WC_INIT_E when the initialization PKCS#11 fails.
* @return WC_HW_E when unable to get PKCS#11 function list.
* @return 0 on success.
*/
int wc_Pkcs11_Initialize(Pkcs11Dev* dev, const char* library, void* heap)
{
return wc_Pkcs11_Initialize_v3(dev, library, heap, NULL, NULL, NULL);
}
/**
* Load library, get function list and initialize PKCS#11.
*
* @param [in] dev Device object.
* @param [in] library Library name including path.
* @param [in] heap Heap hint.
* @param [out] rvp PKCS#11 return value. Last return value seen.
* May be NULL.
* @return BAD_FUNC_ARG when dev or library are NULL pointers.
* @return BAD_PATH_ERROR when dynamic library cannot be opened.
* @return WC_INIT_E when the initialization PKCS#11 fails.
* @return WC_HW_E when unable to get PKCS#11 function list.
* @return 0 on success.
*/
int wc_Pkcs11_Initialize_ex(Pkcs11Dev* dev, const char* library, void* heap,
CK_RV* rvp)
{
return wc_Pkcs11_Initialize_v3(dev, library, heap, NULL, NULL, rvp);
}
/**
* Load library, get function list and initialize PKCS#11.
*
* @param [in] dev Device object.
* @param [in] library Library name including path.
* @param [in] heap Heap hint.
* @param [in,out] version On in, desired version of interface.
* On out, actual obtained version of interface.
* @param [in] interfaceName Name of the interface to use.
* @param [out] rvp PKCS#11 return value. Last return value seen.
* May be NULL.
* @return BAD_FUNC_ARG when dev or library are NULL pointers.
* @return BAD_PATH_ERROR when dynamic library cannot be opened.
* @return WC_INIT_E when the initialization PKCS#11 fails.
* @return WC_HW_E when unable to get PKCS#11 function list.
* @return 0 on success.
*/
int wc_Pkcs11_Initialize_v3(Pkcs11Dev* dev, const char* library,
void* heap, int* version, const char* interfaceName, CK_RV* rvp)
{
int ret = 0;
CK_RV rv = CKR_OK;
#if !defined(HAVE_PKCS11_STATIC) && !defined(HAVE_PKCS11_V3_STATIC)
void* func;
#endif
CK_C_INITIALIZE_ARGS args;
CK_VERSION_PTR version_ptr = NULL;
if (dev == NULL)
ret = BAD_FUNC_ARG;
#if !defined(HAVE_PKCS11_STATIC) && !defined(HAVE_PKCS11_V3_STATIC)
if (library == NULL)
ret = BAD_FUNC_ARG;
#endif
if (ret == 0) {
dev->heap = heap;
#if defined(HAVE_PKCS11_V3_STATIC)
CK_INTERFACE_PTR interface = NULL;
CK_VERSION pkcs11_version = {0, 0};
if (version != NULL) {
if (*version == WC_PCKS11VERSION_2_20) {
pkcs11_version.major = 2;
pkcs11_version.minor = 20;
}
else if (*version == WC_PCKS11VERSION_2_40) {
pkcs11_version.major = 2;
pkcs11_version.minor = 40;
}
else if (*version == WC_PCKS11VERSION_3_0) {
pkcs11_version.major = 3;
pkcs11_version.minor = 0;
}
else if (*version == WC_PCKS11VERSION_3_1) {
pkcs11_version.major = 3;
pkcs11_version.minor = 1;
}
else if (*version == WC_PCKS11VERSION_3_2) {
pkcs11_version.major = 3;
pkcs11_version.minor = 2;
}
version_ptr = &pkcs11_version;
}
else {
version_ptr = NULL;
}
rv = C_GetInterface((CK_UTF8CHAR_PTR) interfaceName, version_ptr,
&interface, 0);
if (rv == CKR_OK) {
dev->func = interface->pFunctionList;
version_ptr = (CK_VERSION_PTR) interface->pFunctionList;
if (version_ptr->major == 2 && version_ptr->minor == 20) {
dev->version = WC_PCKS11VERSION_2_20;
}
else if (version_ptr->major == 2 &&
version_ptr->minor == 40) {
dev->version = WC_PCKS11VERSION_2_40;
}
else if (version_ptr->major == 3 &&
version_ptr->minor == 0) {
dev->version = WC_PCKS11VERSION_3_0;
}
else if (version_ptr->major == 3 &&
version_ptr->minor == 1) {
dev->version = WC_PCKS11VERSION_3_1;
}
else if (version_ptr->major == 3 &&
version_ptr->minor == 2) {
dev->version = WC_PCKS11VERSION_3_2;
}
else {
WOLFSSL_MSG_EX("Unsupported PKCS#11 version: %d.%d",
version_ptr->major, version_ptr->minor);
ret = WC_HW_E;
}
}
else {
PKCS11_RV("CK_C_GetInterface", rv);
ret = WC_HW_E;
}
#elif defined(HAVE_PKCS11_STATIC)
rv = C_GetFunctionList(&dev->func);
if (rv == CKR_OK) {
version_ptr = (CK_VERSION_PTR) dev->func;
if (version_ptr->major == 2 &&
version_ptr->minor == 20) {
dev->version = WC_PCKS11VERSION_2_20;
}
else if (version_ptr->major == 2 &&
version_ptr->minor == 40) {
dev->version = WC_PCKS11VERSION_2_40;
}
else {
WOLFSSL_MSG_EX("Unsupported PKCS#11 version: %d.%d",
version_ptr->major,
version_ptr->minor);
ret = WC_HW_E;
}
}
else {
PKCS11_RV("CK_C_GetFunctionList", rv);
ret = WC_HW_E;
}
#else
/* Load dynamic library */
dev->dlHandle = dlopen(library, RTLD_NOW | RTLD_LOCAL);
if (dev->dlHandle == NULL) {
WOLFSSL_MSG(dlerror());
ret = BAD_PATH_ERROR;
}
if (ret == 0) {
/* Check if the library supports PKCS#11 version 3.0 (or above) by
* looking for the C_GetInterface method (only present for >= V3.0).
*/
func = dlsym(dev->dlHandle, "C_GetInterface");
if (func != NULL) {
/* Function is present, use it */
CK_INTERFACE_PTR interface = NULL;
CK_VERSION pkcs11_version = {0, 0};
if (version != NULL) {
if (*version == WC_PCKS11VERSION_2_20) {
pkcs11_version.major = 2;
pkcs11_version.minor = 20;
}
else if (*version == WC_PCKS11VERSION_2_40) {
pkcs11_version.major = 2;
pkcs11_version.minor = 40;
}
else if (*version == WC_PCKS11VERSION_3_0) {
pkcs11_version.major = 3;
pkcs11_version.minor = 0;
}
else if (*version == WC_PCKS11VERSION_3_1) {
pkcs11_version.major = 3;
pkcs11_version.minor = 1;
}
else if (*version == WC_PCKS11VERSION_3_2) {
pkcs11_version.major = 3;
pkcs11_version.minor = 2;
}
version_ptr = &pkcs11_version;
}
else {
version_ptr = NULL;
}
rv = ((CK_C_GetInterface)func)((CK_UTF8CHAR_PTR) interfaceName,
version_ptr, &interface, 0);
if (rv == CKR_OK) {
dev->func = interface->pFunctionList;
version_ptr = (CK_VERSION_PTR) interface->pFunctionList;
if (version_ptr->major == 2 && version_ptr->minor == 20) {
dev->version = WC_PCKS11VERSION_2_20;
}
else if (version_ptr->major == 2 &&
version_ptr->minor == 40) {
dev->version = WC_PCKS11VERSION_2_40;
}
else if (version_ptr->major == 3 &&
version_ptr->minor == 0) {
dev->version = WC_PCKS11VERSION_3_0;
}
else if (version_ptr->major == 3 &&
version_ptr->minor == 1) {
dev->version = WC_PCKS11VERSION_3_1;
}
else if (version_ptr->major == 3 &&
version_ptr->minor == 2) {
dev->version = WC_PCKS11VERSION_3_2;
}
else {
WOLFSSL_MSG_EX("Unsupported PKCS#11 version: %d.%d",
version_ptr->major, version_ptr->minor);
ret = WC_HW_E;
}
}
else {
PKCS11_RV("CK_C_GetInterface", rv);
ret = WC_HW_E;
}
}
else {
/* Function not present, try a 2.x library by looking for
* C_GetFunctionList. */
func = dlsym(dev->dlHandle, "C_GetFunctionList");
if (func == NULL) {
#if defined(_WIN32)
WOLFSSL_MSG_EX("GetProcAddress(): %d", GetLastError());
#else
WOLFSSL_MSG(dlerror());
#endif
ret = WC_HW_E;
}
if (ret == 0) {
rv = ((CK_C_GetFunctionList)func)(&dev->func);
if (rv == CKR_OK) {
version_ptr = (CK_VERSION_PTR) dev->func;
if (version_ptr->major == 2 &&
version_ptr->minor == 20) {
dev->version = WC_PCKS11VERSION_2_20;
}
else if (version_ptr->major == 2 &&
version_ptr->minor == 40) {
dev->version = WC_PCKS11VERSION_2_40;
}
else {
WOLFSSL_MSG_EX("Unsupported PKCS#11 version: %d.%d",
version_ptr->major,
version_ptr->minor);
ret = WC_HW_E;
}
}
else {
PKCS11_RV("CK_C_GetFunctionList", rv);
ret = WC_HW_E;
}
}
}
}
#endif
}
if (ret == 0 && version != NULL)
*version = dev->version;
if (ret == 0) {
XMEMSET(&args, 0x00, sizeof(args));
args.flags = CKF_OS_LOCKING_OK;
rv = dev->func->C_Initialize(&args);
if (rv == CKR_CRYPTOKI_ALREADY_INITIALIZED) {
WOLFSSL_MSG("PKCS#11 already initialized");
rv = CKR_OK;
}
else if (rv != CKR_OK) {
PKCS11_RV("C_Initialize", rv);
ret = WC_INIT_E;
}
}
if (rvp != NULL) {
*rvp = rv;
}
if (ret != 0) {
wc_Pkcs11_Finalize(dev);
}
return ret;
}
/**
* Close the Pkcs#11 library.
*
* @param [in] dev Device object.
*/
void wc_Pkcs11_Finalize(Pkcs11Dev* dev)
{
if (dev != NULL
#if !defined(HAVE_PKCS11_STATIC) && !defined(HAVE_PKCS11_V3_STATIC)
&& dev->dlHandle != NULL
#endif
) {
if (dev->func != NULL) {
dev->func->C_Finalize(NULL);
dev->func = NULL;
}
#if !defined(HAVE_PKCS11_STATIC) && !defined(HAVE_PKCS11_V3_STATIC)
dlclose(dev->dlHandle);
dev->dlHandle = NULL;
#endif
}
}
/* lookup by token name and return slotId or (-1) if not found */
static int Pkcs11Slot_FindByTokenName(Pkcs11Dev* dev,
const char* tokenName, size_t tokenNameSz)
{
int ret = -1;
CK_RV rv;
CK_ULONG slotCnt = 0;
CK_TOKEN_INFO tinfo;
int idx = -1;
CK_SLOT_ID* slot = NULL;
rv = dev->func->C_GetSlotList(CK_TRUE, NULL, &slotCnt);
if (rv == CKR_OK) {
slot = (CK_SLOT_ID*)XMALLOC(slotCnt * sizeof(*slot), dev->heap,
DYNAMIC_TYPE_TMP_BUFFER);
if (slot == NULL)
goto out;
rv = dev->func->C_GetSlotList(CK_TRUE, slot, &slotCnt);
if (rv != CKR_OK)
goto out;
for (idx = 0; idx < (int)slotCnt; idx++) {
rv = dev->func->C_GetTokenInfo(slot[idx], &tinfo);
PKCS11_RV("C_GetTokenInfo", rv);
if (rv == CKR_OK &&
XMEMCMP(tinfo.label, tokenName, tokenNameSz) == 0) {
ret = (int)slot[idx];
break;
}
}
}
out:
XFREE(slot, dev->heap, DYNAMIC_TYPE_TMP_BUFFER);
return ret;
}
/* lookup by slotId or tokenName */
static int Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev, int slotId,
const char* tokenName, size_t tokenNameSz)
{
int ret = 0;
CK_RV rv;
CK_SLOT_ID* slot = NULL;
CK_ULONG slotCnt = 0;
if (token == NULL || dev == NULL) {
ret = BAD_FUNC_ARG;
}
if (ret == 0) {
if (slotId < 0) {
rv = dev->func->C_GetSlotList(CK_TRUE, NULL, &slotCnt);
PKCS11_RV("C_GetSlotList", rv);
if (rv != CKR_OK) {
ret = WC_HW_E;
}
if (ret == 0) {
slot = (CK_SLOT_ID*)XMALLOC(slotCnt * sizeof(*slot), dev->heap,
DYNAMIC_TYPE_TMP_BUFFER);
if (slot == NULL)
ret = MEMORY_E;
}
if (ret == 0) {
rv = dev->func->C_GetSlotList(CK_TRUE, slot, &slotCnt);
PKCS11_RV("C_GetSlotList", rv);
if (rv != CKR_OK) {
ret = WC_HW_E;
}
}
if (ret == 0) {
if (tokenName != NULL && tokenNameSz > 0) {
/* find based on token name */
slotId = Pkcs11Slot_FindByTokenName(dev,
tokenName, tokenNameSz);
}
else {
/* Use first available slot with a token. */
slotId = (int)slot[0];
}
}
}
else {
/* verify slotId is valid */
CK_SLOT_INFO sinfo;
rv = dev->func->C_GetSlotInfo(slotId, &sinfo);
PKCS11_RV("C_GetSlotInfo", rv);
if (rv != CKR_OK) {
ret = WC_INIT_E;
}
}
}
if (ret == 0) {
token->func = dev->func;
token->slotId = (CK_SLOT_ID)slotId;
token->handle = NULL_PTR;
token->userPin = NULL_PTR;
token->userPinSz = 0;
token->userPinLogin = 0;
token->version = dev->version;
}
XFREE(slot, dev->heap, DYNAMIC_TYPE_TMP_BUFFER);
return ret;
}
/**
* Set up a token for use. Lookup by slotId or tokenName. Set User PIN.
*
* @param [in] token Token object.
* @param [in] dev PKCS#11 device object.
* @param [in] slotId Slot number of the token.<br>
* Passing -1 uses the first available slot.
* @param [in] tokenName Name of token to initialize (optional)
* @param [in] userPin PIN to use to login as user.
* @param [in] userPinSz Number of bytes in PIN.
* @return BAD_FUNC_ARG when token, dev and/or tokenName is NULL.
* @return WC_INIT_E when initializing token fails.
* @return WC_HW_E when another PKCS#11 library call fails.
* @return 0 on success.
*/
int wc_Pkcs11Token_Init(Pkcs11Token* token, Pkcs11Dev* dev, int slotId,
const char* tokenName, const unsigned char* userPin, int userPinSz)
{
int ret;
size_t tokenNameSz = 0;
if (tokenName != NULL) {
tokenNameSz = XSTRLEN(tokenName);
}
ret = Pkcs11Token_Init(token, dev, slotId, tokenName, tokenNameSz);
if (ret == 0 && userPin != NULL) {
token->userPin = (CK_UTF8CHAR_PTR)userPin;
token->userPinSz = (CK_ULONG)userPinSz;
token->userPinLogin = 1;
}
return ret;
}
/**
* Set up a token for use. Lookup by slotId or tokenName.
*