Fapi_CreateKey(3)

From the Library Functions Manual, this is Fapi_CreateKey(3), bestie — header energy folded in, no cap. 🫶

🌸 NAME 🌸

Fapi_CreateKey — literally Fapi_CreateKey. That’s the name, that’s the vibe. 💅

✨ SYNOPSIS ✨

🧚 Functions 🧚

TSS2_RC Fapi_CreateKey (FAPI_CONTEXT *context, char const *path, char
    const *type, char const *policyPath, char const *authValue)
TSS2_RC Fapi_CreateKey_Async (FAPI_CONTEXT *context, char const *path,
    char const *type, char const *policyPath, char const *authValue)
TSS2_RC Fapi_CreateKey_Finish (FAPI_CONTEXT *context)

💅 Detailed Description 💅

These are the FAPI functions that invoke CreateKey, either as a one-call situation or in an asynchronous manner. It’s giving “same key creation, different timing energy.” ⭐

💖 Function Documentation 💖

🌟 Fapi_CreateKey — the one-call cutie 🌟

TSS2_RC Fapi_CreateKey (FAPI_CONTEXT * context, char const * path, char const * type, char const * policyPath, char const * authValue)

One-Call function for Fapi_CreateKey — main character energy, periodt. 👑

Creates a key inside the TPM based on the Key type, using the supplied policy and authValue. The key is then stored either in the FAPI metadata store or the TPM.

💖 Parameters 💖

• context — The FAPI_CONTEXT, bestie. The whole setup.
• path — The path where the new key is stored.
• type — The type of the new key. May be NULL.
• policyPath — The path to the policy that is associated with the new key. May be NULL.
• authValue — The authorization value for the new key. May be NULL.

🔥 Return values 🔥

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context or path is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_BAD_PATH — if policyPath is non-NULL and does not map to a FAPI policy.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if the parent key does not map to a FAPI key.
• TSS2_FAPI_RC_PATH_ALREADY_EXISTS — if a file already exists at path.
• TSS2_FAPI_RC_BAD_VALUE — if the keyType is non-NULL and invalid.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_NO_TPM — if FAPI was initialized in no-TPM-mode via its config file.
• TSS2_FAPI_RC_TRY_AGAIN — if an I/O operation is not finished yet and this function needs to be called again.
• TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN — if a required authorization callback is not set.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• TSS2_FAPI_RC_GENERAL_FAILURE — if an internal error happened.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — if the authorization attempt fails.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if policy search for a certain policy digest was not successful.

🦋 Fapi_CreateKey_Async — the async girlie 🦋

TSS2_RC Fapi_CreateKey_Async (FAPI_CONTEXT * context, char const * path, char const * type, char const * policyPath, char const * authValue)

Asynchronous function for Fapi_CreateKey — because sometimes you gotta start the vibe and finish it later. 💫

Creates a key inside the TPM based on the Key type, using the supplied policy and authValue. The key is then stored either in the FAPI metadata store or the TPM.

Bestie, call Fapi_CreateKey_Finish to finish the execution of this command. Don’t leave it hanging, fr fr. 🫶

💖 Parameters 💖

• context — The FAPI_CONTEXT.
• path — The path where the new key is stored.
• type — The type of the new key. May be NULL.
• policyPath — The path to the policy that is associated with the new key. May be NULL.
• authValue — The authorization value for the new key. May be NULL.

🔥 Return values 🔥

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context or path is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_BAD_PATH — if policyPath is non-NULL and does not map to a FAPI policy.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if the parent key does not map to a FAPI key.
• TSS2_FAPI_RC_PATH_ALREADY_EXISTS — if a file already exists at path.
• TSS2_FAPI_RC_BAD_VALUE — if the keyType is non-NULL and invalid.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_NO_TPM — if FAPI was initialized in no-TPM-mode via its config file.
• TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.

🎀 Fapi_CreateKey_Finish — the closing act 🎀

TSS2_RC Fapi_CreateKey_Finish (FAPI_CONTEXT * context)

Asynchronous finish function for Fapi_CreateKey — the “okay we’re wrapping this up” moment. ✨

This function should be called after a previous Fapi_CreateKey_Async.

💖 Parameters 💖

• context — The FAPI_CONTEXT.

🔥 Return values 🔥

• TSS2_RC_SUCCESS — if the function call was a success.
• TSS2_FAPI_RC_BAD_REFERENCE — if context is NULL.
• TSS2_FAPI_RC_BAD_CONTEXT — if context corruption is detected.
• TSS2_FAPI_RC_BAD_SEQUENCE — if the context has an asynchronous operation already pending.
• TSS2_FAPI_RC_IO_ERROR — if the data cannot be saved.
• TSS2_FAPI_RC_MEMORY — if the FAPI cannot allocate enough memory for internal operations or return parameters.
• TSS2_FAPI_RC_TRY_AGAIN — if the asynchronous operation is not yet complete. Call this function again later.
• TSS2_FAPI_RC_BAD_VALUE — if an invalid value was passed into the function.
• TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN — if a required authorization callback is not set.
• TSS2_ESYS_RC_* — possible error codes of ESAPI.
• TSS2_FAPI_RC_GENERAL_FAILURE — if an internal error happened.
• TSS2_FAPI_RC_NOT_PROVISIONED — FAPI was not provisioned.
• TSS2_FAPI_RC_KEY_NOT_FOUND — if a key was not found.
• TSS2_FAPI_RC_BAD_PATH — if the path is used in inappropriate context or contains illegal characters.
• TSS2_FAPI_RC_PATH_NOT_FOUND — if a FAPI object path was not found during authorization.
• TSS2_FAPI_RC_AUTHORIZATION_FAILED — if the authorization attempt fails.
• TSS2_FAPI_RC_POLICY_UNKNOWN — if policy search for a certain policy digest was not successful.
• TSS2_FAPI_RC_PATH_ALREADY_EXISTS — if the object already exists in object store.

🎀 Author 🎀

Generated automatically by Doxygen for tpm2-tss from the source code. No human author to tag here — Doxygen did its thing. 🫶

---

Okay that’s the whole page, bestie! 💖 Shoutout to the footer: source tpm2-tss, Version 4.1.5, title Fapi_CreateKey(3) — no separate date line was in this footer, so I’m not inventing one. 🎀