/
fipstokn.c
2072 lines (1807 loc) · 62 KB
/
fipstokn.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/*
* This file implements PKCS 11 on top of our existing security modules
*
* For more information about PKCS 11 See PKCS 11 Token Inteface Standard.
* This implementation has two slots:
* slot 1 is our generic crypto support. It does not require login
* (unless you've enabled FIPS). It supports Public Key ops, and all they
* bulk ciphers and hashes. It can also support Private Key ops for imported
* Private keys. It does not have any token storage.
* slot 2 is our private key support. It requires a login before use. It
* can store Private Keys and Certs as token objects. Currently only private
* keys and their associated Certificates are saved on the token.
*
* In this implementation, session objects are only visible to the session
* that created or generated them.
*/
#include "seccomon.h"
#include "softoken.h"
#include "lowkeyi.h"
#include "pkcs11.h"
#include "pkcs11i.h"
#include "prenv.h"
#include "prprf.h"
#include <ctype.h>
#ifdef XP_UNIX
#define NSS_AUDIT_WITH_SYSLOG 1
#include <syslog.h>
#include <unistd.h>
#endif
#ifdef LINUX
#include <pthread.h>
#include <dlfcn.h>
#define LIBAUDIT_NAME "libaudit.so.1"
#ifndef AUDIT_CRYPTO_TEST_USER
#define AUDIT_CRYPTO_TEST_USER 2400 /* Crypto test results */
#define AUDIT_CRYPTO_PARAM_CHANGE_USER 2401 /* Crypto attribute change */
#define AUDIT_CRYPTO_LOGIN 2402 /* Logged in as crypto officer */
#define AUDIT_CRYPTO_LOGOUT 2403 /* Logged out from crypto */
#define AUDIT_CRYPTO_KEY_USER 2404 /* Create,delete,negotiate */
#define AUDIT_CRYPTO_FAILURE_USER 2405 /* Fail decrypt,encrypt,randomize */
#endif
static void *libaudit_handle;
static int (*audit_open_func)(void);
static void (*audit_close_func)(int fd);
static int (*audit_log_user_message_func)(int audit_fd, int type,
const char *message, const char *hostname, const char *addr,
const char *tty, int result);
static int (*audit_send_user_message_func)(int fd, int type,
const char *message);
static pthread_once_t libaudit_once_control = PTHREAD_ONCE_INIT;
static void
libaudit_init(void)
{
libaudit_handle = dlopen(LIBAUDIT_NAME, RTLD_LAZY);
if (!libaudit_handle) {
return;
}
audit_open_func = dlsym(libaudit_handle, "audit_open");
audit_close_func = dlsym(libaudit_handle, "audit_close");
/*
* audit_send_user_message is the older function.
* audit_log_user_message, if available, is preferred.
*/
audit_log_user_message_func = dlsym(libaudit_handle,
"audit_log_user_message");
if (!audit_log_user_message_func) {
audit_send_user_message_func = dlsym(libaudit_handle,
"audit_send_user_message");
}
if (!audit_open_func || !audit_close_func ||
(!audit_log_user_message_func && !audit_send_user_message_func)) {
dlclose(libaudit_handle);
libaudit_handle = NULL;
audit_open_func = NULL;
audit_close_func = NULL;
audit_log_user_message_func = NULL;
audit_send_user_message_func = NULL;
}
}
#endif /* LINUX */
/*
* ******************** Password Utilities *******************************
*/
static PRBool isLoggedIn = PR_FALSE;
static PRBool isLevel2 = PR_TRUE;
PRBool sftk_fatalError = PR_FALSE;
/*
* This function returns
* - CKR_PIN_INVALID if the password/PIN is not a legal UTF8 string
* - CKR_PIN_LEN_RANGE if the password/PIN is too short or does not
* consist of characters from three or more character classes.
* - CKR_OK otherwise
*
* The minimum password/PIN length is FIPS_MIN_PIN Unicode characters.
* We define five character classes: digits (0-9), ASCII lowercase letters,
* ASCII uppercase letters, ASCII non-alphanumeric characters (such as
* space and punctuation marks), and non-ASCII characters. If an ASCII
* uppercase letter is the first character of the password/PIN, the
* uppercase letter is not counted toward its character class. Similarly,
* if a digit is the last character of the password/PIN, the digit is not
* counted toward its character class.
*
* Although NSC_SetPIN and NSC_InitPIN already do the maximum and minimum
* password/PIN length checks, they check the length in bytes as opposed
* to characters. To meet the minimum password/PIN guessing probability
* requirements in FIPS 140-2, we need to check the length in characters.
*/
static CK_RV
sftk_newPinCheck(CK_CHAR_PTR pPin, CK_ULONG ulPinLen)
{
unsigned int i;
int nchar = 0; /* number of characters */
int ntrail = 0; /* number of trailing bytes to follow */
int ndigit = 0; /* number of decimal digits */
int nlower = 0; /* number of ASCII lowercase letters */
int nupper = 0; /* number of ASCII uppercase letters */
int nnonalnum = 0; /* number of ASCII non-alphanumeric characters */
int nnonascii = 0; /* number of non-ASCII characters */
int nclass; /* number of character classes */
for (i = 0; i < ulPinLen; i++) {
unsigned int byte = pPin[i];
if (ntrail) {
if ((byte & 0xc0) != 0x80) {
/* illegal */
nchar = -1;
break;
}
if (--ntrail == 0) {
nchar++;
nnonascii++;
}
continue;
}
if ((byte & 0x80) == 0x00) {
/* single-byte (ASCII) character */
nchar++;
if (isdigit(byte)) {
if (i < ulPinLen - 1) {
ndigit++;
}
} else if (islower(byte)) {
nlower++;
} else if (isupper(byte)) {
if (i > 0) {
nupper++;
}
} else {
nnonalnum++;
}
} else if ((byte & 0xe0) == 0xc0) {
/* leading byte of two-byte character */
ntrail = 1;
} else if ((byte & 0xf0) == 0xe0) {
/* leading byte of three-byte character */
ntrail = 2;
} else if ((byte & 0xf8) == 0xf0) {
/* leading byte of four-byte character */
ntrail = 3;
} else {
/* illegal */
nchar = -1;
break;
}
}
if (nchar == -1) {
/* illegal UTF8 string */
return CKR_PIN_INVALID;
}
if (nchar < FIPS_MIN_PIN) {
return CKR_PIN_LEN_RANGE;
}
nclass = (ndigit != 0) + (nlower != 0) + (nupper != 0) +
(nnonalnum != 0) + (nnonascii != 0);
if (nclass < 3) {
return CKR_PIN_LEN_RANGE;
}
return CKR_OK;
}
/* FIPS required checks before any useful cryptographic services */
static CK_RV
sftk_fipsCheck(void)
{
if (sftk_fatalError)
return CKR_DEVICE_ERROR;
if (isLevel2 && !isLoggedIn)
return CKR_USER_NOT_LOGGED_IN;
return CKR_OK;
}
#define SFTK_FIPSCHECK() \
CK_RV rv; \
if ((rv = sftk_fipsCheck()) != CKR_OK) \
return rv;
#define SFTK_FIPSFATALCHECK() \
if (sftk_fatalError) \
return CKR_DEVICE_ERROR;
/* grab an attribute out of a raw template */
void *
fc_getAttribute(CK_ATTRIBUTE_PTR pTemplate,
CK_ULONG ulCount, CK_ATTRIBUTE_TYPE type)
{
int i;
for (i = 0; i < (int)ulCount; i++) {
if (pTemplate[i].type == type) {
return pTemplate[i].pValue;
}
}
return NULL;
}
#define __PASTE(x, y) x##y
/* ------------- forward declare all the NSC_ functions ------------- */
#undef CK_NEED_ARG_LIST
#undef CK_PKCS11_FUNCTION_INFO
#define CK_PKCS11_3_0 1
#define CK_PKCS11_FUNCTION_INFO(name) CK_RV __PASTE(NS, name)
#define CK_NEED_ARG_LIST 1
#include "pkcs11f.h"
/* ------------- forward declare all the FIPS functions ------------- */
#undef CK_NEED_ARG_LIST
#undef CK_PKCS11_FUNCTION_INFO
#define CK_PKCS11_FUNCTION_INFO(name) CK_RV __PASTE(F, name)
#define CK_NEED_ARG_LIST 1
#include "pkcs11f.h"
/* ------------- build the CK_CRYPTO_TABLE ------------------------- */
static CK_FUNCTION_LIST_3_0 sftk_fipsTable = {
{ CRYPTOKI_VERSION_MAJOR, CRYPTOKI_VERSION_MINOR },
#undef CK_NEED_ARG_LIST
#undef CK_PKCS11_FUNCTION_INFO
#define CK_PKCS11_FUNCTION_INFO(name) \
__PASTE(F, name) \
,
#include "pkcs11f.h"
};
/* forward declaration of special GetInfo functions */
CK_RV FC_GetInfoV2(CK_INFO_PTR pInfo);
CK_RV NSC_GetInfoV2(CK_INFO_PTR pInfo);
CK_RV FC_GetMechanismInfoV2(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type,
CK_MECHANISM_INFO_PTR pInfo);
CK_RV NSC_GetMechanismInfoV2(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type,
CK_MECHANISM_INFO_PTR pInfo);
static CK_FUNCTION_LIST sftk_fipsTable_v2 = {
{ 2, 40 },
#undef CK_PKCS11_3_0
#define CK_PKCS11_2_0_ONLY 1
#undef CK_NEED_ARG_LIST
#undef CK_PKCS11_FUNCTION_INFO
#define C_GetInfo C_GetInfoV2
#define C_GetMechanismInfo C_GetMechanismInfoV2
#define CK_PKCS11_FUNCTION_INFO(name) \
__PASTE(F, name) \
,
#include "pkcs11f.h"
};
#undef C_GetInfo
#undef C_GetMechanismInfo
#undef CK_NEED_ARG_LIST
#undef CK_PKCS11_FUNCTION_INFO
#undef CK_PKCS11_2_0_ONLY
#undef __PASTE
/*
* Array is orderd by default first
*/
static CK_INTERFACE fips_interfaces[] = {
{ (CK_UTF8CHAR_PTR) "PKCS 11", &sftk_fipsTable, NSS_INTERFACE_FLAGS },
{ (CK_UTF8CHAR_PTR) "PKCS 11", &sftk_fipsTable_v2, NSS_INTERFACE_FLAGS },
{ (CK_UTF8CHAR_PTR) "Vendor NSS Module Interface", &sftk_module_funcList, NSS_INTERFACE_FLAGS }
};
/* must match the count of interfaces in fips_interfaces above*/
#define FIPS_INTERFACE_COUNT 3
/* CKO_NOT_A_KEY can be any object class that's not a key object. */
#define CKO_NOT_A_KEY CKO_DATA
#define SFTK_IS_KEY_OBJECT(objClass) \
(((objClass) == CKO_PUBLIC_KEY) || \
((objClass) == CKO_PRIVATE_KEY) || \
((objClass) == CKO_SECRET_KEY))
#define SFTK_IS_NONPUBLIC_KEY_OBJECT(objClass) \
(((objClass) == CKO_PRIVATE_KEY) || ((objClass) == CKO_SECRET_KEY))
static CK_RV
sftk_get_object_class_and_fipsCheck(CK_SESSION_HANDLE hSession,
CK_OBJECT_HANDLE hObject, CK_OBJECT_CLASS *pObjClass)
{
CK_RV rv;
CK_ATTRIBUTE class;
class.type = CKA_CLASS;
class.pValue = pObjClass;
class.ulValueLen = sizeof(*pObjClass);
rv = NSC_GetAttributeValue(hSession, hObject, &class, 1);
if ((rv == CKR_OK) && SFTK_IS_NONPUBLIC_KEY_OBJECT(*pObjClass)) {
rv = sftk_fipsCheck();
}
return rv;
}
#ifdef LINUX
int
sftk_mapLinuxAuditType(NSSAuditSeverity severity, NSSAuditType auditType)
{
switch (auditType) {
case NSS_AUDIT_ACCESS_KEY:
case NSS_AUDIT_CHANGE_KEY:
case NSS_AUDIT_COPY_KEY:
case NSS_AUDIT_DERIVE_KEY:
case NSS_AUDIT_DESTROY_KEY:
case NSS_AUDIT_DIGEST_KEY:
case NSS_AUDIT_GENERATE_KEY:
case NSS_AUDIT_LOAD_KEY:
case NSS_AUDIT_UNWRAP_KEY:
case NSS_AUDIT_WRAP_KEY:
return AUDIT_CRYPTO_KEY_USER;
case NSS_AUDIT_CRYPT:
return (severity == NSS_AUDIT_ERROR) ? AUDIT_CRYPTO_FAILURE_USER : AUDIT_CRYPTO_KEY_USER;
case NSS_AUDIT_FIPS_STATE:
case NSS_AUDIT_INIT_PIN:
case NSS_AUDIT_INIT_TOKEN:
case NSS_AUDIT_SET_PIN:
return AUDIT_CRYPTO_PARAM_CHANGE_USER;
case NSS_AUDIT_SELF_TEST:
return AUDIT_CRYPTO_TEST_USER;
case NSS_AUDIT_LOGIN:
return AUDIT_CRYPTO_LOGIN;
case NSS_AUDIT_LOGOUT:
return AUDIT_CRYPTO_LOGOUT;
/* we skip the fault case here so we can get compiler
* warnings if new 'NSSAuditType's are added without
* added them to this list, defaults fall through */
}
/* default */
return AUDIT_CRYPTO_PARAM_CHANGE_USER;
}
#endif
/**********************************************************************
*
* FIPS 140 auditable event logging
*
**********************************************************************/
PRBool sftk_audit_enabled = PR_FALSE;
/*
* Each audit record must have the following information:
* - Date and time of the event
* - Type of event
* - user (subject) identity
* - outcome (success or failure) of the event
* - process ID
* - name (ID) of the object
* - for changes to data (except for authentication data and CSPs), the new
* and old values of the data
* - for authentication attempts, the origin of the attempt (e.g., terminal
* identifier)
* - for assuming a role, the type of role, and the location of the request
*/
void
sftk_LogAuditMessage(NSSAuditSeverity severity, NSSAuditType auditType,
const char *msg)
{
#ifdef NSS_AUDIT_WITH_SYSLOG
int level;
switch (severity) {
case NSS_AUDIT_ERROR:
level = LOG_ERR;
break;
case NSS_AUDIT_WARNING:
level = LOG_WARNING;
break;
default:
level = LOG_INFO;
break;
}
/* timestamp is provided by syslog in the message header */
syslog(level | LOG_USER /* facility */,
"NSS " SOFTOKEN_LIB_NAME "[pid=%d uid=%d]: %s",
(int)getpid(), (int)getuid(), msg);
#ifdef LINUX
if (pthread_once(&libaudit_once_control, libaudit_init) != 0) {
return;
}
if (libaudit_handle) {
int audit_fd;
int linuxAuditType;
int result = (severity != NSS_AUDIT_ERROR); /* 1=success; 0=failed */
char *message = PR_smprintf("NSS " SOFTOKEN_LIB_NAME ": %s", msg);
if (!message) {
return;
}
audit_fd = audit_open_func();
if (audit_fd < 0) {
PR_smprintf_free(message);
return;
}
linuxAuditType = sftk_mapLinuxAuditType(severity, auditType);
if (audit_log_user_message_func) {
audit_log_user_message_func(audit_fd, linuxAuditType, message,
NULL, NULL, NULL, result);
} else {
audit_send_user_message_func(audit_fd, linuxAuditType, message);
}
audit_close_func(audit_fd);
PR_smprintf_free(message);
}
#endif /* LINUX */
#else
/* do nothing */
#endif
}
/**********************************************************************
*
* Start of PKCS 11 functions
*
**********************************************************************/
/* return the function list */
CK_RV
FC_GetFunctionList(CK_FUNCTION_LIST_PTR *pFunctionList)
{
CHECK_FORK();
*pFunctionList = &sftk_fipsTable_v2;
return CKR_OK;
}
CK_RV
FC_GetInterfaceList(CK_INTERFACE_PTR interfaces, CK_ULONG_PTR pulCount)
{
CK_ULONG count = *pulCount;
*pulCount = FIPS_INTERFACE_COUNT;
if (interfaces == NULL) {
return CKR_OK;
}
if (count < FIPS_INTERFACE_COUNT) {
return CKR_BUFFER_TOO_SMALL;
}
PORT_Memcpy(interfaces, fips_interfaces, sizeof(fips_interfaces));
return CKR_OK;
}
/*
* Get the requested interface, use the fips_interfaces array so we can
* easily add new interfaces as they occur.
*/
CK_RV
FC_GetInterface(CK_UTF8CHAR_PTR pInterfaceName, CK_VERSION_PTR pVersion,
CK_INTERFACE_PTR_PTR ppInterface, CK_FLAGS flags)
{
int i;
for (i = 0; i < FIPS_INTERFACE_COUNT; i++) {
CK_INTERFACE_PTR interface = &fips_interfaces[i];
if (pInterfaceName && PORT_Strcmp((char *)pInterfaceName, (char *)interface->pInterfaceName) != 0) {
continue;
}
if (pVersion && PORT_Memcmp(pVersion, (CK_VERSION *)interface->pFunctionList, sizeof(CK_VERSION)) != 0) {
continue;
}
if (flags & ((interface->flags & flags) != flags)) {
continue;
}
*ppInterface = interface;
return CKR_OK;
}
return CKR_ARGUMENTS_BAD;
}
/* sigh global so pkcs11 can read it */
PRBool nsf_init = PR_FALSE;
void
fc_log_init_error(CK_RV crv)
{
if (sftk_audit_enabled) {
char msg[128];
PR_snprintf(msg, sizeof msg,
"C_Initialize()=0x%08lX "
"power-up self-tests failed",
(PRUint32)crv);
sftk_LogAuditMessage(NSS_AUDIT_ERROR, NSS_AUDIT_SELF_TEST, msg);
}
}
/* FC_Initialize initializes the PKCS #11 library. */
CK_RV
FC_Initialize(CK_VOID_PTR pReserved)
{
const char *envp;
CK_RV crv;
if ((envp = PR_GetEnv("NSS_ENABLE_AUDIT")) != NULL) {
sftk_audit_enabled = (atoi(envp) == 1);
}
/* At this point we should have already done post and integrity checks.
* if we haven't, it probably means the FIPS product has not been installed
* or the tests failed. Don't let an application try to enter FIPS mode */
crv = sftk_FIPSEntryOK();
if (crv != CKR_OK) {
sftk_fatalError = PR_TRUE;
fc_log_init_error(crv);
return crv;
}
sftk_ForkReset(pReserved, &crv);
if (nsf_init) {
return CKR_CRYPTOKI_ALREADY_INITIALIZED;
}
crv = nsc_CommonInitialize(pReserved, PR_TRUE);
/* not an 'else' rv can be set by either SFTK_LowInit or SFTK_SlotInit*/
if (crv != CKR_OK) {
sftk_fatalError = PR_TRUE;
return crv;
}
sftk_fatalError = PR_FALSE; /* any error has been reset */
nsf_init = PR_TRUE;
isLevel2 = PR_TRUE; /* assume level 2 unless we learn otherwise */
return CKR_OK;
}
/*FC_Finalize indicates that an application is done with the PKCS #11 library.*/
CK_RV
FC_Finalize(CK_VOID_PTR pReserved)
{
CK_RV crv;
if (sftk_ForkReset(pReserved, &crv)) {
return crv;
}
if (!nsf_init) {
return CKR_OK;
}
crv = nsc_CommonFinalize(pReserved, PR_TRUE);
nsf_init = (PRBool) !(crv == CKR_OK);
return crv;
}
/* FC_GetInfo returns general information about PKCS #11. */
CK_RV
FC_GetInfo(CK_INFO_PTR pInfo)
{
CHECK_FORK();
return NSC_GetInfo(pInfo);
}
/* FC_GetInfo returns general information about PKCS #11. */
CK_RV
FC_GetInfoV2(CK_INFO_PTR pInfo)
{
CHECK_FORK();
return NSC_GetInfoV2(pInfo);
}
/* FC_GetSlotList obtains a list of slots in the system. */
CK_RV
FC_GetSlotList(CK_BBOOL tokenPresent,
CK_SLOT_ID_PTR pSlotList, CK_ULONG_PTR pulCount)
{
CHECK_FORK();
return nsc_CommonGetSlotList(tokenPresent, pSlotList, pulCount,
NSC_FIPS_MODULE);
}
/* FC_GetSlotInfo obtains information about a particular slot in the system. */
CK_RV
FC_GetSlotInfo(CK_SLOT_ID slotID, CK_SLOT_INFO_PTR pInfo)
{
CHECK_FORK();
return NSC_GetSlotInfo(slotID, pInfo);
}
/*FC_GetTokenInfo obtains information about a particular token in the system.*/
CK_RV
FC_GetTokenInfo(CK_SLOT_ID slotID, CK_TOKEN_INFO_PTR pInfo)
{
CK_RV crv;
CHECK_FORK();
crv = NSC_GetTokenInfo(slotID, pInfo);
if (crv == CKR_OK) {
/* use the global database to figure out if we are running in
* FIPS 140 Level 1 or Level 2 */
if (slotID == FIPS_SLOT_ID &&
(pInfo->flags & CKF_LOGIN_REQUIRED) == 0) {
isLevel2 = PR_FALSE;
}
}
return crv;
}
/*FC_GetMechanismList obtains a list of mechanism types supported by a token.*/
CK_RV
FC_GetMechanismList(CK_SLOT_ID slotID,
CK_MECHANISM_TYPE_PTR pMechanismList, CK_ULONG_PTR pusCount)
{
CHECK_FORK();
SFTK_FIPSFATALCHECK();
if (sftk_isFIPS(slotID)) {
slotID = NETSCAPE_SLOT_ID;
}
/* FIPS Slots support all functions */
return NSC_GetMechanismList(slotID, pMechanismList, pusCount);
}
/* FC_GetMechanismInfo obtains information about a particular mechanism
* possibly supported by a token. */
CK_RV
FC_GetMechanismInfo(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type,
CK_MECHANISM_INFO_PTR pInfo)
{
CHECK_FORK();
SFTK_FIPSFATALCHECK();
if (sftk_isFIPS(slotID)) {
slotID = NETSCAPE_SLOT_ID;
}
/* FIPS Slots support all functions */
return NSC_GetMechanismInfo(slotID, type, pInfo);
}
/* FC_GetMechanismInfoV2 same as FC_GetMechanismInfo except the Message
* flags have been stripped out */
CK_RV
FC_GetMechanismInfoV2(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type,
CK_MECHANISM_INFO_PTR pInfo)
{
CHECK_FORK();
SFTK_FIPSFATALCHECK();
if (sftk_isFIPS(slotID)) {
slotID = NETSCAPE_SLOT_ID;
}
/* FIPS Slots support all functions */
return NSC_GetMechanismInfoV2(slotID, type, pInfo);
}
/* FC_InitToken initializes a token. */
CK_RV
FC_InitToken(CK_SLOT_ID slotID, CK_CHAR_PTR pPin,
CK_ULONG usPinLen, CK_CHAR_PTR pLabel)
{
CK_RV crv;
CHECK_FORK();
crv = NSC_InitToken(slotID, pPin, usPinLen, pLabel);
if (sftk_audit_enabled) {
char msg[128];
NSSAuditSeverity severity = (crv == CKR_OK) ? NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
/* pLabel points to a 32-byte label, which is not null-terminated */
PR_snprintf(msg, sizeof msg,
"C_InitToken(slotID=%lu, pLabel=\"%.32s\")=0x%08lX",
(PRUint32)slotID, pLabel, (PRUint32)crv);
sftk_LogAuditMessage(severity, NSS_AUDIT_INIT_TOKEN, msg);
}
return crv;
}
/* FC_InitPIN initializes the normal user's PIN. */
CK_RV
FC_InitPIN(CK_SESSION_HANDLE hSession,
CK_CHAR_PTR pPin, CK_ULONG ulPinLen)
{
CK_RV rv;
CHECK_FORK();
if (sftk_fatalError)
return CKR_DEVICE_ERROR;
/* NSC_InitPIN will only work once per database. We can either initialize
* it to level1 (pin len == 0) or level2. If we initialize to level 2, then
* we need to make sure the pin meets FIPS requirements */
if ((ulPinLen == 0) || ((rv = sftk_newPinCheck(pPin, ulPinLen)) == CKR_OK)) {
rv = NSC_InitPIN(hSession, pPin, ulPinLen);
if ((rv == CKR_OK) &&
(sftk_SlotIDFromSessionHandle(hSession) == FIPS_SLOT_ID)) {
isLevel2 = (ulPinLen > 0) ? PR_TRUE : PR_FALSE;
}
}
if (sftk_audit_enabled) {
char msg[128];
NSSAuditSeverity severity = (rv == CKR_OK) ? NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
PR_snprintf(msg, sizeof msg,
"C_InitPIN(hSession=0x%08lX)=0x%08lX",
(PRUint32)hSession, (PRUint32)rv);
sftk_LogAuditMessage(severity, NSS_AUDIT_INIT_PIN, msg);
}
return rv;
}
/* FC_SetPIN modifies the PIN of user that is currently logged in. */
/* NOTE: This is only valid for the PRIVATE_KEY_SLOT */
CK_RV
FC_SetPIN(CK_SESSION_HANDLE hSession, CK_CHAR_PTR pOldPin,
CK_ULONG usOldLen, CK_CHAR_PTR pNewPin, CK_ULONG usNewLen)
{
CK_RV rv;
CHECK_FORK();
rv = sftk_fipsCheck();
if (rv != CKR_OK) {
goto loser;
}
if (isLevel2 || usNewLen > 0) {
rv = sftk_newPinCheck(pNewPin, usNewLen);
if (rv != CKR_OK) {
goto loser;
}
rv = NSC_SetPIN(hSession, pOldPin, usOldLen, pNewPin, usNewLen);
if (rv != CKR_OK) {
goto loser;
}
if (sftk_SlotIDFromSessionHandle(hSession) == FIPS_SLOT_ID) {
/* if we set the password in level1 we now go
* to level2. NOTE: we don't allow the user to
* go from level2 to level1 */
isLevel2 = PR_TRUE;
}
} else {
/* here both old and new passwords are empty, but we need to
* call NSC_SetPIN to force rekey the database entries */
PORT_Assert(usNewLen == 0);
rv = NSC_SetPIN(hSession, pOldPin, usOldLen, pNewPin, usNewLen);
if (rv != CKR_OK) {
goto loser;
}
}
loser:
if (sftk_audit_enabled) {
char msg[128];
NSSAuditSeverity severity = (rv == CKR_OK) ? NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
PR_snprintf(msg, sizeof msg,
"C_SetPIN(hSession=0x%08lX)=0x%08lX",
(PRUint32)hSession, (PRUint32)rv);
sftk_LogAuditMessage(severity, NSS_AUDIT_SET_PIN, msg);
}
return rv;
}
/* FC_OpenSession opens a session between an application and a token. */
CK_RV
FC_OpenSession(CK_SLOT_ID slotID, CK_FLAGS flags,
CK_VOID_PTR pApplication, CK_NOTIFY Notify, CK_SESSION_HANDLE_PTR phSession)
{
SFTK_FIPSFATALCHECK();
CHECK_FORK();
return NSC_OpenSession(slotID, flags, pApplication, Notify, phSession);
}
/* FC_CloseSession closes a session between an application and a token. */
CK_RV
FC_CloseSession(CK_SESSION_HANDLE hSession)
{
CHECK_FORK();
return NSC_CloseSession(hSession);
}
/* FC_CloseAllSessions closes all sessions with a token. */
CK_RV
FC_CloseAllSessions(CK_SLOT_ID slotID)
{
CHECK_FORK();
return NSC_CloseAllSessions(slotID);
}
CK_RV
FC_SessionCancel(CK_SESSION_HANDLE hSession, CK_FLAGS flags)
{
SFTK_FIPSFATALCHECK();
CHECK_FORK();
return NSC_SessionCancel(hSession, flags);
}
/* FC_GetSessionInfo obtains information about the session. */
CK_RV
FC_GetSessionInfo(CK_SESSION_HANDLE hSession,
CK_SESSION_INFO_PTR pInfo)
{
CK_RV rv;
SFTK_FIPSFATALCHECK();
CHECK_FORK();
rv = NSC_GetSessionInfo(hSession, pInfo);
if (rv == CKR_OK) {
/* handle the case where the auxilary slot doesn't require login.
* piggy back on the main token's login state */
if (isLoggedIn &&
((pInfo->state == CKS_RO_PUBLIC_SESSION) ||
(pInfo->state == CKS_RW_PUBLIC_SESSION))) {
CK_RV crv;
CK_TOKEN_INFO tInfo;
crv = NSC_GetTokenInfo(sftk_SlotIDFromSessionHandle(hSession),
&tInfo);
/* if the token doesn't login, use our global login state */
if ((crv == CKR_OK) && ((tInfo.flags & CKF_LOGIN_REQUIRED) == 0)) {
if (pInfo->state == CKS_RO_PUBLIC_SESSION) {
pInfo->state = CKS_RO_USER_FUNCTIONS;
} else {
pInfo->state = CKS_RW_USER_FUNCTIONS;
}
}
}
}
return rv;
}
/* FC_Login logs a user into a token. */
CK_RV
FC_Login(CK_SESSION_HANDLE hSession, CK_USER_TYPE userType,
CK_CHAR_PTR pPin, CK_ULONG usPinLen)
{
CK_RV rv;
PRBool successful;
if (sftk_fatalError)
return CKR_DEVICE_ERROR;
rv = NSC_Login(hSession, userType, pPin, usPinLen);
successful = (rv == CKR_OK) || (rv == CKR_USER_ALREADY_LOGGED_IN);
if (successful)
isLoggedIn = PR_TRUE;
if (sftk_audit_enabled) {
char msg[128];
NSSAuditSeverity severity;
severity = successful ? NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
PR_snprintf(msg, sizeof msg,
"C_Login(hSession=0x%08lX, userType=%lu)=0x%08lX",
(PRUint32)hSession, (PRUint32)userType, (PRUint32)rv);
sftk_LogAuditMessage(severity, NSS_AUDIT_LOGIN, msg);
}
return rv;
}
CK_RV
FC_LoginUser(CK_SESSION_HANDLE hSession, CK_USER_TYPE userType,
CK_CHAR_PTR pPin, CK_ULONG ulPinLen, CK_UTF8CHAR_PTR pUsername,
CK_ULONG ulUsernameLen)
{
CK_RV rv;
PRBool successful;
if (sftk_fatalError)
return CKR_DEVICE_ERROR;
rv = NSC_LoginUser(hSession, userType, pPin, ulPinLen,
pUsername, ulUsernameLen);
successful = (rv == CKR_OK) || (rv == CKR_USER_ALREADY_LOGGED_IN);
if (successful)
isLoggedIn = PR_TRUE;
if (sftk_audit_enabled) {
char msg[128];
char user[61];
int len = PR_MIN(ulUsernameLen, sizeof(user) - 1);
PORT_Memcpy(user, pUsername, len);
user[len] = 0;
NSSAuditSeverity severity;
severity = successful ? NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
PR_snprintf(msg, sizeof msg,
"C_LoginUser(hSession=0x%08lX, userType=%lu username=%s)=0x%08lX",
(PRUint32)hSession, (PRUint32)userType, user, (PRUint32)rv);
sftk_LogAuditMessage(severity, NSS_AUDIT_LOGIN, msg);
}
return rv;
}
/* FC_Logout logs a user out from a token. */
CK_RV
FC_Logout(CK_SESSION_HANDLE hSession)
{
CK_RV rv;
CHECK_FORK();
if ((rv = sftk_fipsCheck()) == CKR_OK) {
rv = NSC_Logout(hSession);
isLoggedIn = PR_FALSE;
}
if (sftk_audit_enabled) {
char msg[128];
NSSAuditSeverity severity = (rv == CKR_OK) ? NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
PR_snprintf(msg, sizeof msg,
"C_Logout(hSession=0x%08lX)=0x%08lX",
(PRUint32)hSession, (PRUint32)rv);
sftk_LogAuditMessage(severity, NSS_AUDIT_LOGOUT, msg);
}
return rv;
}
/* FC_CreateObject creates a new object. */
CK_RV
FC_CreateObject(CK_SESSION_HANDLE hSession,
CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount,
CK_OBJECT_HANDLE_PTR phObject)
{
CK_OBJECT_CLASS *classptr;
CK_RV rv = CKR_OK;
CHECK_FORK();
classptr = (CK_OBJECT_CLASS *)fc_getAttribute(pTemplate, ulCount, CKA_CLASS);
if (classptr == NULL)
return CKR_TEMPLATE_INCOMPLETE;
if (*classptr == CKO_NSS_NEWSLOT || *classptr == CKO_NSS_DELSLOT) {
if (sftk_fatalError)
return CKR_DEVICE_ERROR;
} else {
rv = sftk_fipsCheck();
if (rv != CKR_OK)
return rv;
}
/* FIPS can't create keys from raw key material */
if (SFTK_IS_NONPUBLIC_KEY_OBJECT(*classptr)) {
rv = CKR_ATTRIBUTE_VALUE_INVALID;
} else {
rv = NSC_CreateObject(hSession, pTemplate, ulCount, phObject);
}
if (sftk_audit_enabled && SFTK_IS_KEY_OBJECT(*classptr)) {
sftk_AuditCreateObject(hSession, pTemplate, ulCount, phObject, rv);
}
return rv;
}
/* FC_CopyObject copies an object, creating a new object for the copy. */
CK_RV
FC_CopyObject(CK_SESSION_HANDLE hSession,
CK_OBJECT_HANDLE hObject, CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount,
CK_OBJECT_HANDLE_PTR phNewObject)
{
CK_RV rv;
CK_OBJECT_CLASS objClass = CKO_NOT_A_KEY;
CHECK_FORK();
SFTK_FIPSFATALCHECK();
rv = sftk_get_object_class_and_fipsCheck(hSession, hObject, &objClass);
if (rv == CKR_OK) {