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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
|
/*
* (C) 2016 Daniel Neus
* (C) 2016 Philipp Weber
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
#include "tests.h"
#include "test_pkcs11.h"
#include <string>
#include <vector>
#include <functional>
#include <memory>
#include <array>
#include <type_traits>
#include <map>
#include <numeric>
#if defined(BOTAN_HAS_PKCS11)
#include <botan/p11.h>
#include <botan/p11_slot.h>
#include <botan/p11_session.h>
#include <botan/p11_module.h>
#include <botan/p11_object.h>
#include <botan/p11_randomgenerator.h>
#endif
#if defined(BOTAN_HAS_ASN1)
#include <botan/der_enc.h>
#endif
#if defined (BOTAN_HAS_PUBLIC_KEY_CRYPTO)
#include <botan/pubkey.h>
#endif
#if defined(BOTAN_HAS_RSA) && defined(BOTAN_HAS_PKCS11)
#include <botan/rsa.h>
#include <botan/p11_rsa.h>
#endif
#if defined(BOTAN_HAS_ECC_PUBLIC_KEY_CRYPTO) && defined(BOTAN_HAS_PKCS11)
#include <botan/ecc_key.h>
#include <botan/ecdsa.h>
#include <botan/ecdh.h>
#include <botan/p11_ecc_key.h>
#include <botan/p11_ecdh.h>
#include <botan/p11_ecdsa.h>
#endif
#if defined(BOTAN_HAS_X509_CERTIFICATES) && defined(BOTAN_HAS_PKCS11)
#include <botan/p11_x509.h>
#endif
#if defined(BOTAN_HAS_AUTO_SEEDING_RNG)
#include <botan/auto_rng.h>
#endif
#if defined(BOTAN_HAS_HMAC_DRBG)
#include <botan/hmac_drbg.h>
#endif
namespace Botan_Tests {
namespace {
#if defined(BOTAN_HAS_PKCS11)
using namespace Botan;
using namespace PKCS11;
class TestSession
{
public:
explicit TestSession(bool login) :
m_module(new Module(Test::pkcs11_lib()))
{
std::vector<SlotId> slot_vec = Slot::get_available_slots(*m_module, true);
m_slot.reset(new Slot(*m_module, slot_vec.at(0)));
m_session.reset(new Session(*m_slot, false));
if(login)
{
m_session->login(UserType::User, PIN_SECVEC);
}
}
inline Module& module() const { return *m_module; }
inline Slot& slot() const { return *m_slot; }
inline Session& session() const { return *m_session; }
private:
std::unique_ptr<Module> m_module = nullptr;
std::unique_ptr<Slot> m_slot = nullptr;
std::unique_ptr<Session> m_session = nullptr;
};
/***************************** Module *****************************/
Test::Result test_module_ctor()
{
Test::Result result("Module ctor");
result.test_throws("Module ctor fails for non existent path", []()
{
Module module("/a/b/c");
});
Module module(Test::pkcs11_lib());
result.test_success("Module ctor did not throw and completed successfully");
return result;
}
Test::Result test_module_reload()
{
Test::Result result("Module reload");
Module module(Test::pkcs11_lib());
module.reload();
result.test_success("Module reload did not throw and completed successfully");
module.get_info();
result.test_success("Module get_info() still works after reload");
return result;
}
Test::Result test_multiple_modules()
{
Test::Result result("Module copy");
Module first_module(Test::pkcs11_lib());
result.test_throws("Module ctor fails if module is already initialized", []()
{
Module second_module(Test::pkcs11_lib());
});
return result;
}
Test::Result test_module_get_info()
{
Test::Result result("Module info");
Module module(Test::pkcs11_lib());
Info info = module.get_info();
result.test_ne("Cryptoki version != 0", info.cryptokiVersion.major, 0);
return result;
}
class Module_Tests : public PKCS11_Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<std::function<Test::Result()>> fns =
{
test_module_ctor,
test_multiple_modules,
test_module_get_info,
test_module_reload
};
return run_pkcs11_tests("Module", fns);
}
};
BOTAN_REGISTER_TEST("pkcs11-module", Module_Tests);
/***************************** Slot *****************************/
Test::Result test_slot_get_available_slots()
{
Test::Result result("Slot get_available_slots");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
result.test_gte("Available Slots with attached token >= 1", slot_vec.size(), 1);
return result;
}
Test::Result test_slot_ctor()
{
Test::Result result("Slot ctor");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
result.test_success("Slot ctor completed successfully");
result.test_is_eq(slot.slot_id(), slot_vec.at(0));
return result;
}
Test::Result test_get_slot_info()
{
Test::Result result("Slot get_slot_info");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
SlotInfo info = slot.get_slot_info();
std::string description = reinterpret_cast< char* >(info.slotDescription);
result.confirm("Slot description is not empty", !description.empty());
return result;
}
SlotId get_invalid_slot_id(Module& module)
{
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, false);
SlotId invalid_id = 0;
// find invalid slot id
while(std::find(slot_vec.begin(), slot_vec.end(), invalid_id) != slot_vec.end())
{
invalid_id++;
}
return invalid_id;
}
Test::Result test_slot_invalid_id()
{
Test::Result result("Slot get_slot_info with invalid slot id");
Module module(Test::pkcs11_lib());
SlotId invalid_id = get_invalid_slot_id(module);
Slot slot(module, invalid_id);
result.test_throws("get_slot_info fails for non existent slot id", [ &slot ]()
{
slot.get_slot_info();
});
return result;
}
Test::Result test_get_token_info()
{
Test::Result result("Slot get_token_info");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
TokenInfo info = slot.get_token_info();
std::string label = reinterpret_cast< char* >(info.label);
result.confirm("Token label is not empty", ! label.empty());
return result;
}
Test::Result test_get_mechanism_list()
{
Test::Result result("Slot get_mechanism_list");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
std::vector<MechanismType> mechanisms = slot.get_mechanism_list();
result.confirm("The Slot supports at least one mechanism", !mechanisms.empty());
return result;
}
Test::Result test_get_mechanisms_info()
{
Test::Result result("Slot get_mechanism_info");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
slot.get_mechanism_info(MechanismType::RsaPkcsKeyPairGen);
result.test_success("get_mechanism_info() completed successfully.");
return result;
}
class Slot_Tests : public PKCS11_Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<std::function<Test::Result()>> fns =
{
test_slot_get_available_slots,
test_slot_ctor,
test_get_slot_info,
test_slot_invalid_id,
test_get_token_info,
test_get_mechanism_list,
test_get_mechanisms_info
};
return run_pkcs11_tests("Slot", fns);
}
};
BOTAN_REGISTER_TEST("pkcs11-slot", Slot_Tests);
/***************************** Session *****************************/
Test::Result test_session_ctor()
{
Test::Result result("Session ctor");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
{
Session read_only_session(slot, true);
result.test_success("read only session opened successfully");
}
{
Session read_write_session(slot, false);
result.test_success("read write session opened successfully");
}
{
Flags flags = PKCS11::flags(Flag::SerialSession | Flag::RwSession);
Session read_write_session2(slot, flags, nullptr, nullptr);
result.test_success("read write session with flags param opened successfully");
}
{
Session read_only_session(slot, true);
Session read_write_session(slot, false);
result.test_success("Opened multiple sessions successfully");
}
return result;
}
Test::Result test_session_ctor_invalid_slot()
{
Test::Result result("Session ctor with invalid slot id");
Module module(Test::pkcs11_lib());
SlotId invalid_id = get_invalid_slot_id(module);
Slot slot(module, invalid_id);
result.test_throws("Session ctor with invalid slot id fails", [&slot]()
{
Session session(slot, true);
});
return result;
}
Test::Result test_session_release()
{
Test::Result result("Session release/take ownership");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
Session session(slot, false);
SessionHandle handle = session.release();
Session session2(slot, handle);
result.test_success("releasing ownership and taking ownership works as expected.");
return result;
}
Test::Result test_session_login_logout()
{
Test::Result result("Session login/logout");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
Session session(slot, false);
session.login(UserType::User, PIN_SECVEC);
session.logoff();
result.test_success("user login/logout succeeded");
session.login(UserType::SO, SO_PIN_SECVEC);
result.test_success("SO login succeeded");
return result;
}
Test::Result test_session_info()
{
Test::Result result("Session session info");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
Session session(slot, false);
SessionInfo info = session.get_info();
result.test_is_eq("slot id is correct", info.slotID, slot_vec.at(0));
result.test_is_eq("state is a read write public session", info.state,
static_cast<CK_STATE>(SessionState::RwPublicSession));
session.login(UserType::User, PIN_SECVEC);
info = session.get_info();
result.test_is_eq("state is a read write user session", info.state,
static_cast<CK_STATE>(SessionState::RwUserFunctions));
session.logoff();
result.test_success("user login/logout succeeded");
session.login(UserType::SO, SO_PIN_SECVEC);
result.test_success("SO login succeeded");
return result;
}
class Session_Tests : public PKCS11_Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<std::function<Test::Result()>> fns =
{
test_session_ctor,
test_session_ctor_invalid_slot,
test_session_release,
test_session_login_logout,
test_session_info
};
return run_pkcs11_tests("Session", fns);
}
};
BOTAN_REGISTER_TEST("pkcs11-session", Session_Tests);
/***************************** Object *****************************/
Test::Result test_attribute_container()
{
Test::Result result("AttributeContainer");
AttributeContainer attributes;
attributes.add_class(ObjectClass::PrivateKey);
std::string label("test");
attributes.add_string(AttributeType::Label, label);
std::vector<uint8_t> bin(4);
attributes.add_binary(AttributeType::Value, bin);
attributes.add_bool(AttributeType::Sensitive, true);
attributes.add_numeric(AttributeType::ObjectId, 12);
result.test_eq("Five elements in attribute container", attributes.count(), 5);
return result;
}
#if defined(BOTAN_HAS_ASN1)
Test::Result test_create_destroy_data_object()
{
Test::Result result("Object create/delete data object");
TestSession test_session(true);
std::string value_string("test data");
secure_vector<uint8_t> value(value_string.begin(), value_string.end());
std::size_t id = 1337;
std::string label = "Botan test data object";
std::string application = "Botan test application";
DataObjectProperties data_obj_props;
data_obj_props.set_application(application);
data_obj_props.set_label(label);
data_obj_props.set_value(value);
data_obj_props.set_token(true);
data_obj_props.set_modifiable(true);
data_obj_props.set_object_id(DER_Encoder().encode(id).get_contents_unlocked());
Object data_obj(test_session.session(), data_obj_props);
result.test_success("Data object creation was successful");
data_obj.destroy();
result.test_success("Data object deletion was successful");
return result;
}
Test::Result test_get_set_attribute_values()
{
Test::Result result("Object get/set attributes");
TestSession test_session(true);
// create object
std::string value_string("test data");
secure_vector<uint8_t> value(value_string.begin(), value_string.end());
std::size_t id = 1337;
std::string label = "Botan test data object";
std::string application = "Botan test application";
DataObjectProperties data_obj_props;
data_obj_props.set_application(application);
data_obj_props.set_label(label);
data_obj_props.set_value(value);
data_obj_props.set_token(true);
data_obj_props.set_modifiable(true);
data_obj_props.set_object_id(DER_Encoder().encode(id).get_contents_unlocked());
Object data_obj(test_session.session(), data_obj_props);
// get attribute
secure_vector<uint8_t> retrieved_label = data_obj.get_attribute_value(AttributeType::Label);
std::string retrieved_label_string(retrieved_label.begin(), retrieved_label.end());
result.test_eq("label was set correctly", retrieved_label_string, label);
// set attribute
std::string new_label = "Botan test modified data object label";
secure_vector<uint8_t> new_label_secvec(new_label.begin(), new_label.end());
data_obj.set_attribute_value(AttributeType::Label, new_label_secvec);
// get and check attribute
retrieved_label = data_obj.get_attribute_value(AttributeType::Label);
retrieved_label_string = std::string(retrieved_label.begin(), retrieved_label.end());
result.test_eq("label was modified correctly", retrieved_label_string, new_label);
data_obj.destroy();
return result;
}
Test::Result test_object_finder()
{
Test::Result result("ObjectFinder");
TestSession test_session(true);
// create object
std::string value_string("test data");
secure_vector<uint8_t> value(value_string.begin(), value_string.end());
std::size_t id = 1337;
std::string label = "Botan test data object";
std::string application = "Botan test application";
DataObjectProperties data_obj_props;
data_obj_props.set_application(application);
data_obj_props.set_label(label);
data_obj_props.set_value(value);
data_obj_props.set_token(true);
data_obj_props.set_modifiable(true);
data_obj_props.set_object_id(DER_Encoder().encode(id).get_contents_unlocked());
Object data_obj(test_session.session(), data_obj_props);
// search created object
AttributeContainer search_template;
search_template.add_string(AttributeType::Label, label);
ObjectFinder finder(test_session.session(), search_template.attributes());
auto search_result = finder.find();
result.test_eq("one object found", search_result.size(), 1);
finder.finish();
Object obj_found(test_session.session(), search_result.at(0));
result.test_eq("found the object just created (same application)",
obj_found.get_attribute_value(AttributeType::Application) , data_obj.get_attribute_value(AttributeType::Application));
auto search_result2 = Object::search<Object>(test_session.session(), search_template.attributes());
result.test_eq("found the object just created (same label)", obj_found.get_attribute_value(AttributeType::Label),
search_result2.at(0).get_attribute_value(AttributeType::Label));
data_obj.destroy();
return result;
}
Test::Result test_object_copy()
{
Test::Result result("Object copy");
TestSession test_session(true);
// create object
std::string value_string("test data");
secure_vector<uint8_t> value(value_string.begin(), value_string.end());
std::size_t id = 1337;
std::string label = "Botan test data object";
std::string application = "Botan test application";
DataObjectProperties data_obj_props;
data_obj_props.set_application(application);
data_obj_props.set_label(label);
data_obj_props.set_value(value);
data_obj_props.set_token(true);
data_obj_props.set_modifiable(true);
data_obj_props.set_object_id(DER_Encoder().encode(id).get_contents_unlocked());
Object data_obj(test_session.session(), data_obj_props);
// copy created object
AttributeContainer copy_attributes;
copy_attributes.add_string(AttributeType::Label, "Botan test copied object");
ObjectHandle copied_obj_handle = data_obj.copy(copy_attributes);
ObjectFinder searcher(test_session.session(), copy_attributes.attributes());
auto search_result = searcher.find();
result.test_eq("one object found", search_result.size(), 1);
data_obj.destroy();
Object copied_obj(test_session.session(), copied_obj_handle);
copied_obj.destroy();
return result;
}
#endif
class Object_Tests : public PKCS11_Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<std::function<Test::Result()>> fns =
{
test_attribute_container
#if defined(BOTAN_HAS_ASN1)
,test_create_destroy_data_object
,test_get_set_attribute_values
,test_object_finder
,test_object_copy
#endif
};
return run_pkcs11_tests("Object", fns);
}
};
BOTAN_REGISTER_TEST("pkcs11-object", Object_Tests);
/***************************** PKCS11 RSA *****************************/
#if defined(BOTAN_HAS_RSA)
Test::Result test_rsa_privkey_import()
{
Test::Result result("PKCS11 import RSA private key");
TestSession test_session(true);
// create private key
RSA_PrivateKey priv_key(Test::rng(), 2048);
result.confirm("Key self test OK", priv_key.check_key(Test::rng(), true));
// import to card
RSA_PrivateKeyImportProperties props(priv_key.get_n(), priv_key.get_d());
props.set_pub_exponent(priv_key.get_e());
props.set_prime_1(priv_key.get_p());
props.set_prime_2(priv_key.get_q());
props.set_coefficient(priv_key.get_c());
props.set_exponent_1(priv_key.get_d1());
props.set_exponent_2(priv_key.get_d2());
props.set_token(true);
props.set_private(true);
props.set_decrypt(true);
props.set_sign(true);
PKCS11_RSA_PrivateKey pk(test_session.session(), props);
result.test_success("RSA private key import was successful");
result.confirm("PK self test OK", pk.check_key(Test::rng(), true));
pk.destroy();
return result;
}
Test::Result test_rsa_privkey_export()
{
Test::Result result("PKCS11 export RSA private key");
TestSession test_session(true);
// create private key
RSA_PrivateKey priv_key(Test::rng(), 2048);
// import to card
RSA_PrivateKeyImportProperties props(priv_key.get_n(), priv_key.get_d());
props.set_pub_exponent(priv_key.get_e());
props.set_prime_1(priv_key.get_p());
props.set_prime_2(priv_key.get_q());
props.set_coefficient(priv_key.get_c());
props.set_exponent_1(priv_key.get_d1());
props.set_exponent_2(priv_key.get_d2());
props.set_token(true);
props.set_private(true);
props.set_decrypt(true);
props.set_sign(true);
props.set_extractable(true);
props.set_sensitive(false);
PKCS11_RSA_PrivateKey pk(test_session.session(), props);
result.confirm("Check PK11 key", pk.check_key(Test::rng(), true));
RSA_PrivateKey exported = pk.export_key();
result.test_success("RSA private key export was successful");
result.confirm("Check exported key", exported.check_key(Test::rng(), true));
pk.destroy();
return result;
}
Test::Result test_rsa_pubkey_import()
{
Test::Result result("PKCS11 import RSA public key");
TestSession test_session(true);
// create public key from private key
RSA_PrivateKey priv_key(Test::rng(), 2048);
// import to card
RSA_PublicKeyImportProperties props(priv_key.get_n(), priv_key.get_e());
props.set_token(true);
props.set_encrypt(true);
props.set_private(false);
PKCS11_RSA_PublicKey pk(test_session.session(), props);
result.test_success("RSA public key import was successful");
result.confirm("Check PK11 key", pk.check_key(Test::rng(), true));
pk.destroy();
return result;
}
Test::Result test_rsa_generate_private_key()
{
Test::Result result("PKCS11 generate RSA private key");
TestSession test_session(true);
RSA_PrivateKeyGenerationProperties props;
props.set_token(true);
props.set_private(true);
props.set_sign(true);
props.set_decrypt(true);
PKCS11_RSA_PrivateKey pk(test_session.session(), 2048, props);
result.test_success("RSA private key generation was successful");
pk.destroy();
return result;
}
PKCS11_RSA_KeyPair generate_rsa_keypair(const TestSession& test_session)
{
RSA_PublicKeyGenerationProperties pub_props(2048UL);
pub_props.set_pub_exponent();
pub_props.set_label("BOTAN_TEST_RSA_PUB_KEY");
pub_props.set_token(true);
pub_props.set_encrypt(true);
pub_props.set_verify(true);
pub_props.set_private(false);
RSA_PrivateKeyGenerationProperties priv_props;
priv_props.set_label("BOTAN_TEST_RSA_PRIV_KEY");
priv_props.set_token(true);
priv_props.set_private(true);
priv_props.set_sign(true);
priv_props.set_decrypt(true);
return PKCS11::generate_rsa_keypair(test_session.session(), pub_props, priv_props);
}
Test::Result test_rsa_generate_key_pair()
{
Test::Result result("PKCS11 generate RSA key pair");
TestSession test_session(true);
PKCS11_RSA_KeyPair keypair = generate_rsa_keypair(test_session);
result.test_success("RSA key pair generation was successful");
keypair.first.destroy();
keypair.second.destroy();
return result;
}
Test::Result test_rsa_encrypt_decrypt()
{
Test::Result result("PKCS11 RSA encrypt decrypt");
TestSession test_session(true);
// generate key pair
PKCS11_RSA_KeyPair keypair = generate_rsa_keypair(test_session);
auto encrypt_and_decrypt = [&keypair, &result](const std::vector<uint8_t>& plaintext, const std::string& padding) -> void
{
Botan::PK_Encryptor_EME encryptor(keypair.first, Test::rng(), padding, "pkcs11");
auto encrypted = encryptor.encrypt(plaintext, Test::rng());
Botan::PK_Decryptor_EME decryptor(keypair.second, Test::rng(), padding, "pkcs11");
auto decrypted = decryptor.decrypt(encrypted);
// some token / middlewares do not remove the padding bytes
decrypted.resize(plaintext.size());
result.test_eq("RSA PKCS11 encrypt and decrypt: " + padding, decrypted, plaintext);
};
std::vector<uint8_t> plaintext(256);
std::iota(std::begin(plaintext), std::end(plaintext), 0);
encrypt_and_decrypt(plaintext, "Raw");
plaintext = { 0x00, 0x01, 0x02, 0x03, 0x04, 0x00 };
encrypt_and_decrypt(plaintext, "EME-PKCS1-v1_5");
encrypt_and_decrypt(plaintext, "OAEP(SHA-1)");
keypair.first.destroy();
keypair.second.destroy();
return result;
}
Test::Result test_rsa_sign_verify()
{
Test::Result result("PKCS11 RSA sign and verify");
TestSession test_session(true);
// generate key pair
PKCS11_RSA_KeyPair keypair = generate_rsa_keypair(test_session);
std::vector<uint8_t> plaintext(256);
std::iota(std::begin(plaintext), std::end(plaintext), 0);
auto sign_and_verify = [&keypair, &plaintext, &result](const std::string& emsa, bool multipart) -> void
{
Botan::PK_Signer signer(keypair.second, Test::rng(), emsa, Botan::IEEE_1363, "pkcs11");
std::vector<uint8_t> signature;
if ( multipart )
{
signer.update(plaintext.data(), plaintext.size() / 2);
signature = signer.sign_message(plaintext.data() + plaintext.size() / 2, plaintext.size() / 2, Test::rng());
}
else
{
signature = signer.sign_message(plaintext, Test::rng());
}
Botan::PK_Verifier verifier(keypair.first, emsa, Botan::IEEE_1363, "pkcs11");
bool rsa_ok = false;
if ( multipart )
{
verifier.update(plaintext.data(), plaintext.size() / 2);
rsa_ok = verifier.verify_message(plaintext.data() + plaintext.size() / 2, plaintext.size() / 2, signature.data(), signature.size());
}
else
{
rsa_ok = verifier.verify_message(plaintext, signature);
}
result.test_eq("RSA PKCS11 sign and verify: " + emsa, rsa_ok, true);
};
// single-part sign
sign_and_verify("Raw", false);
sign_and_verify("EMSA3(SHA-256)", false);
sign_and_verify("EMSA4(SHA-256)", false);
// multi-part sign
sign_and_verify("EMSA3(SHA-256)", true);
sign_and_verify("EMSA4(SHA-256)", true);
keypair.first.destroy();
keypair.second.destroy();
return result;
}
class PKCS11_RSA_Tests : public PKCS11_Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<std::function<Test::Result()>> fns =
{
test_rsa_privkey_import,
test_rsa_pubkey_import,
test_rsa_privkey_export,
test_rsa_generate_private_key,
test_rsa_generate_key_pair,
test_rsa_encrypt_decrypt,
test_rsa_sign_verify
};
return run_pkcs11_tests("PKCS11 RSA", fns);
}
};
BOTAN_REGISTER_TEST("pkcs11-rsa", PKCS11_RSA_Tests);
#endif
/***************************** PKCS11 ECDSA *****************************/
#if defined(BOTAN_HAS_ECC_PUBLIC_KEY_CRYPTO)
Test::Result test_ecdsa_privkey_import()
{
Test::Result result("PKCS11 import ECDSA private key");
TestSession test_session(true);
// create ecdsa private key
ECDSA_PrivateKey priv_key(Test::rng(), EC_Group("secp256r1"));
result.confirm("Key self test OK", priv_key.check_key(Test::rng(), true));
priv_key.set_parameter_encoding(EC_Group_Encoding::EC_DOMPAR_ENC_OID);
// import to card
EC_PrivateKeyImportProperties props(priv_key.DER_domain(), priv_key.private_value());
props.set_token(true);
props.set_private(true);
props.set_sign(true);
// label
std::string label = "Botan test ecdsa key";
props.set_label(label);
PKCS11_ECDSA_PrivateKey pk(test_session.session(), props);
result.test_success("ECDSA private key import was successful");
pk.set_public_point(priv_key.public_point());
result.confirm("P11 key self test OK", pk.check_key(Test::rng(), false));
pk.destroy();
return result;
}
Test::Result test_ecdsa_privkey_export()
{
Test::Result result("PKCS11 export ECDSA private key");
TestSession test_session(true);
// create private key
ECDSA_PrivateKey priv_key(Test::rng(), EC_Group("secp256r1"));
priv_key.set_parameter_encoding(EC_Group_Encoding::EC_DOMPAR_ENC_OID);
result.confirm("Check ECDSA key", priv_key.check_key(Test::rng(), true));
// import to card
EC_PrivateKeyImportProperties props(priv_key.DER_domain(), priv_key.private_value());
props.set_token(true);
props.set_private(true);
props.set_sign(true);
props.set_extractable(true);
// label
std::string label = "Botan test ecdsa key";
props.set_label(label);
PKCS11_ECDSA_PrivateKey pk(test_session.session(), props);
pk.set_public_point(priv_key.public_point());
result.confirm("Check PK11 key", pk.check_key(Test::rng(), false));
ECDSA_PrivateKey exported = pk.export_key();
result.test_success("ECDSA private key export was successful");
result.confirm("Check exported key valid", exported.check_key(Test::rng(), true));
result.test_eq("Check exported key contents", exported.private_key_bits(), priv_key.private_key_bits());
pk.destroy();
return result;
}
Test::Result test_ecdsa_pubkey_import()
{
Test::Result result("PKCS11 import ECDSA public key");
TestSession test_session(true);
// create ecdsa private key
ECDSA_PrivateKey priv_key(Test::rng(), EC_Group("secp256r1"));
priv_key.set_parameter_encoding(EC_Group_Encoding::EC_DOMPAR_ENC_OID);
// import to card
EC_PublicKeyImportProperties props(priv_key.DER_domain(), DER_Encoder().encode(EC2OSP(priv_key.public_point(),
PointGFp::UNCOMPRESSED), OCTET_STRING).get_contents_unlocked());
props.set_token(true);
props.set_verify(true);
props.set_private(false);
// label
std::string label = "Botan test ecdsa pub key";
props.set_label(label);
PKCS11_ECDSA_PublicKey pk(test_session.session(), props);
result.test_success("ECDSA public key import was successful");
pk.destroy();
return result;
}
Test::Result test_ecdsa_pubkey_export()
{
Test::Result result("PKCS11 export ECDSA public key");
TestSession test_session(true);
// create public key from private key
ECDSA_PrivateKey priv_key(Test::rng(), EC_Group("secp256r1"));
priv_key.set_parameter_encoding(EC_Group_Encoding::EC_DOMPAR_ENC_OID);
// import to card
EC_PublicKeyImportProperties props(priv_key.DER_domain(), DER_Encoder().encode(EC2OSP(priv_key.public_point(),
PointGFp::UNCOMPRESSED), OCTET_STRING).get_contents_unlocked());
props.set_token(true);
props.set_verify(true);
props.set_private(false);
// label
std::string label = "Botan test ecdsa pub key";
props.set_label(label);
PKCS11_ECDSA_PublicKey pk(test_session.session(), props);
ECDSA_PublicKey exported = pk.export_key();
result.test_success("ECDSA public key export was successful");
pk.destroy();
return result;
}
Test::Result test_ecdsa_generate_private_key()
{
Test::Result result("PKCS11 generate ECDSA private key");
TestSession test_session(true);
EC_PrivateKeyGenerationProperties props;
props.set_token(true);
props.set_private(true);
props.set_sign(true);
PKCS11_ECDSA_PrivateKey pk(test_session.session(),
EC_Group("secp256r1").DER_encode(EC_Group_Encoding::EC_DOMPAR_ENC_OID), props);
result.test_success("ECDSA private key generation was successful");
pk.destroy();
return result;
}
PKCS11_ECDSA_KeyPair generate_ecdsa_keypair(const TestSession& test_session)
{
EC_PublicKeyGenerationProperties pub_props(EC_Group("secp256r1").DER_encode(
EC_Group_Encoding::EC_DOMPAR_ENC_OID));
pub_props.set_label("BOTAN_TEST_ECDSA_PUB_KEY");
pub_props.set_token(true);
pub_props.set_verify(true);
pub_props.set_private(false);
pub_props.set_modifiable(true);
EC_PrivateKeyGenerationProperties priv_props;
priv_props.set_label("BOTAN_TEST_ECDSA_PRIV_KEY");
priv_props.set_token(true);
priv_props.set_private(true);
priv_props.set_sensitive(true);
priv_props.set_extractable(false);
priv_props.set_sign(true);
priv_props.set_modifiable(true);
return PKCS11::generate_ecdsa_keypair(test_session.session(), pub_props, priv_props);
}
Test::Result test_ecdsa_generate_keypair()
{
Test::Result result("PKCS11 generate ECDSA key pair");
TestSession test_session(true);
PKCS11_ECDSA_KeyPair keypair = generate_ecdsa_keypair(test_session);
result.test_success("ECDSA key pair generation was successful");
keypair.first.destroy();
keypair.second.destroy();
return result;
}
Test::Result test_ecdsa_sign_verify()
{
Test::Result result("PKCS11 ECDSA sign and verify");
TestSession test_session(true);
// generate key pair
PKCS11_ECDSA_KeyPair keypair = generate_ecdsa_keypair(test_session);
std::vector<uint8_t> plaintext(20, 0x01);
auto sign_and_verify = [ &keypair, &plaintext, &result ](const std::string& emsa) -> void
{
Botan::PK_Signer signer(keypair.second, Test::rng(), emsa, Botan::IEEE_1363, "pkcs11");
auto signature = signer.sign_message(plaintext, Test::rng());
Botan::PK_Verifier token_verifier(keypair.first, emsa, Botan::IEEE_1363, "pkcs11");
bool ecdsa_ok = token_verifier.verify_message(plaintext, signature);
result.test_eq("ECDSA PKCS11 sign and verify: " + emsa, ecdsa_ok, true);
// test against software implementation if available
#if defined (BOTAN_HAS_EMSA_RAW)
Botan::PK_Verifier soft_verifier(keypair.first, emsa, Botan::IEEE_1363);
bool soft_ecdsa_ok = soft_verifier.verify_message(plaintext, signature);
result.test_eq("ECDSA PKCS11 verify (in software): " + emsa, soft_ecdsa_ok, true);
#endif
};
sign_and_verify("Raw"); // SoftHSMv2 until now only supports "Raw"
keypair.first.destroy();
keypair.second.destroy();
return result;
}
class PKCS11_ECDSA_Tests : public PKCS11_Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<std::function<Test::Result()>> fns =
{
test_ecdsa_privkey_import,
test_ecdsa_privkey_export,
test_ecdsa_pubkey_import,
test_ecdsa_pubkey_export,
test_ecdsa_generate_private_key,
test_ecdsa_generate_keypair,
test_ecdsa_sign_verify
};
return run_pkcs11_tests("PKCS11 ECDSA", fns);
}
};
BOTAN_REGISTER_TEST("pkcs11-ecdsa", PKCS11_ECDSA_Tests);
/***************************** PKCS11 ECDH *****************************/
Test::Result test_ecdh_privkey_import()
{
Test::Result result("PKCS11 import ECDH private key");
TestSession test_session(true);
// create ecdh private key
ECDH_PrivateKey priv_key(Test::rng(), EC_Group("secp256r1"));
priv_key.set_parameter_encoding(EC_Group_Encoding::EC_DOMPAR_ENC_OID);
// import to card
EC_PrivateKeyImportProperties props(priv_key.DER_domain(), priv_key.private_value());
props.set_token(true);
props.set_private(true);
props.set_derive(true);
// label
std::string label = "Botan test ecdh key";
props.set_label(label);
PKCS11_ECDH_PrivateKey pk(test_session.session(), props);
result.test_success("ECDH private key import was successful");
pk.destroy();
return result;
}
Test::Result test_ecdh_privkey_export()
{
Test::Result result("PKCS11 export ECDH private key");
TestSession test_session(true);
// create private key
ECDH_PrivateKey priv_key(Test::rng(), EC_Group("secp256r1"));
priv_key.set_parameter_encoding(EC_Group_Encoding::EC_DOMPAR_ENC_OID);
// import to card
EC_PrivateKeyImportProperties props(priv_key.DER_domain(), priv_key.private_value());
props.set_token(true);
props.set_private(true);
props.set_derive(true);
props.set_extractable(true);
// label
std::string label = "Botan test ecdh key";
props.set_label(label);
PKCS11_ECDH_PrivateKey pk(test_session.session(), props);
ECDH_PrivateKey exported = pk.export_key();
result.test_success("ECDH private key export was successful");
pk.destroy();
return result;
}
Test::Result test_ecdh_pubkey_import()
{
Test::Result result("PKCS11 import ECDH public key");
TestSession test_session(true);
// create ECDH private key
ECDH_PrivateKey priv_key(Test::rng(), EC_Group("secp256r1"));
priv_key.set_parameter_encoding(EC_Group_Encoding::EC_DOMPAR_ENC_OID);
// import to card
EC_PublicKeyImportProperties props(priv_key.DER_domain(), DER_Encoder().encode(EC2OSP(priv_key.public_point(),
PointGFp::UNCOMPRESSED), OCTET_STRING).get_contents_unlocked());
props.set_token(true);
props.set_private(false);
props.set_derive(true);
// label
std::string label = "Botan test ECDH pub key";
props.set_label(label);
PKCS11_ECDH_PublicKey pk(test_session.session(), props);
result.test_success("ECDH public key import was successful");
pk.destroy();
return result;
}
Test::Result test_ecdh_pubkey_export()
{
Test::Result result("PKCS11 export ECDH public key");
TestSession test_session(true);
// create public key from private key
ECDH_PrivateKey priv_key(Test::rng(), EC_Group("secp256r1"));
priv_key.set_parameter_encoding(EC_Group_Encoding::EC_DOMPAR_ENC_OID);
// import to card
EC_PublicKeyImportProperties props(priv_key.DER_domain(), DER_Encoder().encode(EC2OSP(priv_key.public_point(),
PointGFp::UNCOMPRESSED), OCTET_STRING).get_contents_unlocked());
props.set_token(true);
props.set_derive(true);
props.set_private(false);
// label
std::string label = "Botan test ECDH pub key";
props.set_label(label);
PKCS11_ECDH_PublicKey pk(test_session.session(), props);
ECDH_PublicKey exported = pk.export_key();
result.test_success("ECDH public key export was successful");
pk.destroy();
return result;
}
Test::Result test_ecdh_generate_private_key()
{
Test::Result result("PKCS11 generate ECDH private key");
TestSession test_session(true);
EC_PrivateKeyGenerationProperties props;
props.set_token(true);
props.set_private(true);
props.set_derive(true);
PKCS11_ECDH_PrivateKey pk(test_session.session(),
EC_Group("secp256r1").DER_encode(EC_Group_Encoding::EC_DOMPAR_ENC_OID), props);
result.test_success("ECDH private key generation was successful");
pk.destroy();
return result;
}
PKCS11_ECDH_KeyPair generate_ecdh_keypair(const TestSession& test_session, const std::string& label)
{
EC_PublicKeyGenerationProperties pub_props(EC_Group("secp256r1").DER_encode(
EC_Group_Encoding::EC_DOMPAR_ENC_OID));
pub_props.set_label(label + "_PUB_KEY");
pub_props.set_token(true);
pub_props.set_derive(true);
pub_props.set_private(false);
pub_props.set_modifiable(true);
EC_PrivateKeyGenerationProperties priv_props;
priv_props.set_label(label + "_PRIV_KEY");
priv_props.set_token(true);
priv_props.set_private(true);
priv_props.set_sensitive(true);
priv_props.set_extractable(false);
priv_props.set_derive(true);
priv_props.set_modifiable(true);
return PKCS11::generate_ecdh_keypair(test_session.session(), pub_props, priv_props);
}
Test::Result test_ecdh_generate_keypair()
{
Test::Result result("PKCS11 generate ECDH key pair");
TestSession test_session(true);
PKCS11_ECDH_KeyPair keypair = generate_ecdh_keypair(test_session, "Botan test ECDH key1");
result.test_success("ECDH key pair generation was successful");
keypair.first.destroy();
keypair.second.destroy();
return result;
}
Test::Result test_ecdh_derive()
{
Test::Result result("PKCS11 ECDH derive");
TestSession test_session(true);
PKCS11_ECDH_KeyPair keypair = generate_ecdh_keypair(test_session, "Botan test ECDH key1");
PKCS11_ECDH_KeyPair keypair2 = generate_ecdh_keypair(test_session, "Botan test ECDH key2");
// SoftHSMv2 only supports CKD_NULL KDF at the moment
Botan::PK_Key_Agreement ka(keypair.second, Test::rng(), "Raw", "pkcs11");
Botan::PK_Key_Agreement kb(keypair2.second, Test::rng(), "Raw", "pkcs11");
Botan::SymmetricKey alice_key = ka.derive_key(32, unlock(EC2OSP(keypair2.first.public_point(),
PointGFp::UNCOMPRESSED)));
Botan::SymmetricKey bob_key = kb.derive_key(32, unlock(EC2OSP(keypair.first.public_point(), PointGFp::UNCOMPRESSED)));
bool eq = alice_key == bob_key;
result.test_eq("same secret key derived", eq, true);
keypair.first.destroy();
keypair.second.destroy();
keypair2.first.destroy();
keypair2.second.destroy();
return result;
}
class PKCS11_ECDH_Tests : public PKCS11_Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<std::function<Test::Result()>> fns =
{
test_ecdh_privkey_import,
test_ecdh_privkey_export,
test_ecdh_pubkey_import,
test_ecdh_pubkey_export,
test_ecdh_generate_private_key,
test_ecdh_generate_keypair,
test_ecdh_derive
};
return run_pkcs11_tests("PKCS11 ECDH", fns);
}
};
BOTAN_REGISTER_TEST("pkcs11-ecdh", PKCS11_ECDH_Tests);
#endif
/***************************** PKCS11 RNG *****************************/
Test::Result test_rng_generate_random()
{
Test::Result result("PKCS11 RNG generate random");
TestSession test_session(true);
PKCS11_RNG rng(test_session.session());
result.confirm("RNG already seeded", rng.is_seeded());
std::vector<uint8_t> random(20);
rng.randomize(random.data(), random.size());
result.test_ne("random data generated", random, std::vector<uint8_t>(20));
return result;
}
Test::Result test_rng_add_entropy()
{
Test::Result result("PKCS11 RNG add entropy random");
TestSession test_session(true);
PKCS11_RNG rng(test_session.session());
auto random = Test::rng().random_vec(20);
rng.add_entropy(random.data(), random.size());
result.test_success("entropy added");
return result;
}
#if defined(BOTAN_HAS_HMAC_DRBG) && defined(BOTAN_HAS_SHA2_64)
Test::Result test_pkcs11_hmac_drbg()
{
Test::Result result("PKCS11 HMAC_DRBG using PKCS11_RNG");
TestSession test_session(true);
PKCS11_RNG p11_rng(test_session.session());
HMAC_DRBG drbg(MessageAuthenticationCode::create("HMAC(SHA-512)"), p11_rng);
// result.test_success("HMAC_DRBG(HMAC(SHA512)) instantiated with PKCS11_RNG");
result.test_eq("HMAC_DRBG is not seeded yet.", drbg.is_seeded(), false);
secure_vector<uint8_t> rnd = drbg.random_vec(64);
result.test_eq("HMAC_DRBG is seeded now", drbg.is_seeded(), true);
std::string personalization_string = "Botan PKCS#11 Tests";
std::vector<uint8_t> personalization_data(personalization_string.begin(), personalization_string.end());
drbg.add_entropy(personalization_data.data(), personalization_data.size());
auto rnd_vec = drbg.random_vec(256);
result.test_ne("HMAC_DRBG generated a random vector", rnd_vec, std::vector<uint8_t>(256));
return result;
}
#endif
class PKCS11_RNG_Tests : public PKCS11_Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<std::function<Test::Result()>> fns =
{
test_rng_generate_random
,test_rng_add_entropy
#if defined(BOTAN_HAS_HMAC_DRBG )&& defined(BOTAN_HAS_SHA2_64)
,test_pkcs11_hmac_drbg
#endif
};
return run_pkcs11_tests("PKCS11 RNG", fns);
}
};
BOTAN_REGISTER_TEST("pkcs11-rng", PKCS11_RNG_Tests);
/***************************** PKCS11 token management *****************************/
Test::Result test_set_pin()
{
Test::Result result("PKCS11 set pin");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
PKCS11::set_pin(slot, SO_PIN_SECVEC, TEST_PIN_SECVEC);
result.test_success("PIN set with SO_PIN to TEST_PIN");
PKCS11::set_pin(slot, SO_PIN_SECVEC, PIN_SECVEC);
result.test_success("PIN changed back with SO_PIN");
return result;
}
Test::Result test_initialize()
{
Test::Result result("PKCS11 initialize token");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
PKCS11::initialize_token(slot, "Botan PKCS#11 tests", SO_PIN_SECVEC, PIN_SECVEC);
result.test_success("token initialized");
return result;
}
Test::Result test_change_pin()
{
Test::Result result("PKCS11 change pin");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
PKCS11::change_pin(slot, PIN_SECVEC, TEST_PIN_SECVEC);
result.test_success("PIN changed with PIN to TEST_PIN");
PKCS11::change_pin(slot, TEST_PIN_SECVEC, PIN_SECVEC);
result.test_success("PIN changed back with TEST_PIN to PIN");
return result;
}
Test::Result test_change_so_pin()
{
Test::Result result("PKCS11 change so_pin");
Module module(Test::pkcs11_lib());
std::vector<SlotId> slot_vec = Slot::get_available_slots(module, true);
Slot slot(module, slot_vec.at(0));
PKCS11::change_so_pin(slot, SO_PIN_SECVEC, TEST_SO_PIN_SECVEC);
result.test_success("SO_PIN changed with SO_PIN to TEST_SO_PIN");
PKCS11::change_so_pin(slot, TEST_SO_PIN_SECVEC, SO_PIN_SECVEC);
result.test_success("SO_PIN changed back with TEST_SO_PIN to SO_PIN");
return result;
}
class PKCS11_Token_Management_Tests : public PKCS11_Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<std::function<Test::Result()>> fns =
{
test_set_pin,
test_initialize,
test_change_pin,
test_change_so_pin
};
return run_pkcs11_tests("PKCS11 token management", fns);
}
};
BOTAN_REGISTER_TEST("pkcs11-manage", PKCS11_Token_Management_Tests);
/***************************** PKCS11 token management *****************************/
#if defined(BOTAN_HAS_X509_CERTIFICATES)
Test::Result test_x509_import()
{
Test::Result result("PKCS11 X509 cert import");
TestSession test_session(true);
X509_Certificate root(Test::data_file("nist_x509/test01/end.crt"));
X509_CertificateProperties props(DER_Encoder().encode(root.subject_dn()).get_contents_unlocked(), root.BER_encode());
props.set_label("Botan PKCS#11 test certificate");
props.set_private(false);
props.set_token(true);
PKCS11_X509_Certificate pkcs11_cert(test_session.session(), props);
result.test_success("X509 certificate imported");
PKCS11_X509_Certificate pkcs11_cert2(test_session.session(), pkcs11_cert.handle());
result.test_eq("X509 certificate by handle", pkcs11_cert == pkcs11_cert2, true);
pkcs11_cert.destroy();
return result;
}
class PKCS11_X509_Tests : public PKCS11_Test
{
public:
std::vector<Test::Result> run() override
{
std::vector<std::function<Test::Result()>> fns =
{
test_x509_import
};
return run_pkcs11_tests("PKCS11 X509", fns);
}
};
BOTAN_REGISTER_TEST("pkcs11-x509", PKCS11_X509_Tests);
#endif
#endif
}
}
|