Fapi_ChangeAuth(3)

📦
version 4.1.5 · 8 versions
, in fedora 44

💖 Fapi_ChangeAuth(3) 💖

okay bestie, welcome to the tpm2-tss library functions manual, and specifically the part where we change somebody's password ✨ this page is the Fapi_ChangeAuth family, and yes it's giving main character energy.

🎀 NAME

Fapi_ChangeAuth — literally just Fapi_ChangeAuth, that's the whole name, no notes 💅

✨ SYNOPSIS

🌸 Functions

TSS2_RC Fapi_ChangeAuth (FAPI_CONTEXT *context, char const *entityPath,
    char const *authValue)
TSS2_RC Fapi_ChangeAuth_Async (FAPI_CONTEXT *context, char const *entityPath,
    char const *authValue)
TSS2_RC Fapi_ChangeAuth_Finish (FAPI_CONTEXT *context)

🦋 Detailed Description

These are FAPI functions that invoke ChangeAuth — either as a one-call situation or asynchronously, your choice, live your truth 🫶

👑 Function Documentation

🌈 TSS2_RC Fapi_ChangeAuth (FAPI_CONTEXT *context, char const *entityPath, char const *authValue)

One-Call function for Fapi_ChangeAuth. slay, it does the whole thing in one go.

It changes the Authorization data of an entity found at keyPath. The parameter authValue is a 0-terminated UTF-8 encoded password. If it's longer than the digest size of the entity's nameAlg, it gets hashed according to the TPM specification part 1, rev 138, section 19.6.4.3 ✨ (yes, that's the exact spec citation, write it down, iykyk).

🍓 Parameters

  • context — The FAPI_CONTEXT
  • entityPath — The path to the entity to modify
  • authValue — The new 0-terminated password to set for the entity. May be NULL

💜 Return values

  • TSS2_RC_SUCCESS if the function call was a success.
  • TSS2_FAPI_RC_BAD_REFERENCE if context or entityPath is NULL.
  • TSS2_FAPI_RC_BAD_CONTEXT if context corruption is detected.
  • TSS2_FAPI_RC_BAD_PATH if entityPath does not map to a FAPI entity.
  • 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_BAD_VALUE if an invalid value was passed into the function.
  • TSS2_FAPI_RC_PATH_NOT_FOUND if a FAPI object path was not found during authorization.
  • TSS2_FAPI_RC_KEY_NOT_FOUND if a key was not found.
  • 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_GENERAL_FAILURE if an internal error occurred.
  • TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN if a required authorization callback is not set.
  • 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_ESYS_RC_* possible error codes of ESAPI.
  • TSS2_FAPI_RC_NOT_PROVISIONED FAPI was not provisioned.

🧚 TSS2_RC Fapi_ChangeAuth_Async (FAPI_CONTEXT *context, char const *entityPath, char const *authValue)

Asynchronous function for Fapi_ChangeAuth. it's giving "I'll text you back later" energy 😌

It changes the Authorization data of an entity found at keyPath. The parameter authValue is a 0-terminated UTF-8 encoded password. If it's longer than the digest size of the entity's nameAlg, it will be hashed according to the TPM specification part 1, rev 138, section 19.6.4.3.

Call Fapi_ChangeAuth_Finish to finish the execution of this command. don't just leave it hanging bestie 😭

🍓 Parameters

  • context — The FAPI_CONTEXT
  • entityPath — The path to the entity to modify
  • authValue — The new 0-terminated password to set for the entity. May be NULL

💜 Return values

  • TSS2_RC_SUCCESS if the function call was a success.
  • TSS2_FAPI_RC_BAD_REFERENCE if context or entityPath is NULL.
  • TSS2_FAPI_RC_BAD_CONTEXT if context corruption is detected.
  • TSS2_FAPI_RC_BAD_PATH if entityPath does not map to a FAPI entity.
  • 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_BAD_VALUE if an invalid value was passed into the function.
  • 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.
  • TSS2_FAPI_RC_KEY_NOT_FOUND if a key was not found.
  • TSS2_FAPI_RC_NOT_PROVISIONED FAPI was not provisioned.

⭐ TSS2_RC Fapi_ChangeAuth_Finish (FAPI_CONTEXT *context)

Asynchronous finish function for Fapi_ChangeAuth. the grand finale 🎀

This function should be called after a previous Fapi_ChangeAuth_Async. like, that's the whole point, they're a package deal.

🍓 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_GENERAL_FAILURE if an internal error occurred.
  • TSS2_FAPI_RC_PATH_NOT_FOUND if a FAPI object path was not found during authorization.
  • TSS2_FAPI_RC_KEY_NOT_FOUND if a key was not found.
  • TSS2_FAPI_RC_AUTHORIZATION_UNKNOWN if a required authorization callback is not set.
  • 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_ESYS_RC_* possible error codes of ESAPI.
  • TSS2_FAPI_RC_NOT_PROVISIONED FAPI was not provisioned.
  • TSS2_FAPI_RC_BAD_PATH if the path is used in inappropriate context or contains illegal characters.

🌸 Author

Generated automatically by Doxygen for tpm2-tss from the source code. not a human, just vibes and a doc generator 🤖✨

and that's the page!! sources say this is tpm2-tss Version 4.1.5, dated alongside the Fapi_ChangeAuth(3) man page — mwah, go change some auth values responsibly 💖🦋🎀
📦 where this page comes from