/* * CDDL HEADER START * * The contents of this file are subject to the terms of the * Common Development and Distribution License (the "License"). * You may not use this file except in compliance with the License. * * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE * or http://www.opensolaris.org/os/licensing. * See the License for the specific language governing permissions * and limitations under the License. * * When distributing Covered Code, include this CDDL HEADER in each * file and include the License file at usr/src/OPENSOLARIS.LICENSE. * If applicable, add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your own identifying * information: Portions Copyright [yyyy] [name of copyright owner] * * CDDL HEADER END */ /* * Copyright 2009 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. */ #include #include #include #include #include #include "cryptoutil.h" static int uef_interpret(char *, uentry_t **); static int parse_policylist(char *, uentry_t *); static boolean_t is_fips(char *); /* * Retrieve the user-level provider info from the pkcs11.conf file. * If successful, the result is returned from the ppliblist argument. * This function returns SUCCESS if successfully done; otherwise it returns * FAILURE. */ int get_pkcs11conf_info(uentrylist_t **ppliblist) { FILE *pfile; char buffer[BUFSIZ]; size_t len; uentry_t *pent; uentrylist_t *pentlist; uentrylist_t *pcur; int rc = SUCCESS; *ppliblist = NULL; if ((pfile = fopen(_PATH_PKCS11_CONF, "rF")) == NULL) { cryptoerror(LOG_ERR, "failed to open %s.\n", _PATH_PKCS11_CONF); return (FAILURE); } while (fgets(buffer, BUFSIZ, pfile) != NULL) { if (buffer[0] == '#' || buffer[0] == ' ' || buffer[0] == '\n'|| buffer[0] == '\t') { continue; /* ignore comment lines */ } len = strlen(buffer); if (buffer[len-1] == '\n') { /* get rid of trailing '\n' */ len--; } buffer[len] = '\0'; if ((rc = uef_interpret(buffer, &pent)) != SUCCESS) { break; } /* append pent into ppliblist */ pentlist = malloc(sizeof (uentrylist_t)); if (pentlist == NULL) { cryptoerror(LOG_ERR, "parsing %s, out of memory.\n", _PATH_PKCS11_CONF); free_uentry(pent); rc = FAILURE; break; } pentlist->puent = pent; pentlist->next = NULL; if (*ppliblist == NULL) { *ppliblist = pcur = pentlist; } else { pcur->next = pentlist; pcur = pcur->next; } } (void) fclose(pfile); if (rc != SUCCESS) { free_uentrylist(*ppliblist); *ppliblist = NULL; } return (rc); } static int parse_fips_mode(char *buf, boolean_t *mode) { char *value; if (strncmp(buf, EF_FIPS_STATUS, sizeof (EF_FIPS_STATUS) - 1) == 0) { if (value = strpbrk(buf, SEP_EQUAL)) { value++; /* get rid of = */ if (strcmp(value, DISABLED_KEYWORD) == 0) { *mode = B_FALSE; } else if (strcmp(value, ENABLED_KEYWORD) == 0) { *mode = B_TRUE; } else { cryptoerror(LOG_ERR, gettext( "Failed to parse pkcs11.conf file.\n")); return (CKR_FUNCTION_FAILED); } return (CKR_OK); } else { return (CKR_FUNCTION_FAILED); } } else { /* should not come here */ cryptoerror(LOG_ERR, gettext( "Failed to parse pkcs11.conf file.\n")); return (CKR_FUNCTION_FAILED); } } /* * This routine converts a char string into a uentry_t structure * The input string "buf" should be one of the following: * library_name * library_name:NO_RANDOM * library_name:disabledlist=m1,m2,...,mk * library_name:disabledlist=m1,m2,...,mk;NO_RANDOM * library_name:enabledlist= * library_name:enabledlist=;NO_RANDOM * library_name:enabledlist=m1,m2,...,mk * library_name:enabledlist=m1,m2,...,mk;NO_RANDOM * metaslot:status=enabled;enabledlist=m1,m2,....;slot=;\ * token= * * Note: * The mechanisms m1,..mk are in hex form. For example, "0x00000210" * for CKM_MD5. * * For the metaslot entry, "enabledlist", "slot", "auto_key_migrate" * or "token" is optional */ static int uef_interpret(char *buf, uentry_t **ppent) { uentry_t *pent; char *token1; char *token2; char *lasts; int rc; *ppent = NULL; if ((token1 = strtok_r(buf, SEP_COLON, &lasts)) == NULL) { /* buf is NULL */ return (FAILURE); }; pent = calloc(sizeof (uentry_t), 1); if (pent == NULL) { cryptoerror(LOG_ERR, "parsing %s, out of memory.\n", _PATH_PKCS11_CONF); return (FAILURE); } (void) strlcpy(pent->name, token1, sizeof (pent->name)); if (is_fips(token1)) { if ((rc = parse_fips_mode(buf + strlen(token1) + 1, &pent->flag_fips_enabled)) != SUCCESS) { free_uentry(pent); return (rc); } *ppent = pent; return (SUCCESS); } /* * in case metaslot_auto_key_migrate is not specified, it should * be default to true */ pent->flag_metaslot_auto_key_migrate = B_TRUE; while ((token2 = strtok_r(NULL, SEP_SEMICOLON, &lasts)) != NULL) { if ((rc = parse_policylist(token2, pent)) != SUCCESS) { free_uentry(pent); return (rc); } } *ppent = pent; return (SUCCESS); } /* * This routine parses the policy list and stored the result in the argument * pent. * * Arg buf: input only, its format should be one of the following: * enabledlist= * enabledlist=m1,m2,...,mk * disabledlist=m1,m2,...,mk * NO_RANDOM * metaslot_status=enabled|disabled * metaslot_token= * metaslot_slot=flag_enabledlist = B_FALSE; } else if (strncmp(buf, EF_ENABLED, sizeof (EF_ENABLED) - 1) == 0) { pent->flag_enabledlist = B_TRUE; } else if (strncmp(buf, EF_NORANDOM, sizeof (EF_NORANDOM) - 1) == 0) { pent->flag_norandom = B_TRUE; return (rc); } else if (strncmp(buf, METASLOT_TOKEN, sizeof (METASLOT_TOKEN) - 1) == 0) { if (value = strpbrk(buf, SEP_EQUAL)) { value++; /* get rid of = */ (void) strlcpy((char *)pent->metaslot_ks_token, value, sizeof (pent->metaslot_ks_token)); return (SUCCESS); } else { cryptoerror(LOG_ERR, "failed to parse %s.\n", _PATH_PKCS11_CONF); return (FAILURE); } } else if (strncmp(buf, METASLOT_SLOT, sizeof (METASLOT_SLOT) - 1) == 0) { if (value = strpbrk(buf, SEP_EQUAL)) { value++; /* get rid of = */ (void) strlcpy((char *)pent->metaslot_ks_slot, value, sizeof (pent->metaslot_ks_slot)); return (SUCCESS); } else { cryptoerror(LOG_ERR, "failed to parse %s.\n", _PATH_PKCS11_CONF); return (FAILURE); } } else if (strncmp(buf, METASLOT_STATUS, sizeof (METASLOT_STATUS) - 1) == 0) { if (value = strpbrk(buf, SEP_EQUAL)) { value++; /* get rid of = */ if (strcmp(value, DISABLED_KEYWORD) == 0) { pent->flag_metaslot_enabled = B_FALSE; } else if (strcmp(value, ENABLED_KEYWORD) == 0) { pent->flag_metaslot_enabled = B_TRUE; } else { cryptoerror(LOG_ERR, "failed to parse %s.\n", _PATH_PKCS11_CONF); return (FAILURE); } return (SUCCESS); } else { cryptoerror(LOG_ERR, "failed to parse %s.\n", _PATH_PKCS11_CONF); return (FAILURE); } } else if (strncmp(buf, METASLOT_AUTO_KEY_MIGRATE, sizeof (METASLOT_AUTO_KEY_MIGRATE) - 1) == 0) { if (value = strpbrk(buf, SEP_EQUAL)) { value++; /* get rid of = */ if (strcmp(value, DISABLED_KEYWORD) == 0) { pent->flag_metaslot_auto_key_migrate = B_FALSE; } else if (strcmp(value, ENABLED_KEYWORD) == 0) { pent->flag_metaslot_auto_key_migrate = B_TRUE; } else { cryptoerror(LOG_ERR, "failed to parse %s.\n", _PATH_PKCS11_CONF); return (FAILURE); } return (SUCCESS); } else { cryptoerror(LOG_ERR, "failed to parse %s.\n", _PATH_PKCS11_CONF); return (FAILURE); } } else { cryptoerror(LOG_ERR, "failed to parse %s.\n", _PATH_PKCS11_CONF); return (FAILURE); } if (value = strpbrk(buf, SEP_EQUAL)) { value++; /* get rid of = */ } if ((next_token = strtok_r(value, SEP_COMMA, &lasts)) == NULL) { if (pent->flag_enabledlist) { return (SUCCESS); } else { cryptoerror(LOG_ERR, "failed to parse %s.\n", _PATH_PKCS11_CONF); return (FAILURE); } } while (next_token) { if ((pmech = create_umech(next_token)) == NULL) { cryptoerror(LOG_ERR, "parsing %s, out of memory.\n", _PATH_PKCS11_CONF); rc = FAILURE; break; } if (phead == NULL) { phead = pcur = pmech; } else { pcur->next = pmech; pcur = pcur->next; } count++; next_token = strtok_r(NULL, SEP_COMMA, &lasts); } if (rc == SUCCESS) { pent->policylist = phead; pent->count = count; } else { free_umechlist(phead); } return (rc); } /* * Create one item of type umechlist_t with the mechanism name. A NULL is * returned when the input name is NULL or the heap memory is insufficient. */ umechlist_t * create_umech(char *name) { umechlist_t *pmech = NULL; if (name == NULL) { return (NULL); } if ((pmech = malloc(sizeof (umechlist_t))) != NULL) { (void) strlcpy(pmech->name, name, sizeof (pmech->name)); pmech->next = NULL; } return (pmech); } void free_umechlist(umechlist_t *plist) { umechlist_t *pnext; while (plist != NULL) { pnext = plist->next; free(plist); plist = pnext; } } void free_uentry(uentry_t *pent) { if (pent == NULL) { return; } else { free_umechlist(pent->policylist); free(pent); } } void free_uentrylist(uentrylist_t *entrylist) { uentrylist_t *pnext; while (entrylist != NULL) { pnext = entrylist->next; free_uentry(entrylist->puent); free(entrylist); entrylist = pnext; } } /* * Duplicate an UEF mechanism list. A NULL pointer is returned if out of * memory or the input argument is NULL. */ static umechlist_t * dup_umechlist(umechlist_t *plist) { umechlist_t *pres = NULL; umechlist_t *pcur; umechlist_t *ptmp; int rc = SUCCESS; while (plist != NULL) { if (!(ptmp = create_umech(plist->name))) { rc = FAILURE; break; } if (pres == NULL) { pres = pcur = ptmp; } else { pcur->next = ptmp; pcur = pcur->next; } plist = plist->next; } if (rc != SUCCESS) { free_umechlist(pres); return (NULL); } return (pres); } /* * Duplicate an uentry. A NULL pointer is returned if out of memory * or the input argument is NULL. */ static uentry_t * dup_uentry(uentry_t *puent1) { uentry_t *puent2 = NULL; if (puent1 == NULL) { return (NULL); } if ((puent2 = malloc(sizeof (uentry_t))) == NULL) { cryptoerror(LOG_STDERR, gettext("out of memory.")); return (NULL); } else { (void) strlcpy(puent2->name, puent1->name, sizeof (puent2->name)); puent2->flag_norandom = puent1->flag_norandom; puent2->flag_enabledlist = puent1->flag_enabledlist; puent2->policylist = dup_umechlist(puent1->policylist); puent2->flag_metaslot_enabled = puent1->flag_metaslot_enabled; puent2->flag_metaslot_auto_key_migrate = puent1->flag_metaslot_auto_key_migrate; (void) memcpy(puent2->metaslot_ks_slot, puent1->metaslot_ks_slot, SLOT_DESCRIPTION_SIZE); (void) memcpy(puent2->metaslot_ks_token, puent1->metaslot_ks_token, TOKEN_LABEL_SIZE); puent2->count = puent1->count; puent2->flag_fips_enabled = puent1->flag_fips_enabled; return (puent2); } } /* * Find the entry in the "pkcs11.conf" file with "libname" as the provider * name. Return the entry if found, otherwise return NULL. */ uentry_t * getent_uef(char *libname) { uentrylist_t *pliblist = NULL; uentrylist_t *plib = NULL; uentry_t *puent = NULL; boolean_t found = B_FALSE; if (libname == NULL) { return (NULL); } if ((get_pkcs11conf_info(&pliblist)) == FAILURE) { return (NULL); } plib = pliblist; while (plib) { if (strcmp(plib->puent->name, libname) == 0) { found = B_TRUE; break; } else { plib = plib->next; } } if (found) { puent = dup_uentry(plib->puent); } free_uentrylist(pliblist); return (puent); } /* * Retrieve the metaslot information from the pkcs11.conf file. * This function returns SUCCESS if successfully done; otherwise it returns * FAILURE. If successful, the caller is responsible to free the space * allocated for objectstore_slot_info and objectstore_token_info. */ int get_metaslot_info(boolean_t *status_enabled, boolean_t *migrate_enabled, char **objectstore_slot_info, char **objectstore_token_info) { int rc = SUCCESS; uentry_t *puent; char *buf1 = NULL; char *buf2 = NULL; if ((puent = getent_uef(METASLOT_KEYWORD)) == NULL) { /* metaslot entry doesn't exist */ return (FAILURE); } *status_enabled = puent->flag_metaslot_enabled; *migrate_enabled = puent->flag_metaslot_auto_key_migrate; buf1 = malloc(SLOT_DESCRIPTION_SIZE); if (buf1 == NULL) { cryptoerror(LOG_ERR, "get_metaslot_info() - out of memory.\n"); rc = FAILURE; goto out; } (void) strcpy(buf1, (const char *) puent->metaslot_ks_slot); *objectstore_slot_info = buf1; buf2 = malloc(TOKEN_LABEL_SIZE); if (objectstore_slot_info == NULL) { cryptoerror(LOG_ERR, "get_metaslot_info() - out of memory.\n"); rc = FAILURE; goto out; } (void) strcpy(buf2, (const char *) puent->metaslot_ks_token); *objectstore_token_info = buf2; out: if (puent != NULL) { free_uentry(puent); } if (rc == FAILURE) { if (buf1 != NULL) { free(buf1); } if (buf2 != NULL) { free(buf2); } } return (rc); } static boolean_t is_fips(char *name) { if (strcmp(name, FIPS_KEYWORD) == 0) { return (B_TRUE); } else { return (B_FALSE); } }