2 * Copyright (c) 2004 - 2008 Kungliga Tekniska Högskolan
3 * (Royal Institute of Technology, Stockholm, Sweden).
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the Institute nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #define CRYPTOKI_EXPORTS 1
39 #define OBJECT_ID_MASK 0xfff
40 #define HANDLE_OBJECT_ID(h) ((h) & OBJECT_ID_MASK)
41 #define OBJECT_ID(obj) HANDLE_OBJECT_ID((obj)->object_handle)
44 #define random() rand()
45 #define srandom(s) srand(s)
53 CK_ATTRIBUTE attribute;
58 CK_OBJECT_HANDLE object_handle;
59 struct st_attr *attrs;
64 static struct soft_token {
65 CK_VOID_PTR application;
70 struct st_object **objs;
79 struct session_state {
80 CK_SESSION_HANDLE session_handle;
83 CK_ATTRIBUTE *attributes;
84 CK_ULONG num_attributes;
89 CK_MECHANISM_PTR sign_mechanism;
91 CK_MECHANISM_PTR verify_mechanism;
93 #define MAX_NUM_SESSION (sizeof(soft_token.state)/sizeof(soft_token.state[0]))
97 static hx509_context context;
100 application_error(const char *fmt, ...)
106 if (soft_token.flags.app_error_fatal)
111 st_logf(const char *fmt, ...)
114 if (soft_token.logfile == NULL)
117 vfprintf(soft_token.logfile, fmt, ap);
119 fflush(soft_token.logfile);
125 if (context == NULL) {
126 int ret = hx509_context_init(&context);
128 return CKR_GENERAL_ERROR;
133 #define INIT_CONTEXT() { CK_RV icret = init_context(); if (icret) return icret; }
136 snprintf_fill(char *str, size_t size, char fillchar, const char *fmt, ...)
141 len = vsnprintf(str, size, fmt, ap);
143 if (len < 0 || (size_t)len > size)
145 while ((size_t)len < size)
146 str[len++] = fillchar;
150 #define printf error_use_st_logf
153 #define VERIFY_SESSION_HANDLE(s, state) \
156 xret = verify_session_handle(s, state); \
157 if (xret != CKR_OK) { \
158 /* return CKR_OK */; \
163 verify_session_handle(CK_SESSION_HANDLE hSession,
164 struct session_state **state)
168 for (i = 0; i < MAX_NUM_SESSION; i++){
169 if (soft_token.state[i].session_handle == hSession)
172 if (i == MAX_NUM_SESSION) {
173 application_error("use of invalid handle: 0x%08lx\n",
174 (unsigned long)hSession);
175 return CKR_SESSION_HANDLE_INVALID;
178 *state = &soft_token.state[i];
183 object_handle_to_object(CK_OBJECT_HANDLE handle,
184 struct st_object **object)
186 int i = HANDLE_OBJECT_ID(handle);
189 if (i >= soft_token.object.num_objs)
190 return CKR_ARGUMENTS_BAD;
191 if (soft_token.object.objs[i] == NULL)
192 return CKR_ARGUMENTS_BAD;
193 if (soft_token.object.objs[i]->object_handle != handle)
194 return CKR_ARGUMENTS_BAD;
195 *object = soft_token.object.objs[i];
200 attributes_match(const struct st_object *obj,
201 const CK_ATTRIBUTE *attributes,
202 CK_ULONG num_attributes)
207 st_logf("attributes_match: %ld\n", (unsigned long)OBJECT_ID(obj));
209 for (i = 0; i < num_attributes; i++) {
211 for (j = 0; j < obj->num_attributes; j++) {
212 if (attributes[i].type == obj->attrs[j].attribute.type &&
213 attributes[i].ulValueLen == obj->attrs[j].attribute.ulValueLen &&
214 memcmp(attributes[i].pValue, obj->attrs[j].attribute.pValue,
215 attributes[i].ulValueLen) == 0) {
221 st_logf("type %d attribute have no match\n", attributes[i].type);
225 st_logf("attribute matches\n");
230 print_attributes(const CK_ATTRIBUTE *attributes,
231 CK_ULONG num_attributes)
235 st_logf("find objects: attrs: %lu\n", (unsigned long)num_attributes);
237 for (i = 0; i < num_attributes; i++) {
239 switch (attributes[i].type) {
242 if (attributes[i].ulValueLen != sizeof(CK_BBOOL)) {
243 application_error("token attribute wrong length\n");
246 ck_true = attributes[i].pValue;
247 st_logf("token: %s", *ck_true ? "TRUE" : "FALSE");
251 CK_OBJECT_CLASS *class;
252 if (attributes[i].ulValueLen != sizeof(CK_ULONG)) {
253 application_error("class attribute wrong length\n");
256 class = attributes[i].pValue;
259 case CKO_CERTIFICATE:
260 st_logf("certificate");
263 st_logf("public key");
265 case CKO_PRIVATE_KEY:
266 st_logf("private key");
269 st_logf("secret key");
271 case CKO_DOMAIN_PARAMETERS:
272 st_logf("domain parameters");
275 st_logf("[class %lx]", (long unsigned)*class);
286 case CKA_APPLICATION:
287 st_logf("application");
296 st_logf("[unknown 0x%08lx]", (unsigned long)attributes[i].type);
303 static struct st_object *
306 struct st_object *o, **objs;
309 o = calloc(1, sizeof(*o));
313 for (i = 0; i < soft_token.object.num_objs; i++) {
314 if (soft_token.object.objs == NULL) {
315 soft_token.object.objs[i] = o;
319 if (i == soft_token.object.num_objs) {
320 objs = realloc(soft_token.object.objs,
321 (soft_token.object.num_objs + 1) * sizeof(soft_token.object.objs[0]));
326 soft_token.object.objs = objs;
327 soft_token.object.objs[soft_token.object.num_objs++] = o;
329 soft_token.object.objs[i]->object_handle =
330 (random() & (~OBJECT_ID_MASK)) | i;
336 add_object_attribute(struct st_object *o,
338 CK_ATTRIBUTE_TYPE type,
345 if (pValue == NULL && ulValueLen)
346 return CKR_ARGUMENTS_BAD;
348 i = o->num_attributes;
349 a = realloc(o->attrs, (i + 1) * sizeof(o->attrs[0]));
351 return CKR_DEVICE_MEMORY;
353 o->attrs[i].secret = secret;
354 o->attrs[i].attribute.type = type;
355 o->attrs[i].attribute.pValue = malloc(ulValueLen);
356 if (o->attrs[i].attribute.pValue == NULL && ulValueLen != 0)
357 return CKR_DEVICE_MEMORY;
359 memcpy(o->attrs[i].attribute.pValue, pValue, ulValueLen);
360 o->attrs[i].attribute.ulValueLen = ulValueLen;
367 add_pubkey_info(hx509_context hxctx, struct st_object *o,
368 CK_KEY_TYPE key_type, hx509_cert cert)
371 CK_BYTE *modulus = NULL;
372 size_t modulus_len = 0;
373 CK_ULONG modulus_bits = 0;
374 CK_BYTE *exponent = NULL;
375 size_t exponent_len = 0;
377 if (key_type != CKK_RSA)
379 if (_hx509_cert_private_key(cert) == NULL)
382 num = _hx509_private_key_get_internal(context,
383 _hx509_cert_private_key(cert),
386 return CKR_GENERAL_ERROR;
387 modulus_bits = BN_num_bits(num);
389 modulus_len = BN_num_bytes(num);
390 modulus = malloc(modulus_len);
391 BN_bn2bin(num, modulus);
394 add_object_attribute(o, 0, CKA_MODULUS, modulus, modulus_len);
395 add_object_attribute(o, 0, CKA_MODULUS_BITS,
396 &modulus_bits, sizeof(modulus_bits));
400 num = _hx509_private_key_get_internal(context,
401 _hx509_cert_private_key(cert),
404 return CKR_GENERAL_ERROR;
406 exponent_len = BN_num_bytes(num);
407 exponent = malloc(exponent_len);
408 BN_bn2bin(num, exponent);
411 add_object_attribute(o, 0, CKA_PUBLIC_EXPONENT,
412 exponent, exponent_len);
426 add_cert(hx509_context hxctx, void *ctx, hx509_cert cert)
428 static char empty[] = "";
429 struct foo *foo = (struct foo *)ctx;
430 struct st_object *o = NULL;
431 CK_OBJECT_CLASS type;
432 CK_BBOOL bool_true = CK_TRUE;
433 CK_BBOOL bool_false = CK_FALSE;
434 CK_CERTIFICATE_TYPE cert_type = CKC_X_509;
435 CK_KEY_TYPE key_type;
436 CK_MECHANISM_TYPE mech_type;
437 CK_RV ret = CKR_GENERAL_ERROR;
439 heim_octet_string cert_data, subject_data, issuer_data, serial_data;
441 st_logf("adding certificate\n");
443 serial_data.data = NULL;
444 serial_data.length = 0;
445 cert_data = subject_data = issuer_data = serial_data;
447 hret = hx509_cert_binary(hxctx, cert, &cert_data);
454 hret = hx509_cert_get_issuer(cert, &name);
457 hret = hx509_name_binary(name, &issuer_data);
458 hx509_name_free(&name);
462 hret = hx509_cert_get_subject(cert, &name);
465 hret = hx509_name_binary(name, &subject_data);
466 hx509_name_free(&name);
472 AlgorithmIdentifier alg;
474 hret = hx509_cert_get_SPKI_AlgorithmIdentifier(context, cert, &alg);
476 ret = CKR_DEVICE_MEMORY;
480 key_type = CKK_RSA; /* XXX */
482 free_AlgorithmIdentifier(&alg);
486 type = CKO_CERTIFICATE;
489 ret = CKR_DEVICE_MEMORY;
493 o->cert = hx509_cert_ref(cert);
495 add_object_attribute(o, 0, CKA_CLASS, &type, sizeof(type));
496 add_object_attribute(o, 0, CKA_TOKEN, &bool_true, sizeof(bool_true));
497 add_object_attribute(o, 0, CKA_PRIVATE, &bool_false, sizeof(bool_false));
498 add_object_attribute(o, 0, CKA_MODIFIABLE, &bool_false, sizeof(bool_false));
499 add_object_attribute(o, 0, CKA_LABEL, foo->label, strlen(foo->label));
501 add_object_attribute(o, 0, CKA_CERTIFICATE_TYPE, &cert_type, sizeof(cert_type));
502 add_object_attribute(o, 0, CKA_ID, foo->id, strlen(foo->id));
504 add_object_attribute(o, 0, CKA_SUBJECT, subject_data.data, subject_data.length);
505 add_object_attribute(o, 0, CKA_ISSUER, issuer_data.data, issuer_data.length);
506 add_object_attribute(o, 0, CKA_SERIAL_NUMBER, serial_data.data, serial_data.length);
507 add_object_attribute(o, 0, CKA_VALUE, cert_data.data, cert_data.length);
508 add_object_attribute(o, 0, CKA_TRUSTED, &bool_false, sizeof(bool_false));
510 st_logf("add cert ok: %lx\n", (unsigned long)OBJECT_ID(o));
512 type = CKO_PUBLIC_KEY;
515 ret = CKR_DEVICE_MEMORY;
518 o->cert = hx509_cert_ref(cert);
520 add_object_attribute(o, 0, CKA_CLASS, &type, sizeof(type));
521 add_object_attribute(o, 0, CKA_TOKEN, &bool_true, sizeof(bool_true));
522 add_object_attribute(o, 0, CKA_PRIVATE, &bool_false, sizeof(bool_false));
523 add_object_attribute(o, 0, CKA_MODIFIABLE, &bool_false, sizeof(bool_false));
524 add_object_attribute(o, 0, CKA_LABEL, foo->label, strlen(foo->label));
526 add_object_attribute(o, 0, CKA_KEY_TYPE, &key_type, sizeof(key_type));
527 add_object_attribute(o, 0, CKA_ID, foo->id, strlen(foo->id));
528 add_object_attribute(o, 0, CKA_START_DATE, empty, 1); /* XXX */
529 add_object_attribute(o, 0, CKA_END_DATE, empty, 1); /* XXX */
530 add_object_attribute(o, 0, CKA_DERIVE, &bool_false, sizeof(bool_false));
531 add_object_attribute(o, 0, CKA_LOCAL, &bool_false, sizeof(bool_false));
532 mech_type = CKM_RSA_X_509;
533 add_object_attribute(o, 0, CKA_KEY_GEN_MECHANISM, &mech_type, sizeof(mech_type));
535 add_object_attribute(o, 0, CKA_SUBJECT, subject_data.data, subject_data.length);
536 add_object_attribute(o, 0, CKA_ENCRYPT, &bool_true, sizeof(bool_true));
537 add_object_attribute(o, 0, CKA_VERIFY, &bool_true, sizeof(bool_true));
538 add_object_attribute(o, 0, CKA_VERIFY_RECOVER, &bool_false, sizeof(bool_false));
539 add_object_attribute(o, 0, CKA_WRAP, &bool_true, sizeof(bool_true));
540 add_object_attribute(o, 0, CKA_TRUSTED, &bool_true, sizeof(bool_true));
542 add_pubkey_info(hxctx, o, key_type, cert);
544 st_logf("add key ok: %lx\n", (unsigned long)OBJECT_ID(o));
546 if (hx509_cert_have_private_key(cert)) {
549 type = CKO_PRIVATE_KEY;
552 ret = CKR_DEVICE_MEMORY;
555 o->cert = hx509_cert_ref(cert);
557 add_object_attribute(o, 0, CKA_CLASS, &type, sizeof(type));
558 add_object_attribute(o, 0, CKA_TOKEN, &bool_true, sizeof(bool_true));
559 add_object_attribute(o, 0, CKA_PRIVATE, &bool_true, sizeof(bool_false));
560 add_object_attribute(o, 0, CKA_MODIFIABLE, &bool_false, sizeof(bool_false));
561 add_object_attribute(o, 0, CKA_LABEL, foo->label, strlen(foo->label));
563 add_object_attribute(o, 0, CKA_KEY_TYPE, &key_type, sizeof(key_type));
564 add_object_attribute(o, 0, CKA_ID, foo->id, strlen(foo->id));
565 add_object_attribute(o, 0, CKA_START_DATE, empty, 1); /* XXX */
566 add_object_attribute(o, 0, CKA_END_DATE, empty, 1); /* XXX */
567 add_object_attribute(o, 0, CKA_DERIVE, &bool_false, sizeof(bool_false));
568 add_object_attribute(o, 0, CKA_LOCAL, &bool_false, sizeof(bool_false));
569 mech_type = CKM_RSA_X_509;
570 add_object_attribute(o, 0, CKA_KEY_GEN_MECHANISM, &mech_type, sizeof(mech_type));
572 add_object_attribute(o, 0, CKA_SUBJECT, subject_data.data, subject_data.length);
573 add_object_attribute(o, 0, CKA_SENSITIVE, &bool_true, sizeof(bool_true));
574 add_object_attribute(o, 0, CKA_SECONDARY_AUTH, &bool_false, sizeof(bool_true));
576 add_object_attribute(o, 0, CKA_AUTH_PIN_FLAGS, &flags, sizeof(flags));
578 add_object_attribute(o, 0, CKA_DECRYPT, &bool_true, sizeof(bool_true));
579 add_object_attribute(o, 0, CKA_SIGN, &bool_true, sizeof(bool_true));
580 add_object_attribute(o, 0, CKA_SIGN_RECOVER, &bool_false, sizeof(bool_false));
581 add_object_attribute(o, 0, CKA_UNWRAP, &bool_true, sizeof(bool_true));
582 add_object_attribute(o, 0, CKA_EXTRACTABLE, &bool_true, sizeof(bool_true));
583 add_object_attribute(o, 0, CKA_NEVER_EXTRACTABLE, &bool_false, sizeof(bool_false));
585 add_pubkey_info(hxctx, o, key_type, cert);
591 st_logf("something went wrong when adding cert!\n");
595 hx509_xfree(cert_data.data);
596 hx509_xfree(serial_data.data);
597 hx509_xfree(issuer_data.data);
598 hx509_xfree(subject_data.data);
604 add_certificate(const char *cert_file,
610 hx509_lock lock = NULL;
618 flags |= HX509_CERTS_UNPROTECT_ALL;
622 asprintf(&str, "PASS:%s", pin);
624 hx509_lock_init(context, &lock);
625 hx509_lock_command_string(lock, str);
627 memset(str, 0, strlen(str));
631 ret = hx509_certs_init(context, cert_file, flags, lock, &certs);
633 st_logf("failed to open file %s\n", cert_file);
634 return CKR_GENERAL_ERROR;
637 ret = hx509_certs_iter_f(context, certs, add_cert, &foo);
638 hx509_certs_free(&certs);
640 st_logf("failed adding certs from file %s\n", cert_file);
641 return CKR_GENERAL_ERROR;
648 find_object_final(struct session_state *state)
650 if (state->find.attributes) {
653 for (i = 0; i < state->find.num_attributes; i++) {
654 if (state->find.attributes[i].pValue)
655 free(state->find.attributes[i].pValue);
657 free(state->find.attributes);
658 state->find.attributes = NULL;
659 state->find.num_attributes = 0;
660 state->find.next_object = -1;
665 reset_crypto_state(struct session_state *state)
667 state->sign_object = -1;
668 if (state->sign_mechanism)
669 free(state->sign_mechanism);
670 state->sign_mechanism = NULL_PTR;
671 state->verify_object = -1;
672 if (state->verify_mechanism)
673 free(state->verify_mechanism);
674 state->verify_mechanism = NULL_PTR;
678 close_session(struct session_state *state)
680 if (state->find.attributes) {
681 application_error("application didn't do C_FindObjectsFinal\n");
682 find_object_final(state);
685 state->session_handle = CK_INVALID_HANDLE;
686 soft_token.application = NULL_PTR;
687 soft_token.notify = NULL_PTR;
688 reset_crypto_state(state);
694 return soft_token.open_sessions > 0 ? "yes" : "no";
698 read_conf_file(const char *fn, CK_USER_TYPE userType, const char *pin)
700 char buf[1024], *type, *s, *p;
703 CK_RV failed = CKR_OK;
706 st_logf("Can't open configuration file. No file specified\n");
707 return CKR_GENERAL_ERROR;
712 st_logf("can't open configuration file %s\n", fn);
713 return CKR_GENERAL_ERROR;
717 while(fgets(buf, sizeof(buf), f) != NULL) {
718 buf[strcspn(buf, "\n")] = '\0';
720 st_logf("line: %s\n", buf);
723 while (isspace((unsigned char)*p))
727 while (isspace((unsigned char)*p))
731 type = strtok_r(p, "\t", &s);
735 if (strcasecmp("certificate", type) == 0) {
736 char *cert, *id, *label;
738 id = strtok_r(NULL, "\t", &s);
743 st_logf("id: %s\n", id);
744 label = strtok_r(NULL, "\t", &s);
746 st_logf("no label\n");
749 cert = strtok_r(NULL, "\t", &s);
751 st_logf("no certfiicate store\n");
755 st_logf("adding: %s: %s in file %s\n", id, label, cert);
757 ret = add_certificate(cert, pin, id, label);
760 } else if (strcasecmp("debug", type) == 0) {
763 name = strtok_r(NULL, "\t", &s);
765 st_logf("no filename\n");
769 if (soft_token.logfile)
770 fclose(soft_token.logfile);
772 if (strcasecmp(name, "stdout") == 0)
773 soft_token.logfile = stdout;
775 soft_token.logfile = fopen(name, "a");
776 if (soft_token.logfile)
777 rk_cloexec_file(soft_token.logfile);
779 if (soft_token.logfile == NULL)
780 st_logf("failed to open file: %s\n", name);
782 } else if (strcasecmp("app-fatal", type) == 0) {
785 name = strtok_r(NULL, "\t", &s);
787 st_logf("argument to app-fatal\n");
791 if (strcmp(name, "true") == 0 || strcmp(name, "on") == 0)
792 soft_token.flags.app_error_fatal = 1;
793 else if (strcmp(name, "false") == 0 || strcmp(name, "off") == 0)
794 soft_token.flags.app_error_fatal = 0;
796 st_logf("unknown app-fatal: %s\n", name);
799 st_logf("unknown type: %s\n", type);
809 func_not_supported(void)
811 st_logf("function not supported\n");
812 return CKR_FUNCTION_NOT_SUPPORTED;
816 get_config_file_for_user(void)
824 fn = getenv("SOFTPKCS11RC");
827 home = getenv("HOME");
829 if (fn == NULL && home == NULL) {
830 struct passwd *pw = getpwuid(getuid());
836 asprintf(&fn, "%s/.soft-token.rc", home);
838 fn = strdup("/etc/soft-token.rc");
842 char appdatafolder[MAX_PATH];
844 fn = getenv("SOFTPKCS11RC");
846 /* Retrieve the roaming AppData folder for the current user. The
847 current user is the user account represented by the current
851 SUCCEEDED(SHGetFolderPath(NULL, CSIDL_APPDATA, NULL, SHGFP_TYPE_CURRENT, appdatafolder))) {
853 asprintf(&fn, "%s\\.soft-token.rc", appdatafolder);
863 C_Initialize(CK_VOID_PTR a)
865 CK_C_INITIALIZE_ARGS_PTR args = a;
869 st_logf("Initialize\n");
873 OpenSSL_add_all_algorithms();
875 srandom(getpid() ^ (int) time(NULL));
877 for (i = 0; i < MAX_NUM_SESSION; i++) {
878 soft_token.state[i].session_handle = CK_INVALID_HANDLE;
879 soft_token.state[i].find.attributes = NULL;
880 soft_token.state[i].find.num_attributes = 0;
881 soft_token.state[i].find.next_object = -1;
882 reset_crypto_state(&soft_token.state[i]);
885 soft_token.flags.hardware_slot = 1;
886 soft_token.flags.app_error_fatal = 0;
887 soft_token.flags.login_done = 0;
889 soft_token.object.objs = NULL;
890 soft_token.object.num_objs = 0;
892 soft_token.logfile = NULL;
894 soft_token.logfile = stdout;
897 soft_token.logfile = fopen("/tmp/log-pkcs11.txt", "a");
901 st_logf("\tCreateMutex:\t%p\n", args->CreateMutex);
902 st_logf("\tDestroyMutext\t%p\n", args->DestroyMutex);
903 st_logf("\tLockMutext\t%p\n", args->LockMutex);
904 st_logf("\tUnlockMutext\t%p\n", args->UnlockMutex);
905 st_logf("\tFlags\t%04x\n", (unsigned int)args->flags);
908 soft_token.config_file = get_config_file_for_user();
911 * This operations doesn't return CKR_OK if any of the
912 * certificates failes to be unparsed (ie password protected).
914 ret = read_conf_file(soft_token.config_file, CKU_USER, NULL);
916 soft_token.flags.login_done = 1;
922 C_Finalize(CK_VOID_PTR args)
928 st_logf("Finalize\n");
930 for (i = 0; i < MAX_NUM_SESSION; i++) {
931 if (soft_token.state[i].session_handle != CK_INVALID_HANDLE) {
932 application_error("application finalized without "
933 "closing session\n");
934 close_session(&soft_token.state[i]);
942 C_GetInfo(CK_INFO_PTR args)
946 st_logf("GetInfo\n");
948 memset(args, 17, sizeof(*args));
949 args->cryptokiVersion.major = 2;
950 args->cryptokiVersion.minor = 10;
951 snprintf_fill((char *)args->manufacturerID,
952 sizeof(args->manufacturerID),
954 "Heimdal hx509 SoftToken");
955 snprintf_fill((char *)args->libraryDescription,
956 sizeof(args->libraryDescription), ' ',
957 "Heimdal hx509 SoftToken");
958 args->libraryVersion.major = 2;
959 args->libraryVersion.minor = 0;
964 extern CK_FUNCTION_LIST funcs;
967 C_GetFunctionList(CK_FUNCTION_LIST_PTR_PTR ppFunctionList)
971 *ppFunctionList = &funcs;
976 C_GetSlotList(CK_BBOOL tokenPresent,
977 CK_SLOT_ID_PTR pSlotList,
978 CK_ULONG_PTR pulCount)
981 st_logf("GetSlotList: %s\n",
982 tokenPresent ? "tokenPresent" : "token not Present");
990 C_GetSlotInfo(CK_SLOT_ID slotID,
991 CK_SLOT_INFO_PTR pInfo)
994 st_logf("GetSlotInfo: slot: %d : %s\n", (int)slotID, has_session());
996 memset(pInfo, 18, sizeof(*pInfo));
999 return CKR_ARGUMENTS_BAD;
1001 snprintf_fill((char *)pInfo->slotDescription,
1002 sizeof(pInfo->slotDescription),
1004 "Heimdal hx509 SoftToken (slot)");
1005 snprintf_fill((char *)pInfo->manufacturerID,
1006 sizeof(pInfo->manufacturerID),
1008 "Heimdal hx509 SoftToken (slot)");
1009 pInfo->flags = CKF_TOKEN_PRESENT;
1010 if (soft_token.flags.hardware_slot)
1011 pInfo->flags |= CKF_HW_SLOT;
1012 pInfo->hardwareVersion.major = 1;
1013 pInfo->hardwareVersion.minor = 0;
1014 pInfo->firmwareVersion.major = 1;
1015 pInfo->firmwareVersion.minor = 0;
1021 C_GetTokenInfo(CK_SLOT_ID slotID,
1022 CK_TOKEN_INFO_PTR pInfo)
1025 st_logf("GetTokenInfo: %s\n", has_session());
1027 memset(pInfo, 19, sizeof(*pInfo));
1029 snprintf_fill((char *)pInfo->label,
1030 sizeof(pInfo->label),
1032 "Heimdal hx509 SoftToken (token)");
1033 snprintf_fill((char *)pInfo->manufacturerID,
1034 sizeof(pInfo->manufacturerID),
1036 "Heimdal hx509 SoftToken (token)");
1037 snprintf_fill((char *)pInfo->model,
1038 sizeof(pInfo->model),
1040 "Heimdal hx509 SoftToken (token)");
1041 snprintf_fill((char *)pInfo->serialNumber,
1042 sizeof(pInfo->serialNumber),
1046 CKF_TOKEN_INITIALIZED |
1047 CKF_USER_PIN_INITIALIZED;
1049 if (soft_token.flags.login_done == 0)
1050 pInfo->flags |= CKF_LOGIN_REQUIRED;
1053 CKF_RESTORE_KEY_NOT_NEEDED |
1055 pInfo->ulMaxSessionCount = MAX_NUM_SESSION;
1056 pInfo->ulSessionCount = soft_token.open_sessions;
1057 pInfo->ulMaxRwSessionCount = MAX_NUM_SESSION;
1058 pInfo->ulRwSessionCount = soft_token.open_sessions;
1059 pInfo->ulMaxPinLen = 1024;
1060 pInfo->ulMinPinLen = 0;
1061 pInfo->ulTotalPublicMemory = 4711;
1062 pInfo->ulFreePublicMemory = 4712;
1063 pInfo->ulTotalPrivateMemory = 4713;
1064 pInfo->ulFreePrivateMemory = 4714;
1065 pInfo->hardwareVersion.major = 2;
1066 pInfo->hardwareVersion.minor = 0;
1067 pInfo->firmwareVersion.major = 2;
1068 pInfo->firmwareVersion.minor = 0;
1074 C_GetMechanismList(CK_SLOT_ID slotID,
1075 CK_MECHANISM_TYPE_PTR pMechanismList,
1076 CK_ULONG_PTR pulCount)
1079 st_logf("GetMechanismList\n");
1082 if (pMechanismList == NULL_PTR)
1084 pMechanismList[1] = CKM_RSA_PKCS;
1090 C_GetMechanismInfo(CK_SLOT_ID slotID,
1091 CK_MECHANISM_TYPE type,
1092 CK_MECHANISM_INFO_PTR pInfo)
1095 st_logf("GetMechanismInfo: slot %d type: %d\n",
1096 (int)slotID, (int)type);
1097 memset(pInfo, 0, sizeof(*pInfo));
1103 C_InitToken(CK_SLOT_ID slotID,
1104 CK_UTF8CHAR_PTR pPin,
1106 CK_UTF8CHAR_PTR pLabel)
1109 st_logf("InitToken: slot %d\n", (int)slotID);
1110 return CKR_FUNCTION_NOT_SUPPORTED;
1114 C_OpenSession(CK_SLOT_ID slotID,
1116 CK_VOID_PTR pApplication,
1118 CK_SESSION_HANDLE_PTR phSession)
1122 st_logf("OpenSession: slot: %d\n", (int)slotID);
1124 if (soft_token.open_sessions == MAX_NUM_SESSION)
1125 return CKR_SESSION_COUNT;
1127 soft_token.application = pApplication;
1128 soft_token.notify = Notify;
1130 for (i = 0; i < MAX_NUM_SESSION; i++)
1131 if (soft_token.state[i].session_handle == CK_INVALID_HANDLE)
1133 if (i == MAX_NUM_SESSION)
1136 soft_token.open_sessions++;
1138 soft_token.state[i].session_handle =
1139 (CK_SESSION_HANDLE)(random() & 0xfffff);
1140 *phSession = soft_token.state[i].session_handle;
1146 C_CloseSession(CK_SESSION_HANDLE hSession)
1148 struct session_state *state;
1150 st_logf("CloseSession\n");
1152 if (verify_session_handle(hSession, &state) != CKR_OK)
1153 application_error("closed session not open");
1155 close_session(state);
1161 C_CloseAllSessions(CK_SLOT_ID slotID)
1166 st_logf("CloseAllSessions\n");
1168 for (i = 0; i < MAX_NUM_SESSION; i++)
1169 if (soft_token.state[i].session_handle != CK_INVALID_HANDLE)
1170 close_session(&soft_token.state[i]);
1176 C_GetSessionInfo(CK_SESSION_HANDLE hSession,
1177 CK_SESSION_INFO_PTR pInfo)
1179 st_logf("GetSessionInfo\n");
1182 VERIFY_SESSION_HANDLE(hSession, NULL);
1184 memset(pInfo, 20, sizeof(*pInfo));
1187 if (soft_token.flags.login_done)
1188 pInfo->state = CKS_RO_USER_FUNCTIONS;
1190 pInfo->state = CKS_RO_PUBLIC_SESSION;
1191 pInfo->flags = CKF_SERIAL_SESSION;
1192 pInfo->ulDeviceError = 0;
1198 C_Login(CK_SESSION_HANDLE hSession,
1199 CK_USER_TYPE userType,
1200 CK_UTF8CHAR_PTR pPin,
1209 VERIFY_SESSION_HANDLE(hSession, NULL);
1211 if (pPin != NULL_PTR) {
1212 asprintf(&pin, "%.*s", (int)ulPinLen, pPin);
1213 st_logf("type: %d password: %s\n", (int)userType, pin);
1220 ret = read_conf_file(soft_token.config_file, userType, pin);
1222 soft_token.flags.login_done = 1;
1226 return soft_token.flags.login_done ? CKR_OK : CKR_PIN_INCORRECT;
1230 C_Logout(CK_SESSION_HANDLE hSession)
1232 st_logf("Logout\n");
1235 VERIFY_SESSION_HANDLE(hSession, NULL);
1236 return CKR_FUNCTION_NOT_SUPPORTED;
1240 C_GetObjectSize(CK_SESSION_HANDLE hSession,
1241 CK_OBJECT_HANDLE hObject,
1242 CK_ULONG_PTR pulSize)
1244 st_logf("GetObjectSize\n");
1247 VERIFY_SESSION_HANDLE(hSession, NULL);
1248 return CKR_FUNCTION_NOT_SUPPORTED;
1252 C_GetAttributeValue(CK_SESSION_HANDLE hSession,
1253 CK_OBJECT_HANDLE hObject,
1254 CK_ATTRIBUTE_PTR pTemplate,
1257 struct session_state *state;
1258 struct st_object *obj;
1265 st_logf("GetAttributeValue: %lx\n",
1266 (unsigned long)HANDLE_OBJECT_ID(hObject));
1267 VERIFY_SESSION_HANDLE(hSession, &state);
1269 if ((ret = object_handle_to_object(hObject, &obj)) != CKR_OK) {
1270 st_logf("object not found: %lx\n",
1271 (unsigned long)HANDLE_OBJECT_ID(hObject));
1275 for (i = 0; i < ulCount; i++) {
1276 st_logf(" getting 0x%08lx\n", (unsigned long)pTemplate[i].type);
1277 for (j = 0; j < obj->num_attributes; j++) {
1278 if (obj->attrs[j].secret) {
1279 pTemplate[i].ulValueLen = (CK_ULONG)-1;
1282 if (pTemplate[i].type == obj->attrs[j].attribute.type) {
1283 if (pTemplate[i].pValue != NULL_PTR && obj->attrs[j].secret == 0) {
1284 if (pTemplate[i].ulValueLen >= obj->attrs[j].attribute.ulValueLen)
1285 memcpy(pTemplate[i].pValue, obj->attrs[j].attribute.pValue,
1286 obj->attrs[j].attribute.ulValueLen);
1288 pTemplate[i].ulValueLen = obj->attrs[j].attribute.ulValueLen;
1292 if (j == obj->num_attributes) {
1293 st_logf("key type: 0x%08lx not found\n", (unsigned long)pTemplate[i].type);
1294 pTemplate[i].ulValueLen = (CK_ULONG)-1;
1302 C_FindObjectsInit(CK_SESSION_HANDLE hSession,
1303 CK_ATTRIBUTE_PTR pTemplate,
1306 struct session_state *state;
1308 st_logf("FindObjectsInit\n");
1312 VERIFY_SESSION_HANDLE(hSession, &state);
1314 if (state->find.next_object != -1) {
1315 application_error("application didn't do C_FindObjectsFinal\n");
1316 find_object_final(state);
1321 print_attributes(pTemplate, ulCount);
1323 state->find.attributes =
1324 calloc(1, ulCount * sizeof(state->find.attributes[0]));
1325 if (state->find.attributes == NULL)
1326 return CKR_DEVICE_MEMORY;
1327 for (i = 0; i < ulCount; i++) {
1328 state->find.attributes[i].pValue =
1329 malloc(pTemplate[i].ulValueLen);
1330 if (state->find.attributes[i].pValue == NULL) {
1331 find_object_final(state);
1332 return CKR_DEVICE_MEMORY;
1334 memcpy(state->find.attributes[i].pValue,
1335 pTemplate[i].pValue, pTemplate[i].ulValueLen);
1336 state->find.attributes[i].type = pTemplate[i].type;
1337 state->find.attributes[i].ulValueLen = pTemplate[i].ulValueLen;
1339 state->find.num_attributes = ulCount;
1340 state->find.next_object = 0;
1342 st_logf("find all objects\n");
1343 state->find.attributes = NULL;
1344 state->find.num_attributes = 0;
1345 state->find.next_object = 0;
1352 C_FindObjects(CK_SESSION_HANDLE hSession,
1353 CK_OBJECT_HANDLE_PTR phObject,
1354 CK_ULONG ulMaxObjectCount,
1355 CK_ULONG_PTR pulObjectCount)
1357 struct session_state *state;
1362 st_logf("FindObjects\n");
1364 VERIFY_SESSION_HANDLE(hSession, &state);
1366 if (state->find.next_object == -1) {
1367 application_error("application didn't do C_FindObjectsInit\n");
1368 return CKR_ARGUMENTS_BAD;
1370 if (ulMaxObjectCount == 0) {
1371 application_error("application asked for 0 objects\n");
1372 return CKR_ARGUMENTS_BAD;
1374 *pulObjectCount = 0;
1375 for (i = state->find.next_object; i < soft_token.object.num_objs; i++) {
1376 st_logf("FindObjects: %d\n", i);
1377 state->find.next_object = i + 1;
1378 if (attributes_match(soft_token.object.objs[i],
1379 state->find.attributes,
1380 state->find.num_attributes)) {
1381 *phObject++ = soft_token.object.objs[i]->object_handle;
1383 (*pulObjectCount)++;
1384 if (ulMaxObjectCount == 0)
1392 C_FindObjectsFinal(CK_SESSION_HANDLE hSession)
1394 struct session_state *state;
1398 st_logf("FindObjectsFinal\n");
1399 VERIFY_SESSION_HANDLE(hSession, &state);
1400 find_object_final(state);
1405 commonInit(CK_ATTRIBUTE *attr_match, int attr_match_len,
1406 const CK_MECHANISM_TYPE *mechs, int mechs_len,
1407 const CK_MECHANISM_PTR pMechanism, CK_OBJECT_HANDLE hKey,
1408 struct st_object **o)
1414 if ((ret = object_handle_to_object(hKey, o)) != CKR_OK)
1417 ret = attributes_match(*o, attr_match, attr_match_len);
1419 application_error("called commonInit on key that doesn't "
1420 "support required attr");
1421 return CKR_ARGUMENTS_BAD;
1424 for (i = 0; i < mechs_len; i++)
1425 if (mechs[i] == pMechanism->mechanism)
1427 if (i == mechs_len) {
1428 application_error("called mech (%08lx) not supported\n",
1429 pMechanism->mechanism);
1430 return CKR_ARGUMENTS_BAD;
1437 dup_mechanism(CK_MECHANISM_PTR *dp, const CK_MECHANISM_PTR pMechanism)
1441 p = malloc(sizeof(*p));
1443 return CKR_DEVICE_MEMORY;
1448 memcpy(p, pMechanism, sizeof(*p));
1454 C_DigestInit(CK_SESSION_HANDLE hSession,
1455 CK_MECHANISM_PTR pMechanism)
1457 st_logf("DigestInit\n");
1459 VERIFY_SESSION_HANDLE(hSession, NULL);
1460 return CKR_FUNCTION_NOT_SUPPORTED;
1464 C_SignInit(CK_SESSION_HANDLE hSession,
1465 CK_MECHANISM_PTR pMechanism,
1466 CK_OBJECT_HANDLE hKey)
1468 struct session_state *state;
1469 CK_MECHANISM_TYPE mechs[] = { CKM_RSA_PKCS };
1470 CK_BBOOL bool_true = CK_TRUE;
1471 CK_ATTRIBUTE attr[] = {
1472 { CKA_SIGN, &bool_true, sizeof(bool_true) }
1474 struct st_object *o;
1478 st_logf("SignInit\n");
1479 VERIFY_SESSION_HANDLE(hSession, &state);
1481 ret = commonInit(attr, sizeof(attr)/sizeof(attr[0]),
1482 mechs, sizeof(mechs)/sizeof(mechs[0]),
1483 pMechanism, hKey, &o);
1487 ret = dup_mechanism(&state->sign_mechanism, pMechanism);
1489 state->sign_object = OBJECT_ID(o);
1495 C_Sign(CK_SESSION_HANDLE hSession,
1498 CK_BYTE_PTR pSignature,
1499 CK_ULONG_PTR pulSignatureLen)
1501 struct session_state *state;
1502 struct st_object *o;
1505 const AlgorithmIdentifier *alg;
1506 heim_octet_string sig, data;
1510 VERIFY_SESSION_HANDLE(hSession, &state);
1515 if (state->sign_object == -1)
1516 return CKR_ARGUMENTS_BAD;
1518 if (pulSignatureLen == NULL) {
1519 st_logf("signature len NULL\n");
1520 ret = CKR_ARGUMENTS_BAD;
1524 if (pData == NULL_PTR) {
1525 st_logf("data NULL\n");
1526 ret = CKR_ARGUMENTS_BAD;
1530 o = soft_token.object.objs[state->sign_object];
1532 if (hx509_cert_have_private_key(o->cert) == 0) {
1533 st_logf("private key NULL\n");
1534 return CKR_ARGUMENTS_BAD;
1537 switch(state->sign_mechanism->mechanism) {
1539 alg = hx509_signature_rsa_pkcs1_x509();
1542 ret = CKR_FUNCTION_NOT_SUPPORTED;
1547 data.length = ulDataLen;
1549 hret = _hx509_create_signature(context,
1550 _hx509_cert_private_key(o->cert),
1556 ret = CKR_DEVICE_ERROR;
1559 *pulSignatureLen = sig.length;
1561 if (pSignature != NULL_PTR)
1562 memcpy(pSignature, sig.data, sig.length);
1567 memset(sig.data, 0, sig.length);
1568 der_free_octet_string(&sig);
1574 C_SignUpdate(CK_SESSION_HANDLE hSession,
1579 st_logf("SignUpdate\n");
1580 VERIFY_SESSION_HANDLE(hSession, NULL);
1581 return CKR_FUNCTION_NOT_SUPPORTED;
1586 C_SignFinal(CK_SESSION_HANDLE hSession,
1587 CK_BYTE_PTR pSignature,
1588 CK_ULONG_PTR pulSignatureLen)
1591 st_logf("SignUpdate\n");
1592 VERIFY_SESSION_HANDLE(hSession, NULL);
1593 return CKR_FUNCTION_NOT_SUPPORTED;
1597 C_VerifyInit(CK_SESSION_HANDLE hSession,
1598 CK_MECHANISM_PTR pMechanism,
1599 CK_OBJECT_HANDLE hKey)
1601 struct session_state *state;
1602 CK_MECHANISM_TYPE mechs[] = { CKM_RSA_PKCS };
1603 CK_BBOOL bool_true = CK_TRUE;
1604 CK_ATTRIBUTE attr[] = {
1605 { CKA_VERIFY, &bool_true, sizeof(bool_true) }
1607 struct st_object *o;
1611 st_logf("VerifyInit\n");
1612 VERIFY_SESSION_HANDLE(hSession, &state);
1614 ret = commonInit(attr, sizeof(attr)/sizeof(attr[0]),
1615 mechs, sizeof(mechs)/sizeof(mechs[0]),
1616 pMechanism, hKey, &o);
1620 ret = dup_mechanism(&state->verify_mechanism, pMechanism);
1622 state->verify_object = OBJECT_ID(o);
1628 C_Verify(CK_SESSION_HANDLE hSession,
1631 CK_BYTE_PTR pSignature,
1632 CK_ULONG ulSignatureLen)
1634 struct session_state *state;
1635 struct st_object *o;
1636 const AlgorithmIdentifier *alg;
1639 heim_octet_string data, sig;
1642 st_logf("Verify\n");
1643 VERIFY_SESSION_HANDLE(hSession, &state);
1645 if (state->verify_object == -1)
1646 return CKR_ARGUMENTS_BAD;
1648 o = soft_token.object.objs[state->verify_object];
1650 switch(state->verify_mechanism->mechanism) {
1652 alg = hx509_signature_rsa_pkcs1_x509();
1655 ret = CKR_FUNCTION_NOT_SUPPORTED;
1660 sig.length = ulDataLen;
1661 data.data = pSignature;
1662 data.length = ulSignatureLen;
1664 hret = _hx509_verify_signature(context,
1670 ret = CKR_GENERAL_ERROR;
1681 C_VerifyUpdate(CK_SESSION_HANDLE hSession,
1686 st_logf("VerifyUpdate\n");
1687 VERIFY_SESSION_HANDLE(hSession, NULL);
1688 return CKR_FUNCTION_NOT_SUPPORTED;
1692 C_VerifyFinal(CK_SESSION_HANDLE hSession,
1693 CK_BYTE_PTR pSignature,
1694 CK_ULONG ulSignatureLen)
1697 st_logf("VerifyFinal\n");
1698 VERIFY_SESSION_HANDLE(hSession, NULL);
1699 return CKR_FUNCTION_NOT_SUPPORTED;
1703 C_GenerateRandom(CK_SESSION_HANDLE hSession,
1704 CK_BYTE_PTR RandomData,
1705 CK_ULONG ulRandomLen)
1708 st_logf("GenerateRandom\n");
1709 VERIFY_SESSION_HANDLE(hSession, NULL);
1710 return CKR_FUNCTION_NOT_SUPPORTED;
1714 CK_FUNCTION_LIST funcs = {
1726 (void *)func_not_supported, /* C_InitPIN */
1727 (void *)func_not_supported, /* C_SetPIN */
1732 (void *)func_not_supported, /* C_GetOperationState */
1733 (void *)func_not_supported, /* C_SetOperationState */
1736 (void *)func_not_supported, /* C_CreateObject */
1737 (void *)func_not_supported, /* C_CopyObject */
1738 (void *)func_not_supported, /* C_DestroyObject */
1739 (void *)func_not_supported, /* C_GetObjectSize */
1740 C_GetAttributeValue,
1741 (void *)func_not_supported, /* C_SetAttributeValue */
1745 (void *)func_not_supported, /* C_EncryptInit, */
1746 (void *)func_not_supported, /* C_Encrypt, */
1747 (void *)func_not_supported, /* C_EncryptUpdate, */
1748 (void *)func_not_supported, /* C_EncryptFinal, */
1749 (void *)func_not_supported, /* C_DecryptInit, */
1750 (void *)func_not_supported, /* C_Decrypt, */
1751 (void *)func_not_supported, /* C_DecryptUpdate, */
1752 (void *)func_not_supported, /* C_DecryptFinal, */
1754 (void *)func_not_supported, /* C_Digest */
1755 (void *)func_not_supported, /* C_DigestUpdate */
1756 (void *)func_not_supported, /* C_DigestKey */
1757 (void *)func_not_supported, /* C_DigestFinal */
1762 (void *)func_not_supported, /* C_SignRecoverInit */
1763 (void *)func_not_supported, /* C_SignRecover */
1768 (void *)func_not_supported, /* C_VerifyRecoverInit */
1769 (void *)func_not_supported, /* C_VerifyRecover */
1770 (void *)func_not_supported, /* C_DigestEncryptUpdate */
1771 (void *)func_not_supported, /* C_DecryptDigestUpdate */
1772 (void *)func_not_supported, /* C_SignEncryptUpdate */
1773 (void *)func_not_supported, /* C_DecryptVerifyUpdate */
1774 (void *)func_not_supported, /* C_GenerateKey */
1775 (void *)func_not_supported, /* C_GenerateKeyPair */
1776 (void *)func_not_supported, /* C_WrapKey */
1777 (void *)func_not_supported, /* C_UnwrapKey */
1778 (void *)func_not_supported, /* C_DeriveKey */
1779 (void *)func_not_supported, /* C_SeedRandom */
1781 (void *)func_not_supported, /* C_GetFunctionStatus */
1782 (void *)func_not_supported, /* C_CancelFunction */
1783 (void *)func_not_supported /* C_WaitForSlotEvent */