security/nss/lib/softoken/fipstokn.c@6474c204b198
security/nss/lib/softoken/fipstokn.c
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
1 /* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
4 /*
5 * This file implements PKCS 11 on top of our existing security modules
6 *
7 * For more information about PKCS 11 See PKCS 11 Token Inteface Standard.
8 * This implementation has two slots:
9 * slot 1 is our generic crypto support. It does not require login
10 * (unless you've enabled FIPS). It supports Public Key ops, and all they
11 * bulk ciphers and hashes. It can also support Private Key ops for imported
12 * Private keys. It does not have any token storage.
13 * slot 2 is our private key support. It requires a login before use. It
14 * can store Private Keys and Certs as token objects. Currently only private
15 * keys and their associated Certificates are saved on the token.
16 *
17 * In this implementation, session objects are only visible to the session
18 * that created or generated them.
19 */
20 #include "seccomon.h"
21 #include "softoken.h"
22 #include "lowkeyi.h"
23 #include "pkcs11.h"
24 #include "pkcs11i.h"
25 #include "prenv.h"
26 #include "prprf.h"
28 #include <ctype.h>
30 #ifdef XP_UNIX
31 #define NSS_AUDIT_WITH_SYSLOG 1
32 #include <syslog.h>
33 #include <unistd.h>
34 #endif
36 #ifdef LINUX
37 #include <pthread.h>
38 #include <dlfcn.h>
39 #define LIBAUDIT_NAME "libaudit.so.0"
40 #ifndef AUDIT_CRYPTO_TEST_USER
41 #define AUDIT_CRYPTO_TEST_USER 2400 /* Crypto test results */
42 #define AUDIT_CRYPTO_PARAM_CHANGE_USER 2401 /* Crypto attribute change */
43 #define AUDIT_CRYPTO_LOGIN 2402 /* Logged in as crypto officer */
44 #define AUDIT_CRYPTO_LOGOUT 2403 /* Logged out from crypto */
45 #define AUDIT_CRYPTO_KEY_USER 2404 /* Create,delete,negotiate */
46 #define AUDIT_CRYPTO_FAILURE_USER 2405 /* Fail decrypt,encrypt,randomize */
47 #endif
48 static void *libaudit_handle;
49 static int (*audit_open_func)(void);
50 static void (*audit_close_func)(int fd);
51 static int (*audit_log_user_message_func)(int audit_fd, int type,
52 const char *message, const char *hostname, const char *addr,
53 const char *tty, int result);
54 static int (*audit_send_user_message_func)(int fd, int type,
55 const char *message);
57 static pthread_once_t libaudit_once_control = PTHREAD_ONCE_INIT;
59 static void
60 libaudit_init(void)
61 {
62 libaudit_handle = dlopen(LIBAUDIT_NAME, RTLD_LAZY);
63 if (!libaudit_handle) {
64 return;
65 }
66 audit_open_func = dlsym(libaudit_handle, "audit_open");
67 audit_close_func = dlsym(libaudit_handle, "audit_close");
68 /*
69 * audit_send_user_message is the older function.
70 * audit_log_user_message, if available, is preferred.
71 */
72 audit_log_user_message_func = dlsym(libaudit_handle,
73 "audit_log_user_message");
74 if (!audit_log_user_message_func) {
75 audit_send_user_message_func = dlsym(libaudit_handle,
76 "audit_send_user_message");
77 }
78 if (!audit_open_func || !audit_close_func ||
79 (!audit_log_user_message_func && !audit_send_user_message_func)) {
80 dlclose(libaudit_handle);
81 libaudit_handle = NULL;
82 audit_open_func = NULL;
83 audit_close_func = NULL;
84 audit_log_user_message_func = NULL;
85 audit_send_user_message_func = NULL;
86 }
87 }
88 #endif /* LINUX */
91 /*
92 * ******************** Password Utilities *******************************
93 */
94 static PRBool isLoggedIn = PR_FALSE;
95 PRBool sftk_fatalError = PR_FALSE;
97 /*
98 * This function returns
99 * - CKR_PIN_INVALID if the password/PIN is not a legal UTF8 string
100 * - CKR_PIN_LEN_RANGE if the password/PIN is too short or does not
101 * consist of characters from three or more character classes.
102 * - CKR_OK otherwise
103 *
104 * The minimum password/PIN length is FIPS_MIN_PIN Unicode characters.
105 * We define five character classes: digits (0-9), ASCII lowercase letters,
106 * ASCII uppercase letters, ASCII non-alphanumeric characters (such as
107 * space and punctuation marks), and non-ASCII characters. If an ASCII
108 * uppercase letter is the first character of the password/PIN, the
109 * uppercase letter is not counted toward its character class. Similarly,
110 * if a digit is the last character of the password/PIN, the digit is not
111 * counted toward its character class.
112 *
113 * Although NSC_SetPIN and NSC_InitPIN already do the maximum and minimum
114 * password/PIN length checks, they check the length in bytes as opposed
115 * to characters. To meet the minimum password/PIN guessing probability
116 * requirements in FIPS 140-2, we need to check the length in characters.
117 */
118 static CK_RV sftk_newPinCheck(CK_CHAR_PTR pPin, CK_ULONG ulPinLen) {
119 unsigned int i;
120 int nchar = 0; /* number of characters */
121 int ntrail = 0; /* number of trailing bytes to follow */
122 int ndigit = 0; /* number of decimal digits */
123 int nlower = 0; /* number of ASCII lowercase letters */
124 int nupper = 0; /* number of ASCII uppercase letters */
125 int nnonalnum = 0; /* number of ASCII non-alphanumeric characters */
126 int nnonascii = 0; /* number of non-ASCII characters */
127 int nclass; /* number of character classes */
129 for (i = 0; i < ulPinLen; i++) {
130 unsigned int byte = pPin[i];
132 if (ntrail) {
133 if ((byte & 0xc0) != 0x80) {
134 /* illegal */
135 nchar = -1;
136 break;
137 }
138 if (--ntrail == 0) {
139 nchar++;
140 nnonascii++;
141 }
142 continue;
143 }
144 if ((byte & 0x80) == 0x00) {
145 /* single-byte (ASCII) character */
146 nchar++;
147 if (isdigit(byte)) {
148 if (i < ulPinLen - 1) {
149 ndigit++;
150 }
151 } else if (islower(byte)) {
152 nlower++;
153 } else if (isupper(byte)) {
154 if (i > 0) {
155 nupper++;
156 }
157 } else {
158 nnonalnum++;
159 }
160 } else if ((byte & 0xe0) == 0xc0) {
161 /* leading byte of two-byte character */
162 ntrail = 1;
163 } else if ((byte & 0xf0) == 0xe0) {
164 /* leading byte of three-byte character */
165 ntrail = 2;
166 } else if ((byte & 0xf8) == 0xf0) {
167 /* leading byte of four-byte character */
168 ntrail = 3;
169 } else {
170 /* illegal */
171 nchar = -1;
172 break;
173 }
174 }
175 if (nchar == -1) {
176 /* illegal UTF8 string */
177 return CKR_PIN_INVALID;
178 }
179 if (nchar < FIPS_MIN_PIN) {
180 return CKR_PIN_LEN_RANGE;
181 }
182 nclass = (ndigit != 0) + (nlower != 0) + (nupper != 0) +
183 (nnonalnum != 0) + (nnonascii != 0);
184 if (nclass < 3) {
185 return CKR_PIN_LEN_RANGE;
186 }
187 return CKR_OK;
188 }
191 /* FIPS required checks before any useful cryptographic services */
192 static CK_RV sftk_fipsCheck(void) {
193 if (sftk_fatalError)
194 return CKR_DEVICE_ERROR;
195 if (!isLoggedIn)
196 return CKR_USER_NOT_LOGGED_IN;
197 return CKR_OK;
198 }
201 #define SFTK_FIPSCHECK() \
202 CK_RV rv; \
203 if ((rv = sftk_fipsCheck()) != CKR_OK) return rv;
205 #define SFTK_FIPSFATALCHECK() \
206 if (sftk_fatalError) return CKR_DEVICE_ERROR;
209 /* grab an attribute out of a raw template */
210 void *
211 fc_getAttribute(CK_ATTRIBUTE_PTR pTemplate,
212 CK_ULONG ulCount, CK_ATTRIBUTE_TYPE type)
213 {
214 int i;
216 for (i=0; i < (int) ulCount; i++) {
217 if (pTemplate[i].type == type) {
218 return pTemplate[i].pValue;
219 }
220 }
221 return NULL;
222 }
225 #define __PASTE(x,y) x##y
227 /* ------------- forward declare all the NSC_ functions ------------- */
228 #undef CK_NEED_ARG_LIST
229 #undef CK_PKCS11_FUNCTION_INFO
231 #define CK_PKCS11_FUNCTION_INFO(name) CK_RV __PASTE(NS,name)
232 #define CK_NEED_ARG_LIST 1
234 #include "pkcs11f.h"
236 /* ------------- forward declare all the FIPS functions ------------- */
237 #undef CK_NEED_ARG_LIST
238 #undef CK_PKCS11_FUNCTION_INFO
240 #define CK_PKCS11_FUNCTION_INFO(name) CK_RV __PASTE(F,name)
241 #define CK_NEED_ARG_LIST 1
243 #include "pkcs11f.h"
245 /* ------------- build the CK_CRYPTO_TABLE ------------------------- */
246 static CK_FUNCTION_LIST sftk_fipsTable = {
247 { 1, 10 },
249 #undef CK_NEED_ARG_LIST
250 #undef CK_PKCS11_FUNCTION_INFO
252 #define CK_PKCS11_FUNCTION_INFO(name) __PASTE(F,name),
255 #include "pkcs11f.h"
257 };
259 #undef CK_NEED_ARG_LIST
260 #undef CK_PKCS11_FUNCTION_INFO
263 #undef __PASTE
265 /* CKO_NOT_A_KEY can be any object class that's not a key object. */
266 #define CKO_NOT_A_KEY CKO_DATA
268 #define SFTK_IS_KEY_OBJECT(objClass) \
269 (((objClass) == CKO_PUBLIC_KEY) || \
270 ((objClass) == CKO_PRIVATE_KEY) || \
271 ((objClass) == CKO_SECRET_KEY))
273 #define SFTK_IS_NONPUBLIC_KEY_OBJECT(objClass) \
274 (((objClass) == CKO_PRIVATE_KEY) || ((objClass) == CKO_SECRET_KEY))
276 static CK_RV
277 sftk_get_object_class_and_fipsCheck(CK_SESSION_HANDLE hSession,
278 CK_OBJECT_HANDLE hObject, CK_OBJECT_CLASS *pObjClass)
279 {
280 CK_RV rv;
281 CK_ATTRIBUTE class;
282 class.type = CKA_CLASS;
283 class.pValue = pObjClass;
284 class.ulValueLen = sizeof(*pObjClass);
285 rv = NSC_GetAttributeValue(hSession, hObject, &class, 1);
286 if ((rv == CKR_OK) && SFTK_IS_NONPUBLIC_KEY_OBJECT(*pObjClass)) {
287 rv = sftk_fipsCheck();
288 }
289 return rv;
290 }
292 #ifdef LINUX
294 int
295 sftk_mapLinuxAuditType(NSSAuditSeverity severity, NSSAuditType auditType)
296 {
297 switch (auditType) {
298 case NSS_AUDIT_ACCESS_KEY:
299 case NSS_AUDIT_CHANGE_KEY:
300 case NSS_AUDIT_COPY_KEY:
301 case NSS_AUDIT_DERIVE_KEY:
302 case NSS_AUDIT_DESTROY_KEY:
303 case NSS_AUDIT_DIGEST_KEY:
304 case NSS_AUDIT_GENERATE_KEY:
305 case NSS_AUDIT_LOAD_KEY:
306 case NSS_AUDIT_UNWRAP_KEY:
307 case NSS_AUDIT_WRAP_KEY:
308 return AUDIT_CRYPTO_KEY_USER;
309 case NSS_AUDIT_CRYPT:
310 return (severity == NSS_AUDIT_ERROR) ? AUDIT_CRYPTO_FAILURE_USER :
311 AUDIT_CRYPTO_KEY_USER;
312 case NSS_AUDIT_FIPS_STATE:
313 case NSS_AUDIT_INIT_PIN:
314 case NSS_AUDIT_INIT_TOKEN:
315 case NSS_AUDIT_SET_PIN:
316 return AUDIT_CRYPTO_PARAM_CHANGE_USER;
317 case NSS_AUDIT_SELF_TEST:
318 return AUDIT_CRYPTO_TEST_USER;
319 case NSS_AUDIT_LOGIN:
320 return AUDIT_CRYPTO_LOGIN;
321 case NSS_AUDIT_LOGOUT:
322 return AUDIT_CRYPTO_LOGOUT;
323 /* we skip the fault case here so we can get compiler
324 * warnings if new 'NSSAuditType's are added without
325 * added them to this list, defaults fall through */
326 }
327 /* default */
328 return AUDIT_CRYPTO_PARAM_CHANGE_USER;
329 }
330 #endif
333 /**********************************************************************
334 *
335 * FIPS 140 auditable event logging
336 *
337 **********************************************************************/
339 PRBool sftk_audit_enabled = PR_FALSE;
341 /*
342 * Each audit record must have the following information:
343 * - Date and time of the event
344 * - Type of event
345 * - user (subject) identity
346 * - outcome (success or failure) of the event
347 * - process ID
348 * - name (ID) of the object
349 * - for changes to data (except for authentication data and CSPs), the new
350 * and old values of the data
351 * - for authentication attempts, the origin of the attempt (e.g., terminal
352 * identifier)
353 * - for assuming a role, the type of role, and the location of the request
354 */
355 void
356 sftk_LogAuditMessage(NSSAuditSeverity severity, NSSAuditType auditType,
357 const char *msg)
358 {
359 #ifdef NSS_AUDIT_WITH_SYSLOG
360 int level;
362 switch (severity) {
363 case NSS_AUDIT_ERROR:
364 level = LOG_ERR;
365 break;
366 case NSS_AUDIT_WARNING:
367 level = LOG_WARNING;
368 break;
369 default:
370 level = LOG_INFO;
371 break;
372 }
373 /* timestamp is provided by syslog in the message header */
374 syslog(level | LOG_USER /* facility */,
375 "NSS " SOFTOKEN_LIB_NAME "[pid=%d uid=%d]: %s",
376 (int)getpid(), (int)getuid(), msg);
377 #ifdef LINUX
378 if (pthread_once(&libaudit_once_control, libaudit_init) != 0) {
379 return;
380 }
381 if (libaudit_handle) {
382 int audit_fd;
383 int linuxAuditType;
384 int result = (severity != NSS_AUDIT_ERROR); /* 1=success; 0=failed */
385 char *message = PR_smprintf("NSS " SOFTOKEN_LIB_NAME ": %s", msg);
386 if (!message) {
387 return;
388 }
389 audit_fd = audit_open_func();
390 if (audit_fd < 0) {
391 PR_smprintf_free(message);
392 return;
393 }
394 linuxAuditType = sftk_mapLinuxAuditType(severity, auditType);
395 if (audit_log_user_message_func) {
396 audit_log_user_message_func(audit_fd, linuxAuditType, message,
397 NULL, NULL, NULL, result);
398 } else {
399 audit_send_user_message_func(audit_fd, linuxAuditType, message);
400 }
401 audit_close_func(audit_fd);
402 PR_smprintf_free(message);
403 }
404 #endif /* LINUX */
405 #else
406 /* do nothing */
407 #endif
408 }
411 /**********************************************************************
412 *
413 * Start of PKCS 11 functions
414 *
415 **********************************************************************/
416 /* return the function list */
417 CK_RV FC_GetFunctionList(CK_FUNCTION_LIST_PTR *pFunctionList) {
419 CHECK_FORK();
421 *pFunctionList = &sftk_fipsTable;
422 return CKR_OK;
423 }
425 /* sigh global so pkcs11 can read it */
426 PRBool nsf_init = PR_FALSE;
428 /* FC_Initialize initializes the PKCS #11 library. */
429 CK_RV FC_Initialize(CK_VOID_PTR pReserved) {
430 const char *envp;
431 CK_RV crv;
433 sftk_ForkReset(pReserved, &crv);
435 if (nsf_init) {
436 return CKR_CRYPTOKI_ALREADY_INITIALIZED;
437 }
439 if ((envp = PR_GetEnv("NSS_ENABLE_AUDIT")) != NULL) {
440 sftk_audit_enabled = (atoi(envp) == 1);
441 }
443 crv = nsc_CommonInitialize(pReserved, PR_TRUE);
445 /* not an 'else' rv can be set by either SFTK_LowInit or SFTK_SlotInit*/
446 if (crv != CKR_OK) {
447 sftk_fatalError = PR_TRUE;
448 return crv;
449 }
451 sftk_fatalError = PR_FALSE; /* any error has been reset */
453 crv = sftk_fipsPowerUpSelfTest();
454 if (crv != CKR_OK) {
455 nsc_CommonFinalize(NULL, PR_TRUE);
456 sftk_fatalError = PR_TRUE;
457 if (sftk_audit_enabled) {
458 char msg[128];
459 PR_snprintf(msg,sizeof msg,
460 "C_Initialize()=0x%08lX "
461 "power-up self-tests failed",
462 (PRUint32)crv);
463 sftk_LogAuditMessage(NSS_AUDIT_ERROR, NSS_AUDIT_SELF_TEST, msg);
464 }
465 return crv;
466 }
467 nsf_init = PR_TRUE;
469 return CKR_OK;
470 }
472 /*FC_Finalize indicates that an application is done with the PKCS #11 library.*/
473 CK_RV FC_Finalize (CK_VOID_PTR pReserved) {
474 CK_RV crv;
476 if (sftk_ForkReset(pReserved, &crv)) {
477 return crv;
478 }
480 if (!nsf_init) {
481 return CKR_OK;
482 }
484 crv = nsc_CommonFinalize (pReserved, PR_TRUE);
486 nsf_init = (PRBool) !(crv == CKR_OK);
487 return crv;
488 }
491 /* FC_GetInfo returns general information about PKCS #11. */
492 CK_RV FC_GetInfo(CK_INFO_PTR pInfo) {
493 CHECK_FORK();
495 return NSC_GetInfo(pInfo);
496 }
498 /* FC_GetSlotList obtains a list of slots in the system. */
499 CK_RV FC_GetSlotList(CK_BBOOL tokenPresent,
500 CK_SLOT_ID_PTR pSlotList, CK_ULONG_PTR pulCount) {
501 CHECK_FORK();
503 return nsc_CommonGetSlotList(tokenPresent,pSlotList,pulCount,
504 NSC_FIPS_MODULE);
505 }
507 /* FC_GetSlotInfo obtains information about a particular slot in the system. */
508 CK_RV FC_GetSlotInfo(CK_SLOT_ID slotID, CK_SLOT_INFO_PTR pInfo) {
509 CHECK_FORK();
511 return NSC_GetSlotInfo(slotID,pInfo);
512 }
515 /*FC_GetTokenInfo obtains information about a particular token in the system.*/
516 CK_RV FC_GetTokenInfo(CK_SLOT_ID slotID,CK_TOKEN_INFO_PTR pInfo) {
517 CK_RV crv;
519 CHECK_FORK();
521 crv = NSC_GetTokenInfo(slotID,pInfo);
522 if (crv == CKR_OK)
523 pInfo->flags |= CKF_LOGIN_REQUIRED;
524 return crv;
526 }
530 /*FC_GetMechanismList obtains a list of mechanism types supported by a token.*/
531 CK_RV FC_GetMechanismList(CK_SLOT_ID slotID,
532 CK_MECHANISM_TYPE_PTR pMechanismList, CK_ULONG_PTR pusCount) {
533 CHECK_FORK();
535 SFTK_FIPSFATALCHECK();
536 if (slotID == FIPS_SLOT_ID) slotID = NETSCAPE_SLOT_ID;
537 /* FIPS Slot supports all functions */
538 return NSC_GetMechanismList(slotID,pMechanismList,pusCount);
539 }
542 /* FC_GetMechanismInfo obtains information about a particular mechanism
543 * possibly supported by a token. */
544 CK_RV FC_GetMechanismInfo(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type,
545 CK_MECHANISM_INFO_PTR pInfo) {
546 CHECK_FORK();
548 SFTK_FIPSFATALCHECK();
549 if (slotID == FIPS_SLOT_ID) slotID = NETSCAPE_SLOT_ID;
550 /* FIPS Slot supports all functions */
551 return NSC_GetMechanismInfo(slotID,type,pInfo);
552 }
555 /* FC_InitToken initializes a token. */
556 CK_RV FC_InitToken(CK_SLOT_ID slotID,CK_CHAR_PTR pPin,
557 CK_ULONG usPinLen,CK_CHAR_PTR pLabel) {
558 CK_RV crv;
560 CHECK_FORK();
562 crv = NSC_InitToken(slotID,pPin,usPinLen,pLabel);
563 if (sftk_audit_enabled) {
564 char msg[128];
565 NSSAuditSeverity severity = (crv == CKR_OK) ?
566 NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
567 /* pLabel points to a 32-byte label, which is not null-terminated */
568 PR_snprintf(msg,sizeof msg,
569 "C_InitToken(slotID=%lu, pLabel=\"%.32s\")=0x%08lX",
570 (PRUint32)slotID,pLabel,(PRUint32)crv);
571 sftk_LogAuditMessage(severity, NSS_AUDIT_INIT_TOKEN, msg);
572 }
573 return crv;
574 }
577 /* FC_InitPIN initializes the normal user's PIN. */
578 CK_RV FC_InitPIN(CK_SESSION_HANDLE hSession,
579 CK_CHAR_PTR pPin, CK_ULONG ulPinLen) {
580 CK_RV rv;
582 CHECK_FORK();
584 if (sftk_fatalError) return CKR_DEVICE_ERROR;
585 if ((rv = sftk_newPinCheck(pPin,ulPinLen)) == CKR_OK) {
586 rv = NSC_InitPIN(hSession,pPin,ulPinLen);
587 }
588 if (sftk_audit_enabled) {
589 char msg[128];
590 NSSAuditSeverity severity = (rv == CKR_OK) ?
591 NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
592 PR_snprintf(msg,sizeof msg,
593 "C_InitPIN(hSession=0x%08lX)=0x%08lX",
594 (PRUint32)hSession,(PRUint32)rv);
595 sftk_LogAuditMessage(severity, NSS_AUDIT_INIT_PIN, msg);
596 }
597 return rv;
598 }
601 /* FC_SetPIN modifies the PIN of user that is currently logged in. */
602 /* NOTE: This is only valid for the PRIVATE_KEY_SLOT */
603 CK_RV FC_SetPIN(CK_SESSION_HANDLE hSession, CK_CHAR_PTR pOldPin,
604 CK_ULONG usOldLen, CK_CHAR_PTR pNewPin, CK_ULONG usNewLen) {
605 CK_RV rv;
607 CHECK_FORK();
609 if ((rv = sftk_fipsCheck()) == CKR_OK &&
610 (rv = sftk_newPinCheck(pNewPin,usNewLen)) == CKR_OK) {
611 rv = NSC_SetPIN(hSession,pOldPin,usOldLen,pNewPin,usNewLen);
612 }
613 if (sftk_audit_enabled) {
614 char msg[128];
615 NSSAuditSeverity severity = (rv == CKR_OK) ?
616 NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
617 PR_snprintf(msg,sizeof msg,
618 "C_SetPIN(hSession=0x%08lX)=0x%08lX",
619 (PRUint32)hSession,(PRUint32)rv);
620 sftk_LogAuditMessage(severity, NSS_AUDIT_SET_PIN, msg);
621 }
622 return rv;
623 }
625 /* FC_OpenSession opens a session between an application and a token. */
626 CK_RV FC_OpenSession(CK_SLOT_ID slotID, CK_FLAGS flags,
627 CK_VOID_PTR pApplication,CK_NOTIFY Notify,CK_SESSION_HANDLE_PTR phSession) {
628 SFTK_FIPSFATALCHECK();
630 CHECK_FORK();
632 return NSC_OpenSession(slotID,flags,pApplication,Notify,phSession);
633 }
636 /* FC_CloseSession closes a session between an application and a token. */
637 CK_RV FC_CloseSession(CK_SESSION_HANDLE hSession) {
638 CHECK_FORK();
640 return NSC_CloseSession(hSession);
641 }
644 /* FC_CloseAllSessions closes all sessions with a token. */
645 CK_RV FC_CloseAllSessions (CK_SLOT_ID slotID) {
647 CHECK_FORK();
649 return NSC_CloseAllSessions (slotID);
650 }
653 /* FC_GetSessionInfo obtains information about the session. */
654 CK_RV FC_GetSessionInfo(CK_SESSION_HANDLE hSession,
655 CK_SESSION_INFO_PTR pInfo) {
656 CK_RV rv;
657 SFTK_FIPSFATALCHECK();
659 CHECK_FORK();
661 rv = NSC_GetSessionInfo(hSession,pInfo);
662 if (rv == CKR_OK) {
663 if ((isLoggedIn) && (pInfo->state == CKS_RO_PUBLIC_SESSION)) {
664 pInfo->state = CKS_RO_USER_FUNCTIONS;
665 }
666 if ((isLoggedIn) && (pInfo->state == CKS_RW_PUBLIC_SESSION)) {
667 pInfo->state = CKS_RW_USER_FUNCTIONS;
668 }
669 }
670 return rv;
671 }
673 /* FC_Login logs a user into a token. */
674 CK_RV FC_Login(CK_SESSION_HANDLE hSession, CK_USER_TYPE userType,
675 CK_CHAR_PTR pPin, CK_ULONG usPinLen) {
676 CK_RV rv;
677 PRBool successful;
678 if (sftk_fatalError) return CKR_DEVICE_ERROR;
679 rv = NSC_Login(hSession,userType,pPin,usPinLen);
680 successful = (rv == CKR_OK) || (rv == CKR_USER_ALREADY_LOGGED_IN);
681 if (successful)
682 isLoggedIn = PR_TRUE;
683 if (sftk_audit_enabled) {
684 char msg[128];
685 NSSAuditSeverity severity;
686 severity = successful ? NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
687 PR_snprintf(msg,sizeof msg,
688 "C_Login(hSession=0x%08lX, userType=%lu)=0x%08lX",
689 (PRUint32)hSession,(PRUint32)userType,(PRUint32)rv);
690 sftk_LogAuditMessage(severity, NSS_AUDIT_LOGIN, msg);
691 }
692 return rv;
693 }
695 /* FC_Logout logs a user out from a token. */
696 CK_RV FC_Logout(CK_SESSION_HANDLE hSession) {
697 CK_RV rv;
699 CHECK_FORK();
701 if ((rv = sftk_fipsCheck()) == CKR_OK) {
702 rv = NSC_Logout(hSession);
703 isLoggedIn = PR_FALSE;
704 }
705 if (sftk_audit_enabled) {
706 char msg[128];
707 NSSAuditSeverity severity = (rv == CKR_OK) ?
708 NSS_AUDIT_INFO : NSS_AUDIT_ERROR;
709 PR_snprintf(msg,sizeof msg,
710 "C_Logout(hSession=0x%08lX)=0x%08lX",
711 (PRUint32)hSession,(PRUint32)rv);
712 sftk_LogAuditMessage(severity, NSS_AUDIT_LOGOUT, msg);
713 }
714 return rv;
715 }
718 /* FC_CreateObject creates a new object. */
719 CK_RV FC_CreateObject(CK_SESSION_HANDLE hSession,
720 CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount,
721 CK_OBJECT_HANDLE_PTR phObject) {
722 CK_OBJECT_CLASS * classptr;
724 SFTK_FIPSCHECK();
725 CHECK_FORK();
727 classptr = (CK_OBJECT_CLASS *)fc_getAttribute(pTemplate,ulCount,CKA_CLASS);
728 if (classptr == NULL) return CKR_TEMPLATE_INCOMPLETE;
730 /* FIPS can't create keys from raw key material */
731 if (SFTK_IS_NONPUBLIC_KEY_OBJECT(*classptr)) {
732 rv = CKR_ATTRIBUTE_VALUE_INVALID;
733 } else {
734 rv = NSC_CreateObject(hSession,pTemplate,ulCount,phObject);
735 }
736 if (sftk_audit_enabled && SFTK_IS_KEY_OBJECT(*classptr)) {
737 sftk_AuditCreateObject(hSession,pTemplate,ulCount,phObject,rv);
738 }
739 return rv;
740 }
746 /* FC_CopyObject copies an object, creating a new object for the copy. */
747 CK_RV FC_CopyObject(CK_SESSION_HANDLE hSession,
748 CK_OBJECT_HANDLE hObject, CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount,
749 CK_OBJECT_HANDLE_PTR phNewObject) {
750 CK_RV rv;
751 CK_OBJECT_CLASS objClass = CKO_NOT_A_KEY;
753 CHECK_FORK();
755 SFTK_FIPSFATALCHECK();
756 rv = sftk_get_object_class_and_fipsCheck(hSession, hObject, &objClass);
757 if (rv == CKR_OK) {
758 rv = NSC_CopyObject(hSession,hObject,pTemplate,ulCount,phNewObject);
759 }
760 if (sftk_audit_enabled && SFTK_IS_KEY_OBJECT(objClass)) {
761 sftk_AuditCopyObject(hSession,
762 hObject,pTemplate,ulCount,phNewObject,rv);
763 }
764 return rv;
765 }
768 /* FC_DestroyObject destroys an object. */
769 CK_RV FC_DestroyObject(CK_SESSION_HANDLE hSession,
770 CK_OBJECT_HANDLE hObject) {
771 CK_RV rv;
772 CK_OBJECT_CLASS objClass = CKO_NOT_A_KEY;
774 CHECK_FORK();
776 SFTK_FIPSFATALCHECK();
777 rv = sftk_get_object_class_and_fipsCheck(hSession, hObject, &objClass);
778 if (rv == CKR_OK) {
779 rv = NSC_DestroyObject(hSession,hObject);
780 }
781 if (sftk_audit_enabled && SFTK_IS_KEY_OBJECT(objClass)) {
782 sftk_AuditDestroyObject(hSession,hObject,rv);
783 }
784 return rv;
785 }
788 /* FC_GetObjectSize gets the size of an object in bytes. */
789 CK_RV FC_GetObjectSize(CK_SESSION_HANDLE hSession,
790 CK_OBJECT_HANDLE hObject, CK_ULONG_PTR pulSize) {
791 CK_RV rv;
792 CK_OBJECT_CLASS objClass = CKO_NOT_A_KEY;
794 CHECK_FORK();
796 SFTK_FIPSFATALCHECK();
797 rv = sftk_get_object_class_and_fipsCheck(hSession, hObject, &objClass);
798 if (rv == CKR_OK) {
799 rv = NSC_GetObjectSize(hSession, hObject, pulSize);
800 }
801 if (sftk_audit_enabled && SFTK_IS_KEY_OBJECT(objClass)) {
802 sftk_AuditGetObjectSize(hSession, hObject, pulSize, rv);
803 }
804 return rv;
805 }
808 /* FC_GetAttributeValue obtains the value of one or more object attributes. */
809 CK_RV FC_GetAttributeValue(CK_SESSION_HANDLE hSession,
810 CK_OBJECT_HANDLE hObject,CK_ATTRIBUTE_PTR pTemplate,CK_ULONG ulCount) {
811 CK_RV rv;
812 CK_OBJECT_CLASS objClass = CKO_NOT_A_KEY;
814 CHECK_FORK();
816 SFTK_FIPSFATALCHECK();
817 rv = sftk_get_object_class_and_fipsCheck(hSession, hObject, &objClass);
818 if (rv == CKR_OK) {
819 rv = NSC_GetAttributeValue(hSession,hObject,pTemplate,ulCount);
820 }
821 if (sftk_audit_enabled && SFTK_IS_KEY_OBJECT(objClass)) {
822 sftk_AuditGetAttributeValue(hSession,hObject,pTemplate,ulCount,rv);
823 }
824 return rv;
825 }
828 /* FC_SetAttributeValue modifies the value of one or more object attributes */
829 CK_RV FC_SetAttributeValue (CK_SESSION_HANDLE hSession,
830 CK_OBJECT_HANDLE hObject,CK_ATTRIBUTE_PTR pTemplate,CK_ULONG ulCount) {
831 CK_RV rv;
832 CK_OBJECT_CLASS objClass = CKO_NOT_A_KEY;
834 CHECK_FORK();
836 SFTK_FIPSFATALCHECK();
837 rv = sftk_get_object_class_and_fipsCheck(hSession, hObject, &objClass);
838 if (rv == CKR_OK) {
839 rv = NSC_SetAttributeValue(hSession,hObject,pTemplate,ulCount);
840 }
841 if (sftk_audit_enabled && SFTK_IS_KEY_OBJECT(objClass)) {
842 sftk_AuditSetAttributeValue(hSession,hObject,pTemplate,ulCount,rv);
843 }
844 return rv;
845 }
849 /* FC_FindObjectsInit initializes a search for token and session objects
850 * that match a template. */
851 CK_RV FC_FindObjectsInit(CK_SESSION_HANDLE hSession,
852 CK_ATTRIBUTE_PTR pTemplate,CK_ULONG usCount) {
853 /* let publically readable object be found */
854 unsigned int i;
855 CK_RV rv;
856 PRBool needLogin = PR_FALSE;
859 CHECK_FORK();
861 SFTK_FIPSFATALCHECK();
863 for (i=0; i < usCount; i++) {
864 CK_OBJECT_CLASS class;
865 if (pTemplate[i].type != CKA_CLASS) {
866 continue;
867 }
868 if (pTemplate[i].ulValueLen != sizeof(CK_OBJECT_CLASS)) {
869 continue;
870 }
871 if (pTemplate[i].pValue == NULL) {
872 continue;
873 }
874 class = *(CK_OBJECT_CLASS *)pTemplate[i].pValue;
875 if ((class == CKO_PRIVATE_KEY) || (class == CKO_SECRET_KEY)) {
876 needLogin = PR_TRUE;
877 break;
878 }
879 }
880 if (needLogin) {
881 if ((rv = sftk_fipsCheck()) != CKR_OK) return rv;
882 }
883 return NSC_FindObjectsInit(hSession,pTemplate,usCount);
884 }
887 /* FC_FindObjects continues a search for token and session objects
888 * that match a template, obtaining additional object handles. */
889 CK_RV FC_FindObjects(CK_SESSION_HANDLE hSession,
890 CK_OBJECT_HANDLE_PTR phObject,CK_ULONG usMaxObjectCount,
891 CK_ULONG_PTR pusObjectCount) {
892 CHECK_FORK();
894 /* let publically readable object be found */
895 SFTK_FIPSFATALCHECK();
896 return NSC_FindObjects(hSession,phObject,usMaxObjectCount,
897 pusObjectCount);
898 }
901 /*
902 ************** Crypto Functions: Encrypt ************************
903 */
905 /* FC_EncryptInit initializes an encryption operation. */
906 CK_RV FC_EncryptInit(CK_SESSION_HANDLE hSession,
907 CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey) {
908 SFTK_FIPSCHECK();
909 CHECK_FORK();
911 rv = NSC_EncryptInit(hSession,pMechanism,hKey);
912 if (sftk_audit_enabled) {
913 sftk_AuditCryptInit("Encrypt",hSession,pMechanism,hKey,rv);
914 }
915 return rv;
916 }
918 /* FC_Encrypt encrypts single-part data. */
919 CK_RV FC_Encrypt (CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData,
920 CK_ULONG usDataLen, CK_BYTE_PTR pEncryptedData,
921 CK_ULONG_PTR pusEncryptedDataLen) {
922 SFTK_FIPSCHECK();
923 CHECK_FORK();
925 return NSC_Encrypt(hSession,pData,usDataLen,pEncryptedData,
926 pusEncryptedDataLen);
927 }
930 /* FC_EncryptUpdate continues a multiple-part encryption operation. */
931 CK_RV FC_EncryptUpdate(CK_SESSION_HANDLE hSession,
932 CK_BYTE_PTR pPart, CK_ULONG usPartLen, CK_BYTE_PTR pEncryptedPart,
933 CK_ULONG_PTR pusEncryptedPartLen) {
934 SFTK_FIPSCHECK();
935 CHECK_FORK();
937 return NSC_EncryptUpdate(hSession,pPart,usPartLen,pEncryptedPart,
938 pusEncryptedPartLen);
939 }
942 /* FC_EncryptFinal finishes a multiple-part encryption operation. */
943 CK_RV FC_EncryptFinal(CK_SESSION_HANDLE hSession,
944 CK_BYTE_PTR pLastEncryptedPart, CK_ULONG_PTR pusLastEncryptedPartLen) {
945 SFTK_FIPSCHECK();
946 CHECK_FORK();
948 return NSC_EncryptFinal(hSession,pLastEncryptedPart,
949 pusLastEncryptedPartLen);
950 }
952 /*
953 ************** Crypto Functions: Decrypt ************************
954 */
957 /* FC_DecryptInit initializes a decryption operation. */
958 CK_RV FC_DecryptInit( CK_SESSION_HANDLE hSession,
959 CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey) {
960 SFTK_FIPSCHECK();
961 CHECK_FORK();
963 rv = NSC_DecryptInit(hSession,pMechanism,hKey);
964 if (sftk_audit_enabled) {
965 sftk_AuditCryptInit("Decrypt",hSession,pMechanism,hKey,rv);
966 }
967 return rv;
968 }
970 /* FC_Decrypt decrypts encrypted data in a single part. */
971 CK_RV FC_Decrypt(CK_SESSION_HANDLE hSession,
972 CK_BYTE_PTR pEncryptedData,CK_ULONG usEncryptedDataLen,CK_BYTE_PTR pData,
973 CK_ULONG_PTR pusDataLen) {
974 SFTK_FIPSCHECK();
975 CHECK_FORK();
977 return NSC_Decrypt(hSession,pEncryptedData,usEncryptedDataLen,pData,
978 pusDataLen);
979 }
982 /* FC_DecryptUpdate continues a multiple-part decryption operation. */
983 CK_RV FC_DecryptUpdate(CK_SESSION_HANDLE hSession,
984 CK_BYTE_PTR pEncryptedPart, CK_ULONG usEncryptedPartLen,
985 CK_BYTE_PTR pPart, CK_ULONG_PTR pusPartLen) {
986 SFTK_FIPSCHECK();
987 CHECK_FORK();
989 return NSC_DecryptUpdate(hSession,pEncryptedPart,usEncryptedPartLen,
990 pPart,pusPartLen);
991 }
994 /* FC_DecryptFinal finishes a multiple-part decryption operation. */
995 CK_RV FC_DecryptFinal(CK_SESSION_HANDLE hSession,
996 CK_BYTE_PTR pLastPart, CK_ULONG_PTR pusLastPartLen) {
997 SFTK_FIPSCHECK();
998 CHECK_FORK();
1000 return NSC_DecryptFinal(hSession,pLastPart,pusLastPartLen);
1001 }
1004 /*
1005 ************** Crypto Functions: Digest (HASH) ************************
1006 */
1008 /* FC_DigestInit initializes a message-digesting operation. */
1009 CK_RV FC_DigestInit(CK_SESSION_HANDLE hSession,
1010 CK_MECHANISM_PTR pMechanism) {
1011 SFTK_FIPSFATALCHECK();
1012 CHECK_FORK();
1014 return NSC_DigestInit(hSession, pMechanism);
1015 }
1018 /* FC_Digest digests data in a single part. */
1019 CK_RV FC_Digest(CK_SESSION_HANDLE hSession,
1020 CK_BYTE_PTR pData, CK_ULONG usDataLen, CK_BYTE_PTR pDigest,
1021 CK_ULONG_PTR pusDigestLen) {
1022 SFTK_FIPSFATALCHECK();
1023 CHECK_FORK();
1025 return NSC_Digest(hSession,pData,usDataLen,pDigest,pusDigestLen);
1026 }
1029 /* FC_DigestUpdate continues a multiple-part message-digesting operation. */
1030 CK_RV FC_DigestUpdate(CK_SESSION_HANDLE hSession,CK_BYTE_PTR pPart,
1031 CK_ULONG usPartLen) {
1032 SFTK_FIPSFATALCHECK();
1033 CHECK_FORK();
1035 return NSC_DigestUpdate(hSession,pPart,usPartLen);
1036 }
1039 /* FC_DigestFinal finishes a multiple-part message-digesting operation. */
1040 CK_RV FC_DigestFinal(CK_SESSION_HANDLE hSession,CK_BYTE_PTR pDigest,
1041 CK_ULONG_PTR pusDigestLen) {
1042 SFTK_FIPSFATALCHECK();
1043 CHECK_FORK();
1045 return NSC_DigestFinal(hSession,pDigest,pusDigestLen);
1046 }
1049 /*
1050 ************** Crypto Functions: Sign ************************
1051 */
1053 /* FC_SignInit initializes a signature (private key encryption) operation,
1054 * where the signature is (will be) an appendix to the data,
1055 * and plaintext cannot be recovered from the signature */
1056 CK_RV FC_SignInit(CK_SESSION_HANDLE hSession,
1057 CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey) {
1058 SFTK_FIPSCHECK();
1059 CHECK_FORK();
1061 rv = NSC_SignInit(hSession,pMechanism,hKey);
1062 if (sftk_audit_enabled) {
1063 sftk_AuditCryptInit("Sign",hSession,pMechanism,hKey,rv);
1064 }
1065 return rv;
1066 }
1069 /* FC_Sign signs (encrypts with private key) data in a single part,
1070 * where the signature is (will be) an appendix to the data,
1071 * and plaintext cannot be recovered from the signature */
1072 CK_RV FC_Sign(CK_SESSION_HANDLE hSession,
1073 CK_BYTE_PTR pData,CK_ULONG usDataLen,CK_BYTE_PTR pSignature,
1074 CK_ULONG_PTR pusSignatureLen) {
1075 SFTK_FIPSCHECK();
1076 CHECK_FORK();
1078 return NSC_Sign(hSession,pData,usDataLen,pSignature,pusSignatureLen);
1079 }
1082 /* FC_SignUpdate continues a multiple-part signature operation,
1083 * where the signature is (will be) an appendix to the data,
1084 * and plaintext cannot be recovered from the signature */
1085 CK_RV FC_SignUpdate(CK_SESSION_HANDLE hSession,CK_BYTE_PTR pPart,
1086 CK_ULONG usPartLen) {
1087 SFTK_FIPSCHECK();
1088 CHECK_FORK();
1090 return NSC_SignUpdate(hSession,pPart,usPartLen);
1091 }
1094 /* FC_SignFinal finishes a multiple-part signature operation,
1095 * returning the signature. */
1096 CK_RV FC_SignFinal(CK_SESSION_HANDLE hSession,CK_BYTE_PTR pSignature,
1097 CK_ULONG_PTR pusSignatureLen) {
1098 SFTK_FIPSCHECK();
1099 CHECK_FORK();
1101 return NSC_SignFinal(hSession,pSignature,pusSignatureLen);
1102 }
1104 /*
1105 ************** Crypto Functions: Sign Recover ************************
1106 */
1107 /* FC_SignRecoverInit initializes a signature operation,
1108 * where the (digest) data can be recovered from the signature.
1109 * E.g. encryption with the user's private key */
1110 CK_RV FC_SignRecoverInit(CK_SESSION_HANDLE hSession,
1111 CK_MECHANISM_PTR pMechanism,CK_OBJECT_HANDLE hKey) {
1112 SFTK_FIPSCHECK();
1113 CHECK_FORK();
1115 rv = NSC_SignRecoverInit(hSession,pMechanism,hKey);
1116 if (sftk_audit_enabled) {
1117 sftk_AuditCryptInit("SignRecover",hSession,pMechanism,hKey,rv);
1118 }
1119 return rv;
1120 }
1123 /* FC_SignRecover signs data in a single operation
1124 * where the (digest) data can be recovered from the signature.
1125 * E.g. encryption with the user's private key */
1126 CK_RV FC_SignRecover(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData,
1127 CK_ULONG usDataLen, CK_BYTE_PTR pSignature, CK_ULONG_PTR pusSignatureLen) {
1128 SFTK_FIPSCHECK();
1129 CHECK_FORK();
1131 return NSC_SignRecover(hSession,pData,usDataLen,pSignature,pusSignatureLen);
1132 }
1134 /*
1135 ************** Crypto Functions: verify ************************
1136 */
1138 /* FC_VerifyInit initializes a verification operation,
1139 * where the signature is an appendix to the data,
1140 * and plaintext cannot be recovered from the signature (e.g. DSA) */
1141 CK_RV FC_VerifyInit(CK_SESSION_HANDLE hSession,
1142 CK_MECHANISM_PTR pMechanism,CK_OBJECT_HANDLE hKey) {
1143 SFTK_FIPSCHECK();
1144 CHECK_FORK();
1146 rv = NSC_VerifyInit(hSession,pMechanism,hKey);
1147 if (sftk_audit_enabled) {
1148 sftk_AuditCryptInit("Verify",hSession,pMechanism,hKey,rv);
1149 }
1150 return rv;
1151 }
1154 /* FC_Verify verifies a signature in a single-part operation,
1155 * where the signature is an appendix to the data,
1156 * and plaintext cannot be recovered from the signature */
1157 CK_RV FC_Verify(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData,
1158 CK_ULONG usDataLen, CK_BYTE_PTR pSignature, CK_ULONG usSignatureLen) {
1159 /* make sure we're legal */
1160 SFTK_FIPSCHECK();
1161 CHECK_FORK();
1163 return NSC_Verify(hSession,pData,usDataLen,pSignature,usSignatureLen);
1164 }
1167 /* FC_VerifyUpdate continues a multiple-part verification operation,
1168 * where the signature is an appendix to the data,
1169 * and plaintext cannot be recovered from the signature */
1170 CK_RV FC_VerifyUpdate( CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart,
1171 CK_ULONG usPartLen) {
1172 SFTK_FIPSCHECK();
1173 CHECK_FORK();
1175 return NSC_VerifyUpdate(hSession,pPart,usPartLen);
1176 }
1179 /* FC_VerifyFinal finishes a multiple-part verification operation,
1180 * checking the signature. */
1181 CK_RV FC_VerifyFinal(CK_SESSION_HANDLE hSession,
1182 CK_BYTE_PTR pSignature,CK_ULONG usSignatureLen) {
1183 SFTK_FIPSCHECK();
1184 CHECK_FORK();
1186 return NSC_VerifyFinal(hSession,pSignature,usSignatureLen);
1187 }
1189 /*
1190 ************** Crypto Functions: Verify Recover ************************
1191 */
1193 /* FC_VerifyRecoverInit initializes a signature verification operation,
1194 * where the data is recovered from the signature.
1195 * E.g. Decryption with the user's public key */
1196 CK_RV FC_VerifyRecoverInit(CK_SESSION_HANDLE hSession,
1197 CK_MECHANISM_PTR pMechanism,CK_OBJECT_HANDLE hKey) {
1198 SFTK_FIPSCHECK();
1199 CHECK_FORK();
1201 rv = NSC_VerifyRecoverInit(hSession,pMechanism,hKey);
1202 if (sftk_audit_enabled) {
1203 sftk_AuditCryptInit("VerifyRecover",hSession,pMechanism,hKey,rv);
1204 }
1205 return rv;
1206 }
1209 /* FC_VerifyRecover verifies a signature in a single-part operation,
1210 * where the data is recovered from the signature.
1211 * E.g. Decryption with the user's public key */
1212 CK_RV FC_VerifyRecover(CK_SESSION_HANDLE hSession,
1213 CK_BYTE_PTR pSignature,CK_ULONG usSignatureLen,
1214 CK_BYTE_PTR pData,CK_ULONG_PTR pusDataLen) {
1215 SFTK_FIPSCHECK();
1216 CHECK_FORK();
1218 return NSC_VerifyRecover(hSession,pSignature,usSignatureLen,pData,
1219 pusDataLen);
1220 }
1222 /*
1223 **************************** Key Functions: ************************
1224 */
1226 /* FC_GenerateKey generates a secret key, creating a new key object. */
1227 CK_RV FC_GenerateKey(CK_SESSION_HANDLE hSession,
1228 CK_MECHANISM_PTR pMechanism,CK_ATTRIBUTE_PTR pTemplate,CK_ULONG ulCount,
1229 CK_OBJECT_HANDLE_PTR phKey) {
1230 CK_BBOOL *boolptr;
1232 SFTK_FIPSCHECK();
1233 CHECK_FORK();
1235 /* all secret keys must be sensitive, if the upper level code tries to say
1236 * otherwise, reject it. */
1237 boolptr = (CK_BBOOL *) fc_getAttribute(pTemplate, ulCount, CKA_SENSITIVE);
1238 if (boolptr != NULL) {
1239 if (!(*boolptr)) {
1240 return CKR_ATTRIBUTE_VALUE_INVALID;
1241 }
1242 }
1244 rv = NSC_GenerateKey(hSession,pMechanism,pTemplate,ulCount,phKey);
1245 if (sftk_audit_enabled) {
1246 sftk_AuditGenerateKey(hSession,pMechanism,pTemplate,ulCount,phKey,rv);
1247 }
1248 return rv;
1249 }
1252 /* FC_GenerateKeyPair generates a public-key/private-key pair,
1253 * creating new key objects. */
1254 CK_RV FC_GenerateKeyPair (CK_SESSION_HANDLE hSession,
1255 CK_MECHANISM_PTR pMechanism, CK_ATTRIBUTE_PTR pPublicKeyTemplate,
1256 CK_ULONG usPublicKeyAttributeCount, CK_ATTRIBUTE_PTR pPrivateKeyTemplate,
1257 CK_ULONG usPrivateKeyAttributeCount, CK_OBJECT_HANDLE_PTR phPublicKey,
1258 CK_OBJECT_HANDLE_PTR phPrivateKey) {
1259 CK_BBOOL *boolptr;
1260 CK_RV crv;
1262 SFTK_FIPSCHECK();
1263 CHECK_FORK();
1266 /* all private keys must be sensitive, if the upper level code tries to say
1267 * otherwise, reject it. */
1268 boolptr = (CK_BBOOL *) fc_getAttribute(pPrivateKeyTemplate,
1269 usPrivateKeyAttributeCount, CKA_SENSITIVE);
1270 if (boolptr != NULL) {
1271 if (!(*boolptr)) {
1272 return CKR_ATTRIBUTE_VALUE_INVALID;
1273 }
1274 }
1275 crv = NSC_GenerateKeyPair (hSession,pMechanism,pPublicKeyTemplate,
1276 usPublicKeyAttributeCount,pPrivateKeyTemplate,
1277 usPrivateKeyAttributeCount,phPublicKey,phPrivateKey);
1278 if (crv == CKR_GENERAL_ERROR) {
1279 /* pairwise consistency check failed. */
1280 sftk_fatalError = PR_TRUE;
1281 }
1282 if (sftk_audit_enabled) {
1283 sftk_AuditGenerateKeyPair(hSession,pMechanism,pPublicKeyTemplate,
1284 usPublicKeyAttributeCount,pPrivateKeyTemplate,
1285 usPrivateKeyAttributeCount,phPublicKey,phPrivateKey,crv);
1286 }
1287 return crv;
1288 }
1291 /* FC_WrapKey wraps (i.e., encrypts) a key. */
1292 CK_RV FC_WrapKey(CK_SESSION_HANDLE hSession,
1293 CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hWrappingKey,
1294 CK_OBJECT_HANDLE hKey, CK_BYTE_PTR pWrappedKey,
1295 CK_ULONG_PTR pulWrappedKeyLen) {
1296 SFTK_FIPSCHECK();
1297 CHECK_FORK();
1299 rv = NSC_WrapKey(hSession,pMechanism,hWrappingKey,hKey,pWrappedKey,
1300 pulWrappedKeyLen);
1301 if (sftk_audit_enabled) {
1302 sftk_AuditWrapKey(hSession,pMechanism,hWrappingKey,hKey,pWrappedKey,
1303 pulWrappedKeyLen,rv);
1304 }
1305 return rv;
1306 }
1309 /* FC_UnwrapKey unwraps (decrypts) a wrapped key, creating a new key object. */
1310 CK_RV FC_UnwrapKey(CK_SESSION_HANDLE hSession,
1311 CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hUnwrappingKey,
1312 CK_BYTE_PTR pWrappedKey, CK_ULONG ulWrappedKeyLen,
1313 CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulAttributeCount,
1314 CK_OBJECT_HANDLE_PTR phKey) {
1315 CK_BBOOL *boolptr;
1317 SFTK_FIPSCHECK();
1318 CHECK_FORK();
1320 /* all secret keys must be sensitive, if the upper level code tries to say
1321 * otherwise, reject it. */
1322 boolptr = (CK_BBOOL *) fc_getAttribute(pTemplate,
1323 ulAttributeCount, CKA_SENSITIVE);
1324 if (boolptr != NULL) {
1325 if (!(*boolptr)) {
1326 return CKR_ATTRIBUTE_VALUE_INVALID;
1327 }
1328 }
1329 rv = NSC_UnwrapKey(hSession,pMechanism,hUnwrappingKey,pWrappedKey,
1330 ulWrappedKeyLen,pTemplate,ulAttributeCount,phKey);
1331 if (sftk_audit_enabled) {
1332 sftk_AuditUnwrapKey(hSession,pMechanism,hUnwrappingKey,pWrappedKey,
1333 ulWrappedKeyLen,pTemplate,ulAttributeCount,phKey,rv);
1334 }
1335 return rv;
1336 }
1339 /* FC_DeriveKey derives a key from a base key, creating a new key object. */
1340 CK_RV FC_DeriveKey( CK_SESSION_HANDLE hSession,
1341 CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hBaseKey,
1342 CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulAttributeCount,
1343 CK_OBJECT_HANDLE_PTR phKey) {
1344 CK_BBOOL *boolptr;
1346 SFTK_FIPSCHECK();
1347 CHECK_FORK();
1349 /* all secret keys must be sensitive, if the upper level code tries to say
1350 * otherwise, reject it. */
1351 boolptr = (CK_BBOOL *) fc_getAttribute(pTemplate,
1352 ulAttributeCount, CKA_SENSITIVE);
1353 if (boolptr != NULL) {
1354 if (!(*boolptr)) {
1355 return CKR_ATTRIBUTE_VALUE_INVALID;
1356 }
1357 }
1358 rv = NSC_DeriveKey(hSession,pMechanism,hBaseKey,pTemplate,
1359 ulAttributeCount, phKey);
1360 if (sftk_audit_enabled) {
1361 sftk_AuditDeriveKey(hSession,pMechanism,hBaseKey,pTemplate,
1362 ulAttributeCount,phKey,rv);
1363 }
1364 return rv;
1365 }
1367 /*
1368 **************************** Radom Functions: ************************
1369 */
1371 /* FC_SeedRandom mixes additional seed material into the token's random number
1372 * generator. */
1373 CK_RV FC_SeedRandom(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pSeed,
1374 CK_ULONG usSeedLen) {
1375 CK_RV crv;
1377 SFTK_FIPSFATALCHECK();
1378 CHECK_FORK();
1380 crv = NSC_SeedRandom(hSession,pSeed,usSeedLen);
1381 if (crv != CKR_OK) {
1382 sftk_fatalError = PR_TRUE;
1383 }
1384 return crv;
1385 }
1388 /* FC_GenerateRandom generates random data. */
1389 CK_RV FC_GenerateRandom(CK_SESSION_HANDLE hSession,
1390 CK_BYTE_PTR pRandomData, CK_ULONG ulRandomLen) {
1391 CK_RV crv;
1393 CHECK_FORK();
1395 SFTK_FIPSFATALCHECK();
1396 crv = NSC_GenerateRandom(hSession,pRandomData,ulRandomLen);
1397 if (crv != CKR_OK) {
1398 sftk_fatalError = PR_TRUE;
1399 if (sftk_audit_enabled) {
1400 char msg[128];
1401 PR_snprintf(msg,sizeof msg,
1402 "C_GenerateRandom(hSession=0x%08lX, pRandomData=%p, "
1403 "ulRandomLen=%lu)=0x%08lX "
1404 "self-test: continuous RNG test failed",
1405 (PRUint32)hSession,pRandomData,
1406 (PRUint32)ulRandomLen,(PRUint32)crv);
1407 sftk_LogAuditMessage(NSS_AUDIT_ERROR, NSS_AUDIT_SELF_TEST, msg);
1408 }
1409 }
1410 return crv;
1411 }
1414 /* FC_GetFunctionStatus obtains an updated status of a function running
1415 * in parallel with an application. */
1416 CK_RV FC_GetFunctionStatus(CK_SESSION_HANDLE hSession) {
1417 SFTK_FIPSCHECK();
1418 CHECK_FORK();
1420 return NSC_GetFunctionStatus(hSession);
1421 }
1424 /* FC_CancelFunction cancels a function running in parallel */
1425 CK_RV FC_CancelFunction(CK_SESSION_HANDLE hSession) {
1426 SFTK_FIPSCHECK();
1427 CHECK_FORK();
1429 return NSC_CancelFunction(hSession);
1430 }
1432 /*
1433 **************************** Version 1.1 Functions: ************************
1434 */
1436 /* FC_GetOperationState saves the state of the cryptographic
1437 *operation in a session. */
1438 CK_RV FC_GetOperationState(CK_SESSION_HANDLE hSession,
1439 CK_BYTE_PTR pOperationState, CK_ULONG_PTR pulOperationStateLen) {
1440 SFTK_FIPSFATALCHECK();
1441 CHECK_FORK();
1443 return NSC_GetOperationState(hSession,pOperationState,pulOperationStateLen);
1444 }
1447 /* FC_SetOperationState restores the state of the cryptographic operation
1448 * in a session. */
1449 CK_RV FC_SetOperationState(CK_SESSION_HANDLE hSession,
1450 CK_BYTE_PTR pOperationState, CK_ULONG ulOperationStateLen,
1451 CK_OBJECT_HANDLE hEncryptionKey, CK_OBJECT_HANDLE hAuthenticationKey) {
1452 SFTK_FIPSFATALCHECK();
1453 CHECK_FORK();
1455 return NSC_SetOperationState(hSession,pOperationState,ulOperationStateLen,
1456 hEncryptionKey,hAuthenticationKey);
1457 }
1459 /* FC_FindObjectsFinal finishes a search for token and session objects. */
1460 CK_RV FC_FindObjectsFinal(CK_SESSION_HANDLE hSession) {
1461 /* let publically readable object be found */
1462 SFTK_FIPSFATALCHECK();
1463 CHECK_FORK();
1465 return NSC_FindObjectsFinal(hSession);
1466 }
1469 /* Dual-function cryptographic operations */
1471 /* FC_DigestEncryptUpdate continues a multiple-part digesting and encryption
1472 * operation. */
1473 CK_RV FC_DigestEncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart,
1474 CK_ULONG ulPartLen, CK_BYTE_PTR pEncryptedPart,
1475 CK_ULONG_PTR pulEncryptedPartLen) {
1476 SFTK_FIPSCHECK();
1477 CHECK_FORK();
1479 return NSC_DigestEncryptUpdate(hSession,pPart,ulPartLen,pEncryptedPart,
1480 pulEncryptedPartLen);
1481 }
1484 /* FC_DecryptDigestUpdate continues a multiple-part decryption and digesting
1485 * operation. */
1486 CK_RV FC_DecryptDigestUpdate(CK_SESSION_HANDLE hSession,
1487 CK_BYTE_PTR pEncryptedPart, CK_ULONG ulEncryptedPartLen,
1488 CK_BYTE_PTR pPart, CK_ULONG_PTR pulPartLen) {
1489 SFTK_FIPSCHECK();
1490 CHECK_FORK();
1492 return NSC_DecryptDigestUpdate(hSession, pEncryptedPart,ulEncryptedPartLen,
1493 pPart,pulPartLen);
1494 }
1496 /* FC_SignEncryptUpdate continues a multiple-part signing and encryption
1497 * operation. */
1498 CK_RV FC_SignEncryptUpdate(CK_SESSION_HANDLE hSession, CK_BYTE_PTR pPart,
1499 CK_ULONG ulPartLen, CK_BYTE_PTR pEncryptedPart,
1500 CK_ULONG_PTR pulEncryptedPartLen) {
1501 SFTK_FIPSCHECK();
1502 CHECK_FORK();
1504 return NSC_SignEncryptUpdate(hSession,pPart,ulPartLen,pEncryptedPart,
1505 pulEncryptedPartLen);
1506 }
1508 /* FC_DecryptVerifyUpdate continues a multiple-part decryption and verify
1509 * operation. */
1510 CK_RV FC_DecryptVerifyUpdate(CK_SESSION_HANDLE hSession,
1511 CK_BYTE_PTR pEncryptedData, CK_ULONG ulEncryptedDataLen,
1512 CK_BYTE_PTR pData, CK_ULONG_PTR pulDataLen) {
1513 SFTK_FIPSCHECK();
1514 CHECK_FORK();
1516 return NSC_DecryptVerifyUpdate(hSession,pEncryptedData,ulEncryptedDataLen,
1517 pData,pulDataLen);
1518 }
1521 /* FC_DigestKey continues a multi-part message-digesting operation,
1522 * by digesting the value of a secret key as part of the data already digested.
1523 */
1524 CK_RV FC_DigestKey(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hKey) {
1525 SFTK_FIPSCHECK();
1526 CHECK_FORK();
1528 rv = NSC_DigestKey(hSession,hKey);
1529 if (sftk_audit_enabled) {
1530 sftk_AuditDigestKey(hSession,hKey,rv);
1531 }
1532 return rv;
1533 }
1536 CK_RV FC_WaitForSlotEvent(CK_FLAGS flags, CK_SLOT_ID_PTR pSlot,
1537 CK_VOID_PTR pReserved)
1538 {
1539 CHECK_FORK();
1541 return NSC_WaitForSlotEvent(flags, pSlot, pReserved);
1542 }
