/* SPDX-License-Identifier: BSD-2-Clause */ /******************************************************************************* * Copyright 2018-2019, Fraunhofer SIT sponsored by Infineon Technologies AG * All rights reserved. ******************************************************************************/ #ifdef HAVE_CONFIG_H #include #endif #include #include #include #include #include #include #include "tss2_fapi.h" #include "fapi_int.h" #include "fapi_util.h" #include "tss2_esys.h" #include "ifapi_json_deserialize.h" #include "ifapi_policy_json_deserialize.h" #include "tpm_json_deserialize.h" #define LOGMODULE fapi #include "util/log.h" #include "util/aux_util.h" #include "fapi_crypto.h" /** One-Call function for Fapi_Import * * Imports a JSON encoded policy, policy template or key and stores it at the * given path. * * @param[in,out] context The FAPI_CONTEXT * @param[in] path the path to which the object is imported * @param[in] importData The data that is imported * * @retval TSS2_RC_SUCCESS: if the function call was a success. * @retval TSS2_FAPI_RC_BAD_REFERENCE: if context, path or importData * is NULL. * @retval TSS2_FAPI_RC_BAD_CONTEXT: if context corruption is detected. * @retval TSS2_FAPI_RC_BAD_PATH: If path does not map to a FAPI policy or key. * @retval TSS2_FAPI_RC_PATH_ALREADY_EXISTS: if a policy or key already exists * at path. * @retval TSS2_FAPI_RC_BAD_VALUE: if importData contains invalid data. * @retval TSS2_FAPI_RC_BAD_SEQUENCE: if the context has an asynchronous * operation already pending. * @retval TSS2_FAPI_RC_IO_ERROR: if the data cannot be saved. * @retval TSS2_FAPI_RC_MEMORY: if the FAPI cannot allocate enough memory for * internal operations or return parameters. * @retval TSS2_FAPI_RC_NO_TPM if FAPI was initialized in no-TPM-mode via its * config file. * @retval TSS2_FAPI_RC_GENERAL_FAILURE if an internal error occurred. * @retval TSS2_FAPI_RC_TRY_AGAIN if an I/O operation is not finished yet and * this function needs to be called again. * @retval TSS2_FAPI_RC_PATH_NOT_FOUND if a FAPI object path was not found * during authorization. * @retval TSS2_FAPI_RC_KEY_NOT_FOUND if a key was not found. * @retval TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN if a required authorization callback * is not set. * @retval TSS2_FAPI_RC_AUTHORIZATION_FAILED if the authorization attempt fails. * @retval TSS2_FAPI_RC_POLICY_UNKNOWN if policy search for a certain policy digest * was not successful. * @retval TSS2_ESYS_RC_* possible error codes of ESAPI. */ TSS2_RC Fapi_Import( FAPI_CONTEXT *context, char const *path, char const *importData) { LOG_TRACE("called for context:%p", context); TSS2_RC r; /* Check for NULL parameters */ check_not_null(context); check_not_null(path); check_not_null(importData); r = Fapi_Import_Async(context, path, importData); return_if_error_reset_state(r, "Entity_Import"); do { /* We wait for file I/O to be ready if the FAPI state automata are in a file I/O state. */ r = ifapi_io_poll(&context->io); return_if_error(r, "Something went wrong with IO polling"); /* Repeatedly call the finish function, until FAPI has transitioned through all execution stages / states of this invocation. */ r = Fapi_Import_Finish(context); } while ((r & ~TSS2_RC_LAYER_MASK) == TSS2_BASE_RC_TRY_AGAIN); return_if_error_reset_state(r, "Entity_Import"); LOG_TRACE("finished"); return TSS2_RC_SUCCESS; } /** Asynchronous function for Fapi_Import * * Imports a JSON encoded policy, policy template or key and stores it at the * given path. * * Call Fapi_Import_Finish to finish the execution of this command. * * @param[in,out] context The FAPI_CONTEXT * @param[in] path the path to which the object is imported * @param[in] importData The data that is imported * * @retval TSS2_RC_SUCCESS: if the function call was a success. * @retval TSS2_FAPI_RC_BAD_REFERENCE: if context, path or importData * is NULL. * @retval TSS2_FAPI_RC_BAD_CONTEXT: if context corruption is detected. * @retval TSS2_FAPI_RC_BAD_PATH: If path does not map to a FAPI policy or key. * @retval TSS2_FAPI_RC_PATH_ALREADY_EXISTS: if a policy or key already exists * at path. * @retval TSS2_FAPI_RC_BAD_VALUE: if importData contains invalid data. * @retval TSS2_FAPI_RC_BAD_SEQUENCE: if the context has an asynchronous * operation already pending. * @retval TSS2_FAPI_RC_IO_ERROR: if the data cannot be saved. * @retval TSS2_FAPI_RC_MEMORY: if the FAPI cannot allocate enough memory for * internal operations or return parameters. * @retval TSS2_FAPI_RC_NO_TPM if FAPI was initialized in no-TPM-mode via its * config file. * @retval TSS2_FAPI_RC_GENERAL_FAILURE if an internal error occurred. * @retval TSS2_ESYS_RC_* possible error codes of ESAPI. */ TSS2_RC Fapi_Import_Async( FAPI_CONTEXT *context, char const *path, char const *importData) { LOG_TRACE("called for context:%p", context); LOG_TRACE("path: %s", path); LOG_TRACE("importData: %s", importData); TSS2_RC r; json_object *jso = NULL; json_object *jso2; size_t pos = 0; TPMS_POLICY policy = { 0 }; /* Check for NULL parameters */ check_not_null(context); check_not_null(path); check_not_null(importData); /* Helpful alias pointers */ IFAPI_ImportKey * command = &context->cmd.ImportKey; IFAPI_OBJECT *object = &command->object; IFAPI_EXT_PUB_KEY * extPubKey = &object->misc.ext_pub_key; IFAPI_DUPLICATE * keyTree = &object->misc.key_tree; if (context->state != _FAPI_STATE_INIT) { return_error(TSS2_FAPI_RC_BAD_SEQUENCE, "Invalid State"); } command->jso_string = NULL; strdup_check(command->out_path, path, r, cleanup_error); memset(&command->object, 0, sizeof(IFAPI_OBJECT)); extPubKey->pem_ext_public = NULL; if (strncmp(importData, IFAPI_PEM_PUBLIC_STRING, sizeof(IFAPI_PEM_PUBLIC_STRING) - 1) == 0) { object->objectType = IFAPI_EXT_PUB_KEY_OBJ; strdup_check(extPubKey->pem_ext_public, importData, r, cleanup_error); extPubKey->certificate = NULL; TPM2_ALG_ID rsaOrEcc = ifapi_get_signature_algorithm_from_pem( extPubKey->pem_ext_public); r = ifapi_initialize_sign_public(rsaOrEcc, &extPubKey->public); goto_if_error(r, "Could not initialize key template", cleanup_error); r = ifapi_get_tpm2b_public_from_pem(extPubKey->pem_ext_public, &extPubKey->public); goto_if_error(r, "Convert PEM public key into TPM public key.", cleanup_error); command->new_object = *object; if (strncmp("/", path, 1) == 0) pos = 1; if (strncmp(&path[pos], IFAPI_PUB_KEY_DIR, strlen(IFAPI_PUB_KEY_DIR)) != 0) { SAFE_FREE(command->out_path); r = ifapi_asprintf(&command->out_path, "%s%s%s", IFAPI_PUB_KEY_DIR, IFAPI_FILE_DELIM, &path[pos]); goto_if_error(r, "Allocate path name", cleanup_error); } r = ifapi_non_tpm_mode_init(context); return_if_error(r, "Initialize Import in none TPM mode"); context->state = IMPORT_KEY_WRITE_OBJECT_PREPARE; } else if (strcmp(importData, IFAPI_PEM_PRIVATE_KEY) == 0) { return_error(TSS2_FAPI_RC_BAD_VALUE, "Invalid import data"); } else { /* Check whether TCTI and ESYS are initialized */ return_if_null(context->esys, "Command can't be executed in none TPM mode.", TSS2_FAPI_RC_NO_TPM); /* If the async state automata of FAPI shall be tested, then we must not set the timeouts of ESYS to blocking mode. During testing, the mssim tcti will ensure multiple re-invocations. Usually however the synchronous invocations of FAPI shall instruct ESYS to block until a result is available. */ #ifndef TEST_FAPI_ASYNC r = Esys_SetTimeout(context->esys, TSS2_TCTI_TIMEOUT_BLOCK); return_if_error_reset_state(r, "Set Timeout to blocking"); #endif /* TEST_FAPI_ASYNC */ r = ifapi_session_init(context); return_if_error(r, "Initialize Import"); /* Otherwise a JSON object has to be checked whether a key or policy is passed */ jso = json_tokener_parse(importData); return_if_null(jso, "Json error.", TSS2_FAPI_RC_BAD_VALUE); if (ifapi_get_sub_object(jso, IFAPI_JSON_TAG_POLICY, &jso2) && !(ifapi_get_sub_object(jso, IFAPI_JSON_TAG_DUPLICATE, &jso2)) ) { /* Create policy object */ r = ifapi_json_TPMS_POLICY_deserialize(jso, &policy); goto_if_error(r, "Serialize policy", cleanup_error); r = ifapi_policy_store_store_async(&context->pstore, &context->io, command->out_path, &policy); goto_if_error_reset_state(r, "Could not open: %s", cleanup_error, command->out_path); ifapi_cleanup_policy(&policy); context->state = IMPORT_KEY_WRITE_POLICY; r = TSS2_RC_SUCCESS; } else { /* Write key object */ r = ifapi_json_IFAPI_OBJECT_deserialize(jso, object); goto_if_error(r, "Invalid object.", cleanup_error); switch (object->objectType) { case IFAPI_EXT_PUB_KEY_OBJ: /* Write json string stored in importData */ /* Start writing the EK to the key store */ r = ifapi_keystore_store_async(&context->keystore, &context->io, command->out_path, object); goto_if_error_reset_state(r, "Could not open: %sh", cleanup_error, command->out_path); context->state = IMPORT_KEY_WRITE; break; case IFAPI_DUPLICATE_OBJ: r = ifapi_get_name( &keyTree->public_parent.publicArea, &command->parent_name); goto_if_error2(r, "Get parent name", cleanup_error); context->state = IMPORT_KEY_SEARCH; break; default: goto_error(r, TSS2_FAPI_RC_GENERAL_FAILURE, "Invalid object type", cleanup_error); break; } command->parent_path = NULL; } } json_object_put(jso); LOG_TRACE("finished"); return r; cleanup_error: if (jso) json_object_put(jso); context->state = _FAPI_STATE_INIT; ifapi_cleanup_policy(&policy); SAFE_FREE(command->jso_string); SAFE_FREE(extPubKey->pem_ext_public); SAFE_FREE(command->out_path); return r; } /** Asynchronous finish function for Fapi_Import_ * * This function should be called after a previous Fapi_Import_Async. * * @param[in,out] context The FAPI_CONTEXT * * @retval TSS2_RC_SUCCESS: if the function call was a success. * @retval TSS2_FAPI_RC_BAD_REFERENCE: if context is NULL. * @retval TSS2_FAPI_RC_BAD_CONTEXT: if context corruption is detected. * @retval TSS2_FAPI_RC_BAD_SEQUENCE: if the context has an asynchronous * operation already pending. * @retval TSS2_FAPI_RC_IO_ERROR: if the data cannot be saved. * @retval TSS2_FAPI_RC_MEMORY: if the FAPI cannot allocate enough memory for * internal operations or return parameters. * @retval TSS2_FAPI_RC_TRY_AGAIN: if the asynchronous operation is not yet * complete. Call this function again later. * @retval TSS2_FAPI_RC_PATH_NOT_FOUND if a FAPI object path was not found * during authorization. * @retval TSS2_FAPI_RC_KEY_NOT_FOUND if a key was not found. * @retval TSS2_FAPI_RC_BAD_VALUE if an invalid value was passed into * the function. * @retval TSS2_FAPI_RC_GENERAL_FAILURE if an internal error occurred. * @retval TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN if a required authorization callback * is not set. * @retval TSS2_FAPI_RC_AUTHORIZATION_FAILED if the authorization attempt fails. * @retval TSS2_FAPI_RC_POLICY_UNKNOWN if policy search for a certain policy digest * was not successful. * @retval TSS2_ESYS_RC_* possible error codes of ESAPI. */ TSS2_RC Fapi_Import_Finish( FAPI_CONTEXT *context) { LOG_TRACE("called for context:%p", context); TSS2_RC r; ESYS_TR session; /* Check for NULL parameters */ check_not_null(context); /* Helpful alias pointers */ IFAPI_ImportKey * command = &context->cmd.ImportKey; IFAPI_OBJECT *newObject = &command->new_object; IFAPI_OBJECT *object = &command->object; IFAPI_DUPLICATE * keyTree = &object->misc.key_tree; switch (context->state) { statecase(context->state, IMPORT_KEY_WRITE_POLICY); r = ifapi_policy_store_store_finish(&context->pstore, &context->io); return_try_again(r); return_if_error_reset_state(r, "write_finish failed"); context->state = _FAPI_STATE_INIT; break; statecase(context->state, IMPORT_KEY_WRITE); r = ifapi_keystore_store_finish(&context->keystore, &context->io); return_try_again(r); return_if_error_reset_state(r, "write_finish failed"); context->state = _FAPI_STATE_INIT; break; statecase(context->state, IMPORT_KEY_SEARCH); r = ifapi_keystore_search_obj(&context->keystore, &context->io, &command->parent_name, &command->parent_path); return_try_again(r); goto_if_error(r, "Search Key", error_cleanup); context->state = IMPORT_KEY_LOAD_PARENT; fallthrough; statecase(context->state, IMPORT_KEY_LOAD_PARENT); r = ifapi_load_key(context, command->parent_path, &command->parent_object); return_try_again(r); goto_if_error(r, "Fapi load key.", error_cleanup); context->state = IMPORT_KEY_AUTHORIZE_PARENT; fallthrough; statecase(context->state, IMPORT_KEY_AUTHORIZE_PARENT); r = ifapi_authorize_object(context, command->parent_object, &session); return_try_again(r); goto_if_error(r, "Authorize key.", error_cleanup); TPMT_SYM_DEF_OBJECT symmetric; symmetric.algorithm = TPM2_ALG_NULL; r = Esys_Import_Async(context->esys, command->parent_object->handle, session, ESYS_TR_NONE, ESYS_TR_NONE, NULL, &keyTree->public, &keyTree->duplicate, &keyTree->encrypted_seed, &symmetric); goto_if_error(r, "Import Async", error_cleanup); context->state = IMPORT_KEY_IMPORT; fallthrough; statecase(context->state, IMPORT_KEY_IMPORT); r = Esys_Import_Finish(context->esys, &command->private); try_again_or_error_goto(r, "Import", error_cleanup); context->state = IMPORT_KEY_WAIT_FOR_FLUSH; fallthrough; statecase(context->state, IMPORT_KEY_WAIT_FOR_FLUSH); r = ifapi_flush_object(context, command->parent_object->handle); ifapi_cleanup_ifapi_object(command->parent_object); return_try_again(r); goto_if_error(r, "Flush key", error_cleanup); memset(newObject, 0, sizeof(IFAPI_OBJECT)); newObject->objectType = IFAPI_KEY_OBJ; newObject->misc.key.public = keyTree->public; newObject->policy = keyTree->policy; newObject->misc.key.private.size = command->private->size; newObject->misc.key.private.buffer = &command->private->buffer[0]; newObject->misc.key.policyInstance = NULL; newObject->misc.key.description = NULL; newObject->misc.key.certificate = NULL; r = ifapi_get_profile_sig_scheme(&context->profiles.default_profile, &keyTree->public.publicArea, &newObject->misc.key.signing_scheme); goto_if_error(r, "Get signing scheme.", error_cleanup); fallthrough; statecase(context->state, IMPORT_KEY_WRITE_OBJECT_PREPARE); /* Perform esys serialization if necessary */ r = ifapi_esys_serialize_object(context->esys, newObject); goto_if_error(r, "Prepare serialization", error_cleanup); /* Start writing the NV object to the key store */ r = ifapi_keystore_store_async(&context->keystore, &context->io, command->out_path, newObject); goto_if_error_reset_state(r, "Could not open: %sh", error_cleanup, context->nv_cmd.nvPath); context->state = IMPORT_KEY_WRITE_OBJECT; fallthrough; statecase(context->state, IMPORT_KEY_WRITE_OBJECT); /* Finish writing the object to the key store */ r = ifapi_keystore_store_finish(&context->keystore, &context->io); return_try_again(r); return_if_error_reset_state(r, "write_finish failed"); fallthrough; statecase(context->state, IMPORT_KEY_CLEANUP) r = ifapi_cleanup_session(context); try_again_or_error_goto(r, "Cleanup", error_cleanup); break; statecasedefault(context->state); } /* Reset the ESYS timeout to non-blocking, immediate response. */ if (context->esys) { r = Esys_SetTimeout(context->esys, 0); goto_if_error(r, "Set Timeout to non-blocking", error_cleanup); } context->state = _FAPI_STATE_INIT; SAFE_FREE(command->out_path); /* Cleanup policy for key objects.*/ if (newObject->objectType == IFAPI_KEY_OBJ) { if (newObject->policy) ifapi_cleanup_policy(newObject->policy); SAFE_FREE(newObject->policy); } SAFE_FREE(command->parent_path); ifapi_cleanup_ifapi_object(&command->object); SAFE_FREE(command->private); ifapi_cleanup_ifapi_object(&context->createPrimary.pkey_object); if (context->loadKey.key_object){ ifapi_cleanup_ifapi_object(context->loadKey.key_object); } LOG_TRACE("finished"); return TSS2_RC_SUCCESS; error_cleanup: if (newObject) ifapi_cleanup_ifapi_object(newObject); SAFE_FREE(command->out_path); SAFE_FREE(command->parent_path); ifapi_cleanup_ifapi_object(&command->object); SAFE_FREE(command->private); Esys_SetTimeout(context->esys, 0); ifapi_session_clean(context); ifapi_cleanup_ifapi_object(&context->loadKey.auth_object); ifapi_cleanup_ifapi_object(context->loadKey.key_object); ifapi_cleanup_ifapi_object(&context->createPrimary.pkey_object); return r; }