-
Notifications
You must be signed in to change notification settings - Fork 400
Expand file tree
/
Copy pathP11Attributes.cpp
More file actions
2536 lines (2102 loc) · 59.4 KB
/
P11Attributes.cpp
File metadata and controls
2536 lines (2102 loc) · 59.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* 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
*****************************************************************************/
#include "config.h"
#include "P11Attributes.h"
#include "ByteString.h"
#include "CryptoFactory.h"
#include "DESKey.h"
#include "AESKey.h"
#include <stdio.h>
#include <stdlib.h>
// Constructor
P11Attribute::P11Attribute(OSObject* inobject)
{
osobject = inobject;
type = CKA_VENDOR_DEFINED;
size = (CK_ULONG)-1;
checks = 0;
}
// Destructor
P11Attribute::~P11Attribute()
{
}
CK_RV P11Attribute::updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
{
ByteString value;
if (isPrivate)
{
if (!token->encrypt(ByteString((unsigned char*)pValue, ulValueLen),value))
return CKR_GENERAL_ERROR;
}
else
value = ByteString((unsigned char*)pValue, ulValueLen);
if (value.size() < ulValueLen)
return CKR_GENERAL_ERROR;
osobject->setAttribute(type, value);
return CKR_OK;
}
CK_RV P11Attribute::retrieveAttrByteString(Token *token, bool isPrivate, OSAttribute *attr, ByteString &value)
{
if (isPrivate && attr->getByteStringValue().size() != 0)
{
if (!token->decrypt(attr->getByteStringValue(), value))
{
ERROR_MSG("Internal error: failed to decrypt private attribute value");
return CKR_GENERAL_ERROR;
}
}
else
{
value = attr->getByteStringValue();
}
return CKR_OK;
}
bool P11Attribute::isModifiable()
{
// Get the CKA_MODIFIABLE attribute, when the attribute is
// not present return the default value which is CK_TRUE.
if (!osobject->attributeExists(CKA_MODIFIABLE)) return true;
return osobject->getBooleanValue(CKA_MODIFIABLE, true);
}
bool P11Attribute::isSensitive()
{
// Get the CKA_SENSITIVE attribute, when the attribute is not present
// assume the object is not sensitive.
if (!osobject->attributeExists(CKA_SENSITIVE)) return false;
return osobject->getBooleanValue(CKA_SENSITIVE, false);
}
bool P11Attribute::isExtractable()
{
// Get the CKA_EXTRACTABLE attribute, when the attribute is
// not present assume the object allows extraction.
if (!osobject->attributeExists(CKA_EXTRACTABLE)) return true;
return osobject->getBooleanValue(CKA_EXTRACTABLE, true);
}
bool P11Attribute::isTrusted()
{
// Get the CKA_TRUSTED attribute, when the attribute is
// not present assume the object is not trusted.
if (!osobject->attributeExists(CKA_TRUSTED)) return false;
return osobject->getBooleanValue(CKA_TRUSTED, false);
}
// Initialize the attribute
bool P11Attribute::init()
{
if (osobject == NULL) return false;
// Create a default value if the attribute does not exist
if (osobject->attributeExists(type) == false)
{
return setDefault();
}
return true;
}
// Return the attribute type
CK_ATTRIBUTE_TYPE P11Attribute::getType()
{
return type;
}
// Return the attribute checks
CK_ATTRIBUTE_TYPE P11Attribute::getChecks()
{
return checks;
}
// Retrieve a template map
static CK_RV retrieveAttributeMap(CK_ATTRIBUTE_PTR pTemplate, const std::map<CK_ATTRIBUTE_TYPE,OSAttribute>& map)
{
size_t nullcnt = 0;
for (size_t i = 0; i < map.size(); ++i)
{
if (pTemplate[i].pValue == NULL_PTR)
++nullcnt;
}
// Caller wants type & size
if (nullcnt == map.size())
{
std::map<CK_ATTRIBUTE_TYPE,OSAttribute>::const_iterator a = map.begin();
for (size_t i = 0; i < map.size(); ++i, ++a)
{
pTemplate[i].type = a->first;
const OSAttribute& attr = a->second;
if (attr.isBooleanAttribute())
{
pTemplate[i].ulValueLen = sizeof(CK_BBOOL);
}
else if (attr.isUnsignedLongAttribute())
{
pTemplate[i].ulValueLen = sizeof(CK_ULONG);
}
else if (attr.isByteStringAttribute())
{
pTemplate[i].ulValueLen = attr.getByteStringValue().size();
}
else
{
// Impossible
ERROR_MSG("Internal error: bad attribute in attribute map");
return CKR_GENERAL_ERROR;
}
}
return CKR_OK;
}
// Callers wants to get values
for (size_t i = 0; i < map.size(); ++i)
{
std::map<CK_ATTRIBUTE_TYPE,OSAttribute>::const_iterator a = map.find(pTemplate[i].type);
if (a == map.end())
{
pTemplate[i].ulValueLen = CK_UNAVAILABLE_INFORMATION;
return CKR_ATTRIBUTE_TYPE_INVALID;
}
const OSAttribute& attr = a->second;
if (attr.isBooleanAttribute())
{
if (pTemplate[i].ulValueLen < sizeof(CK_BBOOL))
{
pTemplate[i].ulValueLen = CK_UNAVAILABLE_INFORMATION;
return CKR_BUFFER_TOO_SMALL;
}
pTemplate[i].ulValueLen = sizeof(CK_BBOOL);
*(CK_BBOOL*)pTemplate[i].pValue = attr.getBooleanValue() ? CK_TRUE : CK_FALSE;
}
else if (attr.isUnsignedLongAttribute())
{
if (pTemplate[i].ulValueLen < sizeof(CK_ULONG))
{
pTemplate[i].ulValueLen= CK_UNAVAILABLE_INFORMATION;
return CKR_BUFFER_TOO_SMALL;
}
pTemplate[i].ulValueLen = sizeof(CK_ULONG);
*(CK_ULONG_PTR)pTemplate[i].pValue= attr.getUnsignedLongValue();
}
else if (attr.isByteStringAttribute())
{
ByteString value = attr.getByteStringValue();
if (pTemplate[i].ulValueLen < value.size())
{
pTemplate[i].ulValueLen= CK_UNAVAILABLE_INFORMATION;
return CKR_BUFFER_TOO_SMALL;
}
pTemplate[i].ulValueLen = value.size();
memcpy(pTemplate[i].pValue, value.const_byte_str(), value.size());
}
else
{
// Impossible
ERROR_MSG("Internal error: bad attribute in attribute map");
return CKR_GENERAL_ERROR;
}
}
return CKR_OK;
}
// Retrieve the value if allowed
CK_RV P11Attribute::retrieve(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG_PTR pulValueLen)
{
if (osobject == NULL) {
ERROR_MSG("Internal error: osobject field contains NULL_PTR");
return CKR_GENERAL_ERROR;
}
if (pulValueLen == NULL) {
ERROR_MSG("Internal error: pulValueLen contains NULL_PTR");
return CKR_GENERAL_ERROR;
}
// [PKCS#11 v2.40, C_GetAttributeValue]
// 1. If the specified attribute (i.e., the attribute specified by the
// type field) for the object cannot be revealed because the object
// is sensitive or unextractable, then the ulValueLen field in that
// triple is modified to hold the value CK_UNAVAILABLE_INFORMATION.
//
// [PKCS#11 v2.40, 4.2 Common attributes, table 10]
// 7 Cannot be revealed if object has its CKA_SENSITIVE attribute
// set to CK_TRUE or its CKA_EXTRACTABLE attribute set to CK_FALSE.
if ((checks & ck7) == ck7 && (isSensitive() || !isExtractable())) {
*pulValueLen = CK_UNAVAILABLE_INFORMATION;
return CKR_ATTRIBUTE_SENSITIVE;
}
// Retrieve the lower level attribute.
if (!osobject->attributeExists(type)) {
// Should be impossible.
ERROR_MSG("Internal error: attribute not present");
return CKR_GENERAL_ERROR;
}
OSAttribute attr = osobject->getAttribute(type);
// Get the actual attribute size.
CK_ULONG attrSize = size;
if (size == (CK_ULONG)-1)
{
// We don't have a fixed size attribute so we need to consult
// the lower level attribute for the exact size.
// Lower level attribute has to be variable sized.
if (attr.isByteStringAttribute())
{
ByteString value;
CK_RV res = retrieveAttrByteString(token, isPrivate, &attr, value);
if (res != CKR_OK)
{
return res;
}
attrSize = value.size();
}
else if (attr.isMechanismTypeSetAttribute())
{
attrSize = attr.getMechanismTypeSetValue().size() * sizeof(CK_MECHANISM_TYPE);
}
else if (attr.isAttributeMapAttribute())
{
attrSize = attr.getAttributeMapValue().size() * sizeof(CK_ATTRIBUTE);
}
else
{
// Should be impossible.
ERROR_MSG("Internal error: attribute has fixed size");
return CKR_GENERAL_ERROR;
}
}
// [PKCS#11 v2.40, C_GetAttributeValue]
// 3. Otherwise, if the pValue field has the value NULL_PTR, then the
// ulValueLen field is modified to hold the exact length of the
// specified attribute for the object.
if (pValue == NULL_PTR) {
// Return the size of the attribute.
*pulValueLen = attrSize;
return CKR_OK;
}
// [PKCS#11 v2.40, C_GetAttributeValue]
// 4. Otherwise, if the length specified in ulValueLen is large enough
// to hold the value of the specified attribute for the object, then
// that attribute is copied into the buffer located at pValue, and
// the ulValueLen field is modified to hold the exact length of the
// attribute.
if (*pulValueLen >= attrSize)
{
// Only copy when there is actually something to copy
CK_RV rv = CKR_OK;
if (attr.isUnsignedLongAttribute()) {
*(CK_ULONG_PTR)pValue = attr.getUnsignedLongValue();
}
else if (attr.isBooleanAttribute())
{
*(CK_BBOOL*)pValue = attr.getBooleanValue() ? CK_TRUE : CK_FALSE;
}
else if (attr.isByteStringAttribute())
{
ByteString value;
CK_RV res = retrieveAttrByteString(token, isPrivate, &attr, value);
if (res != CKR_OK)
{
return res;
}
if (value.size() != 0) {
const unsigned char* attrPtr = value.const_byte_str();
memcpy(pValue,attrPtr,attrSize);
}
}
else if (attr.isMechanismTypeSetAttribute())
{
CK_MECHANISM_TYPE_PTR pTemplate = (CK_MECHANISM_TYPE_PTR) pValue;
size_t i = 0;
std::set<CK_MECHANISM_TYPE> set = attr.getMechanismTypeSetValue();
for (std::set<CK_MECHANISM_TYPE>::const_iterator it = set.begin(); it != set.end(); ++it)
pTemplate[i++] = *it;
}
else
{
// attr is already retrieved and verified to be an Attribute Map
rv = retrieveAttributeMap((CK_ATTRIBUTE_PTR)pValue, attr.getAttributeMapValue());
}
*pulValueLen = attrSize;
return rv;
}
// [PKCS#11 v2.40, C_GetAttributeValue]
// 5. Otherwise, the ulValueLen field is modified to hold the value CK_UNAVAILABLE_INFORMATION.
*pulValueLen = CK_UNAVAILABLE_INFORMATION;
return CKR_BUFFER_TOO_SMALL;
}
// Update the value if allowed
CK_RV P11Attribute::update(Token* token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op)
{
if (osobject == NULL) {
ERROR_MSG("Internal error: osobject field contains NULL_PTR");
return CKR_GENERAL_ERROR;
}
// [PKCS#11 v2.40, 4.1.1 Creating objects]
// 2. If the supplied template specifies an invalid value for a valid attribute, then the
// attempt should fail with the error code CKR_ATTRIBUTE_VALUE_INVALID.
// The valid values for Cryptoki attributes are described in the Cryptoki specification.
// Check for null pointers in values.
if (pValue == NULL_PTR && ulValueLen != 0) {
ERROR_MSG("The attribute is a NULL_PTR but has a non-zero length")
return CKR_ATTRIBUTE_VALUE_INVALID;
}
// For fixed sized attributes check that the size matches.
if (size != ((CK_ULONG)-1) && size != ulValueLen) {
ERROR_MSG("The attribute size is different from the expected size")
return CKR_ATTRIBUTE_VALUE_INVALID;
}
// [PKCS#11 v2.40, 4.1.1 Creating objects] OBJECT_OP_CREATE | OBJECT_OP_SET | OBJECT_OP_COPY
// 3. If the supplied template specifies a value for a read-only attribute, then the attempt
// should fail with the error code CKR_ATTRIBUTE_READ_ONLY.
// Whether or not a given Cryptoki attribute is read-only is explicitly stated in the Cryptoki
// specification; however, a particular library and token may be even more restrictive than
// Cryptoki specifies. In other words, an attribute which Cryptoki says is not read-only may
// nonetheless be read-only under certain circumstances (i.e., in conjunction with some
// combinations of other attributes) for a particular library and token. Whether or not a
// given non-Cryptoki attribute is read-only is obviously outside the scope of Cryptoki.
// Attributes cannot be changed if CKA_MODIFIABLE is set to false
if (!isModifiable() && op != OBJECT_OP_GENERATE && op != OBJECT_OP_CREATE && op != OBJECT_OP_UNWRAP) {
ERROR_MSG("An object is with CKA_MODIFIABLE set to false is not modifiable");
return CKR_ATTRIBUTE_READ_ONLY;
}
// Attributes cannot be modified if CKA_TRUSTED is true on a certificate object.
if (isTrusted() && op != OBJECT_OP_GENERATE && op != OBJECT_OP_CREATE && op != OBJECT_OP_UNWRAP) {
if (osobject->getUnsignedLongValue(CKA_CLASS, CKO_VENDOR_DEFINED) == CKO_CERTIFICATE)
{
ERROR_MSG("A trusted certificate cannot be modified");
return CKR_ATTRIBUTE_READ_ONLY;
}
}
// ck2 MUST not be specified when object is created with C_CreateObject.
if ((checks & ck2) == ck2)
{
if (OBJECT_OP_CREATE==op)
{
ERROR_MSG("Prohibited attribute was passed to object creation function");
return CKR_ATTRIBUTE_READ_ONLY;
}
}
// ck4 MUST not be specified when object is generated with C_GenerateKey or C_GenerateKeyPair.
if ((checks & ck4) == ck4)
{
if (OBJECT_OP_GENERATE==op)
{
ERROR_MSG("Prohibited attribute was passed to key generation function");
return CKR_ATTRIBUTE_READ_ONLY;
}
}
// ck6 MUST not be specified when object is unwrapped with C_UnwrapKey.
if ((checks & ck6) == ck6)
{
if (OBJECT_OP_UNWRAP==op)
{
ERROR_MSG("Prohibited attribute was passed to key unwrapping function");
return CKR_ATTRIBUTE_READ_ONLY;
}
}
// ck8 May be modified after object is created with a C_SetAttributeValue call
// or in the process of copying an 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.
if ((checks & ck8) == ck8)
{
if (OBJECT_OP_SET==op || OBJECT_OP_COPY==op)
{
return updateAttr(token, isPrivate, pValue, ulValueLen, op);
}
}
// ck11 Can only be changed to CK_TRUE on a C_SetAttributeValue call; actual
// enforcement happens in the specific attribute implementation.
if ((checks & ck11) == ck11)
{
if (OBJECT_OP_SET==op || OBJECT_OP_COPY==op)
{
return updateAttr(token, isPrivate, pValue, ulValueLen, op);
}
}
// ck17 Can be changed in the process of copying the object using C_CopyObject.
if ((checks & ck17) == ck17)
{
if (OBJECT_OP_COPY==op)
{
return updateAttr(token, isPrivate, pValue, ulValueLen, op);
}
}
// For attributes that have not been explicitly excluded from modification
// during create/derive/generate/unwrap, we allow them to be modified.
if (OBJECT_OP_CREATE==op || OBJECT_OP_DERIVE==op || OBJECT_OP_GENERATE==op || OBJECT_OP_UNWRAP==op)
{
return updateAttr(token, isPrivate, pValue, ulValueLen, op);
}
return CKR_ATTRIBUTE_READ_ONLY;
}
CK_RV P11NonPrivateAttribute::retrieveAttrByteString(Token* /*token*/, bool /*isPrivate*/, OSAttribute *attr, ByteString &value)
{
value = attr->getByteStringValue();
return CKR_OK;
}
/*****************************************
* CKA_CLASS
*****************************************/
// Set default value
bool P11AttrClass::setDefault()
{
OSAttribute attrClass((unsigned long)CKO_VENDOR_DEFINED);
return osobject->setAttribute(type, attrClass);
}
// Update the value if allowed
CK_RV P11AttrClass::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
{
// Attribute specific checks
if (ulValueLen !=sizeof(CK_ULONG))
{
return CKR_ATTRIBUTE_VALUE_INVALID;
}
if (osobject->getUnsignedLongValue(CKA_CLASS, CKO_VENDOR_DEFINED) != *(CK_ULONG*)pValue)
{
return CKR_TEMPLATE_INCONSISTENT;
}
return CKR_OK;
}
/*****************************************
* CKA_KEY_TYPE
*****************************************/
// Set default value
bool P11AttrKeyType::setDefault()
{
OSAttribute attr((unsigned long)CKK_VENDOR_DEFINED);
return osobject->setAttribute(type, attr);
}
// Update the value if allowed
CK_RV P11AttrKeyType::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
{
// Attribute specific checks
if (ulValueLen !=sizeof(CK_ULONG))
{
return CKR_ATTRIBUTE_VALUE_INVALID;
}
if (osobject->getUnsignedLongValue(CKA_KEY_TYPE, CKK_VENDOR_DEFINED) != *(CK_ULONG*)pValue)
{
return CKR_TEMPLATE_INCONSISTENT;
}
return CKR_OK;
}
/*****************************************
* CKA_CERTIFICATE_TYPE
* footnote 1
* 1 MUST be specified when object is created with C_CreateObject.
*****************************************/
// Set default value
bool P11AttrCertificateType::setDefault()
{
OSAttribute attr((unsigned long)CKC_VENDOR_DEFINED);
return osobject->setAttribute(type, attr);
}
// Update the value if allowed
CK_RV P11AttrCertificateType::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
{
// Attribute specific checks
if (ulValueLen !=sizeof(CK_ULONG))
{
return CKR_ATTRIBUTE_VALUE_INVALID;
}
if (osobject->getUnsignedLongValue(CKA_CERTIFICATE_TYPE, CKC_VENDOR_DEFINED) != *(CK_ULONG*)pValue)
{
return CKR_TEMPLATE_INCONSISTENT;
}
return CKR_OK;
}
/*****************************************
* CKA_TOKEN
*****************************************/
// Set default value
bool P11AttrToken::setDefault()
{
OSAttribute attr(false);
return osobject->setAttribute(type, attr);
}
// Update the value if allowed
CK_RV P11AttrToken::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
{
OSAttribute attrTrue(true);
OSAttribute attrFalse(false);
// Attribute specific checks
if (ulValueLen !=sizeof(CK_BBOOL))
{
return CKR_ATTRIBUTE_VALUE_INVALID;
}
// Store data
if (*(CK_BBOOL*)pValue == CK_FALSE)
{
osobject->setAttribute(type, attrFalse);
}
else
{
osobject->setAttribute(type, attrTrue);
}
return CKR_OK;
}
/*****************************************
* CKA_PRIVATE
*****************************************/
// Set default value
bool P11AttrPrivate::setDefault()
{
OSAttribute attr(true);
return osobject->setAttribute(type, attr);
}
// Update the value if allowed
CK_RV P11AttrPrivate::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
{
OSAttribute attrTrue(true);
OSAttribute attrFalse(false);
// Attribute specific checks
if (ulValueLen !=sizeof(CK_BBOOL))
{
return CKR_ATTRIBUTE_VALUE_INVALID;
}
// Store data
if (*(CK_BBOOL*)pValue == CK_FALSE)
{
osobject->setAttribute(type, attrFalse);
}
else
{
osobject->setAttribute(type, attrTrue);
}
return CKR_OK;
}
/*****************************************
* CKA_MODIFIABLE
*****************************************/
// Set default value
bool P11AttrModifiable::setDefault()
{
OSAttribute attr(true);
return osobject->setAttribute(type, attr);
}
// Update the value if allowed
CK_RV P11AttrModifiable::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
{
OSAttribute attrTrue(true);
OSAttribute attrFalse(false);
// Attribute specific checks
if (ulValueLen !=sizeof(CK_BBOOL))
{
return CKR_ATTRIBUTE_VALUE_INVALID;
}
// Store data
if (*(CK_BBOOL*)pValue == CK_FALSE)
{
osobject->setAttribute(type, attrFalse);
}
else
{
osobject->setAttribute(type, attrTrue);
}
return CKR_OK;
}
/*****************************************
* CKA_LABEL
*****************************************/
// Set default value
bool P11AttrLabel::setDefault()
{
OSAttribute attr(ByteString(""));
return osobject->setAttribute(type, attr);
}
/*****************************************
* CKA_COPYABLE
*****************************************/
// Set default value
bool P11AttrCopyable::setDefault()
{
OSAttribute attr(true);
return osobject->setAttribute(type, attr);
}
// Update the value if allowed
CK_RV P11AttrCopyable::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
{
OSAttribute attrTrue(true);
OSAttribute attrFalse(false);
// Attribute specific checks
if (ulValueLen !=sizeof(CK_BBOOL))
{
return CKR_ATTRIBUTE_VALUE_INVALID;
}
// Store data
if (*(CK_BBOOL*)pValue == CK_FALSE)
{
osobject->setAttribute(type, attrFalse);
}
else
{
if (osobject->getBooleanValue(CKA_COPYABLE, true) == false)
{
return CKR_ATTRIBUTE_READ_ONLY;
}
}
return CKR_OK;
}
/*****************************************
* CKA_DESTROYABLE
*****************************************/
// Set default value
bool P11AttrDestroyable::setDefault()
{
OSAttribute attr(true);
return osobject->setAttribute(type, attr);
}
// Update the value if allowed
CK_RV P11AttrDestroyable::updateAttr(Token* /*token*/, bool /*isPrivate*/, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
{
OSAttribute attrTrue(true);
OSAttribute attrFalse(false);
// Attribute specific checks
if (ulValueLen !=sizeof(CK_BBOOL))
{
return CKR_ATTRIBUTE_VALUE_INVALID;
}
// Store data
if (*(CK_BBOOL*)pValue == CK_FALSE)
{
osobject->setAttribute(type, attrFalse);
}
else
{
osobject->setAttribute(type, attrTrue);
}
return CKR_OK;
}
/*****************************************
* CKA_APPLICATION
*****************************************/
// Set default value
bool P11AttrApplication::setDefault()
{
OSAttribute attr(ByteString(""));
return osobject->setAttribute(type, attr);
}
/*****************************************
* CKA_OBJECT_ID
*****************************************/
// Set default value
bool P11AttrObjectID::setDefault()
{
OSAttribute attr(ByteString(""));
return osobject->setAttribute(type, attr);
}
/*****************************************
* CKA_CHECK_VALUE
*****************************************/
// Set default value
bool P11AttrCheckValue::setDefault()
{
OSAttribute attr(ByteString(""));
return osobject->setAttribute(type, attr);
}
// Update the value if allowed
CK_RV P11AttrCheckValue::updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int /*op*/)
{
ByteString plaintext((unsigned char*)pValue, ulValueLen);
ByteString value;
// Encrypt
if (isPrivate)
{
if (!token->encrypt(plaintext, value))
return CKR_GENERAL_ERROR;
}
else
value = plaintext;
// Attribute specific checks
if (value.size() < ulValueLen)
return CKR_GENERAL_ERROR;
// Store data
if (ulValueLen == 0)
{
osobject->setAttribute(type, value);
}
else
{
ByteString checkValue;
ByteString keybits;
if (isPrivate)
{
if (!token->decrypt(osobject->getByteStringValue(CKA_VALUE), keybits))
return CKR_GENERAL_ERROR;
}
else
{
keybits = osobject->getByteStringValue(CKA_VALUE);
}
SymmetricKey key;
AESKey aes;
DESKey des;
switch (osobject->getUnsignedLongValue(CKA_KEY_TYPE, CKK_VENDOR_DEFINED))
{
case CKK_GENERIC_SECRET:
case CKK_MD5_HMAC:
case CKK_SHA_1_HMAC:
case CKK_SHA224_HMAC:
case CKK_SHA256_HMAC:
case CKK_SHA384_HMAC:
case CKK_SHA512_HMAC:
key.setKeyBits(keybits);
key.setBitLen(keybits.size() * 8);
checkValue = key.getKeyCheckValue();
break;
case CKK_AES:
aes.setKeyBits(keybits);
aes.setBitLen(keybits.size() * 8);
checkValue = aes.getKeyCheckValue();
break;
case CKK_DES:
case CKK_DES2:
case CKK_DES3:
des.setKeyBits(keybits);
des.setBitLen(keybits.size() * 7);
checkValue = des.getKeyCheckValue();
break;
case CKK_GOST28147:
// TODO: Encryption support for CKK_GOST28147
// We do not calculate the KCV
checkValue = plaintext;
break;
default:
return CKR_GENERAL_ERROR;
}
if (plaintext != checkValue)
return CKR_ATTRIBUTE_VALUE_INVALID;
osobject->setAttribute(type, value);
}
return CKR_OK;
}
/*****************************************
* CKA_PUBLIC_KEY_INFO
*****************************************/
// Set default value
bool P11AttrPublicKeyInfo::setDefault()
{
OSAttribute attr(ByteString(""));
return osobject->setAttribute(type, attr);
}
/*****************************************
* CKA_ID
*****************************************/
// Set default value
bool P11AttrID::setDefault()
{
OSAttribute attr(ByteString(""));
return osobject->setAttribute(type, attr);
}
/*****************************************
* CKA_VALUE
*****************************************/
// Set default value
bool P11AttrValue::setDefault()
{
OSAttribute attr(ByteString(""));
return osobject->setAttribute(type, attr);
}
// Update the value if allowed
CK_RV P11AttrValue::updateAttr(Token *token, bool isPrivate, CK_VOID_PTR pValue, CK_ULONG ulValueLen, int op)
{
ByteString plaintext((unsigned char*)pValue, ulValueLen);
ByteString value;
// Encrypt
if (isPrivate)
{
if (!token->encrypt(plaintext, value))
return CKR_GENERAL_ERROR;
}
else
value = plaintext;
// Attribute specific checks
if (value.size() < ulValueLen)
return CKR_GENERAL_ERROR;
// Store data
osobject->setAttribute(type, value);
// Set the size during C_CreateObject and C_UnwrapKey.
if (op == OBJECT_OP_CREATE || op == OBJECT_OP_UNWRAP)
{
// Set the CKA_VALUE_LEN
if (osobject->attributeExists(CKA_VALUE_LEN))
{
OSAttribute bytes((unsigned long)plaintext.size());
osobject->setAttribute(CKA_VALUE_LEN, bytes);
}
// Set the CKA_VALUE_BITS
if (osobject->attributeExists(CKA_VALUE_BITS))
{
OSAttribute bits((unsigned long)plaintext.bits());
osobject->setAttribute(CKA_VALUE_BITS, bits);
}
}
// Calculate the CKA_CHECK_VALUE for certificates
if (osobject->getUnsignedLongValue(CKA_CLASS, CKO_VENDOR_DEFINED) == CKO_CERTIFICATE)
{