/
util_pkcs11.c
5325 lines (4608 loc) · 154 KB
/
util_pkcs11.c
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
/*
* Copyright 2015-2018 Yubico AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <ctype.h>
#include <yubihsm.h>
#include <pkcs11y.h>
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include "../common/platform-config.h"
#include "../common/util.h"
#include "../common/time_win.h"
#ifdef __WIN32
#include <winsock.h>
#else
#include <arpa/inet.h>
#include <pthread.h>
#endif
#include <openssl/ec.h>
#include <openssl/ecdsa.h>
#include <openssl/rsa.h>
#include <openssl/x509.h>
#include "util_pkcs11.h"
#include "debug_p11.h"
#include "../common/util.h"
#include "../common/openssl-compat.h"
#include "../common/insecure_memzero.h"
#define UNUSED(x) (void) (x)
#define ASN1_OID 0x06
static const uint8_t oid_secp224r1[] = {ASN1_OID, 0x05, 0x2b, 0x81,
0x04, 0x00, 0x21};
static const uint8_t oid_secp256r1[] = {ASN1_OID, 0x08, 0x2a, 0x86, 0x48,
0xce, 0x3d, 0x03, 0x01, 0x07};
static const uint8_t oid_secp384r1[] = {ASN1_OID, 0x05, 0x2b, 0x81,
0x04, 0x00, 0x22};
static const uint8_t oid_secp521r1[] = {ASN1_OID, 0x05, 0x2b, 0x81,
0x04, 0x00, 0x23};
static const uint8_t oid_secp256k1[] = {ASN1_OID, 0x05, 0x2b, 0x81,
0x04, 0x00, 0x0a};
static const uint8_t oid_brainpool256r1[] = {ASN1_OID, 0x09, 0x2b, 0x24,
0x03, 0x03, 0x02, 0x08,
0x01, 0x01, 0x07};
static const uint8_t oid_brainpool384r1[] = {ASN1_OID, 0x09, 0x2b, 0x24,
0x03, 0x03, 0x02, 0x08,
0x01, 0x01, 0x0b};
static const uint8_t oid_brainpool512r1[] = {ASN1_OID, 0x09, 0x2b, 0x24,
0x03, 0x03, 0x02, 0x08,
0x01, 0x01, 0x0d};
CK_RV yrc_to_rv(yh_rc rc) {
switch (rc) {
case YHR_SUCCESS:
return CKR_OK;
case YHR_MEMORY_ERROR:
return CKR_HOST_MEMORY;
case YHR_INIT_ERROR:
return CKR_GENERAL_ERROR;
case YHR_CONNECTION_ERROR:
return CKR_DEVICE_REMOVED;
case YHR_CONNECTOR_NOT_FOUND:
return CKR_TOKEN_NOT_PRESENT;
case YHR_INVALID_PARAMETERS:
return CKR_ARGUMENTS_BAD;
case YHR_WRONG_LENGTH:
return CKR_DATA_LEN_RANGE;
case YHR_BUFFER_TOO_SMALL:
return CKR_BUFFER_TOO_SMALL;
case YHR_CRYPTOGRAM_MISMATCH:
return CKR_ENCRYPTED_DATA_INVALID;
case YHR_SESSION_AUTHENTICATION_FAILED:
return CKR_ENCRYPTED_DATA_INVALID;
case YHR_MAC_MISMATCH:
return CKR_ENCRYPTED_DATA_INVALID;
case YHR_DEVICE_OK:
return CKR_OK;
case YHR_DEVICE_INVALID_COMMAND:
return CKR_DEVICE_ERROR;
case YHR_DEVICE_INVALID_DATA:
return CKR_DEVICE_ERROR;
case YHR_DEVICE_INVALID_SESSION:
return CKR_SESSION_CLOSED;
case YHR_DEVICE_AUTHENTICATION_FAILED:
return CKR_DEVICE_ERROR;
case YHR_DEVICE_SESSIONS_FULL:
return CKR_SESSION_COUNT;
case YHR_DEVICE_SESSION_FAILED:
return CKR_DEVICE_ERROR;
case YHR_DEVICE_STORAGE_FAILED:
return CKR_DEVICE_MEMORY;
case YHR_DEVICE_WRONG_LENGTH:
return CKR_DATA_LEN_RANGE;
case YHR_DEVICE_INSUFFICIENT_PERMISSIONS:
return CKR_FUNCTION_REJECTED;
case YHR_DEVICE_LOG_FULL:
return CKR_DEVICE_MEMORY;
case YHR_DEVICE_OBJECT_NOT_FOUND:
return CKR_OBJECT_HANDLE_INVALID;
case YHR_DEVICE_INVALID_ID:
return CKR_OBJECT_HANDLE_INVALID;
case YHR_DEVICE_INVALID_OTP:
return CKR_DEVICE_ERROR;
case YHR_DEVICE_DEMO_MODE:
return CKR_FUNCTION_REJECTED;
case YHR_DEVICE_COMMAND_UNEXECUTED:
return CKR_DEVICE_ERROR;
case YHR_GENERIC_ERROR:
return CKR_FUNCTION_FAILED;
case YHR_DEVICE_OBJECT_EXISTS:
return CKR_ATTRIBUTE_VALUE_INVALID;
case YHR_CONNECTOR_ERROR:
return CKR_DEVICE_REMOVED;
case YHR_DEVICE_SSH_CA_CONSTRAINT_VIOLATION:
return CKR_FUNCTION_REJECTED;
case YHR_DEVICE_ALGORITHM_DISABLED:
return CKR_FUNCTION_REJECTED;
default:
return CKR_GENERAL_ERROR;
}
}
static void add_mech(CK_MECHANISM_TYPE *buf, CK_ULONG_PTR count,
CK_MECHANISM_TYPE item) {
for (CK_ULONG i = 0; i < *count; i++) {
if (buf[i] == item) {
return;
}
}
buf[*count] = item;
*count = *count + 1;
}
CK_RV set_operation_part(yubihsm_pkcs11_op_info *op_info,
yubihsm_pkcs11_part_type part) {
if (part == PART_INIT || op_info->part == PART_INIT ||
op_info->part == part) {
op_info->part = part;
return CKR_OK;
}
return CKR_OPERATION_ACTIVE;
}
CK_RV get_mechanism_list(yubihsm_pkcs11_slot *slot,
CK_MECHANISM_TYPE_PTR pMechanismList,
CK_ULONG_PTR count) {
if (slot->n_algorithms == 0) {
slot->n_algorithms = sizeof(slot->algorithms) / sizeof(slot->algorithms[0]);
yh_rc yrc =
yh_util_get_device_info(slot->connector, NULL, NULL, NULL, NULL, NULL,
NULL, slot->algorithms, &slot->n_algorithms);
if (yrc != YHR_SUCCESS) {
return yrc_to_rv(yrc);
}
}
CK_MECHANISM_TYPE buffer[128] = {0}; // NOTE: this is a bit hardcoded, but much more
// than what we might add below.
CK_ULONG items = 0;
for (size_t i = 0; i < slot->n_algorithms; i++) {
switch (slot->algorithms[i]) {
case YH_ALGO_RSA_PKCS1_SHA1:
add_mech(buffer, &items, CKM_RSA_PKCS);
add_mech(buffer, &items, CKM_SHA1_RSA_PKCS);
break;
case YH_ALGO_RSA_PKCS1_SHA256:
add_mech(buffer, &items, CKM_RSA_PKCS);
add_mech(buffer, &items, CKM_SHA256_RSA_PKCS);
break;
case YH_ALGO_RSA_PKCS1_SHA384:
add_mech(buffer, &items, CKM_RSA_PKCS);
add_mech(buffer, &items, CKM_SHA384_RSA_PKCS);
break;
case YH_ALGO_RSA_PKCS1_SHA512:
add_mech(buffer, &items, CKM_RSA_PKCS);
add_mech(buffer, &items, CKM_SHA512_RSA_PKCS);
break;
case YH_ALGO_RSA_PSS_SHA1:
add_mech(buffer, &items, CKM_RSA_PKCS_PSS);
add_mech(buffer, &items, CKM_SHA1_RSA_PKCS_PSS);
break;
case YH_ALGO_RSA_PSS_SHA256:
add_mech(buffer, &items, CKM_RSA_PKCS_PSS);
add_mech(buffer, &items, CKM_SHA256_RSA_PKCS_PSS);
break;
case YH_ALGO_RSA_PSS_SHA384:
add_mech(buffer, &items, CKM_RSA_PKCS_PSS);
add_mech(buffer, &items, CKM_SHA384_RSA_PKCS_PSS);
break;
case YH_ALGO_RSA_PSS_SHA512:
add_mech(buffer, &items, CKM_RSA_PKCS_PSS);
add_mech(buffer, &items, CKM_SHA512_RSA_PKCS_PSS);
break;
case YH_ALGO_RSA_2048:
case YH_ALGO_RSA_3072:
case YH_ALGO_RSA_4096:
add_mech(buffer, &items, CKM_RSA_PKCS_KEY_PAIR_GEN);
break;
case YH_ALGO_EC_P224:
case YH_ALGO_EC_P256:
case YH_ALGO_EC_P384:
case YH_ALGO_EC_P521:
case YH_ALGO_EC_K256:
case YH_ALGO_EC_BP256:
case YH_ALGO_EC_BP384:
case YH_ALGO_EC_BP512:
add_mech(buffer, &items, CKM_EC_KEY_PAIR_GEN);
break;
case YH_ALGO_HMAC_SHA1:
add_mech(buffer, &items, CKM_SHA_1_HMAC);
add_mech(buffer, &items, CKM_GENERIC_SECRET_KEY_GEN);
break;
case YH_ALGO_HMAC_SHA256:
add_mech(buffer, &items, CKM_SHA256_HMAC);
add_mech(buffer, &items, CKM_GENERIC_SECRET_KEY_GEN);
break;
case YH_ALGO_HMAC_SHA384:
add_mech(buffer, &items, CKM_SHA384_HMAC);
add_mech(buffer, &items, CKM_GENERIC_SECRET_KEY_GEN);
break;
case YH_ALGO_HMAC_SHA512:
add_mech(buffer, &items, CKM_SHA512_HMAC);
add_mech(buffer, &items, CKM_GENERIC_SECRET_KEY_GEN);
break;
case YH_ALGO_EC_ECDSA_SHA1:
add_mech(buffer, &items, CKM_ECDSA);
add_mech(buffer, &items, CKM_ECDSA_SHA1);
break;
case YH_ALGO_EC_ECDSA_SHA256:
add_mech(buffer, &items, CKM_ECDSA);
add_mech(buffer, &items, CKM_ECDSA_SHA256);
break;
case YH_ALGO_EC_ECDSA_SHA384:
add_mech(buffer, &items, CKM_ECDSA);
add_mech(buffer, &items, CKM_ECDSA_SHA384);
break;
case YH_ALGO_EC_ECDSA_SHA512:
add_mech(buffer, &items, CKM_ECDSA);
add_mech(buffer, &items, CKM_ECDSA_SHA512);
break;
case YH_ALGO_EC_ECDH:
add_mech(buffer, &items, CKM_ECDH1_DERIVE);
break;
case YH_ALGO_RSA_OAEP_SHA1:
case YH_ALGO_RSA_OAEP_SHA256:
case YH_ALGO_RSA_OAEP_SHA384:
case YH_ALGO_RSA_OAEP_SHA512:
add_mech(buffer, &items, CKM_RSA_PKCS_OAEP);
break;
case YH_ALGO_AES128_CCM_WRAP:
case YH_ALGO_AES192_CCM_WRAP:
case YH_ALGO_AES256_CCM_WRAP:
add_mech(buffer, &items, CKM_YUBICO_AES_CCM_WRAP);
add_mech(buffer, &items, CKM_GENERIC_SECRET_KEY_GEN);
break;
case YH_ALGO_AES128:
case YH_ALGO_AES192:
case YH_ALGO_AES256:
add_mech(buffer, &items, CKM_AES_KEY_GEN);
break;
case YH_ALGO_AES_ECB:
add_mech(buffer, &items, CKM_AES_ECB);
break;
case YH_ALGO_AES_CBC:
add_mech(buffer, &items, CKM_AES_CBC);
add_mech(buffer, &items, CKM_AES_CBC_PAD);
break;
// NOTE: there are algorithms don't have corresponding mechanisms
default:
break;
}
}
// NOTE(adma): manually add digest mechanisms
add_mech(buffer, &items, CKM_SHA_1);
add_mech(buffer, &items, CKM_SHA256);
add_mech(buffer, &items, CKM_SHA384);
add_mech(buffer, &items, CKM_SHA512);
if (pMechanismList != NULL) {
if (items > *count) {
*count = items;
return CKR_BUFFER_TOO_SMALL;
}
memcpy(pMechanismList, buffer, sizeof(CK_MECHANISM_TYPE) * items);
}
*count = items;
return CKR_OK;
}
static void find_minmax_rsa_key_length_in_bits(yh_algorithm *algorithms,
size_t n_algorithms,
CK_ULONG *min, CK_ULONG *max) {
*min = 0;
*max = 0;
for (size_t i = 0; i < n_algorithms; i++) {
CK_ULONG size;
switch (algorithms[i]) {
case YH_ALGO_RSA_2048:
size = 2048;
break;
case YH_ALGO_RSA_3072:
size = 3072;
break;
case YH_ALGO_RSA_4096:
size = 4096;
break;
default:
size = 0;
}
if (size == 0) {
continue;
}
if (*min == 0 || *min > size) {
*min = size;
}
if (size > *max) {
*max = size;
}
}
}
static void find_minmax_ec_key_length_in_bits(yh_algorithm *algorithms,
size_t n_algorithms,
CK_ULONG *min, CK_ULONG *max) {
*min = 0;
*max = 0;
for (size_t i = 0; i < n_algorithms; i++) {
CK_ULONG size;
switch (algorithms[i]) {
case YH_ALGO_EC_P224:
size = 224;
break;
case YH_ALGO_EC_P256:
case YH_ALGO_EC_K256:
case YH_ALGO_EC_BP256:
size = 256;
break;
case YH_ALGO_EC_P384:
case YH_ALGO_EC_BP384:
size = 384;
break;
case YH_ALGO_EC_BP512:
size = 512;
break;
case YH_ALGO_EC_P521:
size = 521;
break;
default:
size = 0;
}
if (size == 0) {
continue;
}
if (*min == 0 || *min > size) {
*min = size;
}
if (size > *max) {
*max = size;
}
}
}
static void find_minmax_aes_key_length_in_bytes(yh_algorithm *algorithms,
size_t n_algorithms,
CK_ULONG *min, CK_ULONG *max) {
*min = 0;
*max = 0;
for (size_t i = 0; i < n_algorithms; i++) {
CK_ULONG size;
switch (algorithms[i]) {
case YH_ALGO_AES128:
size = 16;
break;
case YH_ALGO_AES192:
size = 24;
break;
case YH_ALGO_AES256:
size = 32;
break;
default:
size = 0;
break;
}
if (size == 0) {
continue;
}
if (*min == 0 || *min > size) {
*min = size;
}
if (size > *max) {
*max = size;
}
}
}
CK_RV get_mechanism_info(yubihsm_pkcs11_slot *slot, CK_MECHANISM_TYPE type,
CK_MECHANISM_INFO_PTR pInfo) {
if (slot->n_algorithms == 0) {
slot->n_algorithms = sizeof(slot->algorithms) / sizeof(slot->algorithms[0]);
yh_rc yrc =
yh_util_get_device_info(slot->connector, NULL, NULL, NULL, NULL, NULL,
NULL, slot->algorithms, &slot->n_algorithms);
if (yrc != YHR_SUCCESS) {
return yrc_to_rv(yrc);
}
}
pInfo->flags = 0;
switch (type) {
case CKM_RSA_PKCS:
pInfo->flags = CKF_DECRYPT | CKF_ENCRYPT;
case CKM_SHA1_RSA_PKCS:
case CKM_SHA256_RSA_PKCS:
case CKM_SHA384_RSA_PKCS:
case CKM_SHA512_RSA_PKCS:
find_minmax_rsa_key_length_in_bits(slot->algorithms, slot->n_algorithms,
&pInfo->ulMinKeySize,
&pInfo->ulMaxKeySize);
pInfo->flags |= CKF_HW | CKF_SIGN | CKF_VERIFY;
break;
case CKM_RSA_PKCS_PSS:
case CKM_SHA1_RSA_PKCS_PSS:
case CKM_SHA256_RSA_PKCS_PSS:
case CKM_SHA384_RSA_PKCS_PSS:
case CKM_SHA512_RSA_PKCS_PSS:
find_minmax_rsa_key_length_in_bits(slot->algorithms, slot->n_algorithms,
&pInfo->ulMinKeySize,
&pInfo->ulMaxKeySize);
pInfo->flags = CKF_HW | CKF_SIGN | CKF_VERIFY;
break;
case CKM_RSA_PKCS_OAEP:
find_minmax_rsa_key_length_in_bits(slot->algorithms, slot->n_algorithms,
&pInfo->ulMinKeySize,
&pInfo->ulMaxKeySize);
pInfo->flags = CKF_HW | CKF_DECRYPT | CKF_ENCRYPT;
break;
case CKM_RSA_PKCS_KEY_PAIR_GEN:
find_minmax_rsa_key_length_in_bits(slot->algorithms, slot->n_algorithms,
&pInfo->ulMinKeySize,
&pInfo->ulMaxKeySize);
pInfo->flags = CKF_HW | CKF_GENERATE_KEY_PAIR;
break;
case CKM_EC_KEY_PAIR_GEN:
find_minmax_ec_key_length_in_bits(slot->algorithms, slot->n_algorithms,
&pInfo->ulMinKeySize,
&pInfo->ulMaxKeySize);
pInfo->flags = CKF_HW | CKF_GENERATE_KEY_PAIR | CKF_EC_F_P |
CKF_EC_NAMEDCURVE | CKF_EC_UNCOMPRESS;
break;
case CKM_SHA_1_HMAC:
pInfo->ulMaxKeySize = 64 * 8;
pInfo->ulMinKeySize = 1;
pInfo->flags = CKF_HW | CKF_SIGN | CKF_VERIFY;
break;
case CKM_SHA256_HMAC:
pInfo->ulMaxKeySize = 64 * 8;
pInfo->ulMinKeySize = 1;
pInfo->flags = CKF_HW | CKF_SIGN | CKF_VERIFY;
break;
case CKM_SHA384_HMAC:
pInfo->ulMaxKeySize = 128 * 8;
pInfo->ulMinKeySize = 1;
pInfo->flags = CKF_HW | CKF_SIGN | CKF_VERIFY;
break;
case CKM_SHA512_HMAC:
pInfo->ulMaxKeySize = 128 * 8;
pInfo->ulMinKeySize = 1;
pInfo->flags = CKF_HW | CKF_SIGN | CKF_VERIFY;
break;
case CKM_ECDSA:
case CKM_ECDSA_SHA1:
case CKM_ECDSA_SHA256:
case CKM_ECDSA_SHA384:
case CKM_ECDSA_SHA512:
// should all ecdsa mechanisms have all keylengths? or should they be
// bounded to length of hash?
find_minmax_ec_key_length_in_bits(slot->algorithms, slot->n_algorithms,
&pInfo->ulMinKeySize,
&pInfo->ulMaxKeySize);
pInfo->flags = CKF_HW | CKF_SIGN | CKF_VERIFY | CKF_EC_F_P |
CKF_EC_NAMEDCURVE | CKF_EC_UNCOMPRESS;
break;
case CKM_ECDH1_DERIVE:
find_minmax_ec_key_length_in_bits(slot->algorithms, slot->n_algorithms,
&pInfo->ulMinKeySize,
&pInfo->ulMaxKeySize);
pInfo->flags = CKF_HW | CKF_DERIVE | CKF_EC_F_P | CKF_EC_NAMEDCURVE |
CKF_EC_UNCOMPRESS;
break;
case CKM_SHA_1:
pInfo->ulMaxKeySize = 0; // NOTE(adma): ignored
pInfo->ulMinKeySize = 0; // NOTE(adma): ignored
pInfo->flags = CKF_DIGEST;
break;
case CKM_SHA256:
pInfo->ulMaxKeySize = 0; // NOTE(adma): ignored
pInfo->ulMinKeySize = 0; // NOTE(adma): ignored
pInfo->flags = CKF_DIGEST;
break;
case CKM_SHA384:
pInfo->ulMaxKeySize = 0; // NOTE(adma): ignored
pInfo->ulMinKeySize = 0; // NOTE(adma): ignored
pInfo->flags = CKF_DIGEST;
break;
case CKM_SHA512:
pInfo->ulMaxKeySize = 0; // NOTE(adma): ignored
pInfo->ulMinKeySize = 0; // NOTE(adma): ignored
pInfo->flags = CKF_DIGEST;
break;
case CKM_YUBICO_AES_CCM_WRAP:
pInfo->ulMaxKeySize = 256;
pInfo->ulMinKeySize = 128;
pInfo->flags = CKF_HW | CKF_WRAP | CKF_UNWRAP | CKF_ENCRYPT | CKF_DECRYPT;
break;
case CKM_GENERIC_SECRET_KEY_GEN:
pInfo->ulMaxKeySize =
128 * 8; // NOTE: 128*8 is max key size for sha512-hmac keys
pInfo->ulMinKeySize = 1;
pInfo->flags = CKF_HW | CKF_GENERATE;
break;
case CKM_AES_KEY_GEN:
find_minmax_aes_key_length_in_bytes(slot->algorithms, slot->n_algorithms,
&pInfo->ulMinKeySize,
&pInfo->ulMaxKeySize);
pInfo->flags = CKF_HW | CKF_GENERATE;
break;
case CKM_AES_ECB:
case CKM_AES_CBC:
case CKM_AES_CBC_PAD:
find_minmax_aes_key_length_in_bytes(slot->algorithms, slot->n_algorithms,
&pInfo->ulMinKeySize,
&pInfo->ulMaxKeySize);
pInfo->flags = CKF_HW | CKF_ENCRYPT | CKF_DECRYPT;
break;
default:
DBG_ERR("Invalid mechanism %lu", type);
return CKR_MECHANISM_INVALID;
}
return CKR_OK;
}
#define PKCS11_ID_TAG 1
#define PKCS11_LABEL_TAG 2
#define PKCS11_PUBKEY_ID_TAG 3
#define PKCS11_PUBKEY_LABEL_TAG 4
const char META_OBJECT_VERSION[4] = "MDB1";
static uint16_t write_meta_item(uint8_t *target_value, uint8_t tag,
cka_meta_item *meta_item) {
if (meta_item->len == 0) {
return 0;
}
uint8_t *p = target_value;
*p++ = tag;
*(uint16_t *) p = htons(meta_item->len);
p += 2;
memcpy(p, &meta_item->value, meta_item->len);
return meta_item->len + 3;
}
static uint16_t read_meta_item(uint8_t *value, cka_meta_item *meta_item) {
uint8_t *p = value;
meta_item->len = ntohs(*(uint16_t *) p);
if (meta_item->len > CKA_ATTRIBUTE_VALUE_SIZE) {
DBG_ERR("Parsed meta item length is too long");
return 0;
}
p += 2;
memcpy(&meta_item->value, p, meta_item->len);
return meta_item->len + 2;
}
/*
* Meta object value structure:
* byte 0-3 : META_OBJECT_VERSION (always present)
* byte 4: Original object type (always present)
* byte 5 and 6: Original object ID (always present)
* byte 7: original object sequence
* byte 8 and onward: TLV tripplets
*/
static CK_RV read_meta_object(yubihsm_pkcs11_slot *slot, uint16_t opaque_id,
pkcs11_meta_object *meta_object) {
uint8_t opaque_value[YH_MSG_BUF_SIZE] = {0};
size_t opaque_value_len = sizeof(opaque_value);
yh_rc yrc = yh_util_get_opaque(slot->device_session, opaque_id, opaque_value,
&opaque_value_len);
if (yrc != YHR_SUCCESS) {
DBG_ERR("Failed to read meta object 0x%x from device", opaque_id);
return yrc_to_rv(yrc);
}
// 4 (version) + 1 (object type) + 2 (id) + 1 (sequence)
if (opaque_value_len < 8) {
DBG_ERR("Opaque value to import is too small to be a meta obeject data");
return CKR_DATA_INVALID;
}
uint8_t *p = opaque_value;
if (memcmp(p, META_OBJECT_VERSION, sizeof(META_OBJECT_VERSION)) != 0) {
DBG_ERR("Meta object value has unexpected version");
return CKR_DATA_INVALID;
}
p += sizeof(META_OBJECT_VERSION);
meta_object->target_type = *p++;
meta_object->target_id = ntohs(*(uint16_t *) p);
p += 2;
meta_object->target_sequence = *p++;
while (p < opaque_value + opaque_value_len) {
uint16_t len = 0;
switch (*p++) {
case PKCS11_ID_TAG:
len = read_meta_item(p, &meta_object->cka_id);
break;
case PKCS11_LABEL_TAG:
len = read_meta_item(p, &meta_object->cka_label);
break;
case PKCS11_PUBKEY_ID_TAG:
len = read_meta_item(p, &meta_object->cka_id_pubkey);
break;
case PKCS11_PUBKEY_LABEL_TAG:
len = read_meta_item(p, &meta_object->cka_label_pubkey);
break;
default:
DBG_ERR("Unknown tag in value of opaque PKCS11 object");
return CKR_DATA_INVALID;
}
if (len == 0) {
return CKR_DATA_INVALID;
}
p += len;
}
return CKR_OK;
}
yubihsm_pkcs11_object_desc *_get_object_desc(yubihsm_pkcs11_slot *slot,
uint16_t id, uint8_t type,
uint16_t sequence) {
yubihsm_pkcs11_object_desc *object = NULL;
for (uint16_t i = 0; i < YH_MAX_ITEMS_COUNT; i++) {
if (slot->objects[i].object.id == id &&
(slot->objects[i].object.type & 0x7f) == (type & 0x7f)) {
object = &slot->objects[i];
if (sequence != 0xffff &&
object->object.sequence !=
sequence) { // Force refresh if cache entry has wrong sequence
memset(object, 0, sizeof(yubihsm_pkcs11_object_desc));
}
break;
}
}
if (!object) {
uint16_t low = 0;
struct timeval *low_time = NULL;
for (uint16_t i = 0; i < YH_MAX_ITEMS_COUNT; i++) {
if (slot->objects[i].tv.tv_sec == 0) {
low = i;
low_time = &slot->objects[i].tv;
break;
} else {
if (!low_time || slot->objects[i].tv.tv_sec < low_time->tv_sec ||
(slot->objects[i].tv.tv_sec == low_time->tv_sec &&
slot->objects[i].tv.tv_usec < low_time->tv_usec)) {
low_time = &slot->objects[i].tv;
low = i;
}
}
}
object = &slot->objects[low];
memset(object, 0, sizeof(yubihsm_pkcs11_object_desc));
}
if (object->tv.tv_sec == 0) {
yh_rc yrc = yh_util_get_object_info(slot->device_session, id, type & 0x7f,
&object->object);
if (yrc != YHR_SUCCESS) {
return NULL;
}
if (is_meta_object(&object->object)) {
// fill in the meta_object value
CK_RV rv =
read_meta_object(slot, object->object.id, &object->meta_object);
if (rv != CKR_OK) {
DBG_ERR("Failed to refresh meta object 0x%x", object->object.id);
return NULL;
}
}
}
object->object.type = type;
gettimeofday(&object->tv, NULL);
if (sequence != 0xffff && object->object.sequence != sequence) {
return NULL; // Only return for correct sequence
}
return object;
}
yubihsm_pkcs11_object_desc *get_object_desc(yubihsm_pkcs11_slot *slot,
CK_OBJECT_HANDLE objHandle) {
uint16_t id = objHandle & 0xffff;
uint8_t type = (objHandle >> 16);
uint8_t sequence = objHandle >> 24;
return _get_object_desc(slot, id, type, sequence);
}
static bool check_domains(uint16_t subset_domains, uint16_t domains) {
for (uint16_t i = 0; i < YH_MAX_DOMAINS; i++) {
if ((subset_domains & (1 << i)) && !(domains & (1 << i))) {
return false;
}
}
return true;
}
CK_RV write_meta_object(yubihsm_pkcs11_slot *slot,
pkcs11_meta_object *meta_object,
yh_capabilities *target_capabilities,
uint16_t target_domains, bool replace) {
if (!check_domains(target_domains, slot->authkey_domains)) {
DBG_ERR(
"Current user's domain access does not match target_object domains.");
return CKR_FUNCTION_REJECTED;
}
size_t opaque_value_len =
8 /* 4 version + 1 original type + 2 original ID 1 opaque sequence */ +
(meta_object->cka_id.len == 0 ? 0 : 3 + meta_object->cka_id.len) +
(meta_object->cka_label.len == 0 ? 0 : 3 + meta_object->cka_label.len) +
(meta_object->cka_id_pubkey.len == 0 ? 0
: 3 + meta_object->cka_id_pubkey.len) +
(meta_object->cka_label_pubkey.len == 0
? 0
: 3 + meta_object->cka_label_pubkey.len);
// 3: 1 tag + 2 value length
if (opaque_value_len > (YH_MSG_BUF_SIZE - 20)) {
DBG_ERR("Failed to write meta object to device. Meta object too large.");
return CKR_DATA_INVALID;
}
uint8_t opaque_value[YH_MSG_BUF_SIZE] = {0};
uint8_t *p = opaque_value;
memcpy(p, META_OBJECT_VERSION, sizeof(META_OBJECT_VERSION));
p += sizeof(META_OBJECT_VERSION);
*p++ = meta_object->target_type;
*(uint16_t *) p = htons(meta_object->target_id);
p += 2;
*p++ = meta_object->target_sequence;
p += write_meta_item(p, PKCS11_ID_TAG, &meta_object->cka_id);
p += write_meta_item(p, PKCS11_LABEL_TAG, &meta_object->cka_label);
p += write_meta_item(p, PKCS11_PUBKEY_ID_TAG, &meta_object->cka_id_pubkey);
p +=
write_meta_item(p, PKCS11_PUBKEY_LABEL_TAG, &meta_object->cka_label_pubkey);
char opaque_label[YH_OBJ_LABEL_LEN] = {0};
sprintf(opaque_label, "Meta object for 0x%02x%02x%04x",
meta_object->target_sequence, meta_object->target_type,
meta_object->target_id);
yh_rc rc = YHR_SUCCESS;
uint16_t meta_object_id = 0;
if (replace) {
yubihsm_pkcs11_object_desc *meta_desc =
find_meta_object_by_target(slot, meta_object->target_id,
meta_object->target_type,
meta_object->target_sequence, target_domains);
if (meta_desc != NULL) {
meta_object_id = meta_desc->object.id;
rc =
yh_util_delete_object(slot->device_session, meta_object_id, YH_OPAQUE);
if (rc != YHR_SUCCESS) {
DBG_INFO("Failed to delete opaque object 0x%x", meta_object_id);
} else {
DBG_INFO("Removed opaque object 0x%x with label %s", meta_object_id,
opaque_label);
}
memset(meta_desc, 0, sizeof(yubihsm_pkcs11_object_desc));
}
}
yh_capabilities capabilities = {{0}};
if (yh_check_capability(target_capabilities, "exportable-under-wrap")) {
rc = yh_string_to_capabilities("exportable-under-wrap", &capabilities);
if (rc != YHR_SUCCESS) {
DBG_ERR("Failed to set meta object capabilities");
return yrc_to_rv(rc);
}
}
rc =
yh_util_import_opaque(slot->device_session, &meta_object_id, opaque_label,
target_domains, &capabilities, YH_ALGO_OPAQUE_DATA,
opaque_value, opaque_value_len);
if (rc != YHR_SUCCESS) {
DBG_ERR("Failed to import opaque meta object for object 0x%x",
meta_object->target_id);
return yrc_to_rv(rc);
}
DBG_INFO("Successfully imported opaque object 0x%x with label: %s",
meta_object_id, opaque_label);
_get_object_desc(slot, meta_object_id, YH_OPAQUE, 0xffff);
return CKR_OK;
}
bool is_meta_object(yh_object_descriptor *object) {
return (object->type == YH_OPAQUE &&
object->algorithm == YH_ALGO_OPAQUE_DATA &&
strncmp(object->label, "Meta object", strlen("Meta object")) == 0);
}
bool match_byte_array(uint8_t *a, uint16_t a_len, uint8_t *b, uint16_t b_len) {
return a_len == b_len && memcmp(a, b, a_len) == 0;
}
CK_RV populate_cache_with_data_opaques(yubihsm_pkcs11_slot *slot) {
if (slot == NULL || slot->device_session == NULL) {
DBG_INFO("No device session available");
return CKR_OK;
}
if (slot->objects[0].object.id != 0) {
DBG_INFO("Cache already populated");
return CKR_OK;
}
yh_rc rc = YHR_SUCCESS;
yh_object_descriptor opaques[YH_MAX_ITEMS_COUNT] = {0};
size_t n_opaques = YH_MAX_ITEMS_COUNT;
yh_capabilities capabilities = {{0}};
rc =
yh_util_list_objects(slot->device_session, 0, YH_OPAQUE, 0, &capabilities,
YH_ALGO_OPAQUE_DATA, NULL, opaques, &n_opaques);
if (rc != YHR_SUCCESS) {
DBG_ERR("Failed to get object list");
return yrc_to_rv(rc);
}
for (size_t i = 0; i < n_opaques; i++) {
_get_object_desc(slot, opaques[i].id, opaques[i].type, opaques[i].sequence);
}
return CKR_OK;
}
yubihsm_pkcs11_object_desc *
find_meta_object_by_target(yubihsm_pkcs11_slot *slot, uint16_t target_id,
uint8_t target_type, uint8_t target_sequence,
uint16_t target_domains) {
for (int i = 0; i < YH_MAX_ITEMS_COUNT; i++) {
pkcs11_meta_object *current_meta = &slot->objects[i].meta_object;
if (target_domains == slot->objects[i].object.domains &&
current_meta->target_id == target_id &&
current_meta->target_type == target_type &&
current_meta->target_sequence == target_sequence) {
return &slot->objects[i];
}
}
return NULL;
}
bool create_session(yubihsm_pkcs11_slot *slot, CK_FLAGS flags,
CK_SESSION_HANDLE_PTR phSession) {
bool authed = false;
yubihsm_pkcs11_session session;
memset(&session, 0, sizeof(session));
if (slot->pkcs11_sessions.head) {
yubihsm_pkcs11_session *s =
(yubihsm_pkcs11_session *) slot->pkcs11_sessions.head->data;
if (s->session_state & SESSION_AUTHENTICATED) {
authed = true;
}
}
if (flags & CKF_RW_SESSION) {
session.session_state =
authed ? SESSION_AUTHENTICATED_RW : SESSION_RESERVED_RW;
} else {
session.session_state =
authed ? SESSION_AUTHENTICATED_RO : SESSION_RESERVED_RO;
}
session.id = slot->max_session_id++;
session.slot = slot;
list_create(&session.ecdh_session_keys, sizeof(ecdh_session_key), NULL);
*phSession = (slot->id << 16) + session.id;
return list_append(&slot->pkcs11_sessions, &session);
}
static void get_label_attribute(yh_object_descriptor *object, bool public,
pkcs11_meta_object *meta_object,
CK_VOID_PTR value, CK_ULONG_PTR length) {
if (meta_object != NULL && !public && meta_object->cka_label.len > 0) {
*length = meta_object->cka_label.len;
memcpy(value, meta_object->cka_label.value, *length);
} else if (meta_object != NULL && public &&
meta_object->cka_label_pubkey.len > 0) {
*length = meta_object->cka_label_pubkey.len;
memcpy(value, meta_object->cka_label_pubkey.value, *length);
} else {
*length = strlen(object->label);
memcpy(value, object->label, *length);
// NOTE(adma): we have seen some weird behvior with different
// PKCS#11 tools. We decided not to add '\0' for now. This *seems*
// to be a good solution ...
}
}
static void get_id_attribute(yh_object_descriptor *object, bool public,
pkcs11_meta_object *meta_object, CK_VOID_PTR value,
CK_ULONG_PTR length) {
if (meta_object != NULL && !public && meta_object->cka_id.len > 0) {
*length = meta_object->cka_id.len;