-
Notifications
You must be signed in to change notification settings - Fork 23
Expand file tree
/
Copy pathcrypto.c
More file actions
8909 lines (8097 loc) · 301 KB
/
crypto.c
File metadata and controls
8909 lines (8097 loc) · 301 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
/* crypto.c
*
* Copyright (C) 2006-2026 wolfSSL Inc.
*
* This file is part of wolfPKCS11.
*
* wolfPKCS11 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.
*
* wolfPKCS11 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
*/
#ifdef HAVE_CONFIG_H
#include <wolfpkcs11/config.h>
#endif
#ifndef WOLFSSL_USER_SETTINGS
#include <wolfssl/options.h>
#else
#include "user_settings.h"
#endif
#include <wolfssl/wolfcrypt/settings.h>
#include <wolfssl/wolfcrypt/error-crypt.h>
#include <wolfssl/wolfcrypt/asn.h>
#include <wolfpkcs11/pkcs11.h>
#include <wolfpkcs11/internal.h>
#define ATTR_TYPE_ULONG 0
#define ATTR_TYPE_BOOL 1
#define ATTR_TYPE_DATA 2
#define ATTR_TYPE_DATE 3
#define PRF_KEY_SIZE 48
/* Check that a CK_ULONG value fits in word32 with room for overhead such as
* authentication tags, key wrap blocks, or padding. On LP64 platforms CK_ULONG
* is 64-bit but wolfCrypt functions use word32/int for lengths. */
#define CK_ULONG_MAX_OVERHEAD ((CK_ULONG)64)
#define CK_ULONG_FITS_WORD32(v) \
((v) <= (CK_ULONG)0xFFFFFFFF - CK_ULONG_MAX_OVERHEAD)
#define CHECK_KEYTYPE(kt) \
(kt == CKK_RSA || kt == CKK_EC || kt == CKK_DH || \
kt == CKK_AES || kt == CKK_HKDF || kt == CKK_GENERIC_SECRET) ? \
CKR_OK : CKR_ATTRIBUTE_VALUE_INVALID
#define CHECK_KEYCLASS(kc) \
(kc == CKO_PRIVATE_KEY || kc == CKO_PUBLIC_KEY || kc == CKO_SECRET_KEY)? CKR_OK : CKR_ATTRIBUTE_VALUE_INVALID
#define CHECK_WRAPPABLE(kc, kt) \
( \
(kc == CKO_PRIVATE_KEY && kt == CKK_RSA) || \
(kc == CKO_SECRET_KEY && kt == CKK_AES) || \
(kc == CKO_SECRET_KEY && kt == CKK_GENERIC_SECRET) || \
(kc == CKO_SECRET_KEY && kt == CKK_HKDF) \
) \
? CKR_OK: CKR_KEY_NOT_WRAPPABLE
#ifndef NO_RSA
/* RSA key data attributes. */
static CK_ATTRIBUTE_TYPE rsaKeyParams[] = {
CKA_MODULUS,
CKA_PRIVATE_EXPONENT,
CKA_PRIME_1,
CKA_PRIME_2,
CKA_EXPONENT_1,
CKA_EXPONENT_2,
CKA_COEFFICIENT,
CKA_PUBLIC_EXPONENT,
CKA_MODULUS_BITS,
};
/* Count of RSA key data attributes. */
#define RSA_KEY_PARAMS_CNT (sizeof(rsaKeyParams)/sizeof(*rsaKeyParams))
#endif
#ifdef HAVE_ECC
/* EC key data attributes. */
static CK_ATTRIBUTE_TYPE ecKeyParams[] = {
CKA_EC_PARAMS,
CKA_VALUE,
CKA_EC_POINT
};
/* Count of EC key data attributes. */
#define EC_KEY_PARAMS_CNT (sizeof(ecKeyParams)/sizeof(*ecKeyParams))
#endif
#ifdef WOLFPKCS11_MLDSA
/* ML-DSA key data attributes. */
static CK_ATTRIBUTE_TYPE mldsaKeyParams[] = {
CKA_PARAMETER_SET,
CKA_SEED,
CKA_VALUE
};
/* Count of ML-DSA key data attributes. */
#define MLDSA_KEY_PARAMS_CNT (sizeof(mldsaKeyParams)/sizeof(*mldsaKeyParams))
#endif
#ifndef NO_DH
/* DH key data attributes. */
static CK_ATTRIBUTE_TYPE dhKeyParams[] = {
CKA_PRIME,
CKA_BASE,
CKA_VALUE,
};
/* Count of DH key data attributes. */
#define DH_KEY_PARAMS_CNT (sizeof(dhKeyParams)/sizeof(*dhKeyParams))
#endif
/* Secret key data attributes. */
static CK_ATTRIBUTE_TYPE secretKeyParams[] = {
CKA_VALUE_LEN,
CKA_VALUE,
};
/* Count of secret key data attributes. */
#define SECRET_KEY_PARAMS_CNT (sizeof(secretKeyParams)/sizeof(*secretKeyParams))
/* Generic data attributes */
static CK_ATTRIBUTE_TYPE genericDataParams[] = {
CKA_VALUE,
CKA_APPLICATION,
CKA_OBJECT_ID
};
/* Count of generic data attributes */
#define DATA_PARAMS_CNT (sizeof(genericDataParams)/sizeof(*genericDataParams))
/* Certificate data attributes */
static CK_ATTRIBUTE_TYPE certParams[] = {
CKA_CERTIFICATE_TYPE,
CKA_VALUE,
};
#define CERT_PARAMS_CNT (sizeof(certParams)/sizeof(*certParams))
#ifdef WOLFPKCS11_NSS
static CK_ATTRIBUTE_TYPE trustParams[] = {
CKA_CERT_SHA1_HASH,
CKA_CERT_MD5_HASH,
CKA_TRUST_SERVER_AUTH,
CKA_TRUST_CLIENT_AUTH,
CKA_TRUST_EMAIL_PROTECTION,
CKA_TRUST_CODE_SIGNING,
CKA_TRUST_STEP_UP_APPROVED,
};
#define TRUST_PARAMS_CNT (sizeof(trustParams)/sizeof(*trustParams))
#endif
/* Identify maximum count for stack array. */
#ifndef NO_RSA
#define OBJ_MAX_PARAMS RSA_KEY_PARAMS_CNT
#elif defined(HAVE_ECC)
#define OBJ_MAX_PARAMS EC_KEY_PARAMS_CNT
#elif !defined(NO_DH)
#define OBJ_MAX_PARAMS DH_KEY_PARAMS_CNT
#else
#define OBJ_MAX_PARAMS SECRET_KEY_PARAMS_CNT
#endif
typedef struct AttributeType {
CK_ATTRIBUTE_TYPE attr; /* Crypto-Ki attribute */
byte type; /* Data type associated with attribute */
} AttributeType;
/* List of recognized attributes and their data type. */
static AttributeType attrType[] = {
{ CKA_CLASS, ATTR_TYPE_ULONG },
{ CKA_TOKEN, ATTR_TYPE_DATA },
{ CKA_PRIVATE, ATTR_TYPE_BOOL },
{ CKA_LABEL, ATTR_TYPE_DATA },
{ CKA_APPLICATION, ATTR_TYPE_DATA },
{ CKA_VALUE, ATTR_TYPE_DATA },
{ CKA_OBJECT_ID, ATTR_TYPE_DATA },
{ CKA_OWNER, ATTR_TYPE_DATA },
{ CKA_TRUSTED, ATTR_TYPE_BOOL },
{ CKA_KEY_TYPE, ATTR_TYPE_ULONG },
{ CKA_SUBJECT, ATTR_TYPE_DATA },
{ CKA_ID, ATTR_TYPE_DATA },
{ CKA_SENSITIVE, ATTR_TYPE_BOOL },
{ CKA_ENCRYPT, ATTR_TYPE_BOOL },
{ CKA_DECRYPT, ATTR_TYPE_BOOL },
{ CKA_WRAP, ATTR_TYPE_BOOL },
{ CKA_UNWRAP, ATTR_TYPE_BOOL },
{ CKA_SIGN, ATTR_TYPE_BOOL },
{ CKA_SIGN_RECOVER, ATTR_TYPE_BOOL },
{ CKA_VERIFY, ATTR_TYPE_BOOL },
{ CKA_VERIFY_RECOVER, ATTR_TYPE_BOOL },
{ CKA_DERIVE, ATTR_TYPE_BOOL },
{ CKA_START_DATE, ATTR_TYPE_DATE },
{ CKA_END_DATE, ATTR_TYPE_DATE },
{ CKA_MODULUS, ATTR_TYPE_DATA },
{ CKA_MODULUS_BITS, ATTR_TYPE_ULONG },
{ CKA_PUBLIC_EXPONENT, ATTR_TYPE_DATA },
{ CKA_PRIVATE_EXPONENT, ATTR_TYPE_DATA },
{ CKA_PRIME_1, ATTR_TYPE_DATA },
{ CKA_PRIME_2, ATTR_TYPE_DATA },
{ CKA_EXPONENT_1, ATTR_TYPE_DATA },
{ CKA_EXPONENT_2, ATTR_TYPE_DATA },
{ CKA_COEFFICIENT, ATTR_TYPE_DATA },
{ CKA_PUBLIC_KEY_INFO, ATTR_TYPE_DATA },
{ CKA_PRIME, ATTR_TYPE_DATA },
{ CKA_BASE, ATTR_TYPE_DATA },
{ CKA_PRIME_BITS, ATTR_TYPE_ULONG },
{ CKA_VALUE_BITS, ATTR_TYPE_ULONG },
{ CKA_VALUE_LEN, ATTR_TYPE_ULONG },
{ CKA_EXTRACTABLE, ATTR_TYPE_BOOL },
{ CKA_LOCAL, ATTR_TYPE_BOOL },
{ CKA_NEVER_EXTRACTABLE, ATTR_TYPE_BOOL },
{ CKA_ALWAYS_SENSITIVE, ATTR_TYPE_BOOL },
{ CKA_KEY_GEN_MECHANISM, ATTR_TYPE_ULONG },
{ CKA_MODIFIABLE, ATTR_TYPE_BOOL },
{ CKA_COPYABLE, ATTR_TYPE_BOOL },
{ CKA_DESTROYABLE, ATTR_TYPE_BOOL },
{ CKA_EC_PARAMS, ATTR_TYPE_DATA },
{ CKA_EC_POINT, ATTR_TYPE_DATA },
{ CKA_ALWAYS_AUTHENTICATE, ATTR_TYPE_BOOL },
{ CKA_WRAP_WITH_TRUSTED, ATTR_TYPE_BOOL },
{ CKA_HW_FEATURE_TYPE, ATTR_TYPE_ULONG },
{ CKA_RESET_ON_INIT, ATTR_TYPE_BOOL },
{ CKA_HAS_RESET, ATTR_TYPE_BOOL },
{ CKA_WRAP_TEMPLATE, ATTR_TYPE_DATA },
{ CKA_UNWRAP_TEMPLATE, ATTR_TYPE_DATA },
{ CKA_DERIVE_TEMPLATE, ATTR_TYPE_DATA },
{ CKA_ALLOWED_MECHANISMS, ATTR_TYPE_DATA },
{ CKA_CERTIFICATE_TYPE, ATTR_TYPE_ULONG },
{ CKA_CERTIFICATE_CATEGORY, ATTR_TYPE_ULONG },
{ CKA_ID, ATTR_TYPE_DATA },
{ CKA_ISSUER, ATTR_TYPE_DATA },
{ CKA_SERIAL_NUMBER, ATTR_TYPE_DATA },
{ CKA_PUBLIC_KEY_INFO, ATTR_TYPE_DATA },
{ CKA_URL, ATTR_TYPE_DATA },
{ CKA_HASH_OF_SUBJECT_PUBLIC_KEY, ATTR_TYPE_DATA },
{ CKA_HASH_OF_ISSUER_PUBLIC_KEY, ATTR_TYPE_DATA },
{ CKA_NAME_HASH_ALGORITHM, ATTR_TYPE_ULONG },
{ CKA_CHECK_VALUE, ATTR_TYPE_DATA },
{ CKA_PARAMETER_SET, ATTR_TYPE_ULONG },
{ CKA_SEED, ATTR_TYPE_DATA },
#ifdef WOLFPKCS11_NSS
{ CKA_CERT_SHA1_HASH, ATTR_TYPE_DATA },
{ CKA_CERT_MD5_HASH, ATTR_TYPE_DATA },
{ CKA_NSS_EMAIL, ATTR_TYPE_DATA },
{ CKA_TRUST_SERVER_AUTH, ATTR_TYPE_ULONG },
{ CKA_TRUST_CLIENT_AUTH, ATTR_TYPE_ULONG },
{ CKA_TRUST_EMAIL_PROTECTION, ATTR_TYPE_ULONG },
{ CKA_TRUST_CODE_SIGNING, ATTR_TYPE_ULONG },
{ CKA_TRUST_STEP_UP_APPROVED, ATTR_TYPE_BOOL },
{ CKA_NSS_DB, ATTR_TYPE_DATA },
#endif
#ifdef WOLFSSL_STM32U5_DHUK
{ CKA_WOLFSSL_DHUK_IV, ATTR_TYPE_DATA },
#endif
{ CKA_WOLFSSL_DEVID, ATTR_TYPE_ULONG },
};
/* Count of elements in attribute type list. */
#define ATTR_TYPE_SIZE (sizeof(attrType) / sizeof(*attrType))
static int IsKnownAttrType(CK_ATTRIBUTE_TYPE type)
{
int j;
for (j = 0; j < (int)ATTR_TYPE_SIZE; j++) {
if (attrType[j].attr == type)
return 1;
}
return 0;
}
/**
* Find the attribute type in the template.
*
* @param pTemplate [in] Template of attributed for an object.
* @param ulCount [in] Number of attribute triplets in template.
* @param type [in] Attribute type to find.
* @param attribute [out] Attribute with the type.
* NULL when type not found.
*/
static void FindAttributeType(CK_ATTRIBUTE* pTemplate, CK_ULONG ulCount,
CK_ATTRIBUTE_TYPE type, CK_ATTRIBUTE** attribute)
{
int i;
*attribute = NULL;
for (i = 0; i < (int)ulCount; i++) {
if (pTemplate[i].type == type) {
*attribute = &pTemplate[i];
break;
}
}
}
static CK_RV FindValidAttributeType(CK_ATTRIBUTE* pTemplate, CK_ULONG ulCount,
CK_ATTRIBUTE_TYPE type, CK_ATTRIBUTE** attr, size_t sz)
{
FindAttributeType(pTemplate, ulCount, type, attr);
if (*attr == NULL) {
return CKR_TEMPLATE_INCOMPLETE;
}
if ((*attr)->pValue == NULL || (*attr)->ulValueLen != sz) {
return CKR_ATTRIBUTE_VALUE_INVALID;
}
return CKR_OK;
}
/**
* Check the value and length are valid for the data type of the attributes in
* the template.
* Boolean value is checked for CK_TRUE or CK_FALSE when setting attributes.
*
* @param pTemplate [in] Template of attributes for object.
* @param ulCount [in] Number of attribute triplets in template.
* @param set [in] Whether attributes are being used to set or get
* value.
* @return CKR_ATTRIBUTE_TYPE_INVALID if the attribute type is not supported.
* CKR_ATTRIBUTE_VALUE_INVALID if value is not valid for data type.
* CKR_BUFFER_TOO_SMALL if length is too short for data type.
* CKR_OK on success.
*/
static CK_RV CheckAttributes(CK_ATTRIBUTE* pTemplate, CK_ULONG ulCount, int set)
{
CK_ATTRIBUTE* attr;
int i, j;
for (i = 0; i < (int)ulCount; i++) {
attr = &pTemplate[i];
for (j = 0; j < (int)ATTR_TYPE_SIZE; j++) {
if (attrType[j].attr == attr->type) {
break;
}
}
if (j == ATTR_TYPE_SIZE)
return CKR_ATTRIBUTE_TYPE_INVALID;
if (attrType[j].type == ATTR_TYPE_ULONG) {
if (attr->pValue == NULL && set)
return CKR_ATTRIBUTE_VALUE_INVALID;
if ((attr->pValue != NULL) &&
(attr->ulValueLen != sizeof(CK_ULONG)))
return CKR_BUFFER_TOO_SMALL;
}
else if (attrType[j].type == ATTR_TYPE_BOOL) {
if (attr->pValue == NULL && set)
return CKR_ATTRIBUTE_VALUE_INVALID;
if ((attr->pValue != NULL) &&
(attr->ulValueLen != sizeof(CK_BBOOL)))
return CKR_BUFFER_TOO_SMALL;
if (set && *(CK_BBOOL*)attr->pValue != CK_TRUE &&
*(CK_BBOOL*)attr->pValue != CK_FALSE) {
return CKR_ATTRIBUTE_VALUE_INVALID;
}
}
else if (attrType[j].type == ATTR_TYPE_DATE) {
if (attr->pValue == NULL && set)
return CKR_ATTRIBUTE_VALUE_INVALID;
if ((attr->pValue != NULL) &&
(attr->ulValueLen != sizeof(CK_DATE)))
return CKR_BUFFER_TOO_SMALL;
}
else if (attrType[j].type == ATTR_TYPE_DATA) {
if (set && attr->ulValueLen == CK_UNAVAILABLE_INFORMATION)
return CKR_ATTRIBUTE_VALUE_INVALID;
}
}
return CKR_OK;
}
static int CheckOpSupported(WP11_Object* obj, CK_ATTRIBUTE_TYPE op)
{
CK_BBOOL haveOp = 0;
CK_ULONG dataLen = sizeof(haveOp);
int ret = WP11_Object_GetAttr(obj, op, &haveOp, &dataLen);
if (ret != 0)
return ret;
if (!haveOp) {
WOLFPKCS11_MSG("Operation not supported by object");
return CKR_KEY_TYPE_INCONSISTENT;
}
return CKR_OK;
}
static CK_RV SetInitialStates(WP11_Object* key)
{
CK_RV rv;
CK_BBOOL trueVar = CK_TRUE;
CK_BBOOL getVar;
CK_ULONG getVarLen = sizeof(CK_BBOOL);
rv = WP11_Object_GetAttr(key, CKA_SENSITIVE, &getVar, &getVarLen);
if ((rv == CKR_OK) && (getVar == CK_TRUE)) {
rv = WP11_Object_SetAttr(key, CKA_ALWAYS_SENSITIVE, &trueVar,
sizeof(CK_BBOOL));
}
if (rv == CKR_OK) {
rv = WP11_Object_GetAttr(key, CKA_EXTRACTABLE, &getVar, &getVarLen);
if ((rv == CKR_OK) && (getVar == CK_FALSE)) {
rv = WP11_Object_SetAttr(key, CKA_NEVER_EXTRACTABLE, &trueVar,
sizeof(CK_BBOOL));
}
}
return rv;
}
static CK_RV TemplateHasAttribute(CK_ATTRIBUTE_TYPE type,
CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount)
{
for (CK_ULONG i = 0; i < ulCount; i++) {
if (type == pTemplate[i].type)
return CKR_OK;
}
return CKR_ATTRIBUTE_TYPE_INVALID;
}
static CK_RV SetIfNotFound(WP11_Object* obj, CK_ATTRIBUTE_TYPE type,
CK_BBOOL state, CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG ulCount)
{
CK_RV ret;
/* False states are always default */
if (state == CK_FALSE) {
return CKR_OK;
}
if (TemplateHasAttribute(type, pTemplate, ulCount) == CKR_OK) {
return CKR_OK;
}
ret = WP11_Object_SetAttr(obj, type, &state, sizeof(CK_BBOOL));
return ret;
}
static CK_RV SetAttributeDefaults(WP11_Object* obj, CK_OBJECT_CLASS keyType,
CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG ulCount)
{
CK_RV ret = CKR_OK;
CK_BBOOL trueVal = CK_TRUE;
CK_BBOOL falseVal = CK_FALSE;
CK_BBOOL encrypt = CK_TRUE;
CK_BBOOL recover = CK_TRUE;
CK_BBOOL wrap = CK_TRUE;
CK_BBOOL derive = (keyType == CKO_PUBLIC_KEY ? CK_FALSE : CK_TRUE);
CK_BBOOL verify = CK_TRUE;
CK_BBOOL sign = CK_FALSE;
CK_KEY_TYPE type = WP11_Object_GetType(obj);
switch (type) {
/* If we implement DSA
case CKK_DSA:
encrypt = CK_FALSE;
recover = CK_FALSE;
wrap = CK_FALSE;
sign = CK_TRUE;
derive = CK_FALSE;
break;
*/
case CKK_RSA:
derive = CK_FALSE;
sign = CK_TRUE;
break;
case CKK_DH:
verify = CK_FALSE;
derive = CK_TRUE;
encrypt = CK_FALSE;
recover = CK_FALSE;
wrap = CK_FALSE;
break;
case CKK_EC:
derive = CK_FALSE;
verify = CK_TRUE;
encrypt = CK_FALSE;
recover = CK_FALSE;
wrap = CK_FALSE;
sign = CK_TRUE;
break;
case CKK_ML_DSA:
derive = CK_FALSE;
verify = CK_TRUE;
encrypt = CK_FALSE;
recover = CK_FALSE;
wrap = CK_FALSE;
sign = CK_TRUE;
break;
}
/* Defaults if not set */
switch (keyType) {
case CKO_PUBLIC_KEY:
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_ENCRYPT, encrypt, pTemplate,
ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_VERIFY, verify, pTemplate,
ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_VERIFY_RECOVER, recover, pTemplate,
ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_WRAP, wrap, pTemplate, ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_DERIVE, derive, pTemplate,
ulCount);
break;
case CKO_SECRET_KEY:
#ifndef WOLFPKCS11_NSS
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_SENSITIVE, trueVal, pTemplate,
ulCount);
#endif
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_EXTRACTABLE, trueVal, pTemplate,
ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_ENCRYPT, trueVal, pTemplate,
ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_DECRYPT, trueVal, pTemplate,
ulCount);
/* CKA_SIGN / CKA_VERIFY default false */
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_WRAP, trueVal, pTemplate, ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_UNWRAP, trueVal, pTemplate,
ulCount);
break;
case CKO_PRIVATE_KEY:
#ifndef WOLFPKCS11_NSS
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_SENSITIVE, trueVal, pTemplate,
ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_EXTRACTABLE, falseVal, pTemplate,
ulCount);
#else
/* NSS operates as the internal crypto module and needs both
* non-sensitive and extractable private keys to read key material
* directly via C_GetAttributeValue during TLS operations. */
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_EXTRACTABLE, trueVal, pTemplate,
ulCount);
#endif
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_DECRYPT, encrypt, pTemplate,
ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_SIGN, sign, pTemplate, ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_SIGN_RECOVER, recover, pTemplate,
ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_UNWRAP, wrap, pTemplate, ulCount);
if (ret == CKR_OK)
ret = SetIfNotFound(obj, CKA_DERIVE, derive, pTemplate,
ulCount);
break;
}
/* Next two are forced attributes */
if (ret == CKR_OK &&
(keyType == CKO_PRIVATE_KEY || keyType == CKO_SECRET_KEY)) {
ret = WP11_Object_SetAttr(obj, CKA_ALWAYS_SENSITIVE, &falseVal,
sizeof(CK_BBOOL));
if (ret == CKR_OK)
ret = WP11_Object_SetAttr(obj, CKA_NEVER_EXTRACTABLE, &falseVal,
sizeof(CK_BBOOL));
}
return ret;
}
/**
* Set the values of the attributes into the object.
*
* @param session [in] Session object.
* @param obj [in] Object to set value against.
* @param pTemplate [in] Template of attributes set against object.
* @param ulCount [in] Number of attribute triplets in template.
* @return CKR_ARGUMENTS_BAD when pTemplate is NULL.
* CKR_SESSION_READ_ONLY when the session cannot modify objects.
* CKR_ATTRIBUTE_TYPE_INVALID if the attribute type is not supported.
* CKR_ATTRIBUTE_VALUE_INVALID if value is not valid for data type.
* CKR_BUFFER_TOO_SMALL if an attribute length is too short.
* CK_UNAVAILABLE_INFORMATION when an attribute type is not supported
* for modification.
* CKR_DEVICE_MEMORY when dynamic memory allocation fails.
* CKR_FUNCTION_FAILED when getting a value fails.
* CKR_OK on success.
*/
static CK_RV SetAttributeValue(WP11_Session* session, WP11_Object* obj,
CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount,
CK_BBOOL newObject)
{
int ret = 0;
CK_RV rv;
CK_ATTRIBUTE* attr;
int i, j;
unsigned char* data[OBJ_MAX_PARAMS] = { 0, };
CK_ULONG len[OBJ_MAX_PARAMS] = { 0, };
CK_ATTRIBUTE_TYPE* attrs = NULL;
int cnt;
CK_BBOOL attrsFound = 0;
CK_KEY_TYPE type;
CK_OBJECT_CLASS objClass;
CK_BBOOL getVar;
CK_ULONG getVarLen = 1;
if (pTemplate == NULL)
return CKR_ARGUMENTS_BAD;
/* Only require R/W session for token objects */
if (!WP11_Session_IsRW(session) && WP11_Object_OnToken(obj))
return CKR_SESSION_READ_ONLY;
rv = CheckAttributes(pTemplate, ulCount, 1);
if (rv != CKR_OK)
return rv;
type = WP11_Object_GetType(obj);
objClass = WP11_Object_GetClass(obj);
if (objClass == CKO_CERTIFICATE) {
attrs = certParams;
cnt = CERT_PARAMS_CNT;
}
#ifdef WOLFPKCS11_NSS
else if (objClass == CKO_NSS_TRUST) {
attrs = trustParams;
cnt = TRUST_PARAMS_CNT;
}
#endif
else if (objClass == CKO_DATA) {
attrs = genericDataParams;
cnt = DATA_PARAMS_CNT;
}
else {
/* Get the value and length of key specific attribute types. */
switch (type) {
#ifndef NO_RSA
case CKK_RSA:
attrs = rsaKeyParams;
cnt = RSA_KEY_PARAMS_CNT;
break;
#endif
#ifdef HAVE_ECC
case CKK_EC:
attrs = ecKeyParams;
cnt = EC_KEY_PARAMS_CNT;
break;
#endif
#ifdef WOLFPKCS11_MLDSA
case CKK_ML_DSA:
attrs = mldsaKeyParams;
cnt = MLDSA_KEY_PARAMS_CNT;
break;
#endif
#ifndef NO_DH
case CKK_DH:
attrs = dhKeyParams;
cnt = DH_KEY_PARAMS_CNT;
break;
#endif
#ifdef WOLFPKCS11_HKDF
case CKK_HKDF:
#endif
#ifndef NO_AES
case CKK_AES:
#endif
case CKK_GENERIC_SECRET:
attrs = secretKeyParams;
cnt = SECRET_KEY_PARAMS_CNT;
break;
default:
(void)len;
return CKR_OBJECT_HANDLE_INVALID;
}
}
for (i = 0; i < cnt; i++) {
for (j = 0; j < (int)ulCount; j++) {
if (attrs[i] == pTemplate[j].type) {
attrsFound = 1;
data[i] = (unsigned char*)pTemplate[j].pValue;
if (data[i] == NULL) {
/* For CKO_DATA, values can be NULL */
if (objClass != CKO_DATA)
return CKR_ATTRIBUTE_VALUE_INVALID;
}
len[i] = (int)pTemplate[j].ulValueLen;
break;
}
}
}
if (newObject == CK_TRUE || attrsFound == 1) {
if (objClass == CKO_CERTIFICATE) {
ret = WP11_Object_SetCert(obj, data, len);
}
#ifdef WOLFPKCS11_NSS
else if (objClass == CKO_NSS_TRUST) {
ret = WP11_Object_SetTrust(obj, data, len);
}
#endif
else if (objClass == CKO_DATA) {
ret = WP11_Object_DataObject(obj, data, len);
}
else {
/* Set the value and length of key specific attributes
* Old key data is cleared.
*/
switch (type) {
#ifndef NO_RSA
case CKK_RSA:
ret = WP11_Object_SetRsaKey(obj, data, len);
break;
#endif
#ifdef HAVE_ECC
case CKK_EC:
ret = WP11_Object_SetEcKey(obj, data, len);
break;
#endif
#ifdef WOLFPKCS11_MLDSA
case CKK_ML_DSA:
ret = WP11_Object_SetMldsaKey(obj, data, len);
break;
#endif
#ifndef NO_DH
case CKK_DH:
ret = WP11_Object_SetDhKey(obj, data, len);
break;
#endif
#ifndef NO_AES
case CKK_AES:
#endif
#ifdef WOLFPKCS11_HKDF
case CKK_HKDF:
#endif
case CKK_GENERIC_SECRET:
ret = WP11_Object_SetSecretKey(obj, data, len);
break;
default:
break;
}
}
if (ret == MEMORY_E)
return CKR_DEVICE_MEMORY;
if (ret != 0)
return CKR_FUNCTION_FAILED;
}
/* Set remaining attributes - key specific attributes ignored. */
for (i = 0; i < (int)ulCount; i++) {
attr = &pTemplate[i];
/* Cannot change sensitive from true to false */
if (attr->type == CKA_SENSITIVE) {
rv = WP11_Object_GetAttr(obj, CKA_SENSITIVE, &getVar, &getVarLen);
if (rv != CKR_OK)
return rv;
if ((getVar == CK_TRUE) && (*(CK_BBOOL*)attr->pValue == CK_FALSE))
return CKR_ATTRIBUTE_READ_ONLY;
}
/* Cannot change extractable from false to true */
if (!newObject && attr->type == CKA_EXTRACTABLE) {
getVarLen = sizeof(getVar);
rv = WP11_Object_GetAttr(obj, CKA_EXTRACTABLE, &getVar,
&getVarLen);
if (rv != CKR_OK)
return rv;
if ((getVar == CK_FALSE) && (*(CK_BBOOL*)attr->pValue == CK_TRUE))
return CKR_ATTRIBUTE_READ_ONLY;
}
ret = WP11_Object_SetAttr(obj, attr->type, (byte*)attr->pValue,
attr->ulValueLen);
if (ret == MEMORY_E)
return CKR_DEVICE_MEMORY;
else if (ret == BAD_FUNC_ARG)
return CKR_ATTRIBUTE_VALUE_INVALID;
else if (ret == BUFFER_E)
return CKR_BUFFER_TOO_SMALL;
else if (ret != 0)
return CKR_FUNCTION_FAILED;
}
return CKR_OK;
}
/**
* New Object object.
*
* @param session [in] Session object.
* @param keyType [in] Type of key object.
* @param keyClass [in] Class of key object.
* @param pTemplate [in] Array of attributes to create object with.
* @param ulCount [in] Count of elements in array.
* @param object [out] New Object object.
* @return CKR_DEVICE_MEMORY when dynamic memory allocation fails.
* CKR_FUNCTION_FAILED when setting an attribute fails.
* CKR_OK on success.
*/
static CK_RV NewObject(WP11_Session* session, CK_KEY_TYPE keyType,
CK_OBJECT_CLASS keyClass, CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG ulCount, WP11_Object** object)
{
int ret;
CK_RV rv;
WP11_Object* obj = NULL;
ret = WP11_Object_New(session, keyType, &obj);
if (ret == MEMORY_E)
return CKR_DEVICE_MEMORY;
if (ret != 0)
return CKR_FUNCTION_FAILED;
ret = WP11_Object_SetClass(obj, keyClass);
if (ret != 0) {
WP11_Object_Free(obj);
return CKR_FUNCTION_FAILED;
}
/* Now that object class is set, allocate type-specific data */
ret = wp11_Object_AllocateTypeData(obj);
if (ret == MEMORY_E) {
WP11_Object_Free(obj);
return CKR_DEVICE_MEMORY;
}
if (ret != 0) {
WP11_Object_Free(obj);
return CKR_FUNCTION_FAILED;
}
rv = SetAttributeValue(session, obj, pTemplate, ulCount, CK_TRUE);
if (rv != CKR_OK) {
WP11_Object_Free(obj);
return rv;
}
switch(keyClass) {
case CKO_PRIVATE_KEY:
case CKO_SECRET_KEY:
case CKO_PUBLIC_KEY:
rv = SetAttributeDefaults(obj, keyClass, pTemplate, ulCount);
break;
default:
/* For other types, such as potential CKO_DATA, not needed */
rv = CKR_OK;
break;
}
if (rv != CKR_OK) {
WP11_Object_Free(obj);
return rv;
}
*object = obj;
return CKR_OK;
}
/**
* Add an object to the session.
*
* @param session [in] Session object.
* @param object [in] Object object.
* @param pTemplate [in] Array of attributes.
* @param ulCount [in] Count of elements in array.
* @param phKey [out] Handle to new key object.
* @return CKR_ATTRIBUTE_VALUE_INVALID when attribute value is not valid for
* data type.
* CKR_FUNCTION_FAILED when setting an attribute fails.
* CKR_OK on success.
*/
static CK_RV AddObject(WP11_Session* session, WP11_Object* object,
CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount,
CK_OBJECT_HANDLE_PTR phKey)
{
int ret;
CK_ATTRIBUTE* attr;
int onToken = 0;
FindAttributeType(pTemplate, ulCount, CKA_TOKEN, &attr);
if (attr != NULL) {
if (attr->pValue == NULL)
return CKR_ATTRIBUTE_VALUE_INVALID;
if (attr->ulValueLen != sizeof(CK_BBOOL))
return CKR_ATTRIBUTE_VALUE_INVALID;
onToken = *(CK_BBOOL*)attr->pValue;
}
ret = WP11_Session_AddObject(session, onToken, object);
if (ret != 0)
return CKR_FUNCTION_FAILED;
*phKey = WP11_Object_GetHandle(object);
return CKR_OK;
}
#ifndef NO_RSA
/**
* Create an RSA private key object in the session or on the token associated with the session.
*
* @param session [in] Handle of session.
* @param pTemplate [in] Template of attributes for object.
* @param ulCount [in] Number of attribute triplets in template.
* @param derBuf [in] DER-encoded private key
* @param derLen [in] Length of the DER-encoded key data
* @param phKey [out] pointer to hold the handle to the new key object
* @return CKR_CRYPTOKI_NOT_INITIALIZED when library not initialized.
* CKR_SESSION_HANDLE_INVALID when session handle is not valid.
* CKR_ARGUMENTS_BAD when pTemplate or phObject is NULL.
* CKR_SESSION_READ_ONLY when the session cannot create objects.
* CKR_TEMPLATE_INCOMPLETE when CKA_KEY_TYPE is missing.
* CKR_ATTRIBUTE_VALUE_INVALID when an attribute has invalid value or
* length.
* CKR_DEVICE_MEMORY when dynamic memory allocation fails.
* CKR_FUNCTION_FAILED when creating the object fails.
* CKR_WRAPPED_KEY_INVALID when DER-encoded key data isn't valid
* CKR_OK on success.
*/
static CK_RV AddRSAPrivateKeyObject(WP11_Session* session,
CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount, byte* derBuf, CK_ULONG derLen,
CK_OBJECT_HANDLE_PTR phKey)
{
CK_RV rv;
WP11_Object* privKeyObject = NULL;
*phKey = CK_INVALID_HANDLE;
rv = NewObject(session, CKK_RSA, CKO_PRIVATE_KEY,
pTemplate, ulCount,
&privKeyObject);
if (rv != CKR_OK)
return rv;
if (WP11_Rsa_ParsePrivKey(derBuf, (word32)derLen, privKeyObject) != 0 ) {
rv = CKR_WRAPPED_KEY_INVALID;
goto err_out;
}
rv = AddObject(session, privKeyObject, pTemplate, ulCount, phKey);
/* Some other libraries create a public key object along with private key.
* We'll do that when WOLFPKCS11_KEYPAIR_GEN_COMMON_LABEL is defined.
*/
#ifdef WOLFPKCS11_KEYPAIR_GEN_COMMON_LABEL
{
const int TOKEN_IDX = 0;
const int LABEL_IDX = 1;
WP11_Object* pubKeyObject = NULL;
CK_ATTRIBUTE* attr = NULL;
CK_BBOOL trueVal = CK_TRUE;
CK_BBOOL falseVal = CK_FALSE;
CK_OBJECT_HANDLE hPub;
CK_ATTRIBUTE pubt[] = {
{CKA_TOKEN, NULL, sizeof(CK_BBOOL)},
{CKA_LABEL, NULL, 0},
{CKA_WRAP, &falseVal, sizeof(falseVal)},
{CKA_VERIFY, &trueVal, sizeof(trueVal)},
{CKA_ENCRYPT, &trueVal, sizeof(trueVal)}
};
if (rv != CKR_OK)
goto err_out;
FindAttributeType(pTemplate, ulCount, CKA_TOKEN, &attr);
if (attr != NULL)
if (attr->pValue != NULL && attr->ulValueLen == sizeof(CK_BBOOL))
pubt[TOKEN_IDX].pValue = attr->pValue;
FindAttributeType(pTemplate, ulCount, CKA_LABEL, &attr);
if (attr != NULL) {
if (attr->pValue != NULL && attr->ulValueLen != 0) {
pubt[LABEL_IDX].pValue = attr->pValue;
pubt[LABEL_IDX].ulValueLen = attr->ulValueLen;
}
}
rv = NewObject(session, CKK_RSA, CKO_PUBLIC_KEY,
pubt, sizeof(pubt) / sizeof(CK_ATTRIBUTE),
&pubKeyObject);
if (rv != CKR_OK)
goto err_out;