File: coolkey.cpp

package info (click to toggle)
coolkey 1.1.0-13
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch
  • size: 3,552 kB
  • sloc: sh: 8,197; cpp: 6,934; ansic: 4,384; makefile: 113
file content (660 lines) | stat: -rw-r--r-- 21,042 bytes parent folder | download | duplicates (4)
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
/* ***** BEGIN COPYRIGHT BLOCK *****
 * Copyright (C) 2005 Red Hat, Inc.
 * All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation version
 * 2.1 of the License.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * ***** END COPYRIGHT BLOCK *****/

#include "mypkcs11.h"

#include <assert.h>
#include <string>
#include <map>
#include <set>
#include <memory>
#include "log.h"
#include "PKCS11Exception.h"
#ifdef _WIN32
#include <windows.h>
#endif
#include <winscard.h>
#include "slot.h"
#include "cky_base.h"
#include "params.h"

#define NULL 0

/* static module data --------------------------------  */

static Log *log = NULL;

static SlotList *slotList = NULL;

static OSLock *finalizeLock = NULL;
#define FINALIZE_GETLOCK() if (finalizeLock) finalizeLock->getLock();
#define FINALIZE_RELEASELOCK() if (finalizeLock) finalizeLock->releaseLock();

static CK_BBOOL initialized = FALSE;
static CK_BBOOL finalizing = FALSE;
static CK_BBOOL waitEvent = FALSE;

char *Params::params = NULL;

// manufacturerID and libraryDescription should not be NULL-terminated,
// so the last character is overwritten with a blank in C_GetInfo().
static CK_INFO ckInfo = {
    {2, 11},
    "Mozilla Foundation             ",
    0,
    "CoolKey PKCS #11 Module     ",
    {1, 0}
};

typedef struct {
    CK_MECHANISM_TYPE mech;
    CK_MECHANISM_INFO info;
} MechInfo;

/**********************************************************************
 ************************** MECHANISM TABLE ***************************
 **********************************************************************/
static MechInfo
mechanismList[] = {
    {CKM_RSA_PKCS, { 1024, 4096, CKF_HW | CKF_SIGN | CKF_DECRYPT } }
};
static unsigned int numMechanisms = sizeof(mechanismList)/sizeof(MechInfo);

/* ------------------------------------------------------------ */

void
dumpTemplates(CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount)
{
    // no try here, let caller catch it.  try {
    unsigned long i;
    if (!pTemplate) 
	return;
    for (i = 0; i < ulCount; ++i) {
	CK_ATTRIBUTE_PTR pT = pTemplate + i;
	if (pT->pValue && pT->ulValueLen == 4) {
	    log->log(
	    "template [%02lu] type: %04lx, pValue: %08lx, ulValueLen: %08lx, value: %lu\n", 
	             i, pT->type, pT->pValue, pT->ulValueLen, *(CK_ULONG_PTR)pT->pValue);
	} else 
	    log->log("template [%02lu] type: %04lx, pValue: %08lx, ulValueLen: %08lx\n", 
	             i, pT->type, pT->pValue, pT->ulValueLen);
    }
}

/* PKCS11 defined functions ----------------------------------- */


#define NOTSUPPORTED(name, args) \
CK_RV name args \
{ \
    log->log(#name " called (notSupported)\n"); \
    return CKR_FUNCTION_NOT_SUPPORTED; \
}

#define SUPPORTED(name, name2, dec_args, use_args) \
CK_RV name dec_args \
{ \
    if( ! initialized ) { \
        return CKR_CRYPTOKI_NOT_INITIALIZED; \
    } \
    try { \
	log->log(#name " called\n"); \
	slotList->name2 use_args ; \
	return CKR_OK; \
    } catch(PKCS11Exception& e) { \
        e.log(log); \
        return e.getCRV(); \
    } \
}



extern "C" {

NOTSUPPORTED(C_InitToken,(CK_SLOT_ID, CK_CHAR_PTR, CK_ULONG, CK_UTF8CHAR_PTR))
NOTSUPPORTED(C_InitPIN,  (CK_SESSION_HANDLE, CK_CHAR_PTR, CK_ULONG))
NOTSUPPORTED(C_SetPIN,   (CK_SESSION_HANDLE, CK_CHAR_PTR, CK_ULONG, CK_CHAR_PTR, CK_ULONG))
NOTSUPPORTED(C_GetOperationState, (CK_SESSION_HANDLE, CK_BYTE_PTR, CK_ULONG_PTR))
NOTSUPPORTED(C_SetOperationState, (CK_SESSION_HANDLE, CK_BYTE_PTR, CK_ULONG, CK_OBJECT_HANDLE, CK_OBJECT_HANDLE))
NOTSUPPORTED(C_CreateObject, (CK_SESSION_HANDLE, CK_ATTRIBUTE_PTR, CK_ULONG, CK_OBJECT_HANDLE_PTR))
NOTSUPPORTED(C_CopyObject, (CK_SESSION_HANDLE,CK_OBJECT_HANDLE,CK_ATTRIBUTE_PTR,CK_ULONG,CK_OBJECT_HANDLE_PTR))
NOTSUPPORTED(C_DestroyObject, (CK_SESSION_HANDLE, CK_OBJECT_HANDLE))
NOTSUPPORTED(C_GetObjectSize, (CK_SESSION_HANDLE,CK_OBJECT_HANDLE,CK_ULONG_PTR))
NOTSUPPORTED(C_SetAttributeValue, (CK_SESSION_HANDLE,CK_OBJECT_HANDLE,CK_ATTRIBUTE_PTR,CK_ULONG))
NOTSUPPORTED(C_EncryptInit, (CK_SESSION_HANDLE,CK_MECHANISM_PTR,CK_OBJECT_HANDLE))
NOTSUPPORTED(C_Encrypt, (CK_SESSION_HANDLE, CK_BYTE_PTR, CK_ULONG, CK_BYTE_PTR, CK_ULONG_PTR))
NOTSUPPORTED(C_EncryptUpdate, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_EncryptFinal, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_DecryptUpdate,(CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_DecryptFinal, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_DigestInit, (CK_SESSION_HANDLE,CK_MECHANISM_PTR))
NOTSUPPORTED(C_Digest, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_DigestUpdate, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG))
NOTSUPPORTED(C_DigestKey, (CK_SESSION_HANDLE,CK_OBJECT_HANDLE))
NOTSUPPORTED(C_DigestFinal, (CK_SESSION_HANDLE, CK_BYTE_PTR, CK_ULONG_PTR))
NOTSUPPORTED(C_SignUpdate, (CK_SESSION_HANDLE, CK_BYTE_PTR, CK_ULONG))
NOTSUPPORTED(C_SignFinal, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_SignRecoverInit, (CK_SESSION_HANDLE,CK_MECHANISM_PTR,CK_OBJECT_HANDLE))
NOTSUPPORTED(C_SignRecover, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_VerifyInit, (CK_SESSION_HANDLE,CK_MECHANISM_PTR,CK_OBJECT_HANDLE))
NOTSUPPORTED(C_Verify, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_BYTE_PTR,CK_ULONG))
NOTSUPPORTED(C_VerifyUpdate, (CK_SESSION_HANDLE, CK_BYTE_PTR, CK_ULONG))
NOTSUPPORTED(C_VerifyFinal, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG))
NOTSUPPORTED(C_VerifyRecoverInit, (CK_SESSION_HANDLE,CK_MECHANISM_PTR,CK_OBJECT_HANDLE))
NOTSUPPORTED(C_VerifyRecover, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_DigestEncryptUpdate, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_DecryptDigestUpdate, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_SignEncryptUpdate, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_DecryptVerifyUpdate, (CK_SESSION_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_GenerateKey, (CK_SESSION_HANDLE,CK_MECHANISM_PTR,CK_ATTRIBUTE_PTR,CK_ULONG,CK_OBJECT_HANDLE_PTR))
NOTSUPPORTED(C_GenerateKeyPair, (CK_SESSION_HANDLE,CK_MECHANISM_PTR,CK_ATTRIBUTE_PTR,CK_ULONG,CK_ATTRIBUTE_PTR,CK_ULONG,CK_OBJECT_HANDLE_PTR,CK_OBJECT_HANDLE_PTR))
NOTSUPPORTED(C_WrapKey, (CK_SESSION_HANDLE,CK_MECHANISM_PTR,CK_OBJECT_HANDLE,CK_OBJECT_HANDLE,CK_BYTE_PTR,CK_ULONG_PTR))
NOTSUPPORTED(C_UnwrapKey, (CK_SESSION_HANDLE,CK_MECHANISM_PTR,CK_OBJECT_HANDLE,CK_BYTE_PTR,CK_ULONG,CK_ATTRIBUTE_PTR,CK_ULONG,CK_OBJECT_HANDLE_PTR))
NOTSUPPORTED(C_DeriveKey, (CK_SESSION_HANDLE,CK_MECHANISM_PTR,CK_OBJECT_HANDLE,CK_ATTRIBUTE_PTR,CK_ULONG,CK_OBJECT_HANDLE_PTR))
NOTSUPPORTED(C_GetFunctionStatus, (CK_SESSION_HANDLE))
NOTSUPPORTED(C_CancelFunction, (CK_SESSION_HANDLE))

/* non-specialized functions supported with the slotList object */

SUPPORTED(C_GetSlotList, getSlotList,
  (CK_BBOOL tokenPresent, CK_SLOT_ID_PTR pSlotList, CK_ULONG_PTR pulCount),
  (tokenPresent, pSlotList, pulCount))
SUPPORTED(C_GetSessionInfo, getSessionInfo,
   (CK_SESSION_HANDLE hSession, CK_SESSION_INFO_PTR pInfo),
   (hSession, pInfo) )
SUPPORTED(C_Logout, logout, (CK_SESSION_HANDLE hSession), (hSession))
SUPPORTED(C_Decrypt, decrypt, 
   (CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, CK_ULONG ulDataLen,
    CK_BYTE_PTR pDecryptedData, CK_ULONG_PTR pulDecryptedDataLen),
   (hSession, pData, ulDataLen, pDecryptedData, pulDecryptedDataLen))
SUPPORTED(C_DecryptInit, decryptInit,
   (CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, 
    CK_OBJECT_HANDLE hKey), (hSession, pMechanism, hKey))
SUPPORTED(C_SignInit, signInit, 
   (CK_SESSION_HANDLE hSession, CK_MECHANISM_PTR pMechanism, 
    CK_OBJECT_HANDLE hKey), 
   (hSession, pMechanism, hKey))
SUPPORTED(C_Sign, sign, 
   (CK_SESSION_HANDLE hSession, CK_BYTE_PTR pData, CK_ULONG ulDataLen, 
    CK_BYTE_PTR pSignature, CK_ULONG_PTR pulSignatureLen), 
  (hSession, pData, ulDataLen, pSignature, pulSignatureLen))
SUPPORTED(C_SeedRandom, seedRandom,
  (CK_SESSION_HANDLE hSession ,CK_BYTE_PTR data,CK_ULONG dataLen),
  (hSession, data, dataLen))
SUPPORTED(C_GenerateRandom, generateRandom,
  (CK_SESSION_HANDLE hSession ,CK_BYTE_PTR data,CK_ULONG dataLen),
  (hSession, data, dataLen))

/* non-specialized functions supported with the slot directly */

CK_RV
C_Initialize(CK_VOID_PTR pInitArgs)
{
  try {
    if( initialized ) {
        return CKR_CRYPTOKI_ALREADY_INITIALIZED;
    }
    if (finalizeLock && !finalizeLock->isValid()) {
	return CKR_CANT_LOCK;
    }
    CK_C_INITIALIZE_ARGS* initArgs = (CK_C_INITIALIZE_ARGS*) pInitArgs;
    OSLock::setThreadSafe(0);
    if( initArgs != NULL ) {
	bool needThreads;
	/* work around a bug in NSS where the library parameters are only
	 * send if locking is requested */
	if (initArgs->LibraryParameters) {
	    Params::SetParams(strdup((char *)initArgs->LibraryParameters));
	} else {
	    Params::ClearParams();
	}
  	needThreads = ((initArgs->flags & CKF_OS_LOCKING_OK) != 0);
	OSLock::setThreadSafe(needThreads);
	/* don't get a finalize lock unless someone initializes us asking
	 * us to use threads */
	if (needThreads && !finalizeLock) {
	    finalizeLock = new OSLock(true);
	    if (finalizeLock == NULL) return CKR_HOST_MEMORY;
	}
	/* only support OS LOCKING threads */
        if( ((initArgs->flags & CKF_OS_LOCKING_OK) == 0) 
						&& initArgs->LockMutex ){
            throw PKCS11Exception(CKR_CANT_LOCK);
        }
    }
    char * logFileName = getenv("COOL_KEY_LOG_FILE");
    if (logFileName) {
	if (strcmp(logFileName,"SYSLOG") == 0) {
	    log = new SysLog();
	} else {
	    log = new FileLog(logFileName);
	}
    } else {
	log = new DummyLog();
    }
    log->log("Initialize called, hello %d\n", 5);
    CKY_SetName("coolkey");
    slotList = new SlotList(log);
    initialized = TRUE;
    return CKR_OK;
  } catch(PKCS11Exception &e) {
        if( log )
            e.log(log);
        return e.getReturnValue();
  }
}

CK_RV
C_Finalize(CK_VOID_PTR pReserved)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    // XXX cleanup all data structures !!!
    //delete sessionManager;
    log->log("Finalizing...\n");
    // don't race the setting of finalizing. If C_WaitEvent gets passed
    // the finalizing call first, we know it will set waitEvent before
    // we can get the lock, so we only need to protect setting finalizing
    // to true.
    FINALIZE_GETLOCK();
    finalizing = TRUE;
    FINALIZE_RELEASELOCK();
    if (waitEvent) {
	/* we're waiting on a slot event, shutdown first to allow
	 * the wait function to complete before we pull the rug out.
	 */
	slotList->shutdown();
	while (waitEvent) {
	    OSSleep(500);
	}
    } 
    delete slotList;
    delete log;
    FINALIZE_GETLOCK();
    finalizing = FALSE;
    initialized = FALSE;
    FINALIZE_RELEASELOCK();
    return CKR_OK;
}


CK_RV
C_GetInfo(CK_INFO_PTR p)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    log->log("C_GetInfo called\n");
    ckInfo.manufacturerID[31] = ' ';
    ckInfo.libraryDescription[31] = ' ';
    *p = ckInfo;
    return CKR_OK;
}


CK_RV
C_GetSlotInfo(CK_SLOT_ID slotID, CK_SLOT_INFO_PTR pSlotInfo)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        log->log("Called C_GetSlotInfo\n");
        slotList->validateSlotID(slotID);
        return slotList->getSlot(
            slotIDToIndex(slotID))->getSlotInfo(pSlotInfo);
    } catch( PKCS11Exception &excep ) {
        excep.log(log);
        return excep.getCRV();
    }
}

CK_RV
C_GetTokenInfo(CK_SLOT_ID slotID, CK_TOKEN_INFO_PTR pTokenInfo)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        log->log("C_GetTokenInfo called\n");
        slotList->validateSlotID(slotID);
        return slotList->getSlot(
            slotIDToIndex(slotID))->getTokenInfo(pTokenInfo);
    } catch( PKCS11Exception &excep ) {
        excep.log(log);
        return excep.getCRV();
    }
}

CK_RV
C_GetMechanismList(CK_SLOT_ID slotID, CK_MECHANISM_TYPE_PTR pMechanismList,
    CK_ULONG_PTR pulCount)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        CK_RV rv = CKR_OK;

        log->log("C_GetMechanismList called\n");
        if( pulCount == NULL ) {
            throw PKCS11Exception(CKR_ARGUMENTS_BAD);
        }

        slotList->validateSlotID(slotID);
        if( ! slotList->getSlot(
            slotIDToIndex(slotID))->isTokenPresent() ) {
            return CKR_TOKEN_NOT_PRESENT;
        }

        if( pMechanismList != NULL ) {
            if( *pulCount < numMechanisms ) {
                rv = CKR_BUFFER_TOO_SMALL;
            } else {
                for(unsigned int i=0; i < numMechanisms; ++i ) {
                    pMechanismList[i] = mechanismList[i].mech;
                }
            }
        }

        *pulCount = numMechanisms;
            
        log->log("C_GetMechanismList returning %d\n", rv);
        return rv;

    } catch(PKCS11Exception &excep ) {
        excep.log(log);
        return excep.getCRV();
    }

}

CK_RV
C_GetMechanismInfo(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type,
    CK_MECHANISM_INFO_PTR pInfo)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        log->log("C_GetMechanismInfo called\n");
        if( pInfo == NULL ) {
            throw PKCS11Exception(CKR_ARGUMENTS_BAD);
        }
        slotList->validateSlotID(slotID);
        if( ! slotList->getSlot(slotIDToIndex(slotID))->isTokenPresent() ) {
            return CKR_TOKEN_NOT_PRESENT;
        }

        for(unsigned int i=0; i < numMechanisms; ++i ) {
            if( mechanismList[i].mech == type ) {
                *pInfo = mechanismList[i].info;
                log->log("C_GetMechanismInfo got info about %d\n", type);
                return CKR_OK;
            }
        }
        log->log("C_GetMechanismInfo failed to find info about %d\n", type);
        return CKR_MECHANISM_INVALID; // mechanism not in the list
    } catch(PKCS11Exception &e) {
        e.log(log);
        return e.getCRV();
    }
}

CK_RV
C_OpenSession(CK_SLOT_ID slotID, CK_FLAGS flags, CK_VOID_PTR pApplication,
    CK_NOTIFY notify, CK_SESSION_HANDLE_PTR phSession)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        log->log("C_OpenSession called\n");
        slotList->validateSlotID(slotID);
#ifdef LATER  // the CSP isn't setting this bit right now.
        if( ! (flags & CKF_SERIAL_SESSION) ) {
            throw PKCS11Exception(CKR_SESSION_PARALLEL_NOT_SUPPORTED);
        }
#endif
        if( phSession == NULL ) {
            throw PKCS11Exception(CKR_ARGUMENTS_BAD);
        }
        Session::Type sessionType =
            (flags & CKF_RW_SESSION) ? Session::RW : Session::RO;

        slotList->openSession(sessionType, slotID, phSession);

        return CKR_OK;

    } catch(PKCS11Exception &e) {
        e.log(log);
        return e.getCRV();
    }
}

CK_RV
C_CloseSession(CK_SESSION_HANDLE hSession)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        log->log("C_CloseSession(0x%x) called\n", hSession);
        // !!!XXX Hack
        // If nothing else, we need to logout the token when all
        // its sessions are closed.
        return CKR_OK;
    } catch(PKCS11Exception &e) {
        e.log(log);
        return e.getCRV();
    }
}

CK_RV
C_CloseAllSessions(CK_SLOT_ID slotID)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        log->log("C_CloseAllSessions(0x%x) called\n", slotID);
        slotList->validateSlotID(slotID);
        // !!!XXX Hack
        // If nothing else, we need to logout the token when all
        // its sessions are closed.
        return CKR_OK;
    } catch(PKCS11Exception &e) {
        e.log(log);
        return e.getCRV();
    }
}


CK_RV
C_FindObjectsInit(CK_SESSION_HANDLE hSession, CK_ATTRIBUTE_PTR pTemplate,
        CK_ULONG ulCount)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        log->log("C_FindObjectsInit called, %lu templates\n", ulCount);
	dumpTemplates(pTemplate, ulCount);

        if( pTemplate == NULL && ulCount != 0 ) {
            throw PKCS11Exception(CKR_ARGUMENTS_BAD);
        }
        slotList->findObjectsInit(hSession, pTemplate, ulCount);
        return CKR_OK;
    } catch(PKCS11Exception &e) {
        e.log(log);
        return e.getCRV();
    }
}

CK_RV
C_FindObjects(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE_PTR phObject,
    CK_ULONG ulMaxObjectCount, CK_ULONG_PTR pulObjectCount)
{
    CK_ULONG count = 0;
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        log->log("C_FindObjects called, max objects = %lu\n", ulMaxObjectCount );
        if( phObject == NULL && ulMaxObjectCount != 0 ) {
            throw PKCS11Exception(CKR_ARGUMENTS_BAD);
        }
        slotList->findObjects(hSession, phObject, ulMaxObjectCount,
            pulObjectCount);
	count = *pulObjectCount;
        log->log("returned %lu objects:", count );
	CK_ULONG i;
	for (i = 0; i < count; ++i) {
	    log->log(" 0x%08lx", phObject[i]);
	}
        log->log("\n" );
        return CKR_OK;
    } catch(PKCS11Exception &e) {
        e.log(log);
        return e.getCRV();
    }
}

CK_RV
C_FindObjectsFinal(CK_SESSION_HANDLE hSession)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    // we don't need to do any cleaup. We could check the session handle.
    return CKR_OK;
}

CK_RV
C_Login(CK_SESSION_HANDLE hSession, CK_USER_TYPE userType,
    CK_UTF8CHAR_PTR pPin, CK_ULONG ulPinLen)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        log->log("C_Login called\n");
        if( userType != CKU_USER ) {
            throw PKCS11Exception(CKR_USER_TYPE_INVALID);
        }
        if( pPin == NULL ) {
            throw PKCS11Exception(CKR_ARGUMENTS_BAD);
        }
        slotList->login(hSession, pPin, ulPinLen);
        return CKR_OK;
    } catch(PKCS11Exception &e) {
        e.log(log);
        return e.getCRV();
    }
}


CK_RV
C_GetAttributeValue(CK_SESSION_HANDLE hSession, CK_OBJECT_HANDLE hObject,
    CK_ATTRIBUTE_PTR pTemplate, CK_ULONG ulCount)
{
    if( ! initialized ) {
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    try {
        log->log("C_GetAttributeValue called, %lu templates for object 0x%08lx\n", ulCount, hObject);
	dumpTemplates(pTemplate, ulCount);
        if( pTemplate == NULL && ulCount != 0 ) {
            throw PKCS11Exception(CKR_ARGUMENTS_BAD);
        }
        slotList->getAttributeValue(hSession, hObject, pTemplate, ulCount);
	dumpTemplates(pTemplate, ulCount);
        return CKR_OK;
    } catch(PKCS11Exception& e) {
	CK_RV rv = e.getCRV();
        e.log(log);
	if (rv == CKR_ATTRIBUTE_TYPE_INVALID ||
	    rv == CKR_BUFFER_TOO_SMALL) {
	    dumpTemplates(pTemplate, ulCount);
	}
        return rv;
    }
}


/*
 * While the rest of the C_ calls are protected by the callers lock,
 * C_WaitForSlotEvent is guaranteed to be on a separate thread.
 * Make sure we are locking with C_Finalize, which is likely to be racing
 * with this function
 */
CK_RV
C_WaitForSlotEvent(CK_FLAGS flags, CK_SLOT_ID_PTR pSlot, CK_VOID_PTR pReserved)
{
    FINALIZE_GETLOCK();
    if( ! initialized ) {
	FINALIZE_RELEASELOCK();
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    if (finalizing) {
	FINALIZE_RELEASELOCK();
        return CKR_CRYPTOKI_NOT_INITIALIZED;
    }
    waitEvent = TRUE;
    FINALIZE_RELEASELOCK();
    try {
        log->log("C_WaitForSlotEvent called\n");
        slotList->waitForSlotEvent(flags, pSlot, pReserved);
        waitEvent = FALSE;
        return CKR_OK;
    } catch(PKCS11Exception& e) {
        e.log(log);
        waitEvent = FALSE;
        return e.getCRV();
    }
}

CK_RV C_GetFunctionList(CK_FUNCTION_LIST_PTR_PTR pPtr);


#undef  CK_NEED_ARG_LIST
#undef  CK_PKCS11_FUNCTION_INFO
#define CK_PKCS11_FUNCTION_INFO(func) (CK_##func) func,

static CK_FUNCTION_LIST
functionList =  {
    {2, 20}, // PKCS #11 spec version we support
#include "pkcs11f.h"
};

CK_RV
C_GetFunctionList(CK_FUNCTION_LIST_PTR_PTR pPtr)
{
    if( pPtr == NULL ) {
        return CKR_ARGUMENTS_BAD;
    }
    *pPtr = &functionList;
    return CKR_OK;
}


} // end extern C