aboutsummaryrefslogtreecommitdiffstats
path: root/SoftHSMv2/src/lib/P11Attributes.h
blob: 8c9b98beb9dcc9c7bdbdca74a846e5fa26f2520a (plain)
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
/*
 * Copyright (c) 2011 .SE (The Internet Infrastructure Foundation)
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*****************************************************************************
 P11Attributes.h

 This file contains classes for controlling attributes
 *****************************************************************************/

#ifndef _SOFTHSM_V2_P11ATTRIBUTES_H
#define _SOFTHSM_V2_P11ATTRIBUTES_H

#include "cryptoki.h"
#include "OSObject.h"
#include "Token.h"
#include "OSAttributes.h"

// The operation types
#define OBJECT_OP_NONE		0x0
#define OBJECT_OP_COPY		0x1
#define OBJECT_OP_CREATE	0x2
#define OBJECT_OP_DERIVE	0x3
#define OBJECT_OP_GENERATE	0x4
#define OBJECT_OP_SET		0x5
#define OBJECT_OP_UNWRAP	0x6

class P11Attribute
{
public:
	// Destructor
	virtual ~P11Attribute();

	// Initialize the attribute
	bool init();

	// Return the attribute type
	CK_ATTRIBUTE_TYPE getType();

	// Return the attribute checks
	CK_ULONG getChecks();

	// Retrieve the value if allowed
	CK_RV retrieve(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG_PTR pulValueLen);

	// Update the value if allowed
	CK_RV update(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);

	// Checks are determined by footnotes from table 10 under section 4.2 in the PKCS#11 v2.40 spec.
	// Table 10 contains common footnotes for object attribute tables that determine the checks to perform on attributes.
	// There are also checks not in table 10 that have been added here to allow enforcing additional contraints.
	enum {
		ck1=1,          //  1  MUST be specified when object is created with C_CreateObject.
		ck2=2,          //  2  MUST not be specified when object is created with C_CreateObject.
		ck3=4,          //  3  MUST be specified when object is generated with C_GenerateKey or C_GenerateKeyPair.
		ck4=8,          //  4  MUST not be specified when object is generated with C_GenerateKey or C_GenerateKeyPair.
		ck5=0x10,       //  5  MUST be specified when object is unwrapped with C_UnwrapKey.
		ck6=0x20,       //  6  MUST not be specified when object is unwrapped with C_UnwrapKey.
		ck7=0x40,       //  7  Cannot be revealed if object has its CKA_SENSITIVE attribute set to CK_TRUE or
		                //      its CKA_EXTRACTABLE attribute set to CK_FALSE.
		ck8=0x80,       //  8  May be modified after object is created with a C_SetAttributeValue call,
		                //      or in the process of copying object with a C_CopyObject call.
		                //      However, it is possible that a particular token may not permit modification of
		                //      the attribute during the course of a C_CopyObject call.
		ck9=0x100,      //  9  Default value is token-specific, and may depend on the values of other attributes.
		ck10=0x200,     // 10  Can only be set to CK_TRUE by the SO user.
		ck11=0x400,     // 11  Attribute cannot be changed once set to CK_TRUE. It becomes a read only attribute.
		ck12=0x800,     // 12  Attribute cannot be changed once set to CK_FALSE. It becomes a read only attribute.
		ck13=0x1000,    // Intentionally not defined
		ck14=0x2000,    // 14  MUST be non-empty if CKA_URL is empty. (CKA_VALUE)
		ck15=0x4000,    // 15  MUST be non-empty if CKA_VALUE is empty. (CKA_URL)
		ck16=0x8000,    // 16  Can only be empty if CKA_URL is empty.
		ck17=0x10000,   // 17  Can be changed in the process of copying the object using C_CopyObject.
		ck18=0x20000,
		ck19=0x40000,
		ck20=0x80000,
		ck21=0x100000,
		ck22=0x200000,
		ck23=0x400000,
		ck24=0x800000
	};
protected:
	// Constructor
	P11Attribute(OSObject* inobject);

	// The object
	OSObject* osobject;

	// The attribute type
	CK_ATTRIBUTE_TYPE type;

	// The checks to perform when the attribute is accessed.
	CK_ULONG checks;

	// The attribute fixed size contains (CK_ULONG)-1 when size is variable.
	CK_ULONG size;

	// Set the default value of the attribute
	virtual bool setDefault() = 0;

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);

	// Helper functions
	bool isModifiable();
	bool isSensitive();
	bool isExtractable();
	bool isTrusted();
};

/*****************************************
 * CKA_CLASS
 *****************************************/

class P11AttrClass : public P11Attribute
{
public:
	// Constructor
	P11AttrClass(OSObject* inobject) : P11Attribute(inobject) { type = CKA_CLASS; size = sizeof(CK_OBJECT_CLASS); checks = ck1; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_KEY_TYPE
 *****************************************/

class P11AttrKeyType : public P11Attribute
{
public:
	// Constructor
	P11AttrKeyType(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_KEY_TYPE; size = sizeof(CK_KEY_TYPE); checks = ck1|inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_CERTIFICATE_TYPE
 *****************************************/

class P11AttrCertificateType : public P11Attribute
{
public:
	// Constructor
	P11AttrCertificateType(OSObject* inobject) : P11Attribute(inobject) { type = CKA_CERTIFICATE_TYPE; size = sizeof(CK_CERTIFICATE_TYPE); checks = ck1; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_TOKEN
 *****************************************/

class P11AttrToken : public P11Attribute
{
public:
	// Constructor
	P11AttrToken(OSObject* inobject) : P11Attribute(inobject) { type = CKA_TOKEN; size = sizeof(CK_BBOOL); checks = ck17; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_PRIVATE
 *****************************************/

class P11AttrPrivate : public P11Attribute
{
public:
	// Constructor
	P11AttrPrivate(OSObject* inobject) : P11Attribute(inobject) { type = CKA_PRIVATE; size = sizeof(CK_BBOOL); checks = ck17; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_MODIFIABLE
 *****************************************/

class P11AttrModifiable : public P11Attribute
{
public:
	// Constructor
	P11AttrModifiable(OSObject* inobject) : P11Attribute(inobject) { type = CKA_MODIFIABLE; size = sizeof(CK_BBOOL); checks = ck17; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_LABEL
 *****************************************/

class P11AttrLabel : public P11Attribute
{
public:
	// Constructor
	P11AttrLabel(OSObject* inobject) : P11Attribute(inobject) { type = CKA_LABEL;  checks = ck8; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_COPYABLE
 *****************************************/

class P11AttrCopyable : public P11Attribute
{
public:
	// Constructor
	P11AttrCopyable(OSObject* inobject) : P11Attribute(inobject) { type = CKA_COPYABLE; size = sizeof(CK_BBOOL); checks = ck12; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_DESTROYABLE
 *****************************************/

class P11AttrDestroyable : public P11Attribute
{
public:
	// Constructor
	P11AttrDestroyable(OSObject* inobject) : P11Attribute(inobject) { type = CKA_DESTROYABLE; size = sizeof(CK_BBOOL); checks = ck17; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_APPLICATION
 *****************************************/

class P11AttrApplication : public P11Attribute
{
public:
	// Constructor
	P11AttrApplication(OSObject* inobject) : P11Attribute(inobject) { type = CKA_APPLICATION; checks = 0; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_OBJECT_ID
 *****************************************/

class P11AttrObjectID : public P11Attribute
{
public:
	// Constructor
	P11AttrObjectID(OSObject* inobject) : P11Attribute(inobject) { type = CKA_OBJECT_ID; checks = 0; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_CHECK_VALUE
 *****************************************/

class P11AttrCheckValue : public P11Attribute
{
public:
	// Constructor
	P11AttrCheckValue(OSObject* inobject, CK_ULONG inchecks) : P11Attribute(inobject) { type = CKA_CHECK_VALUE; checks = inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();


	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_PUBLIC_KEY_INFO
 *****************************************/

class P11AttrPublicKeyInfo : public P11Attribute
{
public:
	// Constructor
	P11AttrPublicKeyInfo(OSObject* inobject, CK_ULONG inchecks) : P11Attribute(inobject) { type = CKA_OBJECT_ID; checks = inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_ID
 *****************************************/

class P11AttrID : public P11Attribute
{
public:
	// Constructor
	P11AttrID(OSObject* inobject) : P11Attribute(inobject) { type = CKA_ID; checks = ck8; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_VALUE
 *****************************************/

class P11AttrValue : public P11Attribute
{
public:
	// Constructor
	P11AttrValue(OSObject* inobject, CK_ULONG inchecks) : P11Attribute(inobject) { type = CKA_VALUE; checks = inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_SUBJECT
 *****************************************/

class P11AttrSubject : public P11Attribute
{
public:
	// Constructor
	P11AttrSubject(OSObject* inobject, CK_ULONG inchecks) : P11Attribute(inobject) { type = CKA_SUBJECT; checks = inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_ISSUER
 *****************************************/

class P11AttrIssuer : public P11Attribute
{
public:
	// Constructor
	P11AttrIssuer(OSObject* inobject) : P11Attribute(inobject) { type = CKA_ISSUER; checks = ck8; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_TRUSTED
 *****************************************/

class P11AttrTrusted : public P11Attribute
{
public:
	// Constructor
	P11AttrTrusted(OSObject* inobject) : P11Attribute(inobject) { type = CKA_TRUSTED; size = sizeof(CK_BBOOL); checks = ck10; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_CERTIFICATE_CATEGORY
 *****************************************/

class P11AttrCertificateCategory : public P11Attribute
{
public:
	// Constructor
	P11AttrCertificateCategory(OSObject* inobject) : P11Attribute(inobject) { type = CKA_CERTIFICATE_CATEGORY; size = sizeof(CK_ULONG); checks = 0; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_START_DATE
 *****************************************/

class P11AttrStartDate : public P11Attribute
{
public:
	// Constructor
	P11AttrStartDate(OSObject* inobject, CK_ULONG inchecks) : P11Attribute(inobject) { type = CKA_START_DATE; checks = inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_END_DATE
 *****************************************/

class P11AttrEndDate : public P11Attribute
{
public:
	// Constructor
	P11AttrEndDate(OSObject* inobject, CK_ULONG inchecks) : P11Attribute(inobject) { type = CKA_END_DATE; checks = inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_SERIAL_NUMBER
 *****************************************/

class P11AttrSerialNumber : public P11Attribute
{
public:
	// Constructor
	P11AttrSerialNumber(OSObject* inobject) : P11Attribute(inobject) { type = CKA_SERIAL_NUMBER; checks = ck8; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_URL
 *****************************************/

class P11AttrURL : public P11Attribute
{
public:
	// Constructor
	P11AttrURL(OSObject* inobject) : P11Attribute(inobject) { type = CKA_URL; checks = ck15; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_HASH_OF_SUBJECT_PUBLIC_KEY
 *****************************************/

class P11AttrHashOfSubjectPublicKey : public P11Attribute
{
public:
	// Constructor
	P11AttrHashOfSubjectPublicKey(OSObject* inobject) : P11Attribute(inobject) { type = CKA_HASH_OF_SUBJECT_PUBLIC_KEY; checks = ck16; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_HASH_OF_ISSUER_PUBLIC_KEY
 *****************************************/

class P11AttrHashOfIssuerPublicKey : public P11Attribute
{
public:
	// Constructor
	P11AttrHashOfIssuerPublicKey(OSObject* inobject) : P11Attribute(inobject) { type = CKA_HASH_OF_ISSUER_PUBLIC_KEY; checks = ck16; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_JAVA_MIDP_SECURITY_DOMAIN
 *****************************************/

class P11AttrJavaMidpSecurityDomain : public P11Attribute
{
public:
	// Constructor
	P11AttrJavaMidpSecurityDomain(OSObject* inobject) : P11Attribute(inobject) { type = CKA_JAVA_MIDP_SECURITY_DOMAIN; size = sizeof(CK_ULONG); checks = 0; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_NAME_HASH_ALGORITHM
 *****************************************/

class P11AttrNameHashAlgorithm : public P11Attribute
{
public:
	// Constructor
	P11AttrNameHashAlgorithm(OSObject* inobject) : P11Attribute(inobject) { type = CKA_NAME_HASH_ALGORITHM; size = sizeof(CK_MECHANISM_TYPE); checks = 0; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_DERIVE
 *****************************************/

class P11AttrDerive : public P11Attribute
{
public:
	// Constructor
	P11AttrDerive(OSObject* inobject) : P11Attribute(inobject) { type = CKA_DERIVE; size = sizeof(CK_BBOOL); checks = ck8;}

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_ENCRYPT
 *****************************************/

class P11AttrEncrypt : public P11Attribute
{
public:
	// Constructor
	P11AttrEncrypt(OSObject* inobject) : P11Attribute(inobject) { type = CKA_ENCRYPT; size = sizeof(CK_BBOOL); checks = ck8|ck9; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_VERIFY
 *****************************************/

class P11AttrVerify : public P11Attribute
{
public:
	// Constructor
	P11AttrVerify(OSObject* inobject) : P11Attribute(inobject) { type = CKA_VERIFY; size = sizeof(CK_BBOOL); checks = ck8|ck9; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_VERIFY_RECOVER
 *****************************************/

class P11AttrVerifyRecover : public P11Attribute
{
public:
	// Constructor
	P11AttrVerifyRecover(OSObject* inobject) : P11Attribute(inobject) { type = CKA_VERIFY_RECOVER; size = sizeof(CK_BBOOL); checks = ck8|ck9; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_WRAP
 *****************************************/

class P11AttrWrap : public P11Attribute
{
public:
	// Constructor
	P11AttrWrap(OSObject* inobject) : P11Attribute(inobject) { type = CKA_WRAP; size = sizeof(CK_BBOOL); checks = ck8|ck9; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_DECRYPT
 *****************************************/

class P11AttrDecrypt : public P11Attribute
{
public:
	// Constructor
	P11AttrDecrypt(OSObject* inobject) : P11Attribute(inobject) { type = CKA_DECRYPT; size = sizeof(CK_BBOOL); checks = ck8|ck9; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_SIGN
 *****************************************/

class P11AttrSign : public P11Attribute
{
public:
	// Constructor
	P11AttrSign(OSObject* inobject) : P11Attribute(inobject) { type = CKA_SIGN; size = sizeof(CK_BBOOL); checks = ck8|ck9; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_SIGN_RECOVER
 *****************************************/

class P11AttrSignRecover : public P11Attribute
{
public:
	// Constructor
	P11AttrSignRecover(OSObject* inobject) : P11Attribute(inobject) { type = CKA_SIGN_RECOVER; size = sizeof(CK_BBOOL); checks = ck8|ck9; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_UNWRAP
 *****************************************/

class P11AttrUnwrap : public P11Attribute
{
public:
	// Constructor
	P11AttrUnwrap(OSObject* inobject) : P11Attribute(inobject) { type = CKA_UNWRAP; size = sizeof(CK_BBOOL); checks = ck8|ck9; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_LOCAL
 *****************************************/

class P11AttrLocal : public P11Attribute
{
public:
	// Constructor
	P11AttrLocal(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_LOCAL; size = sizeof(CK_BBOOL); checks = ck2|ck4|inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_KEY_GEN_MECHANISM
 *****************************************/

class P11AttrKeyGenMechanism : public P11Attribute
{
public:
	// Constructor
	P11AttrKeyGenMechanism(OSObject* inobject) : P11Attribute(inobject) { type = CKA_KEY_GEN_MECHANISM; size = sizeof(CK_MECHANISM_TYPE); checks = ck2|ck4|ck6; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_ALWAYS_SENSITIVE
 *****************************************/

class P11AttrAlwaysSensitive : public P11Attribute
{
public:
	// Constructor
	P11AttrAlwaysSensitive(OSObject* inobject) : P11Attribute(inobject) { type = CKA_ALWAYS_SENSITIVE; size = sizeof(CK_BBOOL); checks = ck2|ck4|ck6; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_NEVER_EXTRACTABLE
 *****************************************/

class P11AttrNeverExtractable : public P11Attribute
{
public:
	// Constructor
	P11AttrNeverExtractable(OSObject* inobject) : P11Attribute(inobject) { type = CKA_NEVER_EXTRACTABLE; size = sizeof(CK_BBOOL); checks = ck2|ck4|ck6; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_SENSITIVE
 *****************************************/

class P11AttrSensitive : public P11Attribute
{
public:
	// Constructor
	P11AttrSensitive(OSObject* inobject) : P11Attribute(inobject) { type = CKA_SENSITIVE; size = sizeof(CK_BBOOL); checks = ck8|ck9|ck11; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_EXTRACTABLE
 *****************************************/

class P11AttrExtractable : public P11Attribute
{
public:
	// Constructor
	P11AttrExtractable(OSObject* inobject) : P11Attribute(inobject) { type = CKA_EXTRACTABLE; size = sizeof(CK_BBOOL); checks = ck8|ck9|ck12; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_WRAP_WITH_TRUSTED
 *****************************************/

class P11AttrWrapWithTrusted : public P11Attribute
{
public:
	// Constructor
	P11AttrWrapWithTrusted(OSObject* inobject) : P11Attribute(inobject) { type = CKA_WRAP_WITH_TRUSTED; size = sizeof(CK_BBOOL); checks = ck11; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_ALWAYS_AUTHENTICATE
 *****************************************/

class P11AttrAlwaysAuthenticate : public P11Attribute
{
public:
	// Constructor
	P11AttrAlwaysAuthenticate(OSObject* inobject) : P11Attribute(inobject) { type = CKA_ALWAYS_AUTHENTICATE; size = sizeof(CK_BBOOL); checks = 0; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_MODULUS
 *****************************************/

class P11AttrModulus : public P11Attribute
{
public:
	// Constructor
	P11AttrModulus(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_MODULUS; checks = ck1|ck4|inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_PUBLIC_EXPONENT
 *****************************************/

class P11AttrPublicExponent : public P11Attribute
{
public:
	// Constructor
	P11AttrPublicExponent(OSObject* inobject, CK_ULONG inchecks) : P11Attribute(inobject) { type = CKA_PUBLIC_EXPONENT; checks = inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_PRIVATE_EXPONENT
 *****************************************/

class P11AttrPrivateExponent : public P11Attribute
{
public:
	// Constructor
	P11AttrPrivateExponent(OSObject* inobject) : P11Attribute(inobject) { type = CKA_PRIVATE_EXPONENT; checks = ck1|ck4|ck6|ck7; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_PRIME_1
 *****************************************/

class P11AttrPrime1 : public P11Attribute
{
public:
	// Constructor
	P11AttrPrime1(OSObject* inobject) : P11Attribute(inobject) { type = CKA_PRIME_1; checks = ck4|ck6|ck7; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_PRIME_2
 *****************************************/

class P11AttrPrime2 : public P11Attribute
{
public:
	// Constructor
	P11AttrPrime2(OSObject* inobject) : P11Attribute(inobject) { type = CKA_PRIME_2; checks = ck4|ck6|ck7; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_EXPONENT_1
 *****************************************/

class P11AttrExponent1 : public P11Attribute
{
public:
	// Constructor
	P11AttrExponent1(OSObject* inobject) : P11Attribute(inobject) { type = CKA_EXPONENT_1; checks = ck4|ck6|ck7; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_EXPONENT_2
 *****************************************/

class P11AttrExponent2 : public P11Attribute
{
public:
	// Constructor
	P11AttrExponent2(OSObject* inobject) : P11Attribute(inobject) { type = CKA_EXPONENT_2; checks = ck4|ck6|ck7; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_COEFFICIENT
 *****************************************/

class P11AttrCoefficient : public P11Attribute
{
public:
	// Constructor
	P11AttrCoefficient(OSObject* inobject) : P11Attribute(inobject) { type = CKA_COEFFICIENT; checks = ck4|ck6|ck7; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_MODULUS_BITS
 *****************************************/

class P11AttrModulusBits : public P11Attribute
{
public:
	// Constructor
	P11AttrModulusBits(OSObject* inobject) : P11Attribute(inobject) { type = CKA_MODULUS_BITS; size = sizeof(CK_ULONG); checks = ck2|ck3;}

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_PRIME
 *****************************************/

class P11AttrPrime : public P11Attribute
{
public:
	// Constructor
	P11AttrPrime(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_PRIME; checks = ck1|inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_SUBPRIME
 *****************************************/

class P11AttrSubPrime : public P11Attribute
{
public:
	// Constructor
	P11AttrSubPrime(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_SUBPRIME; checks = ck1|inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_BASE
 *****************************************/

class P11AttrBase : public P11Attribute
{
public:
	// Constructor
	P11AttrBase(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_BASE; checks = ck1|inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_PRIME_BITS
 *****************************************/

class P11AttrPrimeBits : public P11Attribute
{
public:
	// Constructor
	P11AttrPrimeBits(OSObject* inobject) : P11Attribute(inobject) { type = CKA_PRIME_BITS; size = sizeof(CK_ULONG); checks = ck2|ck3;}

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_VALUE_BITS
 *****************************************/

class P11AttrValueBits : public P11Attribute
{
public:
	// Constructor
	P11AttrValueBits(OSObject* inobject) : P11Attribute(inobject) { type = CKA_VALUE_BITS; size = sizeof(CK_ULONG); checks = ck2|ck6;}

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_EC_PARAMS
 *****************************************/

class P11AttrEcParams : public P11Attribute
{
public:
	// Constructor
	P11AttrEcParams(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_EC_PARAMS; checks = ck1|inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_EC_POINT
 *****************************************/

class P11AttrEcPoint : public P11Attribute
{
public:
	// Constructor
	P11AttrEcPoint(OSObject* inobject) : P11Attribute(inobject) { type = CKA_EC_POINT; checks = ck1|ck4; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_GOSTR3410_PARAMS
 *****************************************/

class P11AttrGostR3410Params : public P11Attribute
{
public:
	// Constructor
	P11AttrGostR3410Params(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_GOSTR3410_PARAMS; checks = ck1|inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_GOSTR3411_PARAMS
 *****************************************/

class P11AttrGostR3411Params : public P11Attribute
{
public:
	// Constructor
	P11AttrGostR3411Params(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_GOSTR3411_PARAMS; checks = ck1|ck8|inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_GOST28147_PARAMS
 *****************************************/

class P11AttrGost28147Params : public P11Attribute
{
public:
	// Constructor
	P11AttrGost28147Params(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_GOST28147_PARAMS; checks = inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();
};

/*****************************************
 * CKA_VALUE_LEN
 *****************************************/

class P11AttrValueLen : public P11Attribute
{
public:
	// Constructor
	P11AttrValueLen(OSObject* inobject, CK_ULONG inchecks = 0) : P11Attribute(inobject) { type = CKA_VALUE_LEN; size = sizeof(CK_ULONG); checks = ck2|ck3|inchecks; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_WRAP_TEMPLATE
 *****************************************/

class P11AttrWrapTemplate : public P11Attribute
{
public:
	// Constructor
	P11AttrWrapTemplate(OSObject* inobject) : P11Attribute(inobject) { type = CKA_WRAP_TEMPLATE; checks = 0; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_UNWRAP_TEMPLATE
 *****************************************/

class P11AttrUnwrapTemplate : public P11Attribute
{
public:
	// Constructor
	P11AttrUnwrapTemplate(OSObject* inobject) : P11Attribute(inobject) { type = CKA_UNWRAP_TEMPLATE; checks = 0; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_ALLOWED_MECHANISMS
 *****************************************/

class P11AttrAllowedMechanisms : public P11Attribute
{
public:
	// Constructor
	P11AttrAllowedMechanisms(OSObject* inobject) : P11Attribute(inobject) { type = CKA_ALLOWED_MECHANISMS; checks = 0; }

protected:
	// Set the default value of the attribute
	virtual bool setDefault();

	// Update the value if allowed
	virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};

/*****************************************
 * CKA_COEFFICIENT
 *****************************************/

class P11AttrPrivateHandle : public P11Attribute
{
public:
        // Constructor
        P11AttrPrivateHandle(OSObject* inobject) : P11Attribute(inobject) { type = CKA_OS_PRIVATE_HANDLE; checks = 0; }

protected:
        // Set the default value of the attribute
        virtual bool setDefault();
        // Update the value if allowed
        virtual CK_RV updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op);
};


#endif // !_SOFTHSM_V2_P11ATTRIBUTES_H