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
#![allow(non_camel_case_types, non_snake_case)]
extern crate libloading;
use std::ptr;
use std::ffi::CString;
pub type CK_BYTE = u8;
pub type CK_BYTE_PTR = *const CK_BYTE;
pub type CK_CHAR = CK_BYTE;
pub type CK_UTF8CHAR = CK_BYTE;
pub type CK_UTF8CHAR_PTR = *const CK_UTF8CHAR;
pub type CK_BBOOL = CK_BYTE;
pub type CK_ULONG = usize;
pub type CK_ULONG_PTR = *const CK_ULONG;
pub type CK_LONG = isize;
pub type CK_FLAGS = CK_ULONG;
pub type CK_RV = CK_ULONG;
pub type CK_SLOT_ID = CK_ULONG;
pub type CK_SLOT_ID_PTR = *const CK_SLOT_ID;
pub type CK_SESSION_HANDLE = CK_ULONG;
pub type CK_SESSION_HANDLE_PTR = *const CK_SESSION_HANDLE;
pub type CK_NOTIFICATION = CK_ULONG;
pub type CK_USER_TYPE = CK_ULONG;
pub const CKU_SO: CK_USER_TYPE = 0;
pub const CKU_USER: CK_USER_TYPE = 1;
pub const CKU_CONTEXT_SPECIFIC: CK_USER_TYPE = 2;
pub const CKR_OK : CK_RV = 0x00000000;
pub const CKR_CANCEL : CK_RV = 0x00000001;
pub const CKR_HOST_MEMORY : CK_RV = 0x00000002;
pub const CKR_SLOT_ID_INVALID : CK_RV = 0x00000003;
pub const CKR_GENERAL_ERROR : CK_RV = 0x00000005;
pub const CKR_FUNCTION_FAILED : CK_RV = 0x00000006;
pub const CKR_ARGUMENTS_BAD : CK_RV = 0x00000007;
pub const CKR_NO_EVENT : CK_RV = 0x00000008;
pub const CKR_NEED_TO_CREATE_THREADS : CK_RV = 0x00000009;
pub const CKR_CANT_LOCK : CK_RV = 0x0000000A;
pub const CKR_ATTRIBUTE_READ_ONLY : CK_RV = 0x00000010;
pub const CKR_ATTRIBUTE_SENSITIVE : CK_RV = 0x00000011;
pub const CKR_ATTRIBUTE_TYPE_INVALID : CK_RV = 0x00000012;
pub const CKR_ATTRIBUTE_VALUE_INVALID : CK_RV = 0x00000013;
pub const CKR_ACTION_PROHIBITED : CK_RV = 0x0000001B;
pub const CKR_DATA_INVALID : CK_RV = 0x00000020;
pub const CKR_DATA_LEN_RANGE : CK_RV = 0x00000021;
pub const CKR_DEVICE_ERROR : CK_RV = 0x00000030;
pub const CKR_DEVICE_MEMORY : CK_RV = 0x00000031;
pub const CKR_DEVICE_REMOVED : CK_RV = 0x00000032;
pub const CKR_ENCRYPTED_DATA_INVALID : CK_RV = 0x00000040;
pub const CKR_ENCRYPTED_DATA_LEN_RANGE : CK_RV = 0x00000041;
pub const CKR_FUNCTION_CANCELED : CK_RV = 0x00000050;
pub const CKR_FUNCTION_NOT_PARALLEL : CK_RV = 0x00000051;
pub const CKR_FUNCTION_NOT_SUPPORTED : CK_RV = 0x00000054;
pub const CKR_KEY_HANDLE_INVALID : CK_RV = 0x00000060;
pub const CKR_KEY_SIZE_RANGE : CK_RV = 0x00000062;
pub const CKR_KEY_TYPE_INCONSISTENT : CK_RV = 0x00000063;
pub const CKR_KEY_NOT_NEEDED : CK_RV = 0x00000064;
pub const CKR_KEY_CHANGED : CK_RV = 0x00000065;
pub const CKR_KEY_NEEDED : CK_RV = 0x00000066;
pub const CKR_KEY_INDIGESTIBLE : CK_RV = 0x00000067;
pub const CKR_KEY_FUNCTION_NOT_PERMITTED : CK_RV = 0x00000068;
pub const CKR_KEY_NOT_WRAPPABLE : CK_RV = 0x00000069;
pub const CKR_KEY_UNEXTRACTABLE : CK_RV = 0x0000006A;
pub const CKR_MECHANISM_INVALID : CK_RV = 0x00000070;
pub const CKR_MECHANISM_PARAM_INVALID : CK_RV = 0x00000071;
pub const CKR_OBJECT_HANDLE_INVALID : CK_RV = 0x00000082;
pub const CKR_OPERATION_ACTIVE : CK_RV = 0x00000090;
pub const CKR_OPERATION_NOT_INITIALIZED : CK_RV = 0x00000091;
pub const CKR_PIN_INCORRECT : CK_RV = 0x000000A0;
pub const CKR_PIN_INVALID : CK_RV = 0x000000A1;
pub const CKR_PIN_LEN_RANGE : CK_RV = 0x000000A2;
pub const CKR_PIN_EXPIRED : CK_RV = 0x000000A3;
pub const CKR_PIN_LOCKED : CK_RV = 0x000000A4;
pub const CKR_SESSION_CLOSED : CK_RV = 0x000000B0;
pub const CKR_SESSION_COUNT : CK_RV = 0x000000B1;
pub const CKR_SESSION_HANDLE_INVALID : CK_RV = 0x000000B3;
pub const CKR_SESSION_PARALLEL_NOT_SUPPORTED : CK_RV = 0x000000B4;
pub const CKR_SESSION_READ_ONLY : CK_RV = 0x000000B5;
pub const CKR_SESSION_EXISTS : CK_RV = 0x000000B6;
pub const CKR_SESSION_READ_ONLY_EXISTS : CK_RV = 0x000000B7;
pub const CKR_SESSION_READ_WRITE_SO_EXISTS : CK_RV = 0x000000B8;
pub const CKR_SIGNATURE_INVALID : CK_RV = 0x000000C0;
pub const CKR_SIGNATURE_LEN_RANGE : CK_RV = 0x000000C1;
pub const CKR_TEMPLATE_INCOMPLETE : CK_RV = 0x000000D0;
pub const CKR_TEMPLATE_INCONSISTENT : CK_RV = 0x000000D1;
pub const CKR_TOKEN_NOT_PRESENT : CK_RV = 0x000000E0;
pub const CKR_TOKEN_NOT_RECOGNIZED : CK_RV = 0x000000E1;
pub const CKR_TOKEN_WRITE_PROTECTED : CK_RV = 0x000000E2;
pub const CKR_UNWRAPPING_KEY_HANDLE_INVALID : CK_RV = 0x000000F0;
pub const CKR_UNWRAPPING_KEY_SIZE_RANGE : CK_RV = 0x000000F1;
pub const CKR_UNWRAPPING_KEY_TYPE_INCONSISTENT : CK_RV = 0x000000F2;
pub const CKR_USER_ALREADY_LOGGED_IN : CK_RV = 0x00000100;
pub const CKR_USER_NOT_LOGGED_IN : CK_RV = 0x00000101;
pub const CKR_USER_PIN_NOT_INITIALIZED : CK_RV = 0x00000102;
pub const CKR_USER_TYPE_INVALID : CK_RV = 0x00000103;
pub const CKR_USER_ANOTHER_ALREADY_LOGGED_IN : CK_RV = 0x00000104;
pub const CKR_USER_TOO_MANY_TYPES : CK_RV = 0x00000105;
pub const CKR_WRAPPED_KEY_INVALID : CK_RV = 0x00000110;
pub const CKR_WRAPPED_KEY_LEN_RANGE : CK_RV = 0x00000112;
pub const CKR_WRAPPING_KEY_HANDLE_INVALID : CK_RV = 0x00000113;
pub const CKR_WRAPPING_KEY_SIZE_RANGE : CK_RV = 0x00000114;
pub const CKR_WRAPPING_KEY_TYPE_INCONSISTENT : CK_RV = 0x00000115;
pub const CKR_RANDOM_SEED_NOT_SUPPORTED : CK_RV = 0x00000120;
pub const CKR_RANDOM_NO_RNG : CK_RV = 0x00000121;
pub const CKR_DOMAIN_PARAMS_INVALID : CK_RV = 0x00000130;
pub const CKR_CURVE_NOT_SUPPORTED : CK_RV = 0x00000140;
pub const CKR_BUFFER_TOO_SMALL : CK_RV = 0x00000150;
pub const CKR_SAVED_STATE_INVALID : CK_RV = 0x00000160;
pub const CKR_INFORMATION_SENSITIVE : CK_RV = 0x00000170;
pub const CKR_STATE_UNSAVEABLE : CK_RV = 0x00000180;
pub const CKR_CRYPTOKI_NOT_INITIALIZED : CK_RV = 0x00000190;
pub const CKR_CRYPTOKI_ALREADY_INITIALIZED : CK_RV = 0x00000191;
pub const CKR_MUTEX_BAD : CK_RV = 0x000001A0;
pub const CKR_MUTEX_NOT_LOCKED : CK_RV = 0x000001A1;
pub const CKR_NEW_PIN_MODE : CK_RV = 0x000001B0;
pub const CKR_NEXT_OTP : CK_RV = 0x000001B1;
pub const CKR_EXCEEDED_MAX_ITERATIONS : CK_RV = 0x000001B5;
pub const CKR_FIPS_SELF_TEST_FAILED : CK_RV = 0x000001B6;
pub const CKR_LIBRARY_LOAD_FAILED : CK_RV = 0x000001B7;
pub const CKR_PIN_TOO_WEAK : CK_RV = 0x000001B8;
pub const CKR_PUBLIC_KEY_INVALID : CK_RV = 0x000001B9;
pub const CKR_FUNCTION_REJECTED : CK_RV = 0x00000200;
pub const CKR_VENDOR_DEFINED : CK_RV = 0x80000000;
trait CkFrom<T> {
fn from(T) -> Self;
}
impl CkFrom<bool> for CK_BBOOL {
fn from(b: bool) -> CK_BBOOL {
match b {
true => 1,
false => 0,
}
}
}
impl CkFrom<CK_BBOOL> for bool {
fn from(b: CK_BBOOL) -> bool {
match b {
0 => false,
_ => true,
}
}
}
#[derive(Debug)]
#[repr(u8)]
pub enum CK_VOID {
#[doc(hidden)]
__Variant1,
#[doc(hidden)]
__Variant2,
}
pub type CK_VOID_PTR = *const CK_VOID;
pub type CK_VOID_PTR_PTR = *const CK_VOID_PTR;
#[derive(Debug,Clone)]
#[repr(C)]
pub struct CK_VERSION {
pub major: CK_BYTE,
pub minor: CK_BYTE,
}
impl CK_VERSION {
pub fn new() -> CK_VERSION {
CK_VERSION {
major: 0,
minor: 0,
}
}
}
pub type CK_CREATEMUTEX = Option<extern "C" fn(CK_VOID_PTR_PTR) -> CK_RV>;
pub type CK_DESTROYMUTEX = Option<extern "C" fn(CK_VOID_PTR) -> CK_RV>;
pub type CK_LOCKMUTEX = Option<extern "C" fn(CK_VOID_PTR) -> CK_RV>;
pub type CK_UNLOCKMUTEX = Option<extern "C" fn(CK_VOID_PTR) -> CK_RV>;
pub type CK_NOTIFY = Option<extern "C" fn(CK_SESSION_HANDLE, CK_NOTIFICATION, CK_VOID_PTR) -> CK_RV>;
#[derive(Debug)]
#[repr(C)]
pub struct CK_C_INITIALIZE_ARGS {
pub CreateMutex: CK_CREATEMUTEX,
pub DestroyMutex: CK_DESTROYMUTEX,
pub LockMutex: CK_LOCKMUTEX,
pub UnlockMutex: CK_UNLOCKMUTEX,
pub flags: CK_FLAGS,
pub pReserved: CK_VOID_PTR,
}
impl CK_C_INITIALIZE_ARGS {
pub fn new() -> CK_C_INITIALIZE_ARGS {
CK_C_INITIALIZE_ARGS {
flags: CKF_OS_LOCKING_OK,
CreateMutex: None,
DestroyMutex: None,
LockMutex: None,
UnlockMutex: None,
pReserved: ptr::null(),
}
}
}
pub const CKF_LIBRARY_CANT_CREATE_OS_THREADS: CK_FLAGS = 0x00000001;
pub const CKF_OS_LOCKING_OK: CK_FLAGS = 0x00000002;
pub type CK_C_INITIALIZE_ARGS_PTR = *const CK_C_INITIALIZE_ARGS;
#[derive(Debug)]
#[repr(C)]
pub struct CK_INFO {
pub cryptokiVersion: CK_VERSION,
pub manufacturerID: [CK_UTF8CHAR; 32],
pub flags: CK_FLAGS,
pub libraryDescription: [CK_UTF8CHAR; 32],
pub libraryVersion: CK_VERSION,
}
impl CK_INFO {
pub fn new() -> CK_INFO {
CK_INFO {
cryptokiVersion: CK_VERSION::new(),
manufacturerID: [0; 32],
flags: 0,
libraryDescription: [0; 32],
libraryVersion: CK_VERSION::new(),
}
}
}
pub type CK_INFO_PTR = *const CK_INFO;
#[repr(C)]
pub struct CK_SLOT_INFO {
pub slotDescription: [CK_UTF8CHAR; 64],
pub manufacturerID: [CK_UTF8CHAR; 32],
pub flags: CK_FLAGS,
pub hardwareVersion: CK_VERSION,
pub firmwareVersion: CK_VERSION,
}
impl CK_SLOT_INFO {
pub fn new() -> CK_SLOT_INFO {
CK_SLOT_INFO {
slotDescription: [0; 64],
manufacturerID: [0; 32],
flags: 0,
hardwareVersion: CK_VERSION::new(),
firmwareVersion: CK_VERSION::new(),
}
}
}
impl std::fmt::Debug for CK_SLOT_INFO {
fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
let sd = self.slotDescription.to_vec();
fmt.debug_struct("CK_SLOT_INFO")
.field("slotDescription", &sd)
.field("manufacturerID", &self.manufacturerID)
.field("flags", &self.flags)
.field("hardwareVersion", &self.hardwareVersion)
.field("firmwareVersion", &self.firmwareVersion)
.finish()
}
}
pub type CK_SLOT_INFO_PTR = *const CK_SLOT_INFO;
#[derive(Debug)]
#[repr(C)]
pub struct CK_TOKEN_INFO {
pub label: [CK_UTF8CHAR; 32],
pub manufacturerID: [CK_UTF8CHAR; 32],
pub model: [CK_UTF8CHAR; 16],
pub serialNumber: [CK_CHAR; 16],
pub flags: CK_FLAGS,
pub ulMaxSessionCount: CK_ULONG,
pub ulSessionCount: CK_ULONG,
pub ulMaxRwSessionCount: CK_ULONG,
pub ulRwSessionCount: CK_ULONG,
pub ulMaxPinLen: CK_ULONG,
pub ulMinPinLen: CK_ULONG,
pub ulTotalPublicMemory: CK_ULONG,
pub ulFreePublicMemory: CK_ULONG,
pub ulTotalPrivateMemory: CK_ULONG,
pub ulFreePrivateMemory: CK_ULONG,
pub hardwareVersion: CK_VERSION,
pub firmwareVersion: CK_VERSION,
pub utcTime: [CK_CHAR; 16],
}
impl CK_TOKEN_INFO {
pub fn new() -> CK_TOKEN_INFO {
CK_TOKEN_INFO {
label: [0; 32],
manufacturerID: [0; 32],
model: [0; 16],
serialNumber: [0; 16],
flags: 0,
ulMaxSessionCount: 0,
ulSessionCount: 0,
ulMaxRwSessionCount: 0,
ulRwSessionCount: 0,
ulMaxPinLen: 0,
ulMinPinLen: 0,
ulTotalPublicMemory: 0,
ulFreePublicMemory: 0,
ulTotalPrivateMemory: 0,
ulFreePrivateMemory: 0,
hardwareVersion: CK_VERSION::new(),
firmwareVersion: CK_VERSION::new(),
utcTime: [0; 16],
}
}
}
pub type CK_TOKEN_INFO_PTR = *const CK_TOKEN_INFO;
pub type CK_MECHANISM_TYPE = CK_ULONG;
pub type CK_MECHANISM_TYPE_PTR = *const CK_MECHANISM_TYPE;
#[derive(Debug,Default,Clone)]
#[repr(C)]
pub struct CK_MECHANISM_INFO {
pub ulMinKeySize: CK_ULONG,
pub ulMaxKeySize: CK_ULONG,
pub flags: CK_FLAGS,
}
pub type CK_MECHANISM_INFO_PTR = *const CK_MECHANISM_INFO;
pub type CK_STATE = CK_ULONG;
#[derive(Debug,Default,Clone)]
#[repr(C)]
pub struct CK_SESSION_INFO {
pub slotID: CK_SLOT_ID,
pub state: CK_STATE,
pub flags: CK_FLAGS,
pub ulDeviceError: CK_ULONG,
}
pub type CK_SESSION_INFO_PTR = *const CK_SESSION_INFO;
pub const CKF_RW_SESSION: CK_FLAGS = 0x00000002;
pub const CKF_SERIAL_SESSION: CK_FLAGS = 0x00000004;
pub type CK_OBJECT_HANDLE = CK_ULONG;
pub type CK_OBJECT_HANDLE_PTR = *const CK_OBJECT_HANDLE;
pub type CK_ATTRIBUTE_TYPE = CK_ULONG;
pub const CKF_ARRAY_ATTRIBUTE: CK_FLAGS = 0x40000000;
pub const CK_OTP_FORMAT_DECIMAL : CK_ULONG = 0;
pub const CK_OTP_FORMAT_HEXADECIMAL : CK_ULONG = 1;
pub const CK_OTP_FORMAT_ALPHANUMERIC : CK_ULONG = 2;
pub const CK_OTP_FORMAT_BINARY : CK_ULONG = 3;
pub const CK_OTP_PARAM_IGNORED : CK_ULONG = 0;
pub const CK_OTP_PARAM_OPTIONAL : CK_ULONG = 1;
pub const CK_OTP_PARAM_MANDATORY : CK_ULONG = 2;
pub const CKA_CLASS : CK_ATTRIBUTE_TYPE = 0x00000000;
pub const CKA_TOKEN : CK_ATTRIBUTE_TYPE = 0x00000001;
pub const CKA_PRIVATE : CK_ATTRIBUTE_TYPE = 0x00000002;
pub const CKA_LABEL : CK_ATTRIBUTE_TYPE = 0x00000003;
pub const CKA_APPLICATION : CK_ATTRIBUTE_TYPE = 0x00000010;
pub const CKA_VALUE : CK_ATTRIBUTE_TYPE = 0x00000011;
pub const CKA_OBJECT_ID : CK_ATTRIBUTE_TYPE = 0x00000012;
pub const CKA_CERTIFICATE_TYPE : CK_ATTRIBUTE_TYPE = 0x00000080;
pub const CKA_ISSUER : CK_ATTRIBUTE_TYPE = 0x00000081;
pub const CKA_SERIAL_NUMBER : CK_ATTRIBUTE_TYPE = 0x00000082;
pub const CKA_AC_ISSUER : CK_ATTRIBUTE_TYPE = 0x00000083;
pub const CKA_OWNER : CK_ATTRIBUTE_TYPE = 0x00000084;
pub const CKA_ATTR_TYPES : CK_ATTRIBUTE_TYPE = 0x00000085;
pub const CKA_TRUSTED : CK_ATTRIBUTE_TYPE = 0x00000086;
pub const CKA_CERTIFICATE_CATEGORY : CK_ATTRIBUTE_TYPE = 0x00000087;
pub const CKA_JAVA_MIDP_SECURITY_DOMAIN : CK_ATTRIBUTE_TYPE = 0x00000088;
pub const CKA_URL : CK_ATTRIBUTE_TYPE = 0x00000089;
pub const CKA_HASH_OF_SUBJECT_PUBLIC_KEY : CK_ATTRIBUTE_TYPE = 0x0000008A;
pub const CKA_HASH_OF_ISSUER_PUBLIC_KEY : CK_ATTRIBUTE_TYPE = 0x0000008B;
pub const CKA_NAME_HASH_ALGORITHM : CK_ATTRIBUTE_TYPE = 0x0000008C;
pub const CKA_CHECK_VALUE : CK_ATTRIBUTE_TYPE = 0x00000090;
pub const CKA_KEY_TYPE : CK_ATTRIBUTE_TYPE = 0x00000100;
pub const CKA_SUBJECT : CK_ATTRIBUTE_TYPE = 0x00000101;
pub const CKA_ID : CK_ATTRIBUTE_TYPE = 0x00000102;
pub const CKA_SENSITIVE : CK_ATTRIBUTE_TYPE = 0x00000103;
pub const CKA_ENCRYPT : CK_ATTRIBUTE_TYPE = 0x00000104;
pub const CKA_DECRYPT : CK_ATTRIBUTE_TYPE = 0x00000105;
pub const CKA_WRAP : CK_ATTRIBUTE_TYPE = 0x00000106;
pub const CKA_UNWRAP : CK_ATTRIBUTE_TYPE = 0x00000107;
pub const CKA_SIGN : CK_ATTRIBUTE_TYPE = 0x00000108;
pub const CKA_SIGN_RECOVER : CK_ATTRIBUTE_TYPE = 0x00000109;
pub const CKA_VERIFY : CK_ATTRIBUTE_TYPE = 0x0000010A;
pub const CKA_VERIFY_RECOVER : CK_ATTRIBUTE_TYPE = 0x0000010B;
pub const CKA_DERIVE : CK_ATTRIBUTE_TYPE = 0x0000010C;
pub const CKA_START_DATE : CK_ATTRIBUTE_TYPE = 0x00000110;
pub const CKA_END_DATE : CK_ATTRIBUTE_TYPE = 0x00000111;
pub const CKA_MODULUS : CK_ATTRIBUTE_TYPE = 0x00000120;
pub const CKA_MODULUS_BITS : CK_ATTRIBUTE_TYPE = 0x00000121;
pub const CKA_PUBLIC_EXPONENT : CK_ATTRIBUTE_TYPE = 0x00000122;
pub const CKA_PRIVATE_EXPONENT : CK_ATTRIBUTE_TYPE = 0x00000123;
pub const CKA_PRIME_1 : CK_ATTRIBUTE_TYPE = 0x00000124;
pub const CKA_PRIME_2 : CK_ATTRIBUTE_TYPE = 0x00000125;
pub const CKA_EXPONENT_1 : CK_ATTRIBUTE_TYPE = 0x00000126;
pub const CKA_EXPONENT_2 : CK_ATTRIBUTE_TYPE = 0x00000127;
pub const CKA_COEFFICIENT : CK_ATTRIBUTE_TYPE = 0x00000128;
pub const CKA_PUBLIC_KEY_INFO : CK_ATTRIBUTE_TYPE = 0x00000129;
pub const CKA_PRIME : CK_ATTRIBUTE_TYPE = 0x00000130;
pub const CKA_SUBPRIME : CK_ATTRIBUTE_TYPE = 0x00000131;
pub const CKA_BASE : CK_ATTRIBUTE_TYPE = 0x00000132;
pub const CKA_PRIME_BITS : CK_ATTRIBUTE_TYPE = 0x00000133;
pub const CKA_SUBPRIME_BITS : CK_ATTRIBUTE_TYPE = 0x00000134;
pub const CKA_SUB_PRIME_BITS : CK_ATTRIBUTE_TYPE = CKA_SUBPRIME_BITS;
pub const CKA_VALUE_BITS : CK_ATTRIBUTE_TYPE = 0x00000160;
pub const CKA_VALUE_LEN : CK_ATTRIBUTE_TYPE = 0x00000161;
pub const CKA_EXTRACTABLE : CK_ATTRIBUTE_TYPE = 0x00000162;
pub const CKA_LOCAL : CK_ATTRIBUTE_TYPE = 0x00000163;
pub const CKA_NEVER_EXTRACTABLE : CK_ATTRIBUTE_TYPE = 0x00000164;
pub const CKA_ALWAYS_SENSITIVE : CK_ATTRIBUTE_TYPE = 0x00000165;
pub const CKA_KEY_GEN_MECHANISM : CK_ATTRIBUTE_TYPE = 0x00000166;
pub const CKA_MODIFIABLE : CK_ATTRIBUTE_TYPE = 0x00000170;
pub const CKA_COPYABLE : CK_ATTRIBUTE_TYPE = 0x00000171;
pub const CKA_DESTROYABLE : CK_ATTRIBUTE_TYPE = 0x00000172;
pub const CKA_ECDSA_PARAMS : CK_ATTRIBUTE_TYPE = 0x00000180;
pub const CKA_EC_PARAMS : CK_ATTRIBUTE_TYPE = 0x00000180;
pub const CKA_EC_POINT : CK_ATTRIBUTE_TYPE = 0x00000181;
pub const CKA_SECONDARY_AUTH : CK_ATTRIBUTE_TYPE = 0x00000200;
pub const CKA_AUTH_PIN_FLAGS : CK_ATTRIBUTE_TYPE = 0x00000201;
pub const CKA_ALWAYS_AUTHENTICATE : CK_ATTRIBUTE_TYPE = 0x00000202;
pub const CKA_WRAP_WITH_TRUSTED : CK_ATTRIBUTE_TYPE = 0x00000210;
pub const CKA_WRAP_TEMPLATE : CK_ATTRIBUTE_TYPE = (CKF_ARRAY_ATTRIBUTE|0x00000211);
pub const CKA_UNWRAP_TEMPLATE : CK_ATTRIBUTE_TYPE = (CKF_ARRAY_ATTRIBUTE|0x00000212);
pub const CKA_DERIVE_TEMPLATE : CK_ATTRIBUTE_TYPE = (CKF_ARRAY_ATTRIBUTE|0x00000213);
pub const CKA_OTP_FORMAT : CK_ATTRIBUTE_TYPE = 0x00000220;
pub const CKA_OTP_LENGTH : CK_ATTRIBUTE_TYPE = 0x00000221;
pub const CKA_OTP_TIME_INTERVAL : CK_ATTRIBUTE_TYPE = 0x00000222;
pub const CKA_OTP_USER_FRIENDLY_MODE : CK_ATTRIBUTE_TYPE = 0x00000223;
pub const CKA_OTP_CHALLENGE_REQUIREMENT : CK_ATTRIBUTE_TYPE = 0x00000224;
pub const CKA_OTP_TIME_REQUIREMENT : CK_ATTRIBUTE_TYPE = 0x00000225;
pub const CKA_OTP_COUNTER_REQUIREMENT : CK_ATTRIBUTE_TYPE = 0x00000226;
pub const CKA_OTP_PIN_REQUIREMENT : CK_ATTRIBUTE_TYPE = 0x00000227;
pub const CKA_OTP_COUNTER : CK_ATTRIBUTE_TYPE = 0x0000022E;
pub const CKA_OTP_TIME : CK_ATTRIBUTE_TYPE = 0x0000022F;
pub const CKA_OTP_USER_IDENTIFIER : CK_ATTRIBUTE_TYPE = 0x0000022A;
pub const CKA_OTP_SERVICE_IDENTIFIER : CK_ATTRIBUTE_TYPE = 0x0000022B;
pub const CKA_OTP_SERVICE_LOGO : CK_ATTRIBUTE_TYPE = 0x0000022C;
pub const CKA_OTP_SERVICE_LOGO_TYPE : CK_ATTRIBUTE_TYPE = 0x0000022D;
pub const CKA_GOSTR3410_PARAMS : CK_ATTRIBUTE_TYPE = 0x00000250;
pub const CKA_GOSTR3411_PARAMS : CK_ATTRIBUTE_TYPE = 0x00000251;
pub const CKA_GOST28147_PARAMS : CK_ATTRIBUTE_TYPE = 0x00000252;
pub const CKA_HW_FEATURE_TYPE : CK_ATTRIBUTE_TYPE = 0x00000300;
pub const CKA_RESET_ON_INIT : CK_ATTRIBUTE_TYPE = 0x00000301;
pub const CKA_HAS_RESET : CK_ATTRIBUTE_TYPE = 0x00000302;
pub const CKA_PIXEL_X : CK_ATTRIBUTE_TYPE = 0x00000400;
pub const CKA_PIXEL_Y : CK_ATTRIBUTE_TYPE = 0x00000401;
pub const CKA_RESOLUTION : CK_ATTRIBUTE_TYPE = 0x00000402;
pub const CKA_CHAR_ROWS : CK_ATTRIBUTE_TYPE = 0x00000403;
pub const CKA_CHAR_COLUMNS : CK_ATTRIBUTE_TYPE = 0x00000404;
pub const CKA_COLOR : CK_ATTRIBUTE_TYPE = 0x00000405;
pub const CKA_BITS_PER_PIXEL : CK_ATTRIBUTE_TYPE = 0x00000406;
pub const CKA_CHAR_SETS : CK_ATTRIBUTE_TYPE = 0x00000480;
pub const CKA_ENCODING_METHODS : CK_ATTRIBUTE_TYPE = 0x00000481;
pub const CKA_MIME_TYPES : CK_ATTRIBUTE_TYPE = 0x00000482;
pub const CKA_MECHANISM_TYPE : CK_ATTRIBUTE_TYPE = 0x00000500;
pub const CKA_REQUIRED_CMS_ATTRIBUTES : CK_ATTRIBUTE_TYPE = 0x00000501;
pub const CKA_DEFAULT_CMS_ATTRIBUTES : CK_ATTRIBUTE_TYPE = 0x00000502;
pub const CKA_SUPPORTED_CMS_ATTRIBUTES : CK_ATTRIBUTE_TYPE = 0x00000503;
pub const CKA_ALLOWED_MECHANISMS : CK_ATTRIBUTE_TYPE = (CKF_ARRAY_ATTRIBUTE|0x00000600);
pub const CKA_VENDOR_DEFINED : CK_ATTRIBUTE_TYPE = 0x80000000;
#[derive(Debug,Clone)]
#[repr(C)]
pub struct CK_ATTRIBUTE {
ulType: CK_ATTRIBUTE_TYPE,
pValue: CK_VOID_PTR,
ulValueLen: CK_ULONG,
}
pub type CK_ATTRIBUTE_PTR = *const CK_ATTRIBUTE;
#[derive(Debug,Default,Clone)]
#[repr(C)]
pub struct CK_DATE{
year: [CK_CHAR; 4],
month: [CK_CHAR; 2],
day: [CK_CHAR; 2],
}
pub type C_Initialize = extern "C" fn(CK_C_INITIALIZE_ARGS_PTR) -> CK_RV;
pub type C_Finalize = extern "C" fn(CK_VOID_PTR) -> CK_RV;
pub type C_GetInfo = extern "C" fn(CK_INFO_PTR) -> CK_RV;
pub type C_GetFunctionList = extern "C" fn(CK_FUNCTION_LIST_PTR_PTR) -> CK_RV;
pub type C_GetSlotList = extern "C" fn(CK_BBOOL, CK_SLOT_ID_PTR, CK_ULONG_PTR) -> CK_RV;
pub type C_GetSlotInfo = extern "C" fn(CK_SLOT_ID, CK_SLOT_INFO_PTR) -> CK_RV;
pub type C_GetTokenInfo = extern "C" fn(CK_SLOT_ID, CK_TOKEN_INFO_PTR) -> CK_RV;
pub type C_GetMechanismList = extern "C" fn(CK_SLOT_ID, CK_MECHANISM_TYPE_PTR, CK_ULONG_PTR) -> CK_RV;
pub type C_GetMechanismInfo = extern "C" fn(CK_SLOT_ID, CK_MECHANISM_TYPE, CK_MECHANISM_INFO_PTR) -> CK_RV;
pub type C_InitToken = extern "C" fn(CK_SLOT_ID, CK_UTF8CHAR_PTR, CK_ULONG, CK_UTF8CHAR_PTR) -> CK_RV;
pub type C_InitPIN = extern "C" fn(CK_SESSION_HANDLE, CK_UTF8CHAR_PTR, CK_ULONG) -> CK_RV;
pub type C_SetPIN = extern "C" fn(CK_SESSION_HANDLE, CK_UTF8CHAR_PTR, CK_ULONG, CK_UTF8CHAR_PTR, CK_ULONG) -> CK_RV;
pub type C_OpenSession = extern "C" fn(CK_SLOT_ID, CK_FLAGS, CK_VOID_PTR, CK_NOTIFY, CK_SESSION_HANDLE_PTR) -> CK_RV;
pub type C_CloseSession = extern "C" fn(CK_SESSION_HANDLE) -> CK_RV;
pub type C_CloseAllSessions = extern "C" fn(CK_SLOT_ID) -> CK_RV;
pub type C_GetSessionInfo = extern "C" fn(CK_SESSION_HANDLE, CK_SESSION_INFO_PTR) -> CK_RV;
pub type C_GetOperationState = extern "C" fn(CK_SESSION_HANDLE, CK_BYTE_PTR, CK_ULONG_PTR) -> CK_RV;
pub type C_SetOperationState = extern "C" fn(CK_SESSION_HANDLE, CK_BYTE_PTR, CK_ULONG, CK_OBJECT_HANDLE, CK_OBJECT_HANDLE) -> CK_RV;
pub type C_Login = extern "C" fn(CK_SESSION_HANDLE, CK_USER_TYPE, CK_UTF8CHAR_PTR, CK_ULONG) -> CK_RV;
pub type C_Logout = extern "C" fn(CK_SESSION_HANDLE) -> CK_RV;
pub type C_CreateObject = extern "C" fn(CK_SESSION_HANDLE, CK_ATTRIBUTE_PTR, CK_ULONG, CK_OBJECT_HANDLE_PTR) -> CK_RV;
pub type C_CopyObject = extern "C" fn(CK_SESSION_HANDLE, CK_OBJECT_HANDLE, CK_ATTRIBUTE_PTR, CK_ULONG, CK_OBJECT_HANDLE_PTR) -> CK_RV;
pub type C_DestroyObject = extern "C" fn(CK_SESSION_HANDLE, CK_OBJECT_HANDLE) -> CK_RV;
pub type C_GetObjectSize = extern "C" fn(CK_SESSION_HANDLE, CK_OBJECT_HANDLE, CK_ULONG_PTR) -> CK_RV;
pub type C_GetAttributeValue = extern "C" fn(CK_SESSION_HANDLE, CK_OBJECT_HANDLE, CK_ATTRIBUTE_PTR, CK_ULONG) -> CK_RV;
pub type C_SetAttributeValue = extern "C" fn(CK_SESSION_HANDLE, CK_OBJECT_HANDLE, CK_ATTRIBUTE_PTR, CK_ULONG) -> CK_RV;
pub type C_FindObjectsInit = extern "C" fn(CK_SESSION_HANDLE, CK_ATTRIBUTE_PTR, CK_ULONG) -> CK_RV;
pub type C_FindObjects = extern "C" fn(CK_SESSION_HANDLE, CK_OBJECT_HANDLE_PTR, CK_ULONG, CK_ULONG_PTR) -> CK_RV;
pub type C_FindObjectsFinal = extern "C" fn(CK_SESSION_HANDLE) -> CK_RV;
#[derive(Debug,Clone)]
#[repr(C)]
pub struct CK_FUNCTION_LIST {
pub version: CK_VERSION,
pub C_Initialize: Option<C_Initialize>,
pub C_Finalize: Option<C_Finalize>,
pub C_GetInfo: Option<C_GetInfo>,
pub C_GetFunctionList: Option<C_GetFunctionList>,
pub C_GetSlotList: Option<C_GetSlotList>,
pub C_GetSlotInfo: Option<C_GetSlotInfo>,
pub C_GetTokenInfo: Option<C_GetTokenInfo>,
pub C_GetMechanismList: Option<C_GetMechanismList>,
pub C_GetMechanismInfo: Option<C_GetMechanismInfo>,
pub C_InitToken: Option<C_InitToken>,
pub C_InitPIN: Option<C_InitPIN>,
pub C_SetPIN: Option<C_SetPIN>,
pub C_OpenSession: Option<C_OpenSession>,
pub C_CloseSession: Option<C_CloseSession>,
pub C_CloseAllSessions: Option<C_CloseAllSessions>,
pub C_GetSessionInfo: Option<C_GetSessionInfo>,
pub C_GetOperationState: Option<C_GetOperationState>,
pub C_SetOperationState: Option<C_SetOperationState>,
pub C_Login: Option<C_Login>,
pub C_Logout: Option<C_Logout>,
pub C_CreateObject: Option<C_CreateObject>,
pub C_CopyObject: Option<C_CopyObject>,
pub C_DestroyObject: Option<C_DestroyObject>,
pub C_GetObjectSize: Option<C_GetObjectSize>,
pub C_GetAttributeValue: Option<C_GetAttributeValue>,
pub C_SetAttributeValue: Option<C_SetAttributeValue>,
pub C_FindObjectsInit: Option<C_FindObjectsInit>,
pub C_FindObjects: Option<C_FindObjects>,
pub C_FindObjectsFinal: Option<C_FindObjectsFinal>,
}
pub type CK_FUNCTION_LIST_PTR = *const CK_FUNCTION_LIST;
pub type CK_FUNCTION_LIST_PTR_PTR = *const CK_FUNCTION_LIST_PTR;
#[derive(Debug)]
pub enum Error {
Io(std::io::Error),
Module(&'static str),
InvalidInput(&'static str),
Pkcs11(CK_RV),
}
impl From<std::io::Error> for Error {
fn from(err: std::io::Error) -> Error {
Error::Io(err)
}
}
impl std::fmt::Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match *self {
Error::Io(ref err) => write!(f, "IO error: {}", err),
Error::Module(ref err) => write!(f, "PKCS#11 Module error: {}", err),
Error::InvalidInput(ref err) => write!(f, "Invalid Input for PKCS#11: {}", err),
Error::Pkcs11(ref err) => write!(f, "PKCS#11 error: 0x{:x}", err),
}
}
}
fn label_from_str(label: &str) -> [CK_UTF8CHAR; 32] {
let mut lab: [CK_UTF8CHAR; 32] = [32; 32];
let mut i = 0;
for c in label.chars() {
if i + c.len_utf8() <= 32 {
let mut buf = [0; 4];
let bytes = c.encode_utf8(&mut buf).as_bytes();
for b in bytes {
lab[i] = b.clone();
i += 1;
}
} else {
break
}
}
lab
}
#[derive(Debug)]
pub struct Ctx {
lib: libloading::Library,
_is_initialized: bool,
C_Initialize: C_Initialize,
C_Finalize: C_Finalize,
C_GetInfo: C_GetInfo,
C_GetFunctionList: C_GetFunctionList,
C_GetSlotList: C_GetSlotList,
C_GetSlotInfo: C_GetSlotInfo,
C_GetTokenInfo: C_GetTokenInfo,
C_GetMechanismList: C_GetMechanismList,
C_GetMechanismInfo: C_GetMechanismInfo,
C_InitToken: C_InitToken,
C_InitPIN: C_InitPIN,
C_SetPIN: C_SetPIN,
C_OpenSession: C_OpenSession,
C_CloseSession: C_CloseSession,
C_CloseAllSessions: C_CloseAllSessions,
C_GetSessionInfo: C_GetSessionInfo,
C_GetOperationState: C_GetOperationState,
C_SetOperationState: C_SetOperationState,
C_Login: C_Login,
C_Logout: C_Logout,
C_CreateObject: C_CreateObject,
C_CopyObject: C_CopyObject,
C_DestroyObject: C_DestroyObject,
C_GetObjectSize: C_GetObjectSize,
C_GetAttributeValue: C_GetAttributeValue,
C_SetAttributeValue: C_SetAttributeValue,
C_FindObjectsInit: C_FindObjectsInit,
C_FindObjects: C_FindObjects,
C_FindObjectsFinal: C_FindObjectsFinal,
}
impl Ctx {
pub fn new(filename: &'static str) -> Result<Ctx, Error> {
unsafe {
let lib = libloading::Library::new(filename)?;
let mut list: CK_FUNCTION_LIST_PTR = std::mem::uninitialized();
{
let func: libloading::Symbol<unsafe extern "C" fn(CK_FUNCTION_LIST_PTR_PTR) -> CK_RV> = lib.get(b"C_GetFunctionList")?;
match func(&mut list) {
CKR_OK => (),
err => return Err(Error::Pkcs11(err)),
}
}
Ok(Ctx {
lib: lib,
_is_initialized: false,
C_Initialize: (*list).C_Initialize.ok_or(Error::Module("C_Initialize function not found"))?,
C_Finalize: (*list).C_Finalize.ok_or(Error::Module("C_Finalize function not found"))?,
C_GetInfo: (*list).C_GetInfo.ok_or(Error::Module("C_GetInfo function not found"))?,
C_GetFunctionList: (*list).C_GetFunctionList.ok_or(Error::Module("C_GetFunctionList function not found"))?,
C_GetSlotList: (*list).C_GetSlotList.ok_or(Error::Module("C_GetSlotList function not found"))?,
C_GetSlotInfo: (*list).C_GetSlotInfo.ok_or(Error::Module("C_GetSlotInfo function not found"))?,
C_GetTokenInfo: (*list).C_GetTokenInfo.ok_or(Error::Module("C_GetTokenInfo function not found"))?,
C_GetMechanismList: (*list).C_GetMechanismList.ok_or(Error::Module("C_GetMechanismList function not found"))?,
C_GetMechanismInfo: (*list).C_GetMechanismInfo.ok_or(Error::Module("C_GetMechanismInfo function not found"))?,
C_InitToken: (*list).C_InitToken.ok_or(Error::Module("C_InitToken function not found"))?,
C_InitPIN: (*list).C_InitPIN.ok_or(Error::Module("C_InitPIN function not found"))?,
C_SetPIN: (*list).C_SetPIN.ok_or(Error::Module("C_SetPIN function not found"))?,
C_OpenSession: (*list).C_OpenSession.ok_or(Error::Module("C_OpenSession function not found"))?,
C_CloseSession: (*list).C_CloseSession.ok_or(Error::Module("C_CloseSession function not found"))?,
C_CloseAllSessions: (*list).C_CloseAllSessions.ok_or(Error::Module("C_CloseAllSessions function not found"))?,
C_GetSessionInfo: (*list).C_GetSessionInfo.ok_or(Error::Module("C_GetSessionInfo function not found"))?,
C_GetOperationState: (*list).C_GetOperationState.ok_or(Error::Module("C_GetOperationState function not found"))?,
C_SetOperationState: (*list).C_SetOperationState.ok_or(Error::Module("C_SetOperationState function not found"))?,
C_Login: (*list).C_Login.ok_or(Error::Module("C_Login function not found"))?,
C_Logout: (*list).C_Logout.ok_or(Error::Module("C_Logout function not found"))?,
C_CreateObject: (*list).C_CreateObject.ok_or(Error::Module("C_CreateObject function not found"))?,
C_CopyObject: (*list).C_CopyObject.ok_or(Error::Module("C_CopyObject function not found"))?,
C_DestroyObject: (*list).C_DestroyObject.ok_or(Error::Module("C_DestroyObject function not found"))?,
C_GetObjectSize: (*list).C_GetObjectSize.ok_or(Error::Module("C_GetObjectSize function not found"))?,
C_GetAttributeValue: (*list).C_GetAttributeValue.ok_or(Error::Module("C_GetAttributeValue function not found"))?,
C_SetAttributeValue: (*list).C_SetAttributeValue.ok_or(Error::Module("C_SetAttributeValue function not found"))?,
C_FindObjectsInit: (*list).C_FindObjectsInit.ok_or(Error::Module("C_FindObjectsInit function not found"))?,
C_FindObjects: (*list).C_FindObjects.ok_or(Error::Module("C_FindObjects function not found"))?,
C_FindObjectsFinal: (*list).C_FindObjectsFinal.ok_or(Error::Module("C_FindObjectsFinal function not found"))?,
})
}
}
pub fn new_and_initialize(filename: &'static str) -> Result<Ctx, Error> {
let mut ctx = Ctx::new(filename)?;
ctx.initialize(None)?;
Ok(ctx)
}
pub fn is_initialized(&self) -> bool {
self._is_initialized
}
fn initialized(&self) -> Result<(),Error> {
if !self._is_initialized {
Err(Error::Module("module not initialized"))
} else {
Ok(())
}
}
fn not_initialized(&self) -> Result<(),Error> {
if self._is_initialized {
Err(Error::Module("module already initialized"))
} else {
Ok(())
}
}
pub fn initialize(&mut self, init_args: Option<CK_C_INITIALIZE_ARGS>) -> Result<(), Error> {
self.not_initialized()?;
match (self.C_Initialize)(&init_args.unwrap_or(CK_C_INITIALIZE_ARGS::new())) {
CKR_OK => {
self._is_initialized = true;
Ok(())
},
err => Err(Error::Pkcs11(err)),
}
}
pub fn finalize(&mut self) -> Result<(), Error> {
self.initialized()?;
match (self.C_Finalize)(ptr::null()) {
CKR_OK => {
self._is_initialized = false;
Ok(())
},
err => Err(Error::Pkcs11(err)),
}
}
pub fn get_info(&self) -> Result<CK_INFO, Error> {
self.initialized()?;
let info = CK_INFO::new();
match (self.C_GetInfo)(&info) {
CKR_OK => {
Ok(info)
},
err => Err(Error::Pkcs11(err)),
}
}
pub fn get_function_list(&self) -> Result<CK_FUNCTION_LIST, Error> {
let list: CK_FUNCTION_LIST_PTR = unsafe { std::mem::uninitialized() };
match (self.C_GetFunctionList)(&list) {
CKR_OK => {
unsafe { Ok((*list).clone()) }
},
err => Err(Error::Pkcs11(err)),
}
}
pub fn get_slot_list(&self, token_present: bool) -> Result<Vec<CK_SLOT_ID>, Error> {
self.initialized()?;
let mut slots_len: CK_ULONG = 0;
match (self.C_GetSlotList)(CkFrom::from(token_present), ptr::null(), &mut slots_len) {
CKR_OK => {
let mut slots = Vec::<CK_SLOT_ID>::with_capacity(slots_len);
let slots_ptr = slots.as_mut_ptr();
match (self.C_GetSlotList)(CkFrom::from(token_present), slots_ptr, &slots_len) {
CKR_OK => {
unsafe {
slots.set_len(slots_len);
}
Ok(slots)
},
err => Err(Error::Pkcs11(err)),
}
},
err => Err(Error::Pkcs11(err)),
}
}
pub fn get_slot_info(&self, slot_id: CK_SLOT_ID) -> Result<CK_SLOT_INFO, Error> {
self.initialized()?;
let info = CK_SLOT_INFO::new();
match (self.C_GetSlotInfo)(slot_id, &info) {
CKR_OK => {
Ok(info)
},
err => Err(Error::Pkcs11(err)),
}
}
pub fn get_token_info(&self, slot_id: CK_SLOT_ID) -> Result<CK_TOKEN_INFO, Error> {
self.initialized()?;
let info = CK_TOKEN_INFO::new();
match (self.C_GetTokenInfo)(slot_id, &info) {
CKR_OK => {
Ok(info)
},
err => Err(Error::Pkcs11(err)),
}
}
pub fn get_mechanism_list(&self, slot_id: CK_SLOT_ID) -> Result<Vec<CK_MECHANISM_TYPE>, Error> {
self.initialized()?;
let mut count: CK_ULONG = 0;
match (self.C_GetMechanismList)(slot_id, ptr::null(), &mut count) {
CKR_OK => {
let mut list = Vec::<CK_MECHANISM_TYPE>::with_capacity(count);
let list_ptr = list.as_mut_ptr();
match (self.C_GetMechanismList)(slot_id, list_ptr, &count) {
CKR_OK => {
unsafe {
list.set_len(count);
}
Ok(list)
},
err => Err(Error::Pkcs11(err))
}
},
err => Err(Error::Pkcs11(err)),
}
}
pub fn get_mechanism_info(&self, slot_id: CK_SLOT_ID, mechanism_type: CK_MECHANISM_TYPE) -> Result<CK_MECHANISM_INFO, Error> {
self.initialized()?;
let info: CK_MECHANISM_INFO = Default::default();
match (self.C_GetMechanismInfo)(slot_id, mechanism_type, &info) {
CKR_OK => {
Ok(info)
},
err => Err(Error::Pkcs11(err)),
}
}
pub fn init_token<'a, 'b>(&self, slot_id: CK_SLOT_ID, pin: Option<&'a str>, label: &'b str) -> Result<(), Error> {
self.initialized()?;
let formatted_label = label_from_str(label).to_vec().as_ptr();
match pin {
Some(pin) => {
if let Ok(cpin) = CString::new(pin) {
let cpin_bytes = cpin.into_bytes();
match (self.C_InitToken)(slot_id, cpin_bytes.as_ptr(), cpin_bytes.len(), formatted_label) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
} else {
Err(Error::InvalidInput("PIN contains a nul byte"))
}
},
None => {
match (self.C_InitToken)(slot_id, ptr::null(), 0, formatted_label) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
}
}
}
pub fn init_pin<'a>(&self, session: CK_SESSION_HANDLE, pin: Option<&'a str>) -> Result<(), Error> {
self.initialized()?;
match pin {
Some(pin) => {
if let Ok(cpin) = CString::new(pin) {
let cpin_bytes = cpin.into_bytes();
match (self.C_InitPIN)(session, cpin_bytes.as_ptr(), cpin_bytes.len()) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
} else {
Err(Error::InvalidInput("PIN contains a nul byte"))
}
},
None => {
match (self.C_InitPIN)(session, ptr::null(), 0) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
}
}
}
pub fn set_pin<'a, 'b>(&self, session: CK_SESSION_HANDLE, old_pin: Option<&'a str>, new_pin: Option<&'b str>) -> Result<(), Error> {
self.initialized()?;
if old_pin.is_none() && new_pin.is_none() {
match (self.C_SetPIN)(session, ptr::null(), 0, ptr::null(), 0) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
} else if old_pin.is_some() && new_pin.is_some() {
let old_cpin_res = CString::new(old_pin.unwrap());
let new_cpin_res = CString::new(new_pin.unwrap());
if old_cpin_res.is_err() {
return Err(Error::InvalidInput("Old PIN contains a nul byte"));
}
if new_cpin_res.is_err() {
return Err(Error::InvalidInput("New PIN contains a nul byte"));
}
let old_cpin = old_cpin_res.unwrap().into_bytes();
let new_cpin = new_cpin_res.unwrap().into_bytes();
match (self.C_SetPIN)(session, old_cpin.as_ptr(), old_cpin.len(), new_cpin.as_ptr(), new_cpin.len()) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
} else {
Err(Error::InvalidInput("both PINs must be either set or unset"))
}
}
pub fn open_session(&self, slot_id: CK_SLOT_ID, flags: CK_FLAGS, application: Option<CK_VOID_PTR>, notify: CK_NOTIFY) -> Result<CK_SESSION_HANDLE, Error> {
self.initialized()?;
let mut session: CK_SESSION_HANDLE = 0;
match (self.C_OpenSession)(slot_id, flags, application.unwrap_or(ptr::null()), notify, &mut session) {
CKR_OK => Ok(session),
err => Err(Error::Pkcs11(err)),
}
}
pub fn close_session(&self, session: CK_SESSION_HANDLE) -> Result<(), Error> {
self.initialized()?;
match (self.C_CloseSession)(session) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
}
pub fn close_all_sessions(&self, slot_id: CK_SLOT_ID) -> Result<(), Error> {
self.initialized()?;
match (self.C_CloseAllSessions)(slot_id) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
}
pub fn get_session_info(&self, session: CK_SESSION_HANDLE) -> Result<CK_SESSION_INFO, Error> {
self.initialized()?;
let info: CK_SESSION_INFO = Default::default();
match (self.C_GetSessionInfo)(session, &info) {
CKR_OK => Ok(info),
err => Err(Error::Pkcs11(err)),
}
}
pub fn get_operation_state(&self, session: CK_SESSION_HANDLE) -> Result<Vec<CK_BYTE>, Error> {
self.initialized()?;
let mut state_length: CK_ULONG = 0;
match (self.C_GetOperationState)(session, ptr::null(), &mut state_length) {
CKR_OK => {
let mut state: Vec<CK_BYTE> = Vec::with_capacity(state_length);
let state_ptr = state.as_mut_ptr();
match (self.C_GetOperationState)(session, state_ptr, &state_length) {
CKR_OK => {
unsafe {
state.set_len(state_length);
}
Ok(state)
},
err => Err(Error::Pkcs11(err)),
}
},
err => Err(Error::Pkcs11(err)),
}
}
pub fn set_operation_state(&self, session: CK_SESSION_HANDLE, operation_state: Vec<CK_BYTE>, encryption_key: Option<CK_OBJECT_HANDLE>, authentication_key: Option<CK_OBJECT_HANDLE>) -> Result<(), Error> {
self.initialized()?;
match (self.C_SetOperationState)(session, operation_state.as_ptr(), operation_state.len(), encryption_key.unwrap_or(0), authentication_key.unwrap_or(0)) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
}
pub fn login<'a>(&self, session: CK_SESSION_HANDLE, user_type: CK_USER_TYPE, pin: Option<&'a str>) -> Result<(), Error> {
self.initialized()?;
match pin {
Some(pin) => {
if let Ok(cpin) = CString::new(pin) {
let cpin_bytes = cpin.into_bytes();
match (self.C_Login)(session, user_type, cpin_bytes.as_ptr(), cpin_bytes.len()) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
} else {
Err(Error::InvalidInput("PIN contains a nul byte"))
}
},
None => {
match (self.C_Login)(session, user_type, ptr::null(), 0) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
}
}
}
pub fn logout(&self, session: CK_SESSION_HANDLE) -> Result<(), Error> {
self.initialized()?;
match (self.C_Logout)(session) {
CKR_OK => Ok(()),
err => Err(Error::Pkcs11(err)),
}
}
}
impl Drop for Ctx {
fn drop(&mut self) {
if self.is_initialized() {
if let Err(err) = self.finalize() {
println!("ERROR: {}", err);
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
const PKCS11_MODULE_FILENAME: &'static str = "/usr/local/lib/softhsm/libsofthsm2.so";
#[test]
fn test_label_from_str() {
let s30 = "Löwe 老虎 Léopar虎d虎aaa";
let s32 = "Löwe 老虎 Léopar虎d虎aaaö";
let s33 = "Löwe 老虎 Léopar虎d虎aaa虎";
let s34 = "Löwe 老虎 Léopar虎d虎aaab虎";
let l30 = label_from_str(s30);
let l32 = label_from_str(s32);
let l33 = label_from_str(s33);
let l34 = label_from_str(s34);
println!("Label l30: {:?}", l30);
println!("Label l32: {:?}", l32);
println!("Label l33: {:?}", l33);
println!("Label l34: {:?}", l34);
assert_ne!(l30[29], 32);
assert_eq!(l30[30], 32);
assert_eq!(l30[31], 32);
assert_ne!(l32[31], 32);
assert_ne!(l33[29], 32);
assert_eq!(l33[30], 32);
assert_eq!(l33[31], 32);
assert_ne!(l34[30], 32);
assert_eq!(l34[31], 32);
}
#[test]
fn ctx_new() {
let res = Ctx::new(PKCS11_MODULE_FILENAME);
assert!(res.is_ok(), "failed to create new context: {}", res.unwrap_err());
}
#[test]
fn ctx_initialize() {
let mut ctx = Ctx::new(PKCS11_MODULE_FILENAME).unwrap();
let res = ctx.initialize(None);
assert!(res.is_ok(), "failed to initialize context: {}", res.unwrap_err());
assert!(ctx.is_initialized(), "internal state is not initialized");
}
#[test]
fn ctx_new_and_initialize() {
let res = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME);
assert!(res.is_ok(), "failed to create or initialize new context: {}", res.unwrap_err());
}
#[test]
fn ctx_finalize() {
let mut ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let res = ctx.finalize();
assert!(res.is_ok(), "failed to finalize context: {}", res.unwrap_err());
}
#[test]
fn ctx_get_info() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let res = ctx.get_info();
assert!(res.is_ok(), "failed to call C_GetInfo: {}", res.unwrap_err());
let info = res.unwrap();
println!("{:?}", info);
}
#[test]
fn ctx_get_function_list() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let res = ctx.get_function_list();
assert!(res.is_ok(), "failed to call C_GetFunctionList: {}", res.unwrap_err());
let list = res.unwrap();
println!("{:?}", list);
}
#[test]
fn ctx_get_slot_list() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let res = ctx.get_slot_list(false);
assert!(res.is_ok(), "failed to call C_GetSlotList: {}", res.unwrap_err());
let slots = res.unwrap();
println!("Slots: {:?}", slots);
}
#[test]
fn ctx_get_slot_infos() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
for slot in slots {
let res = ctx.get_slot_info(slot);
assert!(res.is_ok(), "failed to call C_GetSlotInfo({}): {}", slot, res.unwrap_err());
let info = res.unwrap();
println!("Slot {} {:?}", slot, info);
}
}
#[test]
fn ctx_get_token_infos() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
for slot in slots {
let res = ctx.get_token_info(slot);
assert!(res.is_ok(), "failed to call C_GetTokenInfo({}): {}", slot, res.unwrap_err());
let info = res.unwrap();
println!("Slot {} {:?}", slot, info);
}
}
#[test]
fn ctx_get_mechanism_lists() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
for slot in slots {
let res = ctx.get_mechanism_list(slot);
assert!(res.is_ok(), "failed to call C_GetMechanismList({}): {}", slot, res.unwrap_err());
let mechs = res.unwrap();
println!("Slot {} Mechanisms: {:?}", slot, mechs);
}
}
#[test]
fn ctx_get_mechanism_infos() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
for slot in slots {
let mechanisms = ctx.get_mechanism_list(slot).unwrap();
for mechanism in mechanisms {
let res = ctx.get_mechanism_info(slot, mechanism);
assert!(res.is_ok(), "failed to call C_GetMechanismInfo({}, {}): {}", slot, mechanism, res.unwrap_err());
let info = res.unwrap();
println!("Slot {} Mechanism {}: {:?}", slot, mechanism, info);
}
}
}
#[test]
fn ctx_init_token() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
let pin = Some("1234");
const LABEL: &str = "rust-unit-test";
for slot in slots {
let res = ctx.init_token(slot, pin, LABEL);
assert!(res.is_ok(), "failed to call C_InitToken({}, {}, {}): {}", slot, pin.unwrap(), LABEL, res.unwrap_err());
println!("Slot {} C_InitToken successful, PIN: {}", slot, pin.unwrap());
}
}
#[test]
fn ctx_init_pin() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
let pin = Some("1234");
const LABEL: &str = "rust-unit-test";
for slot in slots {
ctx.init_token(slot, pin, LABEL).unwrap();
let sh = ctx.open_session(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, None, None).unwrap();
ctx.login(sh, CKU_SO, pin).unwrap();
let res = ctx.init_pin(sh, pin);
assert!(res.is_ok(), "failed to call C_InitPIN({}, {}): {}", sh, pin.unwrap(), res.unwrap_err());
println!("InitPIN successful");
}
}
#[test]
fn ctx_set_pin() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
let pin = Some("1234");
let new_pin = Some("1234");
const LABEL: &str = "rust-unit-test";
for slot in slots {
ctx.init_token(slot, pin, LABEL).unwrap();
let sh = ctx.open_session(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, None, None).unwrap();
ctx.login(sh, CKU_SO, pin).unwrap();
let res = ctx.set_pin(sh, pin, new_pin);
assert!(res.is_ok(), "failed to call C_SetPIN({}, {}, {}): {}", sh, pin.unwrap(), new_pin.unwrap(), res.unwrap_err());
println!("SetPIN successful");
}
}
#[test]
fn ctx_open_session() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
let pin = Some("1234");
const LABEL: &str = "rust-unit-test";
for slot in slots {
ctx.init_token(slot, pin, LABEL).unwrap();
let res = ctx.open_session(slot, CKF_SERIAL_SESSION, None, None);
assert!(res.is_ok(), "failed to call C_OpenSession({}, CKF_SERIAL_SESSION, None, None): {}", slot, res.unwrap_err());
let sh = res.unwrap();
println!("Opened Session on Slot {}: CK_SESSION_HANDLE {}", slot, sh);
}
}
#[test]
fn ctx_close_session() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
let pin = Some("1234");
const LABEL: &str = "rust-unit-test";
for slot in slots {
ctx.init_token(slot, pin, LABEL).unwrap();
let sh = ctx.open_session(slot, CKF_SERIAL_SESSION, None, None).unwrap();
let res = ctx.close_session(sh);
assert!(res.is_ok(), "failed to call C_CloseSession({}): {}", sh, res.unwrap_err());
println!("Closed Session with CK_SESSION_HANDLE {}", sh);
}
}
#[test]
fn ctx_close_all_sessions() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
let pin = Some("1234");
const LABEL: &str = "rust-unit-test";
for slot in slots {
ctx.init_token(slot, pin, LABEL).unwrap();
ctx.open_session(slot, CKF_SERIAL_SESSION, None, None).unwrap();
let res = ctx.close_all_sessions(slot);
assert!(res.is_ok(), "failed to call C_CloseAllSessions({}): {}", slot, res.unwrap_err());
println!("Closed All Sessions on Slot {}", slot);
}
}
#[test]
fn ctx_get_session_info() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
let pin = Some("1234");
const LABEL: &str = "rust-unit-test";
for slot in slots {
ctx.init_token(slot, pin, LABEL).unwrap();
let sh = ctx.open_session(slot, CKF_SERIAL_SESSION, None, None).unwrap();
let res = ctx.get_session_info(sh);
assert!(res.is_ok(), "failed to call C_GetSessionInfo({}): {}", sh, res.unwrap_err());
let info = res.unwrap();
println!("{:?}", info);
}
}
#[test]
fn ctx_login() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
let pin = Some("1234");
const LABEL: &str = "rust-unit-test";
for slot in slots {
ctx.init_token(slot, pin, LABEL).unwrap();
let sh = ctx.open_session(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, None, None).unwrap();
let res = ctx.login(sh, CKU_SO, pin);
assert!(res.is_ok(), "failed to call C_Login({}, CKU_SO, {}): {}", sh, pin.unwrap(), res.unwrap_err());
println!("Login successful");
}
}
#[test]
fn ctx_logout() {
let ctx = Ctx::new_and_initialize(PKCS11_MODULE_FILENAME).unwrap();
let slots = ctx.get_slot_list(false).unwrap();
let pin = Some("1234");
const LABEL: &str = "rust-unit-test";
for slot in slots {
ctx.init_token(slot, pin, LABEL).unwrap();
let sh = ctx.open_session(slot, CKF_SERIAL_SESSION | CKF_RW_SESSION, None, None).unwrap();
ctx.login(sh, CKU_SO, pin).unwrap();
let res = ctx.logout(sh);
assert!(res.is_ok(), "failed to call C_Logout({}): {}", sh, res.unwrap_err());
println!("Logout successful");
}
}
}