1/*! 2 \defgroup esys Enhanced System API 3 Enhanced System API (ESAPI) as described in the [TSS 2.0 Enhanced System API (ESAPI) Specification](https://trustedcomputinggroup.org/wp-content/uploads/TSS_ESAPI_Version-0.9_Revision-04_reviewEND030918.pdf). 4This API is a 1-to-1 mapping of the TPM2 commands documented in Part 3 of the TPM2 specification. 5Additionally there are asynchronous versions of each command. 6In addition to SAPI, the ESAPI performs tracking of meta data for TPM object and automatic calculation of session based authorization and encryption values. 7Both the synchronous and asynchronous API are exposed through a single library: libtss2-esys. 8*/ 9 10/*! 11 \defgroup ESYS_CONTEXT Esys Context ESYS_CONTEXT 12 \ingroup esys 13 An ESYS_CONTEXT holds tdata for the connection to the TPM as 14 well as the metadata for TPM Resource; such as Transient key, Persistent 15 objects, NV spaces, Sessions or PCRs. 16 \{ 17 \typedef ESYS_CONTEXT 18 Reference to the ESYS_CONTEXT that holds data for the connection to the TPM as 19 well as the metadata for TPM Resource; such as Transient key, Persistent 20 objects, NV spaces, Sessions or PCRs. 21 \fn TSS2_RC Esys_Initialize(ESYS_CONTEXT ** esys_context, TSS2_TCTI_CONTEXT * tcti, TSS2_ABI_VERSION * abiVersion) 22 \fn void Esys_Finalize(ESYS_CONTEXT * esys_context) 23 \fn TSS2_RC Esys_GetTcti(ESYS_CONTEXT * esys_context, TSS2_TCTI_CONTEXT ** tcti) 24 \fn TSS2_RC Esys_GetPollHandles(ESYS_CONTEXT * esys_context, TSS2_TCTI_POLL_HANDLE ** handles, size_t * count) 25 \fn TSS2_RC Esys_SetTimeout(ESYS_CONTEXT *esys_context, int32_t timeout) 26 \fn TSS2_RC Esys_GetSysContext(ESYS_CONTEXT *esys_context, TSS2_SYS_CONTEXT **sys_context) 27 \fn void Esys_Free(void *__ptr) 28 \} 29*/ 30 31/*! 32 \defgroup ESYS_TR Esys Tpm Resource ESYS_TR 33 \ingroup esys 34 Virtual objects with meta data for Tpm Resources. 35 The Esys TPM Resources are the virtual objects inside the ESYSCONTEXT that hold 36 the metadata for corresponding TPM Resources. 37 38 There are a set of global ESYS_TR objects such as ESYS_TR_NON or for the 39 various PCRs and hierarchies. ESYS_TR_MIN_OBJECT denotes the first non-global 40 ESYS_TR object. 41 \{ 42 \typedef ESYS_TR 43 Reference to the virtual object inside the ESYS_CONTEXT that holds the metadata 44 for the corresponding TPM Resource. Such can be Transient key, Persistent 45 objects, NV spaces, Sessions or PCRs. 46 \fn TSS2_RC Esys_TR_SetAuth(ESYS_CONTEXT * esys_context, ESYS_TR esys_handle, TPM2B_AUTH const *authValue) 47 \fn TSS2_RC Esys_TR_GetName(ESYS_CONTEXT * esys_context, ESYS_TR esys_handle, TPM2B_NAME ** name) 48 \fn TSS2_RC Esys_TR_FromTPMPublic_Async( ESYS_CONTEXT *esysContext, TPM2_HANDLE tpm_handle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 49 \fn TSS2_RC Esys_TR_FromTPMPublic_Finish(ESYS_CONTEXT *esysContext, ESYS_TR *esys_handle) 50 \fn TSS2_RC Esys_TR_FromTPMPublic(ESYS_CONTEXT *esysContext, TPM2_HANDLE tpm_handle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, ESYS_TR *object) 51 \fn TSS2_RC Esys_TR_Serialize(ESYS_CONTEXT *esys_context, ESYS_TR esys_handle, uint8_t **buffer, size_t *buffer_size) 52 \fn TSS2_RC Esys_TR_Deserialize(ESYS_CONTEXT *esys_context, uint8_t const *buffer, size_t buffer_size, ESYS_TR *esys_handle) 53 \fn TSS2_RC Esys_TR_Close(ESYS_CONTEXT *esys_context, ESYS_TR *object) 54 \fn TSS2_RC Esys_TRSess_GetAttributes(ESYS_CONTEXT * esysContext, ESYS_TR esys_handle, TPMA_SESSION * flags) 55 \fn TSS2_RC Esys_TRSess_SetAttributes(ESYS_CONTEXT * esys_context, ESYS_TR esys_handle, TPMA_SESSION flags, TPMA_SESSION mask) 56 \} 57*/ 58 59/*! 60 \defgroup ESYS_TR_defines Global ESYS_TR objects 61 \ingroup ESYS_TR 62 A set of defines for global virtual objects that are always present in every 63 ESYS_CONTEXT. 64 \{ 65 \def ESYS_TR_NONE Identifier for ESYS_TR parameters if no TPM Resource is supplied. 66 \def ESYS_TR_PASSWORD Identifier for ESYS_TR sessions for password authentication. 67 \def ESYS_TR_PCR0 TPM Resource PCR 0. 68 \def ESYS_TR_PCR1 TPM Resource PCR 1. 69 \def ESYS_TR_PCR2 TPM Resource PCR 2. 70 \def ESYS_TR_PCR3 TPM Resource PCR 3. 71 \def ESYS_TR_PCR4 TPM Resource PCR 4. 72 \def ESYS_TR_PCR5 TPM Resource PCR 5. 73 \def ESYS_TR_PCR6 TPM Resource PCR 6. 74 \def ESYS_TR_PCR7 TPM Resource PCR 7. 75 \def ESYS_TR_PCR8 TPM Resource PCR 8. 76 \def ESYS_TR_PCR9 TPM Resource PCR 9. 77 \def ESYS_TR_PCR10 TPM Resource PCR 10. 78 \def ESYS_TR_PCR11 TPM Resource PCR 11. 79 \def ESYS_TR_PCR12 TPM Resource PCR 12. 80 \def ESYS_TR_PCR13 TPM Resource PCR 13. 81 \def ESYS_TR_PCR14 TPM Resource PCR 14. 82 \def ESYS_TR_PCR15 TPM Resource PCR 15. 83 \def ESYS_TR_PCR16 TPM Resource PCR 16. 84 \def ESYS_TR_PCR17 TPM Resource PCR 17. 85 \def ESYS_TR_PCR18 TPM Resource PCR 18. 86 \def ESYS_TR_PCR19 TPM Resource PCR 19. 87 \def ESYS_TR_PCR20 TPM Resource PCR 20. 88 \def ESYS_TR_PCR21 TPM Resource PCR 21. 89 \def ESYS_TR_PCR22 TPM Resource PCR 22. 90 \def ESYS_TR_PCR23 TPM Resource PCR 23. 91 \def ESYS_TR_PCR24 TPM Resource PCR 24. 92 \def ESYS_TR_PCR25 TPM Resource PCR 25. 93 \def ESYS_TR_PCR26 TPM Resource PCR 26. 94 \def ESYS_TR_PCR27 TPM Resource PCR 27. 95 \def ESYS_TR_PCR28 TPM Resource PCR 28. 96 \def ESYS_TR_PCR29 TPM Resource PCR 29. 97 \def ESYS_TR_PCR30 TPM Resource PCR 30. 98 \def ESYS_TR_PCR31 TPM Resource PCR 31. 99 \def ESYS_TR_RH_OWNER TPM Resource Owner Hierarchy 100 \def ESYS_TR_RH_NULL TPM Resource Ephemeral Hierarchy 101 \def ESYS_TR_RH_LOCKOUT TPM Resource for Lockout Authorization 102 \def ESYS_TR_RH_ENDORSEMENT TPM Resource Endorsement Hierarchy 103 \def ESYS_TR_RH_PLATFORM TPM Resource Platform Hierarchy 104 \def ESYS_TR_RH_PLATFORM_NV Identifier for ESYS_TR used for phEnableNV 105 \def ESYS_TR_RH_AUTH_00 Identifier for ESYS_TR for the start of a range of authorization values that are vendor-specific. 106 \def ESYS_TR_RH_AUTH_FF Identifier for ESYS_TR for the end of a range of authorization values that are vendor-specific. 107 \def ESYS_TR_MIN_OBJECT The first non-global ESYS_TR object identifier. These are assigned by ESAPI and beyond this value. 108 \} 109*/ 110 111/*! 112 \defgroup esys_tpm Esys TPM Commands 113 \ingroup esys 114 The following function represent interactions with the corresponding TPM 115 commands. 116 \{ 117 \defgroup Esys_ActivateCredential The ESAPI function for the TPM2_ActivateCredential command. 118 * ESAPI function to invoke the TPM2_ActivateCredential command 119 * either as a one-call or in an asynchronous manner. 120 \{ 121 \fn TSS2_RC Esys_ActivateCredential_Async(ESYS_CONTEXT *esysContext, ESYS_TR activateHandle, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ID_OBJECT *credentialBlob, const TPM2B_ENCRYPTED_SECRET *secret) 122 \fn TSS2_RC Esys_ActivateCredential(ESYS_CONTEXT *esysContext, ESYS_TR activateHandle, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ID_OBJECT *credentialBlob, const TPM2B_ENCRYPTED_SECRET *secret, TPM2B_DIGEST **certInfo) 123 \fn TSS2_RC Esys_ActivateCredential_Finish(ESYS_CONTEXT *esysContext, TPM2B_DIGEST **certInfo) 124 \} 125 \defgroup Esys_Certify The ESAPI function for the TPM2_Certify command. 126 * ESAPI function to invoke the TPM2_Certify command 127 * either as a one-call or in an asynchronous manner. 128 \{ 129 \fn TSS2_RC Esys_Certify_Async(ESYS_CONTEXT *esysContext, ESYS_TR objectHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme) 130 \fn TSS2_RC Esys_Certify(ESYS_CONTEXT *esysContext, ESYS_TR objectHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme, TPM2B_ATTEST **certifyInfo, TPMT_SIGNATURE **signature) 131 \fn TSS2_RC Esys_Certify_Finish(ESYS_CONTEXT *esysContext, TPM2B_ATTEST **certifyInfo, TPMT_SIGNATURE **signature) 132 \} 133 \defgroup Esys_CertifyCreation The ESAPI function for the TPM2_CertifyCreation command. 134 * ESAPI function to invoke the TPM2_CertifyCreation command 135 * either as a one-call or in an asynchronous manner. 136 \{ 137 \fn TSS2_RC Esys_CertifyCreation_Async(ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR objectHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPM2B_DIGEST *creationHash, const TPMT_SIG_SCHEME *inScheme, const TPMT_TK_CREATION *creationTicket) 138 \fn TSS2_RC Esys_CertifyCreation(ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR objectHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPM2B_DIGEST *creationHash, const TPMT_SIG_SCHEME *inScheme, const TPMT_TK_CREATION *creationTicket, TPM2B_ATTEST **certifyInfo, TPMT_SIGNATURE **signature) 139 \fn TSS2_RC Esys_CertifyCreation_Finish(ESYS_CONTEXT *esysContext, TPM2B_ATTEST **certifyInfo, TPMT_SIGNATURE **signature) 140 \} 141 \defgroup Esys_ChangeEPS The ESAPI function for the TPM2_ChangeEPS command. 142 * ESAPI function to invoke the TPM2_ChangeEPS command 143 * either as a one-call or in an asynchronous manner. 144 \{ 145 \fn TSS2_RC Esys_ChangeEPS_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 146 \fn TSS2_RC Esys_ChangeEPS(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 147 \fn TSS2_RC Esys_ChangeEPS_Finish(ESYS_CONTEXT *esysContext) 148 \} 149 \defgroup Esys_ChangePPS The ESAPI function for the TPM2_ChangePPS command. 150 * ESAPI function to invoke the TPM2_ChangePPS command 151 * either as a one-call or in an asynchronous manner. 152 \{ 153 \fn TSS2_RC Esys_ChangePPS_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 154 \fn TSS2_RC Esys_ChangePPS(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 155 \fn TSS2_RC Esys_ChangePPS_Finish(ESYS_CONTEXT *esysContext) 156 \} 157 \defgroup Esys_Clear The ESAPI function for the TPM2_Clear command. 158 * ESAPI function to invoke the TPM2_Clear command 159 * either as a one-call or in an asynchronous manner. 160 \{ 161 \fn TSS2_RC Esys_Clear_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 162 \} 163 \defgroup Esys_ClearControl The ESAPI function for the TPM2_ClearControl command. 164 * ESAPI function to invoke the TPM2_ClearControl command 165 * either as a one-call or in an asynchronous manner. 166 \{ 167 \fn TSS2_RC Esys_ClearControl_Async(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO disable) 168 \fn TSS2_RC Esys_ClearControl(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO disable) 169 \fn TSS2_RC Esys_ClearControl_Finish(ESYS_CONTEXT *esysContext) 170 \fn TSS2_RC Esys_Clear(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 171 \fn TSS2_RC Esys_Clear_Finish(ESYS_CONTEXT *esysContext) 172 \} 173 \defgroup Esys_ClockRateAdjust The ESAPI function for the TPM2_ClockRateAdjust command. 174 * ESAPI function to invoke the TPM2_ClockRateAdjust command 175 * either as a one-call or in an asynchronous manner. 176 \{ 177 \fn TSS2_RC Esys_ClockRateAdjust_Async(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CLOCK_ADJUST rateAdjust) 178 \fn TSS2_RC Esys_ClockRateAdjust(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CLOCK_ADJUST rateAdjust) 179 \fn TSS2_RC Esys_ClockRateAdjust_Finish(ESYS_CONTEXT *esysContext) 180 \} 181 \defgroup Esys_ClockSet The ESAPI function for the TPM2_ClockSet command. 182 * ESAPI function to invoke the TPM2_ClockSet command 183 * either as a one-call or in an asynchronous manner. 184 \{ 185 \fn TSS2_RC Esys_ClockSet_Async(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT64 newTime) 186 \fn TSS2_RC Esys_ClockSet(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT64 newTime) 187 \fn TSS2_RC Esys_ClockSet_Finish(ESYS_CONTEXT *esysContext) 188 \} 189 \defgroup Esys_Commit The ESAPI function for the TPM2_Commit command. 190 * ESAPI function to invoke the TPM2_Commit command 191 * either as a one-call or in an asynchronous manner. 192 \{ 193 \fn TSS2_RC Esys_Commit_Async(ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *P1, const TPM2B_SENSITIVE_DATA *s2, const TPM2B_ECC_PARAMETER *y2) 194 \fn TSS2_RC Esys_Commit(ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *P1, const TPM2B_SENSITIVE_DATA *s2, const TPM2B_ECC_PARAMETER *y2, TPM2B_ECC_POINT **K, TPM2B_ECC_POINT **L, TPM2B_ECC_POINT **E, UINT16 *counter) 195 \fn TSS2_RC Esys_Commit_Finish(ESYS_CONTEXT *esysContext, TPM2B_ECC_POINT **K, TPM2B_ECC_POINT **L, TPM2B_ECC_POINT **E, UINT16 *counter) 196 \} 197 \defgroup Esys_ContextLoad The ESAPI function for the TPM2_ContextLoad command. 198 * ESAPI function to invoke the TPM2_ContextLoad command 199 * either as a one-call or in an asynchronous manner. 200 \{ 201 \fn TSS2_RC Esys_ContextLoad_Async(ESYS_CONTEXT *esysContext, const TPMS_CONTEXT *context) 202 \fn TSS2_RC Esys_ContextLoad(ESYS_CONTEXT *esysContext, const TPMS_CONTEXT *context, ESYS_TR *loadedHandle) 203 \fn TSS2_RC Esys_ContextLoad_Finish(ESYS_CONTEXT *esysContext, ESYS_TR *loadedHandle) 204 \} 205 \defgroup Esys_ContextSave The ESAPI function for the TPM2_ContextSave command. 206 * ESAPI function to invoke the TPM2_ContextSave command 207 * either as a one-call or in an asynchronous manner. 208 \{ 209 \fn TSS2_RC Esys_ContextSave_Async(ESYS_CONTEXT *esysContext, ESYS_TR saveHandle) 210 \fn TSS2_RC Esys_ContextSave(ESYS_CONTEXT *esysContext, ESYS_TR saveHandle, TPMS_CONTEXT **context) 211 \fn TSS2_RC Esys_ContextSave_Finish(ESYS_CONTEXT *esysContext, TPMS_CONTEXT **context) 212 \} 213 \defgroup Esys_Create The ESAPI function for the TPM2_Create command. 214 * ESAPI function to invoke the TPM2_Create command 215 * either as a one-call or in an asynchronous manner. 216 \{ 217 \fn TSS2_RC Esys_Create_Async(ESYS_CONTEXT *esysContext, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_CREATE *inSensitive, const TPM2B_PUBLIC *inPublic, const TPM2B_DATA *outsideInfo, const TPML_PCR_SELECTION *creationPCR) 218 \fn TSS2_RC Esys_Create(ESYS_CONTEXT *esysContext, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_CREATE *inSensitive, const TPM2B_PUBLIC *inPublic, const TPM2B_DATA *outsideInfo, const TPML_PCR_SELECTION *creationPCR, TPM2B_PRIVATE **outPrivate, TPM2B_PUBLIC **outPublic, TPM2B_CREATION_DATA **creationData, TPM2B_DIGEST **creationHash, TPMT_TK_CREATION **creationTicket) 219 \fn TSS2_RC Esys_Create_Finish(ESYS_CONTEXT *esysContext, TPM2B_PRIVATE **outPrivate, TPM2B_PUBLIC **outPublic, TPM2B_CREATION_DATA **creationData, TPM2B_DIGEST **creationHash, TPMT_TK_CREATION **creationTicket) 220 \} 221 \defgroup Esys_CreatePrimary The ESAPI function for the TPM2_CreatePrimary command. 222 * ESAPI function to invoke the TPM2_CreatePrimary command 223 * either as a one-call or in an asynchronous manner. 224 \{ 225 \fn TSS2_RC Esys_CreatePrimary_Async(ESYS_CONTEXT *esysContext, ESYS_TR primaryHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_CREATE *inSensitive, const TPM2B_PUBLIC *inPublic, const TPM2B_DATA *outsideInfo, const TPML_PCR_SELECTION *creationPCR) 226 \fn TSS2_RC Esys_CreatePrimary(ESYS_CONTEXT *esysContext, ESYS_TR primaryHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_CREATE *inSensitive, const TPM2B_PUBLIC *inPublic, const TPM2B_DATA *outsideInfo, const TPML_PCR_SELECTION *creationPCR, ESYS_TR *objectHandle, TPM2B_PUBLIC **outPublic, TPM2B_CREATION_DATA **creationData, TPM2B_DIGEST **creationHash, TPMT_TK_CREATION **creationTicket) 227 \fn TSS2_RC Esys_CreatePrimary_Finish(ESYS_CONTEXT *esysContext, ESYS_TR *objectHandle, TPM2B_PUBLIC **outPublic, TPM2B_CREATION_DATA **creationData, TPM2B_DIGEST **creationHash, TPMT_TK_CREATION **creationTicket) 228 \} 229 \defgroup Esys_DictionaryAttackLockReset The ESAPI function for the TPM2_DictionaryAttackLockReset command. 230 * ESAPI function to invoke the TPM2_DictionaryAttackLockReset command 231 * either as a one-call or in an asynchronous manner. 232 \{ 233 \fn TSS2_RC Esys_DictionaryAttackLockReset_Async(ESYS_CONTEXT *esysContext, ESYS_TR lockHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 234 \fn TSS2_RC Esys_DictionaryAttackLockReset(ESYS_CONTEXT *esysContext, ESYS_TR lockHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 235 \fn TSS2_RC Esys_DictionaryAttackLockReset_Finish(ESYS_CONTEXT *esysContext) 236 \} 237 \defgroup Esys_DictionaryAttackParameters The ESAPI function for the TPM2_DictionaryAttackParameters command. 238 * ESAPI function to invoke the TPM2_DictionaryAttackParameters command 239 * either as a one-call or in an asynchronous manner. 240 \{ 241 \fn TSS2_RC Esys_DictionaryAttackParameters_Async(ESYS_CONTEXT *esysContext, ESYS_TR lockHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT32 newMaxTries, UINT32 newRecoveryTime, UINT32 lockoutRecovery) 242 \fn TSS2_RC Esys_DictionaryAttackParameters(ESYS_CONTEXT *esysContext, ESYS_TR lockHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT32 newMaxTries, UINT32 newRecoveryTime, UINT32 lockoutRecovery) 243 \fn TSS2_RC Esys_DictionaryAttackParameters_Finish(ESYS_CONTEXT *esysContext) 244 \} 245 \defgroup Esys_Duplicate The ESAPI function for the TPM2_Duplicate command. 246 * ESAPI function to invoke the TPM2_Duplicate command 247 * either as a one-call or in an asynchronous manner. 248 \{ 249 \fn TSS2_RC Esys_Duplicate_Async(ESYS_CONTEXT *esysContext, ESYS_TR objectHandle, ESYS_TR newParentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *encryptionKeyIn, const TPMT_SYM_DEF_OBJECT *symmetricAlg) 250 \fn TSS2_RC Esys_Duplicate(ESYS_CONTEXT *esysContext, ESYS_TR objectHandle, ESYS_TR newParentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *encryptionKeyIn, const TPMT_SYM_DEF_OBJECT *symmetricAlg, TPM2B_DATA **encryptionKeyOut, TPM2B_PRIVATE **duplicate, TPM2B_ENCRYPTED_SECRET **outSymSeed) 251 \fn TSS2_RC Esys_Duplicate_Finish(ESYS_CONTEXT *esysContext, TPM2B_DATA **encryptionKeyOut, TPM2B_PRIVATE **duplicate, TPM2B_ENCRYPTED_SECRET **outSymSeed) 252 \} 253 \defgroup Esys_ECC_Parameters The ESAPI function for the TPM2_ECC_Parameters command. 254 * ESAPI function to invoke the TPM2_ECC_Parameters command 255 * either as a one-call or in an asynchronous manner. 256 \{ 257 \fn TSS2_RC Esys_ECC_Parameters_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE curveID) 258 \fn TSS2_RC Esys_ECC_Parameters(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE curveID, TPMS_ALGORITHM_DETAIL_ECC **parameters) 259 \fn TSS2_RC Esys_ECC_Parameters_Finish(ESYS_CONTEXT *esysContext, TPMS_ALGORITHM_DETAIL_ECC **parameters) 260 \} 261 \defgroup Esys_ECDH_KeyGen The ESAPI function for the TPM2_ECDH_KeyGen command. 262 * ESAPI function to invoke the TPM2_ECDH_KeyGen command 263 * either as a one-call or in an asynchronous manner. 264 \{ 265 \fn TSS2_RC Esys_ECDH_KeyGen_Async(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 266 \fn TSS2_RC Esys_ECDH_KeyGen(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2B_ECC_POINT **zPoint, TPM2B_ECC_POINT **pubPoint) 267 \fn TSS2_RC Esys_ECDH_KeyGen_Finish(ESYS_CONTEXT *esysContext, TPM2B_ECC_POINT **zPoint, TPM2B_ECC_POINT **pubPoint) 268 \} 269 \defgroup Esys_ECDH_ZGen The ESAPI function for the TPM2_ECDH_ZGen command. 270 * ESAPI function to invoke the TPM2_ECDH_ZGen command 271 * either as a one-call or in an asynchronous manner. 272 \{ 273 \fn TSS2_RC Esys_ECDH_ZGen_Async(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *inPoint) 274 \fn TSS2_RC Esys_ECDH_ZGen(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *inPoint, TPM2B_ECC_POINT **outPoint) 275 \fn TSS2_RC Esys_ECDH_ZGen_Finish(ESYS_CONTEXT *esysContext, TPM2B_ECC_POINT **outPoint) 276 \} 277 \defgroup Esys_EC_Ephemeral The ESAPI function for the TPM2_EC_Ephemeral command. 278 * ESAPI function to invoke the TPM2_EC_Ephemeral command 279 * either as a one-call or in an asynchronous manner. 280 \{ 281 \fn TSS2_RC Esys_EC_Ephemeral_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE curveID) 282 \fn TSS2_RC Esys_EC_Ephemeral(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ECC_CURVE curveID, TPM2B_ECC_POINT **Q, UINT16 *counter) 283 \fn TSS2_RC Esys_EC_Ephemeral_Finish(ESYS_CONTEXT *esysContext, TPM2B_ECC_POINT **Q, UINT16 *counter) 284 \} 285 \defgroup Esys_EncryptDecrypt The ESAPI function for the TPM2_EncryptDecrypt command. 286 * ESAPI function to invoke the TPM2_EncryptDecrypt command 287 * either as a one-call or in an asynchronous manner. 288 \{ 289 \fn TSS2_RC Esys_EncryptDecrypt_Async(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO decrypt, TPMI_ALG_SYM_MODE mode, const TPM2B_IV *ivIn, const TPM2B_MAX_BUFFER *inData) 290 \fn TSS2_RC Esys_EncryptDecrypt(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO decrypt, TPMI_ALG_SYM_MODE mode, const TPM2B_IV *ivIn, const TPM2B_MAX_BUFFER *inData, TPM2B_MAX_BUFFER **outData, TPM2B_IV **ivOut) 291 \fn TSS2_RC Esys_EncryptDecrypt_Finish(ESYS_CONTEXT *esysContext, TPM2B_MAX_BUFFER **outData, TPM2B_IV **ivOut) 292 \} 293 \defgroup Esys_EventSequenceComplete The ESAPI function for the TPM2_EventSequenceComplete command. 294 * ESAPI function to invoke the TPM2_EventSequenceComplete command 295 * either as a one-call or in an asynchronous manner. 296 \{ 297 \fn TSS2_RC Esys_EventSequenceComplete_Async(ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer) 298 \fn TSS2_RC Esys_EventSequenceComplete(ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer, TPML_DIGEST_VALUES **results) 299 \fn TSS2_RC Esys_EventSequenceComplete_Finish(ESYS_CONTEXT *esysContext, TPML_DIGEST_VALUES **results) 300 \} 301 \defgroup Esys_EvictControl The ESAPI function for the TPM2_EvictControl command. 302 * ESAPI function to invoke the TPM2_EvictControl command 303 * either as a one-call or in an asynchronous manner. 304 \{ 305 \fn TSS2_RC Esys_EvictControl_Async(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR objectHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_DH_PERSISTENT persistentHandle) 306 \fn TSS2_RC Esys_EvictControl(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR objectHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_DH_PERSISTENT persistentHandle, ESYS_TR *newObjectHandle) 307 \fn TSS2_RC Esys_EvictControl_Finish(ESYS_CONTEXT *esysContext, ESYS_TR *newObjectHandle) 308 \} 309 \defgroup Esys_FlushContext The ESAPI function for the TPM2_FlushContext command. 310 * ESAPI function to invoke the TPM2_FlushContext command 311 * either as a one-call or in an asynchronous manner. 312 \{ 313 \fn TSS2_RC Esys_FlushContext_Async(ESYS_CONTEXT *esysContext, ESYS_TR flushHandle) 314 \fn TSS2_RC Esys_FlushContext(ESYS_CONTEXT *esysContext, ESYS_TR flushHandle) 315 \fn TSS2_RC Esys_FlushContext_Finish(ESYS_CONTEXT *esysContext) 316 \} 317 \defgroup Esys_GetCapability The ESAPI function for the TPM2_GetCapability command. 318 * ESAPI function to invoke the TPM2_GetCapability command 319 * either as a one-call or in an asynchronous manner. 320 \{ 321 \fn TSS2_RC Esys_GetCapability_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CAP capability, UINT32 property, UINT32 propertyCount) 322 \fn TSS2_RC Esys_GetCapability(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CAP capability, UINT32 property, UINT32 propertyCount, TPMI_YES_NO *moreData, TPMS_CAPABILITY_DATA **capabilityData) 323 \fn TSS2_RC Esys_GetCapability_Finish(ESYS_CONTEXT *esysContext, TPMI_YES_NO *moreData, TPMS_CAPABILITY_DATA **capabilityData) 324 \} 325 \defgroup Esys_GetCommandAuditDigest The ESAPI function for the TPM2_GetCommandAuditDigest command. 326 * ESAPI function to invoke the TPM2_GetCommandAuditDigest command 327 * either as a one-call or in an asynchronous manner. 328 \{ 329 \fn TSS2_RC Esys_GetCommandAuditDigest_Async(ESYS_CONTEXT *esysContext, ESYS_TR privacyHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme) 330 \fn TSS2_RC Esys_GetCommandAuditDigest(ESYS_CONTEXT *esysContext, ESYS_TR privacyHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme, TPM2B_ATTEST **auditInfo, TPMT_SIGNATURE **signature) 331 \fn TSS2_RC Esys_GetCommandAuditDigest_Finish(ESYS_CONTEXT *esysContext, TPM2B_ATTEST **auditInfo, TPMT_SIGNATURE **signature) 332 \} 333 \defgroup Esys_GetRandom The ESAPI function for the TPM2_GetRandom command. 334 * ESAPI function to invoke the TPM2_GetRandom command 335 * either as a one-call or in an asynchronous manner. 336 \{ 337 \fn TSS2_RC Esys_GetRandom_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT16 bytesRequested) 338 \fn TSS2_RC Esys_GetRandom(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT16 bytesRequested, TPM2B_DIGEST **randomBytes) 339 \fn TSS2_RC Esys_GetRandom_Finish(ESYS_CONTEXT *esysContext, TPM2B_DIGEST **randomBytes) 340 \} 341 \defgroup Esys_GetSessionAuditDigest The ESAPI function for the TPM2_GetSessionAuditDigest command. 342 * ESAPI function to invoke the TPM2_GetSessionAuditDigest command 343 * either as a one-call or in an asynchronous manner. 344 \{ 345 \fn TSS2_RC Esys_GetSessionAuditDigest_Async(ESYS_CONTEXT *esysContext, ESYS_TR privacyAdminHandle, ESYS_TR signHandle, ESYS_TR sessionHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme) 346 \fn TSS2_RC Esys_GetSessionAuditDigest(ESYS_CONTEXT *esysContext, ESYS_TR privacyAdminHandle, ESYS_TR signHandle, ESYS_TR sessionHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme, TPM2B_ATTEST **auditInfo, TPMT_SIGNATURE **signature) 347 \fn TSS2_RC Esys_GetSessionAuditDigest_Finish(ESYS_CONTEXT *esysContext, TPM2B_ATTEST **auditInfo, TPMT_SIGNATURE **signature) 348 \} 349 \defgroup Esys_GetTestResult The ESAPI function for the TPM2_GetTestResult command. 350 * ESAPI function to invoke the TPM2_GetTestResult command 351 * either as a one-call or in an asynchronous manner. 352 \{ 353 \fn TSS2_RC Esys_GetTestResult_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 354 \fn TSS2_RC Esys_GetTestResult(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2B_MAX_BUFFER **outData, TPM2_RC *testResult) 355 \fn TSS2_RC Esys_GetTestResult_Finish(ESYS_CONTEXT *esysContext, TPM2B_MAX_BUFFER **outData, TPM2_RC *testResult) 356 \} 357 \defgroup Esys_GetTime The ESAPI function for the TPM2_GetTime command. 358 * ESAPI function to invoke the TPM2_GetTime command 359 * either as a one-call or in an asynchronous manner. 360 \{ 361 \fn TSS2_RC Esys_GetTime_Async(ESYS_CONTEXT *esysContext, ESYS_TR privacyAdminHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme) 362 \fn TSS2_RC Esys_GetTime(ESYS_CONTEXT *esysContext, ESYS_TR privacyAdminHandle, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme, TPM2B_ATTEST **timeInfo, TPMT_SIGNATURE **signature) 363 \fn TSS2_RC Esys_GetTime_Finish(ESYS_CONTEXT *esysContext, TPM2B_ATTEST **timeInfo, TPMT_SIGNATURE **signature) 364 \} 365 \defgroup Esys_Hash The ESAPI function for the TPM2_Hash command. 366 * ESAPI function to invoke the TPM2_Hash command 367 * either as a one-call or in an asynchronous manner. 368 \{ 369 \fn TSS2_RC Esys_Hash_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *data, TPMI_ALG_HASH hashAlg, TPMI_RH_HIERARCHY hierarchy) 370 \fn TSS2_RC Esys_Hash(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *data, TPMI_ALG_HASH hashAlg, TPMI_RH_HIERARCHY hierarchy, TPM2B_DIGEST **outHash, TPMT_TK_HASHCHECK **validation) 371 \fn TSS2_RC Esys_Hash_Finish(ESYS_CONTEXT *esysContext, TPM2B_DIGEST **outHash, TPMT_TK_HASHCHECK **validation) 372 \} 373 \defgroup Esys_HashSequenceStart The ESAPI function for the TPM2_HashSequenceStart command. 374 * ESAPI function to invoke the TPM2_HashSequenceStart command 375 * either as a one-call or in an asynchronous manner. 376 \{ 377 \fn TSS2_RC Esys_HashSequenceStart_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *auth, TPMI_ALG_HASH hashAlg) 378 \fn TSS2_RC Esys_HashSequenceStart(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *auth, TPMI_ALG_HASH hashAlg, ESYS_TR *sequenceHandle) 379 \fn TSS2_RC Esys_HashSequenceStart_Finish(ESYS_CONTEXT *esysContext, ESYS_TR *sequenceHandle) 380 \} 381 \defgroup Esys_HierarchyChangeAuth The ESAPI function for the TPM2_HierarchyChangeAuth command. 382 * ESAPI function to invoke the TPM2_HierarchyChangeAuth command 383 * either as a one-call or in an asynchronous manner. 384 \{ 385 \fn TSS2_RC Esys_HierarchyChangeAuth_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *newAuth) 386 \fn TSS2_RC Esys_HierarchyChangeAuth(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *newAuth) 387 \fn TSS2_RC Esys_HierarchyChangeAuth_Finish(ESYS_CONTEXT *esysContext) 388 \} 389 \defgroup Esys_HierarchyControl The ESAPI function for the TPM2_HierarchyControl command. 390 * ESAPI function to invoke the TPM2_HierarchyControl command 391 * either as a one-call or in an asynchronous manner. 392 \{ 393 \fn TSS2_RC Esys_HierarchyControl_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_RH_ENABLES enable, TPMI_YES_NO state) 394 \fn TSS2_RC Esys_HierarchyControl(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_RH_ENABLES enable, TPMI_YES_NO state) 395 \fn TSS2_RC Esys_HierarchyControl_Finish(ESYS_CONTEXT *esysContext) 396 \} 397 \defgroup Esys_HMAC The ESAPI function for the TPM2_HMAC command. 398 * ESAPI function to invoke the TPM2_HMAC command 399 * either as a one-call or in an asynchronous manner. 400 \{ 401 \fn TSS2_RC Esys_HMAC_Async(ESYS_CONTEXT *esysContext, ESYS_TR handle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer, TPMI_ALG_HASH hashAlg) 402 \fn TSS2_RC Esys_HMAC(ESYS_CONTEXT *esysContext, ESYS_TR handle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer, TPMI_ALG_HASH hashAlg, TPM2B_DIGEST **outHMAC) 403 \fn TSS2_RC Esys_HMAC_Finish(ESYS_CONTEXT *esysContext, TPM2B_DIGEST **outHMAC) 404 \} 405 \defgroup Esys_HMAC_Start The ESAPI function for the TPM2_HMAC_Start command. 406 * ESAPI function to invoke the TPM2_HMAC_Start command 407 * either as a one-call or in an asynchronous manner. 408 \{ 409 \fn TSS2_RC Esys_HMAC_Start_Async(ESYS_CONTEXT *esysContext, ESYS_TR handle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *auth, TPMI_ALG_HASH hashAlg) 410 \fn TSS2_RC Esys_HMAC_Start(ESYS_CONTEXT *esysContext, ESYS_TR handle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *auth, TPMI_ALG_HASH hashAlg, ESYS_TR *sequenceHandle) 411 \fn TSS2_RC Esys_HMAC_Start_Finish(ESYS_CONTEXT *esysContext, ESYS_TR *sequenceHandle) 412 \} 413 \defgroup Esys_Import The ESAPI function for the TPM2_Import command. 414 * ESAPI function to invoke the TPM2_Import command 415 * either as a one-call or in an asynchronous manner. 416 \{ 417 \fn TSS2_RC Esys_Import_Async(ESYS_CONTEXT *esysContext, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *encryptionKey, const TPM2B_PUBLIC *objectPublic, const TPM2B_PRIVATE *duplicate, const TPM2B_ENCRYPTED_SECRET *inSymSeed, const TPMT_SYM_DEF_OBJECT *symmetricAlg) 418 \fn TSS2_RC Esys_Import(ESYS_CONTEXT *esysContext, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *encryptionKey, const TPM2B_PUBLIC *objectPublic, const TPM2B_PRIVATE *duplicate, const TPM2B_ENCRYPTED_SECRET *inSymSeed, const TPMT_SYM_DEF_OBJECT *symmetricAlg, TPM2B_PRIVATE **outPrivate) 419 \fn TSS2_RC Esys_Import_Finish(ESYS_CONTEXT *esysContext, TPM2B_PRIVATE **outPrivate) 420 \} 421 \defgroup Esys_IncrementalSelfTest The ESAPI function for the TPM2_IncrementalSelfTest command. 422 * ESAPI function to invoke the TPM2_IncrementalSelfTest command 423 * either as a one-call or in an asynchronous manner. 424 \{ 425 \fn TSS2_RC Esys_IncrementalSelfTest_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_ALG *toTest) 426 \fn TSS2_RC Esys_IncrementalSelfTest(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_ALG *toTest, TPML_ALG **toDoList) 427 \fn TSS2_RC Esys_IncrementalSelfTest_Finish(ESYS_CONTEXT *esysContext, TPML_ALG **toDoList) 428 \} 429 \defgroup Esys_Load The ESAPI function for the TPM2_Load command. 430 * ESAPI function to invoke the TPM2_Load command 431 * either as a one-call or in an asynchronous manner. 432 \{ 433 \fn TSS2_RC Esys_Load_Async(ESYS_CONTEXT *esysContext, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_PRIVATE *inPrivate, const TPM2B_PUBLIC *inPublic) 434 \fn TSS2_RC Esys_Load(ESYS_CONTEXT *esysContext, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_PRIVATE *inPrivate, const TPM2B_PUBLIC *inPublic, ESYS_TR *objectHandle) 435 \} 436 \defgroup Esys_LoadExternal The ESAPI function for the TPM2_LoadExternal command. 437 * ESAPI function to invoke the TPM2_LoadExternal command 438 * either as a one-call or in an asynchronous manner. 439 \{ 440 \fn TSS2_RC Esys_LoadExternal_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE *inPrivate, const TPM2B_PUBLIC *inPublic, TPMI_RH_HIERARCHY hierarchy) 441 \fn TSS2_RC Esys_LoadExternal(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE *inPrivate, const TPM2B_PUBLIC *inPublic, TPMI_RH_HIERARCHY hierarchy, ESYS_TR *objectHandle) 442 \fn TSS2_RC Esys_LoadExternal_Finish(ESYS_CONTEXT *esysContext, ESYS_TR *objectHandle) 443 \fn TSS2_RC Esys_Load_Finish(ESYS_CONTEXT *esysContext, ESYS_TR *objectHandle) 444 \} 445 \defgroup Esys_MakeCredential The ESAPI function for the TPM2_MakeCredential command. 446 * ESAPI function to invoke the TPM2_MakeCredential command 447 * either as a one-call or in an asynchronous manner. 448 \{ 449 \fn TSS2_RC Esys_MakeCredential_Async(ESYS_CONTEXT *esysContext, ESYS_TR handle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *credential, const TPM2B_NAME *objectName) 450 \fn TSS2_RC Esys_MakeCredential(ESYS_CONTEXT *esysContext, ESYS_TR handle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *credential, const TPM2B_NAME *objectName, TPM2B_ID_OBJECT **credentialBlob, TPM2B_ENCRYPTED_SECRET **secret) 451 \fn TSS2_RC Esys_MakeCredential_Finish(ESYS_CONTEXT *esysContext, TPM2B_ID_OBJECT **credentialBlob, TPM2B_ENCRYPTED_SECRET **secret) 452 \} 453 \defgroup Esys_NV_Certify The ESAPI function for the TPM2_NV_Certify command. 454 * ESAPI function to invoke the TPM2_NV_Certify command 455 * either as a one-call or in an asynchronous manner. 456 \{ 457 \fn TSS2_RC Esys_NV_Certify_Async(ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme, UINT16 size, UINT16 offset) 458 \fn TSS2_RC Esys_NV_Certify(ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme, UINT16 size, UINT16 offset, TPM2B_ATTEST **certifyInfo, TPMT_SIGNATURE **signature) 459 \fn TSS2_RC Esys_NV_Certify_Finish(ESYS_CONTEXT *esysContext, TPM2B_ATTEST **certifyInfo, TPMT_SIGNATURE **signature) 460 \} 461 \defgroup Esys_NV_ChangeAuth The ESAPI function for the TPM2_NV_ChangeAuth command. 462 * ESAPI function to invoke the TPM2_NV_ChangeAuth command 463 * either as a one-call or in an asynchronous manner. 464 \{ 465 \fn TSS2_RC Esys_NV_ChangeAuth_Async(ESYS_CONTEXT *esysContext, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *newAuth) 466 \fn TSS2_RC Esys_NV_ChangeAuth(ESYS_CONTEXT *esysContext, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *newAuth) 467 \fn TSS2_RC Esys_NV_ChangeAuth_Finish(ESYS_CONTEXT *esysContext) 468 \} 469 \defgroup Esys_NV_DefineSpace The ESAPI function for the TPM2_NV_DefineSpace command. 470 * ESAPI function to invoke the TPM2_NV_DefineSpace command 471 * either as a one-call or in an asynchronous manner. 472 \{ 473 \fn TSS2_RC Esys_NV_DefineSpace_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *auth, const TPM2B_NV_PUBLIC *publicInfo) 474 \fn TSS2_RC Esys_NV_DefineSpace(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *auth, const TPM2B_NV_PUBLIC *publicInfo, ESYS_TR *nvHandle) 475 \fn TSS2_RC Esys_NV_DefineSpace_Finish(ESYS_CONTEXT *esysContext, ESYS_TR *nvHandle) 476 \} 477 \defgroup Esys_NV_Extend The ESAPI function for the TPM2_NV_Extend command. 478 * ESAPI function to invoke the TPM2_NV_Extend command 479 * either as a one-call or in an asynchronous manner. 480 \{ 481 \fn TSS2_RC Esys_NV_Extend_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_NV_BUFFER *data) 482 \fn TSS2_RC Esys_NV_Extend(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_NV_BUFFER *data) 483 \fn TSS2_RC Esys_NV_Extend_Finish(ESYS_CONTEXT *esysContext) 484 \} 485 \defgroup Esys_NV_GlobalWriteLock The ESAPI function for the TPM2_NV_GlobalWriteLock command. 486 * ESAPI function to invoke the TPM2_NV_GlobalWriteLock command 487 * either as a one-call or in an asynchronous manner. 488 \{ 489 \fn TSS2_RC Esys_NV_GlobalWriteLock_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 490 \fn TSS2_RC Esys_NV_GlobalWriteLock(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 491 \fn TSS2_RC Esys_NV_GlobalWriteLock_Finish(ESYS_CONTEXT *esysContext) 492 \} 493 \defgroup Esys_NV_Increment The ESAPI function for the TPM2_NV_Increment command. 494 * ESAPI function to invoke the TPM2_NV_Increment command 495 * either as a one-call or in an asynchronous manner. 496 \{ 497 \fn TSS2_RC Esys_NV_Increment_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 498 \fn TSS2_RC Esys_NV_Increment(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 499 \fn TSS2_RC Esys_NV_Increment_Finish(ESYS_CONTEXT *esysContext) 500 \} 501 \defgroup Esys_NV_Read The ESAPI function for the TPM2_NV_Read command. 502 * ESAPI function to invoke the TPM2_NV_Read command 503 * either as a one-call or in an asynchronous manner. 504 \{ 505 \fn TSS2_RC Esys_NV_Read_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT16 size, UINT16 offset) 506 \fn TSS2_RC Esys_NV_Read(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT16 size, UINT16 offset, TPM2B_MAX_NV_BUFFER **data) 507 \fn TSS2_RC Esys_NV_Read_Finish(ESYS_CONTEXT *esysContext, TPM2B_MAX_NV_BUFFER **data) 508 \} 509 \defgroup Esys_NV_ReadLock The ESAPI function for the TPM2_NV_ReadLock command. 510 * ESAPI function to invoke the TPM2_NV_ReadLock command 511 * either as a one-call or in an asynchronous manner. 512 \{ 513 \fn TSS2_RC Esys_NV_ReadLock_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 514 \fn TSS2_RC Esys_NV_ReadLock(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 515 \fn TSS2_RC Esys_NV_ReadLock_Finish(ESYS_CONTEXT *esysContext) 516 \} 517 \defgroup Esys_NV_ReadPublic The ESAPI function for the TPM2_NV_ReadPublic command. 518 * ESAPI function to invoke the TPM2_NV_ReadPublic command 519 * either as a one-call or in an asynchronous manner. 520 \{ 521 \fn TSS2_RC Esys_NV_ReadPublic_Async(ESYS_CONTEXT *esysContext, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 522 \fn TSS2_RC Esys_NV_ReadPublic(ESYS_CONTEXT *esysContext, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2B_NV_PUBLIC **nvPublic, TPM2B_NAME **nvName) 523 \fn TSS2_RC Esys_NV_ReadPublic_Finish(ESYS_CONTEXT *esysContext, TPM2B_NV_PUBLIC **nvPublic, TPM2B_NAME **nvName) 524 \} 525 \defgroup Esys_NV_SetBits The ESAPI function for the TPM2_NV_SetBits command. 526 * ESAPI function to invoke the TPM2_NV_SetBits command 527 * either as a one-call or in an asynchronous manner. 528 \{ 529 \fn TSS2_RC Esys_NV_SetBits_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT64 bits) 530 \fn TSS2_RC Esys_NV_SetBits(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT64 bits) 531 \fn TSS2_RC Esys_NV_SetBits_Finish(ESYS_CONTEXT *esysContext) 532 \} 533 \defgroup Esys_NV_UndefineSpace The ESAPI function for the TPM2_NV_UndefineSpace command. 534 * ESAPI function to invoke the TPM2_NV_UndefineSpace command 535 * either as a one-call or in an asynchronous manner. 536 \{ 537 \fn TSS2_RC Esys_NV_UndefineSpace_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 538 \fn TSS2_RC Esys_NV_UndefineSpace(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 539 \fn TSS2_RC Esys_NV_UndefineSpace_Finish(ESYS_CONTEXT *esysContext) 540 \} 541 \defgroup Esys_NV_UndefineSpaceSpecial The ESAPI function for the TPM2_NV_UndefineSpaceSpecial command. 542 * ESAPI function to invoke the TPM2_NV_UndefineSpaceSpecial command 543 * either as a one-call or in an asynchronous manner. 544 \{ 545 \fn TSS2_RC Esys_NV_UndefineSpaceSpecial_Async(ESYS_CONTEXT *esysContext, ESYS_TR nvIndex, ESYS_TR platform, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 546 \fn TSS2_RC Esys_NV_UndefineSpaceSpecial(ESYS_CONTEXT *esysContext, ESYS_TR nvIndex, ESYS_TR platform, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 547 \fn TSS2_RC Esys_NV_UndefineSpaceSpecial_Finish(ESYS_CONTEXT *esysContext) 548 \} 549 \defgroup Esys_NV_Write The ESAPI function for the TPM2_NV_Write command. 550 * ESAPI function to invoke the TPM2_NV_Write command 551 * either as a one-call or in an asynchronous manner. 552 \{ 553 \fn TSS2_RC Esys_NV_Write_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_NV_BUFFER *data, UINT16 offset) 554 \fn TSS2_RC Esys_NV_Write(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_NV_BUFFER *data, UINT16 offset) 555 \fn TSS2_RC Esys_NV_Write_Finish(ESYS_CONTEXT *esysContext) 556 \} 557 \defgroup Esys_NV_WriteLock The ESAPI function for the TPM2_NV_WriteLock command. 558 * ESAPI function to invoke the TPM2_NV_WriteLock command 559 * either as a one-call or in an asynchronous manner. 560 \{ 561 \fn TSS2_RC Esys_NV_WriteLock_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 562 \fn TSS2_RC Esys_NV_WriteLock(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 563 \fn TSS2_RC Esys_NV_WriteLock_Finish(ESYS_CONTEXT *esysContext) 564 \} 565 \defgroup Esys_ObjectChangeAuth The ESAPI function for the TPM2_ObjectChangeAuth command. 566 * ESAPI function to invoke the TPM2_ObjectChangeAuth command 567 * either as a one-call or in an asynchronous manner. 568 \{ 569 \fn TSS2_RC Esys_ObjectChangeAuth_Async(ESYS_CONTEXT *esysContext, ESYS_TR objectHandle, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *newAuth) 570 \fn TSS2_RC Esys_ObjectChangeAuth(ESYS_CONTEXT *esysContext, ESYS_TR objectHandle, ESYS_TR parentHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_AUTH *newAuth, TPM2B_PRIVATE **outPrivate) 571 \fn TSS2_RC Esys_ObjectChangeAuth_Finish(ESYS_CONTEXT *esysContext, TPM2B_PRIVATE **outPrivate) 572 \} 573 \defgroup Esys_PCR_Allocate The ESAPI function for the TPM2_PCR_Allocate command. 574 * ESAPI function to invoke the TPM2_PCR_Allocate command 575 * either as a one-call or in an asynchronous manner. 576 \{ 577 \fn TSS2_RC Esys_PCR_Allocate_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_PCR_SELECTION *pcrAllocation) 578 \fn TSS2_RC Esys_PCR_Allocate(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_PCR_SELECTION *pcrAllocation, TPMI_YES_NO *allocationSuccess, UINT32 *maxPCR, UINT32 *sizeNeeded, UINT32 *sizeAvailable) 579 \fn TSS2_RC Esys_PCR_Allocate_Finish(ESYS_CONTEXT *esysContext, TPMI_YES_NO *allocationSuccess, UINT32 *maxPCR, UINT32 *sizeNeeded, UINT32 *sizeAvailable) 580 \} 581 \defgroup Esys_PCR_Event The ESAPI function for the TPM2_PCR_Event command. 582 * ESAPI function to invoke the TPM2_PCR_Event command 583 * either as a one-call or in an asynchronous manner. 584 \{ 585 \fn TSS2_RC Esys_PCR_Event_Async(ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_EVENT *eventData) 586 \fn TSS2_RC Esys_PCR_Event(ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_EVENT *eventData, TPML_DIGEST_VALUES **digests) 587 \fn TSS2_RC Esys_PCR_Event_Finish(ESYS_CONTEXT *esysContext, TPML_DIGEST_VALUES **digests) 588 \} 589 \defgroup Esys_PCR_Extend The ESAPI function for the TPM2_PCR_Extend command. 590 * ESAPI function to invoke the TPM2_PCR_Extend command 591 * either as a one-call or in an asynchronous manner. 592 \{ 593 \fn TSS2_RC Esys_PCR_Extend_Async(ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_DIGEST_VALUES *digests) 594 \fn TSS2_RC Esys_PCR_Extend(ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_DIGEST_VALUES *digests) 595 \fn TSS2_RC Esys_PCR_Extend_Finish(ESYS_CONTEXT *esysContext) 596 \} 597 \defgroup Esys_PCR_Read The ESAPI function for the TPM2_PCR_Read command. 598 * ESAPI function to invoke the TPM2_PCR_Read command 599 * either as a one-call or in an asynchronous manner. 600 \{ 601 \fn TSS2_RC Esys_PCR_Read_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_PCR_SELECTION *pcrSelectionIn) 602 \fn TSS2_RC Esys_PCR_Read(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_PCR_SELECTION *pcrSelectionIn, UINT32 *pcrUpdateCounter, TPML_PCR_SELECTION **pcrSelectionOut, TPML_DIGEST **pcrValues) 603 \fn TSS2_RC Esys_PCR_Read_Finish(ESYS_CONTEXT *esysContext, UINT32 *pcrUpdateCounter, TPML_PCR_SELECTION **pcrSelectionOut, TPML_DIGEST **pcrValues) 604 \} 605 \defgroup Esys_PCR_Reset The ESAPI function for the TPM2_PCR_Reset command. 606 * ESAPI function to invoke the TPM2_PCR_Reset command 607 * either as a one-call or in an asynchronous manner. 608 \{ 609 \fn TSS2_RC Esys_PCR_Reset_Async(ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 610 \fn TSS2_RC Esys_PCR_Reset(ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 611 \fn TSS2_RC Esys_PCR_Reset_Finish(ESYS_CONTEXT *esysContext) 612 \} 613 \defgroup Esys_PCR_SetAuthPolicy The ESAPI function for the TPM2_PCR_SetAuthPolicy command. 614 * ESAPI function to invoke the TPM2_PCR_SetAuthPolicy command 615 * either as a one-call or in an asynchronous manner. 616 \{ 617 \fn TSS2_RC Esys_PCR_SetAuthPolicy_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *authPolicy, TPMI_ALG_HASH hashAlg, TPMI_DH_PCR pcrNum) 618 \fn TSS2_RC Esys_PCR_SetAuthPolicy(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *authPolicy, TPMI_ALG_HASH hashAlg, TPMI_DH_PCR pcrNum) 619 \fn TSS2_RC Esys_PCR_SetAuthPolicy_Finish(ESYS_CONTEXT *esysContext) 620 \} 621 \defgroup Esys_PCR_SetAuthValue The ESAPI function for the TPM2_PCR_SetAuthValue command. 622 * ESAPI function to invoke the TPM2_PCR_SetAuthValue command 623 * either as a one-call or in an asynchronous manner. 624 \{ 625 \fn TSS2_RC Esys_PCR_SetAuthValue_Async(ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *auth) 626 \fn TSS2_RC Esys_PCR_SetAuthValue(ESYS_CONTEXT *esysContext, ESYS_TR pcrHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *auth) 627 \fn TSS2_RC Esys_PCR_SetAuthValue_Finish(ESYS_CONTEXT *esysContext) 628 \} 629 \defgroup Esys_PolicyAuthorize The ESAPI function for the TPM2_PolicyAuthorize command. 630 * ESAPI function to invoke the TPM2_PolicyAuthorize command 631 * either as a one-call or in an asynchronous manner. 632 \{ 633 \fn TSS2_RC Esys_PolicyAuthorize_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *approvedPolicy, const TPM2B_NONCE *policyRef, const TPM2B_NAME *keySign, const TPMT_TK_VERIFIED *checkTicket) 634 \fn TSS2_RC Esys_PolicyAuthorize(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *approvedPolicy, const TPM2B_NONCE *policyRef, const TPM2B_NAME *keySign, const TPMT_TK_VERIFIED *checkTicket) 635 \fn TSS2_RC Esys_PolicyAuthorize_Finish(ESYS_CONTEXT *esysContext) 636 \} 637 \defgroup Esys_PolicyAuthValue The ESAPI function for the TPM2_PolicyAuthValue command. 638 * ESAPI function to invoke the TPM2_PolicyAuthValue command 639 * either as a one-call or in an asynchronous manner. 640 \{ 641 \fn TSS2_RC Esys_PolicyAuthValue_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 642 \fn TSS2_RC Esys_PolicyAuthValue(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 643 \fn TSS2_RC Esys_PolicyAuthValue_Finish(ESYS_CONTEXT *esysContext) 644 \} 645 \defgroup Esys_PolicyCommandCode The ESAPI function for the TPM2_PolicyCommandCode command. 646 * ESAPI function to invoke the TPM2_PolicyCommandCode command 647 * either as a one-call or in an asynchronous manner. 648 \{ 649 \fn TSS2_RC Esys_PolicyCommandCode_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CC code) 650 \fn TSS2_RC Esys_PolicyCommandCode(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_CC code) 651 \fn TSS2_RC Esys_PolicyCommandCode_Finish(ESYS_CONTEXT *esysContext) 652 \} 653 \defgroup Esys_PolicyCounterTimer The ESAPI function for the TPM2_PolicyCounterTimer command. 654 * ESAPI function to invoke the TPM2_PolicyCounterTimer command 655 * either as a one-call or in an asynchronous manner. 656 \{ 657 \fn TSS2_RC Esys_PolicyCounterTimer_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_OPERAND *operandB, UINT16 offset, TPM2_EO operation) 658 \fn TSS2_RC Esys_PolicyCounterTimer(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_OPERAND *operandB, UINT16 offset, TPM2_EO operation) 659 \fn TSS2_RC Esys_PolicyCounterTimer_Finish(ESYS_CONTEXT *esysContext) 660 \} 661 \defgroup Esys_PolicyCpHash The ESAPI function for the TPM2_PolicyCpHash command. 662 * ESAPI function to invoke the TPM2_PolicyCpHash command 663 * either as a one-call or in an asynchronous manner. 664 \{ 665 \fn TSS2_RC Esys_PolicyCpHash_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *cpHashA) 666 \fn TSS2_RC Esys_PolicyCpHash(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *cpHashA) 667 \fn TSS2_RC Esys_PolicyCpHash_Finish(ESYS_CONTEXT *esysContext) 668 \} 669 \defgroup Esys_PolicyDuplicationSelect The ESAPI function for the TPM2_PolicyDuplicationSelect command. 670 * ESAPI function to invoke the TPM2_PolicyDuplicationSelect command 671 * either as a one-call or in an asynchronous manner. 672 \{ 673 \fn TSS2_RC Esys_PolicyDuplicationSelect_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_NAME *objectName, const TPM2B_NAME *newParentName, TPMI_YES_NO includeObject) 674 \fn TSS2_RC Esys_PolicyDuplicationSelect(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_NAME *objectName, const TPM2B_NAME *newParentName, TPMI_YES_NO includeObject) 675 \fn TSS2_RC Esys_PolicyDuplicationSelect_Finish(ESYS_CONTEXT *esysContext) 676 \} 677 \defgroup Esys_PolicyGetDigest The ESAPI function for the TPM2_PolicyGetDigest command. 678 * ESAPI function to invoke the TPM2_PolicyGetDigest command 679 * either as a one-call or in an asynchronous manner. 680 \{ 681 \fn TSS2_RC Esys_PolicyGetDigest_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 682 \fn TSS2_RC Esys_PolicyGetDigest(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2B_DIGEST **policyDigest) 683 \fn TSS2_RC Esys_PolicyGetDigest_Finish(ESYS_CONTEXT *esysContext, TPM2B_DIGEST **policyDigest) 684 \} 685 \defgroup Esys_PolicyLocality The ESAPI function for the TPM2_PolicyLocality command. 686 * ESAPI function to invoke the TPM2_PolicyLocality command 687 * either as a one-call or in an asynchronous manner. 688 \{ 689 \fn TSS2_RC Esys_PolicyLocality_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMA_LOCALITY locality) 690 \fn TSS2_RC Esys_PolicyLocality(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMA_LOCALITY locality) 691 \fn TSS2_RC Esys_PolicyLocality_Finish(ESYS_CONTEXT *esysContext) 692 \} 693 \defgroup Esys_PolicyNameHash The ESAPI function for the TPM2_PolicyNameHash command. 694 * ESAPI function to invoke the TPM2_PolicyNameHash command 695 * either as a one-call or in an asynchronous manner. 696 \{ 697 \fn TSS2_RC Esys_PolicyNameHash_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *nameHash) 698 \fn TSS2_RC Esys_PolicyNameHash(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *nameHash) 699 \fn TSS2_RC Esys_PolicyNameHash_Finish(ESYS_CONTEXT *esysContext) 700 \} 701 \defgroup Esys_PolicyNV The ESAPI function for the TPM2_PolicyNV command. 702 * ESAPI function to invoke the TPM2_PolicyNV command 703 * either as a one-call or in an asynchronous manner. 704 \{ 705 \fn TSS2_RC Esys_PolicyNV_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_OPERAND *operandB, UINT16 offset, TPM2_EO operation) 706 \fn TSS2_RC Esys_PolicyNV(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR nvIndex, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_OPERAND *operandB, UINT16 offset, TPM2_EO operation) 707 \fn TSS2_RC Esys_PolicyNV_Finish(ESYS_CONTEXT *esysContext) 708 \} 709 \defgroup Esys_PolicyNvWritten The ESAPI function for the TPM2_PolicyNvWritten command. 710 * ESAPI function to invoke the TPM2_PolicyNvWritten command 711 * either as a one-call or in an asynchronous manner. 712 \{ 713 \fn TSS2_RC Esys_PolicyNvWritten_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO writtenSet) 714 \fn TSS2_RC Esys_PolicyNvWritten(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO writtenSet) 715 \fn TSS2_RC Esys_PolicyNvWritten_Finish(ESYS_CONTEXT *esysContext) 716 \} 717 \defgroup Esys_PolicyOR The ESAPI function for the TPM2_PolicyOR command. 718 * ESAPI function to invoke the TPM2_PolicyOR command 719 * either as a one-call or in an asynchronous manner. 720 \{ 721 \fn TSS2_RC Esys_PolicyOR_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_DIGEST *pHashList) 722 \fn TSS2_RC Esys_PolicyOR(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_DIGEST *pHashList) 723 \fn TSS2_RC Esys_PolicyOR_Finish(ESYS_CONTEXT *esysContext) 724 \} 725 \defgroup Esys_PolicyPassword The ESAPI function for the TPM2_PolicyPassword command. 726 * ESAPI function to invoke the TPM2_PolicyPassword command 727 * either as a one-call or in an asynchronous manner. 728 \{ 729 \fn TSS2_RC Esys_PolicyPassword_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 730 \fn TSS2_RC Esys_PolicyPassword(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 731 \fn TSS2_RC Esys_PolicyPassword_Finish(ESYS_CONTEXT *esysContext) 732 \} 733 \defgroup Esys_PolicyPCR The ESAPI function for the TPM2_PolicyPCR command. 734 * ESAPI function to invoke the TPM2_PolicyPCR command 735 * either as a one-call or in an asynchronous manner. 736 \{ 737 \fn TSS2_RC Esys_PolicyPCR_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *pcrDigest, const TPML_PCR_SELECTION *pcrs) 738 \fn TSS2_RC Esys_PolicyPCR(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *pcrDigest, const TPML_PCR_SELECTION *pcrs) 739 \fn TSS2_RC Esys_PolicyPCR_Finish(ESYS_CONTEXT *esysContext) 740 \} 741 \defgroup Esys_PolicyPhysicalPresence The ESAPI function for the TPM2_PolicyPhysicalPresence command. 742 * ESAPI function to invoke the TPM2_PolicyPhysicalPresence command 743 * either as a one-call or in an asynchronous manner. 744 \{ 745 \fn TSS2_RC Esys_PolicyPhysicalPresence_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 746 \fn TSS2_RC Esys_PolicyPhysicalPresence(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 747 \fn TSS2_RC Esys_PolicyPhysicalPresence_Finish(ESYS_CONTEXT *esysContext) 748 \} 749 \defgroup Esys_PolicyRestart The ESAPI function for the TPM2_PolicyRestart command. 750 * ESAPI function to invoke the TPM2_PolicyRestart command 751 * either as a one-call or in an asynchronous manner. 752 \{ 753 \fn TSS2_RC Esys_PolicyRestart_Async(ESYS_CONTEXT *esysContext, ESYS_TR sessionHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 754 \fn TSS2_RC Esys_PolicyRestart(ESYS_CONTEXT *esysContext, ESYS_TR sessionHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 755 \fn TSS2_RC Esys_PolicyRestart_Finish(ESYS_CONTEXT *esysContext) 756 \} 757 \defgroup Esys_PolicySecret The ESAPI function for the TPM2_PolicySecret command. 758 * ESAPI function to invoke the TPM2_PolicySecret command 759 * either as a one-call or in an asynchronous manner. 760 \{ 761 \fn TSS2_RC Esys_PolicySecret_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_NONCE *nonceTPM, const TPM2B_DIGEST *cpHashA, const TPM2B_NONCE *policyRef, INT32 expiration) 762 \fn TSS2_RC Esys_PolicySecret(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_NONCE *nonceTPM, const TPM2B_DIGEST *cpHashA, const TPM2B_NONCE *policyRef, INT32 expiration, TPM2B_TIMEOUT **timeout, TPMT_TK_AUTH **policyTicket) 763 \fn TSS2_RC Esys_PolicySecret_Finish(ESYS_CONTEXT *esysContext, TPM2B_TIMEOUT **timeout, TPMT_TK_AUTH **policyTicket) 764 \} 765 \defgroup Esys_PolicySigned The ESAPI function for the TPM2_PolicySigned command. 766 * ESAPI function to invoke the TPM2_PolicySigned command 767 * either as a one-call or in an asynchronous manner. 768 \{ 769 \fn TSS2_RC Esys_PolicySigned_Async(ESYS_CONTEXT *esysContext, ESYS_TR authObject, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_NONCE *nonceTPM, const TPM2B_DIGEST *cpHashA, const TPM2B_NONCE *policyRef, INT32 expiration, const TPMT_SIGNATURE *auth) 770 \fn TSS2_RC Esys_PolicySigned(ESYS_CONTEXT *esysContext, ESYS_TR authObject, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_NONCE *nonceTPM, const TPM2B_DIGEST *cpHashA, const TPM2B_NONCE *policyRef, INT32 expiration, const TPMT_SIGNATURE *auth, TPM2B_TIMEOUT **timeout, TPMT_TK_AUTH **policyTicket) 771 \fn TSS2_RC Esys_PolicySigned_Finish(ESYS_CONTEXT *esysContext, TPM2B_TIMEOUT **timeout, TPMT_TK_AUTH **policyTicket) 772 \} 773 \defgroup Esys_PolicyTicket The ESAPI function for the TPM2_PolicyTicket command. 774 * ESAPI function to invoke the TPM2_PolicyTicket command 775 * either as a one-call or in an asynchronous manner. 776 \{ 777 \fn TSS2_RC Esys_PolicyTicket_Async(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_TIMEOUT *timeout, const TPM2B_DIGEST *cpHashA, const TPM2B_NONCE *policyRef, const TPM2B_NAME *authName, const TPMT_TK_AUTH *ticket) 778 \fn TSS2_RC Esys_PolicyTicket(ESYS_CONTEXT *esysContext, ESYS_TR policySession, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_TIMEOUT *timeout, const TPM2B_DIGEST *cpHashA, const TPM2B_NONCE *policyRef, const TPM2B_NAME *authName, const TPMT_TK_AUTH *ticket) 779 \fn TSS2_RC Esys_PolicyTicket_Finish(ESYS_CONTEXT *esysContext) 780 \} 781 \defgroup Esys_PP_Commands The ESAPI function for the TPM2_PP_Commands command. 782 * ESAPI function to invoke the TPM2_PP_Commands command 783 * either as a one-call or in an asynchronous manner. 784 \{ 785 \fn TSS2_RC Esys_PP_Commands_Async(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_CC *setList, const TPML_CC *clearList) 786 \fn TSS2_RC Esys_PP_Commands(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPML_CC *setList, const TPML_CC *clearList) 787 \fn TSS2_RC Esys_PP_Commands_Finish(ESYS_CONTEXT *esysContext) 788 \} 789 \defgroup Esys_Quote The ESAPI function for the TPM2_Quote command. 790 * ESAPI function to invoke the TPM2_Quote command 791 * either as a one-call or in an asynchronous manner. 792 \{ 793 \fn TSS2_RC Esys_Quote_Async(ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme, const TPML_PCR_SELECTION *PCRselect) 794 \fn TSS2_RC Esys_Quote(ESYS_CONTEXT *esysContext, ESYS_TR signHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *qualifyingData, const TPMT_SIG_SCHEME *inScheme, const TPML_PCR_SELECTION *PCRselect, TPM2B_ATTEST **quoted, TPMT_SIGNATURE **signature) 795 \fn TSS2_RC Esys_Quote_Finish(ESYS_CONTEXT *esysContext, TPM2B_ATTEST **quoted, TPMT_SIGNATURE **signature) 796 \} 797 \defgroup Esys_ReadClock The ESAPI function for the TPM2_ReadClock command. 798 * ESAPI function to invoke the TPM2_ReadClock command 799 * either as a one-call or in an asynchronous manner. 800 \{ 801 \fn TSS2_RC Esys_ReadClock_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 802 \fn TSS2_RC Esys_ReadClock(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMS_TIME_INFO **currentTime) 803 \fn TSS2_RC Esys_ReadClock_Finish(ESYS_CONTEXT *esysContext, TPMS_TIME_INFO **currentTime) 804 \} 805 \defgroup Esys_ReadPublic The ESAPI function for the TPM2_ReadPublic command. 806 * ESAPI function to invoke the TPM2_ReadPublic command 807 * either as a one-call or in an asynchronous manner. 808 \{ 809 \fn TSS2_RC Esys_ReadPublic_Async(ESYS_CONTEXT *esysContext, ESYS_TR objectHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 810 \fn TSS2_RC Esys_ReadPublic(ESYS_CONTEXT *esysContext, ESYS_TR objectHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2B_PUBLIC **outPublic, TPM2B_NAME **name, TPM2B_NAME **qualifiedName) 811 \fn TSS2_RC Esys_ReadPublic_Finish(ESYS_CONTEXT *esysContext, TPM2B_PUBLIC **outPublic, TPM2B_NAME **name, TPM2B_NAME **qualifiedName) 812 \} 813 \defgroup Esys_Rewrap The ESAPI function for the TPM2_Rewrap command. 814 * ESAPI function to invoke the TPM2_Rewrap command 815 * either as a one-call or in an asynchronous manner. 816 \{ 817 \fn TSS2_RC Esys_Rewrap_Async(ESYS_CONTEXT *esysContext, ESYS_TR oldParent, ESYS_TR newParent, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_PRIVATE *inDuplicate, const TPM2B_NAME *name, const TPM2B_ENCRYPTED_SECRET *inSymSeed) 818 \fn TSS2_RC Esys_Rewrap(ESYS_CONTEXT *esysContext, ESYS_TR oldParent, ESYS_TR newParent, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_PRIVATE *inDuplicate, const TPM2B_NAME *name, const TPM2B_ENCRYPTED_SECRET *inSymSeed, TPM2B_PRIVATE **outDuplicate, TPM2B_ENCRYPTED_SECRET **outSymSeed) 819 \fn TSS2_RC Esys_Rewrap_Finish(ESYS_CONTEXT *esysContext, TPM2B_PRIVATE **outDuplicate, TPM2B_ENCRYPTED_SECRET **outSymSeed) 820 \} 821 \defgroup Esys_RSA_Decrypt The ESAPI function for the TPM2_RSA_Decrypt command. 822 * ESAPI function to invoke the TPM2_RSA_Decrypt command 823 * either as a one-call or in an asynchronous manner. 824 \{ 825 \fn TSS2_RC Esys_RSA_Decrypt_Async(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_PUBLIC_KEY_RSA *cipherText, const TPMT_RSA_DECRYPT *inScheme, const TPM2B_DATA *label) 826 \fn TSS2_RC Esys_RSA_Decrypt(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_PUBLIC_KEY_RSA *cipherText, const TPMT_RSA_DECRYPT *inScheme, const TPM2B_DATA *label, TPM2B_PUBLIC_KEY_RSA **message) 827 \fn TSS2_RC Esys_RSA_Decrypt_Finish(ESYS_CONTEXT *esysContext, TPM2B_PUBLIC_KEY_RSA **message) 828 \} 829 \defgroup Esys_RSA_Encrypt The ESAPI function for the TPM2_RSA_Encrypt command. 830 * ESAPI function to invoke the TPM2_RSA_Encrypt command 831 * either as a one-call or in an asynchronous manner. 832 \{ 833 \fn TSS2_RC Esys_RSA_Encrypt_Async(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_PUBLIC_KEY_RSA *message, const TPMT_RSA_DECRYPT *inScheme, const TPM2B_DATA *label) 834 \fn TSS2_RC Esys_RSA_Encrypt(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_PUBLIC_KEY_RSA *message, const TPMT_RSA_DECRYPT *inScheme, const TPM2B_DATA *label, TPM2B_PUBLIC_KEY_RSA **outData) 835 \fn TSS2_RC Esys_RSA_Encrypt_Finish(ESYS_CONTEXT *esysContext, TPM2B_PUBLIC_KEY_RSA **outData) 836 \} 837 \defgroup Esys_SelfTest The ESAPI function for the TPM2_SelfTest command. 838 * ESAPI function to invoke the TPM2_SelfTest command 839 * either as a one-call or in an asynchronous manner. 840 \{ 841 \fn TSS2_RC Esys_SelfTest_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO fullTest) 842 \fn TSS2_RC Esys_SelfTest(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_YES_NO fullTest) 843 \fn TSS2_RC Esys_SelfTest_Finish(ESYS_CONTEXT *esysContext) 844 \} 845 \defgroup Esys_SequenceComplete The ESAPI function for the TPM2_SequenceComplete command. 846 * ESAPI function to invoke the TPM2_SequenceComplete command 847 * either as a one-call or in an asynchronous manner. 848 \{ 849 \fn TSS2_RC Esys_SequenceComplete_Async(ESYS_CONTEXT *esysContext, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer, TPMI_RH_HIERARCHY hierarchy) 850 \fn TSS2_RC Esys_SequenceComplete(ESYS_CONTEXT *esysContext, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer, TPMI_RH_HIERARCHY hierarchy, TPM2B_DIGEST **result, TPMT_TK_HASHCHECK **validation) 851 \fn TSS2_RC Esys_SequenceComplete_Finish(ESYS_CONTEXT *esysContext, TPM2B_DIGEST **result, TPMT_TK_HASHCHECK **validation) 852 \} 853 \defgroup Esys_SequenceUpdate The ESAPI function for the TPM2_SequenceUpdate command. 854 * ESAPI function to invoke the TPM2_SequenceUpdate command 855 * either as a one-call or in an asynchronous manner. 856 \{ 857 \fn TSS2_RC Esys_SequenceUpdate_Async(ESYS_CONTEXT *esysContext, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer) 858 \fn TSS2_RC Esys_SequenceUpdate(ESYS_CONTEXT *esysContext, ESYS_TR sequenceHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_MAX_BUFFER *buffer) 859 \fn TSS2_RC Esys_SequenceUpdate_Finish(ESYS_CONTEXT *esysContext) 860 \} 861 \defgroup Esys_SetAlgorithmSet The ESAPI function for the TPM2_SetAlgorithmSet command. 862 * ESAPI function to invoke the TPM2_SetAlgorithmSet command 863 * either as a one-call or in an asynchronous manner. 864 \{ 865 \fn TSS2_RC Esys_SetAlgorithmSet_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT32 algorithmSet) 866 \fn TSS2_RC Esys_SetAlgorithmSet(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, UINT32 algorithmSet) 867 \fn TSS2_RC Esys_SetAlgorithmSet_Finish(ESYS_CONTEXT *esysContext) 868 \} 869 \defgroup Esys_SetCommandCodeAuditStatus The ESAPI function for the TPM2_SetCommandCodeAuditStatus command. 870 * ESAPI function to invoke the TPM2_SetCommandCodeAuditStatus command 871 * either as a one-call or in an asynchronous manner. 872 \{ 873 \fn TSS2_RC Esys_SetCommandCodeAuditStatus_Async(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ALG_HASH auditAlg, const TPML_CC *setList, const TPML_CC *clearList) 874 \fn TSS2_RC Esys_SetCommandCodeAuditStatus(ESYS_CONTEXT *esysContext, ESYS_TR auth, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPMI_ALG_HASH auditAlg, const TPML_CC *setList, const TPML_CC *clearList) 875 \fn TSS2_RC Esys_SetCommandCodeAuditStatus_Finish(ESYS_CONTEXT *esysContext) 876 \} 877 \defgroup Esys_SetPrimaryPolicy The ESAPI function for the TPM2_SetPrimaryPolicy command. 878 * ESAPI function to invoke the TPM2_SetPrimaryPolicy command 879 * either as a one-call or in an asynchronous manner. 880 \{ 881 \fn TSS2_RC Esys_SetPrimaryPolicy_Async(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *authPolicy, TPMI_ALG_HASH hashAlg) 882 \fn TSS2_RC Esys_SetPrimaryPolicy(ESYS_CONTEXT *esysContext, ESYS_TR authHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *authPolicy, TPMI_ALG_HASH hashAlg) 883 \fn TSS2_RC Esys_SetPrimaryPolicy_Finish(ESYS_CONTEXT *esysContext) 884 \} 885 \defgroup Esys_Shutdown The ESAPI function for the TPM2_Shutdown command. 886 * ESAPI function to invoke the TPM2_Shutdown command 887 * either as a one-call or in an asynchronous manner. 888 \{ 889 \fn TSS2_RC Esys_Shutdown_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_SU shutdownType) 890 \fn TSS2_RC Esys_Shutdown(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2_SU shutdownType) 891 \fn TSS2_RC Esys_Shutdown_Finish(ESYS_CONTEXT *esysContext) 892 \} 893 \defgroup Esys_Sign The ESAPI function for the TPM2_Sign command. 894 * ESAPI function to invoke the TPM2_Sign command 895 * either as a one-call or in an asynchronous manner. 896 \{ 897 \fn TSS2_RC Esys_Sign_Async(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *digest, const TPMT_SIG_SCHEME *inScheme, const TPMT_TK_HASHCHECK *validation) 898 \fn TSS2_RC Esys_Sign(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *digest, const TPMT_SIG_SCHEME *inScheme, const TPMT_TK_HASHCHECK *validation, TPMT_SIGNATURE **signature) 899 \fn TSS2_RC Esys_Sign_Finish(ESYS_CONTEXT *esysContext, TPMT_SIGNATURE **signature) 900 \} 901 \defgroup Esys_StartAuthSession The ESAPI function for the TPM2_StartAuthSession command. 902 * ESAPI function to invoke the TPM2_StartAuthSession command 903 * either as a one-call or in an asynchronous manner. 904 \{ 905 \fn TSS2_RC Esys_StartAuthSession_Async(ESYS_CONTEXT *esysContext, ESYS_TR tpmKey, ESYS_TR bind, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_NONCE *nonceCaller, TPM2_SE sessionType, const TPMT_SYM_DEF *symmetric, TPMI_ALG_HASH authHash) 906 907 \fn TSS2_RC Esys_StartAuthSession(ESYS_CONTEXT *esysContext, ESYS_TR tpmKey, ESYS_TR bind, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_NONCE *nonceCaller, TPM2_SE sessionType, const TPMT_SYM_DEF *symmetric, TPMI_ALG_HASH authHash, ESYS_TR *sessionHandle) 908 \fn TSS2_RC Esys_StartAuthSession_Finish(ESYS_CONTEXT *esysContext, ESYS_TR *sessionHandle, TPM2B_NONCE **nonceTPM) 909 \} 910 \defgroup Esys_Startup The ESAPI function for the TPM2_Startup command. 911 * ESAPI function to invoke the TPM2_Startup command 912 * either as a one-call or in an asynchronous manner. 913 \{ 914 \fn TSS2_RC Esys_Startup_Async(ESYS_CONTEXT *esysContext, TPM2_SU startupType) 915 \fn TSS2_RC Esys_Startup(ESYS_CONTEXT *esysContext, TPM2_SU startupType) 916 \fn TSS2_RC Esys_Startup_Finish(ESYS_CONTEXT *esysContext) 917 \} 918 \defgroup Esys_StirRandom The ESAPI function for the TPM2_StirRandom command. 919 * ESAPI function to invoke the TPM2_StirRandom command 920 * either as a one-call or in an asynchronous manner. 921 \{ 922 \fn TSS2_RC Esys_StirRandom_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_DATA *inData) 923 \fn TSS2_RC Esys_StirRandom(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_SENSITIVE_DATA *inData) 924 \fn TSS2_RC Esys_StirRandom_Finish(ESYS_CONTEXT *esysContext) 925 \} 926 \defgroup Esys_TestParms The ESAPI function for the TPM2_TestParms command. 927 * ESAPI function to invoke the TPM2_TestParms command 928 * either as a one-call or in an asynchronous manner. 929 \{ 930 \fn TSS2_RC Esys_TestParms_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPMT_PUBLIC_PARMS *parameters) 931 \fn TSS2_RC Esys_TestParms(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPMT_PUBLIC_PARMS *parameters) 932 \fn TSS2_RC Esys_TestParms_Finish(ESYS_CONTEXT *esysContext) 933 \} 934 \defgroup Esys_Unseal The ESAPI function for the TPM2_Unseal command. 935 * ESAPI function to invoke the TPM2_Unseal command 936 * either as a one-call or in an asynchronous manner. 937 \{ 938 \fn TSS2_RC Esys_Unseal_Async(ESYS_CONTEXT *esysContext, ESYS_TR itemHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3) 939 \fn TSS2_RC Esys_Unseal(ESYS_CONTEXT *esysContext, ESYS_TR itemHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, TPM2B_SENSITIVE_DATA **outData) 940 \fn TSS2_RC Esys_Unseal_Finish(ESYS_CONTEXT *esysContext, TPM2B_SENSITIVE_DATA **outData) 941 \} 942 \defgroup Esys_Vendor_TCG_Test The ESAPI function for the TPM2_Vendor_TCG_Test command. 943 * ESAPI function to invoke the TPM2_Vendor_TCG_Test command 944 * either as a one-call or in an asynchronous manner. 945 \{ 946 \fn TSS2_RC Esys_Vendor_TCG_Test_Async(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *inputData) 947 \fn TSS2_RC Esys_Vendor_TCG_Test(ESYS_CONTEXT *esysContext, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DATA *inputData, TPM2B_DATA **outputData) 948 \fn TSS2_RC Esys_Vendor_TCG_Test_Finish(ESYS_CONTEXT *esysContext, TPM2B_DATA **outputData) 949 \} 950 \defgroup Esys_VerifySignature The ESAPI function for the TPM2_VerifySignature command. 951 * ESAPI function to invoke the TPM2_VerifySignature command 952 * either as a one-call or in an asynchronous manner. 953 \{ 954 \fn TSS2_RC Esys_VerifySignature_Async(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *digest, const TPMT_SIGNATURE *signature) 955 \fn TSS2_RC Esys_VerifySignature(ESYS_CONTEXT *esysContext, ESYS_TR keyHandle, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_DIGEST *digest, const TPMT_SIGNATURE *signature, TPMT_TK_VERIFIED **validation) 956 \fn TSS2_RC Esys_VerifySignature_Finish(ESYS_CONTEXT *esysContext, TPMT_TK_VERIFIED **validation) 957 \} 958 \defgroup Esys_ZGen_2Phase The ESAPI function for the TPM2_ZGen_2Phase command. 959 * ESAPI function to invoke the TPM2_ZGen_2Phase command 960 * either as a one-call or in an asynchronous manner. 961 \{ 962 \fn TSS2_RC Esys_ZGen_2Phase_Async(ESYS_CONTEXT *esysContext, ESYS_TR keyA, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *inQsB, const TPM2B_ECC_POINT *inQeB, TPMI_ECC_KEY_EXCHANGE inScheme, UINT16 counter) 963 \fn TSS2_RC Esys_ZGen_2Phase(ESYS_CONTEXT *esysContext, ESYS_TR keyA, ESYS_TR shandle1, ESYS_TR shandle2, ESYS_TR shandle3, const TPM2B_ECC_POINT *inQsB, const TPM2B_ECC_POINT *inQeB, TPMI_ECC_KEY_EXCHANGE inScheme, UINT16 counter, TPM2B_ECC_POINT **outZ1, TPM2B_ECC_POINT **outZ2) 964 \fn TSS2_RC Esys_ZGen_2Phase_Finish(ESYS_CONTEXT *esysContext, TPM2B_ECC_POINT **outZ1, TPM2B_ECC_POINT **outZ2) 965 \} 966 \} 967*/ 968 969/*! 970 \defgroup iesys Internals of Enhanced System API 971 \ingroup esys 972 This module holds internal APIs of the ESAPI implementation. 973 \{ 974 \} 975*/ 976 977/* Note: all *_IN and the union IESYS_CMD_IN_PARAM are excluded from documentation */ 978/*! 979 \defgroup esys_int Internal ESAPI Types 980 \ingroup iesys 981 The ESAPI implementation requires a set of internal type definitions. 982 \{ 983 \struct RSRC_NODE_T 984 \typedef RSRC_NODE_T 985 \enum _ESYS_STATE 986 \struct ESYS_CONTEXT 987 \def _ESYS_MAX_SUBMISSIONS 988 \def _ESYS_ASSERT_NON_NULL 989 \typedef IESYSC_RESOURCE_TYPE_CONSTANT 990 \def IESYSC_KEY_RSRC 991 \def IESYSC_NV_RSRC 992 \def IESYSC_SESSION_RSRC 993 \def IESYSC_WITHOUT_MISC_RSRC 994 \typedef IESYSC_PARAM_ENCRYPT 995 \def ENCRYPT 996 \def NO_ENCRYPT 997 \typedef IESYSC_PARAM_DECRYPT 998 \def DECRYPT 999 \def NO_DECRYPT 1000 \typedef IESYSC_TYPE_POLICY_AUTH 1001 \def POLICY_PASSWORD 1002 \def POLICY_AUTH 1003 \def NO_POLICY_AUTH 1004 \struct IESYS_SESSION 1005 \typedef IESYSC_RESOURCE_TYPE 1006 \union IESYS_RSRC_UNION 1007 \struct IESYS_RESOURCE 1008 \struct IESYS_METADATA 1009 \struct IESYS_CONTEXT_DATA 1010 \} 1011*/ 1012 1013/*! 1014 \defgroup iesys_crypto Internal Cryptographic Backend 1015 \ingroup iesys 1016 The types and functions used internally by ESAPI for cryptographic operations. 1017 Multiple implementations of these functions may exist for different 1018 cryptographic backends. 1019 \{ 1020 \def IESYS_CRYPTO_CONTEXT_BLOB 1021 \fn TSS2_RC iesys_crypto_hash_get_digest_size(TPM2_ALG_ID hashAlg, size_t *size) 1022 \fn TSS2_RC iesys_cryptogcry_hash_start( IESYS_CRYPTO_CONTEXT_BLOB **context, TPM2_ALG_ID hashAlg) 1023 \fn TSS2_RC iesys_cryptogcry_hash_update( IESYS_CRYPTO_CONTEXT_BLOB *context, const uint8_t *buffer, size_t size) 1024 \fn TSS2_RC iesys_cryptogcry_hash_update2b( IESYS_CRYPTO_CONTEXT_BLOB *context, TPM2B *b) 1025 \fn TSS2_RC iesys_cryptogcry_hash_finish( IESYS_CRYPTO_CONTEXT_BLOB **context, uint8_t *buffer, size_t *size) 1026 \fn TSS2_RC iesys_cryptogcry_hash_finish2b( IESYS_CRYPTO_CONTEXT_BLOB **context, TPM2B *b) 1027 void iesys_cryptogcry_hash_abort(IESYS_CRYPTO_CONTEXT_BLOB **context) 1028 \fn TSS2_RC iesys_cryptogcry_hmac_start( IESYS_CRYPTO_CONTEXT_BLOB **context, TPM2_ALG_ID hmacAlg, const uint8_t *key, size_t size) 1029 \fn TSS2_RC iesys_cryptogcry_hmac_start2b( IESYS_CRYPTO_CONTEXT_BLOB **context, TPM2_ALG_ID hmacAlg, TPM2B *b) 1030 \fn TSS2_RC iesys_cryptogcry_hmac_update( IESYS_CRYPTO_CONTEXT_BLOB *context, const uint8_t *buffer, size_t size) 1031 \fn TSS2_RC iesys_cryptogcry_hmac_update2b( IESYS_CRYPTO_CONTEXT_BLOB *context, TPM2B *b) 1032 \fn TSS2_RC iesys_cryptogcry_hmac_finish( IESYS_CRYPTO_CONTEXT_BLOB **context, uint8_t *buffer, size_t *size) 1033 \fn TSS2_RC iesys_cryptogcry_hmac_finish2b( IESYS_CRYPTO_CONTEXT_BLOB **context, TPM2B *b) 1034 \fn void iesys_cryptogcry_hmac_abort(IESYS_CRYPTO_CONTEXT_BLOB **context) 1035 \fn TSS2_RC iesys_crypto_pHash( TPM2_ALG_ID alg, const uint8_t rcBuffer[4], const uint8_t ccBuffer[4], const TPM2B_NAME *name1, const TPM2B_NAME *name2, const TPM2B_NAME *name3, const uint8_t *pBuffer, size_t pBuffer_size, uint8_t *pHash, size_t *pHash_size) 1036 \fn TSS2_RC iesys_crypto_authHmac( TPM2_ALG_ID alg, uint8_t *hmacKey, size_t hmacKeySize, const uint8_t *pHash, size_t pHash_size, const TPM2B_NONCE *nonceNewer, const TPM2B_NONCE *nonceOlder, const TPM2B_NONCE *nonceDecrypt, const TPM2B_NONCE *nonceEncrypt, TPMA_SESSION sessionAttributes, TPM2B_AUTH *hmac) 1037 \fn TSS2_RC iesys_cryptogcry_random2b(TPM2B_NONCE *nonce, size_t num_bytes) 1038 \fn TSS2_RC iesys_cryptogcry_pk_encrypt( TPM2B_PUBLIC *key, size_t in_size, BYTE *in_buffer, size_t max_out_size, BYTE *out_buffer, size_t *out_size, const char *label) 1039 \fn TSS2_RC iesys_crypto_KDFaHmac( TPM2_ALG_ID alg, uint8_t *hmacKey, size_t hmacKeySize, uint32_t counter, const char *label, TPM2B_NONCE *contextU, TPM2B_NONCE *contextV, uint32_t bitlength, uint8_t *hmac, size_t *hmacSize) 1040 \fn TSS2_RC iesys_crypto_KDFa( TPM2_ALG_ID hashAlg, uint8_t *hmacKey, size_t hmacKeySize, const char *label, TPM2B_NONCE *contextU, TPM2B_NONCE *contextV, uint32_t bitLength, uint32_t *counterInOut, BYTE *outKey, BOOL use_digest_size) 1041 \fn TSS2_RC iesys_crypto_KDFe( TPM2_ALG_ID hashAlg, TPM2B_ECC_PARAMETER *Z, const char *label, TPM2B_ECC_PARAMETER *partyUInfo, TPM2B_ECC_PARAMETER *partyVInfo, UINT32 bit_size, BYTE *key) 1042 \fn TSS2_RC iesys_cryptogcry_sym_aes_encrypt( uint8_t *key, TPM2_ALG_ID tpm_sym_alg, TPMI_AES_KEY_BITS key_bits, TPM2_ALG_ID tpm_mode, size_t blk_len, uint8_t *dst, size_t dst_size, uint8_t *iv) 1043 \fn TSS2_RC iesys_cryptogcry_sym_aes_decrypt( uint8_t *key, TPM2_ALG_ID tpm_sym_alg, TPMI_AES_KEY_BITS key_bits, TPM2_ALG_ID tpm_mode, size_t blk_len, uint8_t *dst, size_t dst_size, uint8_t *iv) 1044 \fn TSS2_RC iesys_xor_parameter_obfuscation( TPM2_ALG_ID hash_alg, uint8_t *key, size_t key_size, TPM2B_NONCE * contextU, TPM2B_NONCE * contextV, BYTE *data, size_t data_size) 1045 \fn TSS2_RC iesys_cryptogcry_get_ecdh_point( TPM2B_PUBLIC * key, size_t max_out_size, TPM2B_ECC_PARAMETER *Z, TPMS_ECC_POINT *Q, BYTE * out_buffer, size_t * out_size) 1046 \} 1047*/ 1048 1049/*! 1050 \defgroup iesys_util Internal ESAPI utility functions. 1051 \ingroup iesys 1052 \todo Description and Documentat of functions 1053 \{ 1054 \struct HASH_TAB_ITEM 1055 \} 1056*/ 1057 1058/*! 1059 \defgroup Testgroup Testing 1060 Description of the test plan. 1061*/ 1062 1063/*! 1064 \defgroup EsysTestgroup Esys-Testing 1065 \ingroup Testgroup 1066 \{ 1067 @brief \{ 1068 For every integration test a function with a name corresponding to the name of the source code 1069file of the test is created: 1070test_esys_<test_name>(ESYS_CONTEXT * esys_context). 1071This function is called by the standard function test_invoke_esapi in every integration test. 1072 1073For some tests different test cases can be created with compiler defines to avoid duplicate 1074code in different test cases.The following defines are used and listed in the function's 1075documentation if used: 1076- TEST_ECC Create an ECC key instead of an RSA key. 1077- TEST_SESSION Use session authentication instead of password authentication. 1078- TEST_READ_LOCK Activate test of Esys_NV_ReadLock. 1079- TEST_WRITE_LOCK Activate test of Esys_NV_WriteLock. 1080- TEST_XOR_OBFUSCATION Use xor obfuscation for parameter encryption. 1081- TEST_AES_ENCRYPTION Use AES for parameter encryption. 1082- TEST_BOUND_SESSION Run test with a bound session. 1083 1084The ESAPI command calls which are used in a test are listed in the function's documentation 1085and are marked according to the PC Client Profile Revision 01.03 v22: 1086- (M) Mandatory 1087- (O) Optional 1088- (F) Commands added after TPM Specification Rev. 1.16 is integrated. 1089\} 1090\{ 1091\fn test_esys_evict_control_serialization(ESYS_CONTEXT * esys_context) 1092 \fn test_esys_lock(ESYS_CONTEXT * esys_context) 1093 \fn test_esys_get_capability(ESYS_CONTEXT * esys_context) 1094 \fn test_esys_zgen_2phase(ESYS_CONTEXT * esys_context) 1095 \fn test_esys_verify_signature(ESYS_CONTEXT * esys_context) 1096 \fn test_esys_import(ESYS_CONTEXT * esys_context) 1097 \fn test_esys_policy_regression(ESYS_CONTEXT * esys_context) 1098 \fn test_esys_policy_authorize_nv_opt(ESYS_CONTEXT * esys_context) 1099 \fn test_esys_policy_physical_presence_opt(ESYS_CONTEXT * esys_context) 1100 \fn test_esys_policy_template_opt(ESYS_CONTEXT * esys_context) 1101 \fn test_esys_policy_ticket(ESYS_CONTEXT * esys_context) 1102 \fn test_esys_change_eps(ESYS_CONTEXT * esys_context) 1103 \fn test_esys_policy_nv_undefine_special(ESYS_CONTEXT * esys_context) 1104 \fn test_esys_create_fail(ESYS_CONTEXT * esys_context) 1105 \fn test_esys_testparms(ESYS_CONTEXT * esys_context) 1106 \fn test_esys_create_password_auth(ESYS_CONTEXT * esys_context) 1107 \fn test_esys_stir_random(ESYS_CONTEXT * esys_context) 1108 \fn test_esys_clockset(ESYS_CONTEXT * esys_context) 1109 \fn test_esys_clear_control(ESYS_CONTEXT * esys_context) 1110 \fn test_esys_nv_ram_extend_index(ESYS_CONTEXT * esys_context) 1111 \fn test_esys_save_and_load_context(ESYS_CONTEXT * esys_context) 1112 \fn test_esys_encrypt_decrypt(ESYS_CONTEXT * esys_context) 1113 \fn test_esys_createloaded(ESYS_CONTEXT * esys_context) 1114 \fn test_esys_audit(ESYS_CONTEXT * esys_context) 1115 \fn test_esys_policy_password(ESYS_CONTEXT * esys_context) 1116 \fn test_esys_hierarchy_control(ESYS_CONTEXT * esys_context) 1117 \fn test_esys_tpm_tests(ESYS_CONTEXT * esys_context) 1118 \fn test_esys_certify(ESYS_CONTEXT * esys_context) 1119 \fn test_esys_pcr_basic(ESYS_CONTEXT * esys_context) 1120 \fn test_esys_quote(ESYS_CONTEXT * esys_context) 1121 \fn test_esys_tr_getName_hierarchy(ESYS_CONTEXT * ectx) 1122 \fn test_esys_field_upgrade(ESYS_CONTEXT * esys_context) 1123 \fn test_esys_unseal_password_auth(ESYS_CONTEXT * esys_context) 1124 \fn test_esys_nv_ram_set_bits(ESYS_CONTEXT * esys_context) 1125 \fn test_esys_nv_certify(ESYS_CONTEXT * esys_context) 1126 \fn test_esys_ecdh_keygen(ESYS_CONTEXT * esys_context) 1127 \fn test_esys_tr_fromTpmPublic_key(ESYS_CONTEXT * ectx) 1128 \fn test_esys_ecdh_zgen(ESYS_CONTEXT * esys_context) 1129 \fn test_esys_certify_creation(ESYS_CONTEXT * esys_context) 1130 \fn test_esys_nv_ram_counter(ESYS_CONTEXT * esys_context) 1131 \fn test_esys_event_sequence_complete(ESYS_CONTEXT * esys_context) 1132 \fn test_esys_create_session_auth(ESYS_CONTEXT * esys_context) 1133 \fn test_esys_tr_fromTpmPublic_nv(ESYS_CONTEXT * ectx) 1134 \fn test_esys_create_primary_hmac(ESYS_CONTEXT * esys_context) 1135 \fn test_esys_firmware_read(ESYS_CONTEXT * esys_context) 1136 \fn test_esys_hmacsequencestart(ESYS_CONTEXT * esys_context) 1137 \fn test_esys_hmac(ESYS_CONTEXT * esys_context) 1138 \fn test_esys_ecc_parameters(ESYS_CONTEXT * esys_context) 1139 \fn test_esys_hierarchychangeauth(ESYS_CONTEXT * esys_context) 1140 \fn test_esys_pcr_auth_value(ESYS_CONTEXT * esys_context) 1141 \fn test_esys_nv_ram_ordinary_index(ESYS_CONTEXT * esys_context) 1142 \fn test_esys_duplicate(ESYS_CONTEXT * esys_context) 1143 \fn test_esys_rsa_encrypt_decrypt(ESYS_CONTEXT * esys_context) 1144 \fn test_esys_set_algorithm_set(ESYS_CONTEXT * esys_context) 1145 \fn test_esys_object_changeauth(ESYS_CONTEXT * esys_context) 1146 \fn test_esys_pp_commands(ESYS_CONTEXT * esys_context) 1147 \fn test_esys_hash(ESYS_CONTEXT * esys_context) 1148 \fn test_esys_hashsequencestart(ESYS_CONTEXT * esys_context) 1149 \fn test_esys_clear(ESYS_CONTEXT * esys_context) 1150 \fn test_esys_policy_authorize(ESYS_CONTEXT * esys_context) 1151 \fn test_esys_get_time(ESYS_CONTEXT * esys_context) 1152 \fn test_esys_make_credential(ESYS_CONTEXT * esys_context) 1153 \fn test_esys_commit(ESYS_CONTEXT * esys_context) 1154 \fn test_esys_policy_nv_changeauth(ESYS_CONTEXT * esys_context) 1155 \} 1156 \} 1157*/ 1158 1159/*! 1160 \defgroup fapi Feature API 1161 Feature API (FAPI) as described in the [TSS 2.0 Feature API (FAPI) Specification](https://trustedcomputinggroup.org/wp-content/uploads/todo.pdf). 1162 This API provides a very abstract view on TPM functionalities most suitable for 80 percent of applications. In mostly uses standard types in its parameter list. Policies are encoded in JSON, whereas most key material is encoded as PEM. 1163 Both the synchronous and asynchronous API are exposed through a single library: libtss2-fapi. 1164 In order to perform an asynchronous invocation of FAPI functions, the following code serves as a template: 1165 do { r = Fapi_GetPollHandles(fc, &ph, &nph); 1166 if (r == TSS2_RC_SUCCESS) { poll(ph, nph, -1); Fapi_Free(ph); } 1167 r = Fapi_*_Finish(fc, ...); } while (r == TSS2_FAPI_RC_TRY_AGAIN); 1168 \{ 1169 \typedef FAPI_CONTEXT 1170 Reference to the FAPI_CONTEXT that holds data for the connection to the TPM as 1171 well as the metadata for TPM Resource as well as links to the key- and policy 1172 store or key material for encrypted sessions. 1173 \defgroup Fapi_Initialize Fapi_Initialize 1174 FAPI functions to invoke Initialize either as one-call or in an asynchronous manner. 1175 \{ 1176 \fn Fapi_Initialize(FAPI_CONTEXT **context, char const *uri) 1177 \fn Fapi_Initialize_Async(FAPI_CONTEXT **context, char const *uri) 1178 \fn Fapi_Initialize_Finish(FAPI_CONTEXT **context) 1179 \} 1180 \defgroup Fapi_Finalize Fapi_Finalize 1181 FAPI function to invoke Finalize. 1182 \{ 1183 \fn Fapi_Finalize(FAPI_CONTEXT **context) 1184 \} 1185 \defgroup Fapi_GetTcti Fapi_GetTcti 1186 FAPI function to retrieve the TSS2_TCTI_CONTEXT currently used by the corresponding FAPI_CONTEXT. 1187 \{ 1188 \fn Fapi_GetTcti(FAPI_CONTEXT *context, TSS2_TCTI_CONTEXT **tcti) 1189 \} 1190 \defgroup Fapi_GetPollHandles Fapi_GetPollHandles 1191 FAPI function to retrieve the poll handles currently used by the corresponding FAPI_CONTEXT. 1192 \{ 1193 \fn Fapi_GetPollHandles(FAPI_CONTEXT *context, FAPI_POLL_HANDLE **handles, size_t *num_handles) 1194 \} 1195 \defgroup Fapi_Free Fapi_Free 1196 FAPI function to invoke Free. 1197 \{ 1198 \fn Fapi_Free(void *ptr) 1199 \} 1200 \defgroup Fapi_GetInfo Fapi_GetInfo 1201 FAPI functions to invoke GetInfo either as one-call or in an asynchronous manner. 1202 \{ 1203 \fn Fapi_GetInfo(FAPI_CONTEXT *context, char **info) 1204 \fn Fapi_GetInfo_Async(FAPI_CONTEXT *context) 1205 \fn Fapi_GetInfo_Finish(FAPI_CONTEXT *context, char **info) 1206 \} 1207 \defgroup Fapi_Provision Fapi_Provision 1208 FAPI functions to invoke Provision either as one-call or in an asynchronous manner. 1209 \{ 1210 \fn Fapi_Provision(FAPI_CONTEXT *context, char const *authValueEh, char const *authValueSh, char const *authValueLockout) 1211 \fn Fapi_Provision_Async(FAPI_CONTEXT *context, char const *authValueEh, char const *authValueSh, char const *authValueLockout) 1212 \fn Fapi_Provision_Finish(FAPI_CONTEXT *context) 1213 \} 1214 \defgroup Fapi_GetPlatformCertificates Fapi_GetPlatformCertificates 1215 FAPI functions to invoke GetPlatformCertificates either as one-call or in an asynchronous manner. 1216 \{ 1217 \fn Fapi_GetPlatformCertificates(FAPI_CONTEXT *context, uint8_t **certificates, size_t *certificatesSize) 1218 \fn Fapi_GetPlatformCertificates_Async(FAPI_CONTEXT *context) 1219 \fn Fapi_GetPlatformCertificates_Finish(FAPI_CONTEXT *context, uint8_t **certificates, size_t *certificatesSize) 1220 \} 1221 \defgroup Fapi_GetRandom Fapi_GetRandom 1222 FAPI functions to invoke GetRandom either as one-call or in an asynchronous manner. 1223 \{ 1224 \fn Fapi_GetRandom(FAPI_CONTEXT *context, size_t numBytes, uint8_t **data) 1225 \fn Fapi_GetRandom_Async(FAPI_CONTEXT *context, size_t numBytes) 1226 \fn Fapi_GetRandom_Finish(FAPI_CONTEXT *context, uint8_t **data) 1227 \} 1228 \defgroup Fapi_Import Fapi_Import 1229 FAPI functions to invoke Import either as one-call or in an asynchronous manner. 1230 \{ 1231 \fn Fapi_Import(FAPI_CONTEXT *context, char const *path, char const *importData) 1232 \fn Fapi_Import_Async(FAPI_CONTEXT *context, char const *path, char const *importData) 1233 \fn Fapi_Import_Finish(FAPI_CONTEXT *context) 1234 \} 1235 \defgroup Fapi_List Fapi_List 1236 FAPI functions to invoke List either as one-call or in an asynchronous manner. 1237 \{ 1238 \fn Fapi_List(FAPI_CONTEXT *context, char const *searchPath, char **pathList) 1239 \fn Fapi_List_Async(FAPI_CONTEXT *context, char const *searchPath) 1240 \fn Fapi_List_Finish(FAPI_CONTEXT *context, char **pathlist) 1241 \} 1242 \defgroup Fapi_Delete Fapi_Delete 1243 FAPI functions to invoke Delete either as one-call or in an asynchronous manner. 1244 \{ 1245 \fn Fapi_Delete(FAPI_CONTEXT *context, char const *path) 1246 \fn Fapi_Delete_Async(FAPI_CONTEXT *context, char const *path) 1247 \fn Fapi_Delete_Finish(FAPI_CONTEXT *context) 1248 \} 1249 \defgroup Fapi_ChangeAuth Fapi_ChangeAuth 1250 FAPI functions to invoke ChangeAuth either as one-call or in an asynchronous manner. 1251 \{ 1252 \fn Fapi_ChangeAuth(FAPI_CONTEXT *context, char const *entityPath, char const *authValue) 1253 \fn Fapi_ChangeAuth_Async(FAPI_CONTEXT *context, char const *entityPath, char const *authValue) 1254 \fn Fapi_ChangeAuth_Finish(FAPI_CONTEXT *context) 1255 \} 1256 \defgroup Fapi_SetDescription Fapi_SetDescription 1257 FAPI functions to invoke SetDescription either as one-call or in an asynchronous manner. 1258 \{ 1259 \fn Fapi_SetDescription(FAPI_CONTEXT *context, char const *path, char const *description) 1260 \fn Fapi_SetDescription_Async(FAPI_CONTEXT *context, char const *path, char const *description) 1261 \fn Fapi_SetDescription_Finish(FAPI_CONTEXT *context) 1262 \} 1263 \defgroup Fapi_GetDescription Fapi_GetDescription 1264 FAPI functions to invoke GetDescription either as one-call or in an asynchronous manner. 1265 \{ 1266 \fn Fapi_GetDescription(FAPI_CONTEXT *context, char const *path, char **description) 1267 \fn Fapi_GetDescription_Async(FAPI_CONTEXT *context, char const *path) 1268 \fn Fapi_GetDescription_Finish(FAPI_CONTEXT *context, char **description) 1269 \} 1270 \defgroup Fapi_SetAppData Fapi_SetAppData 1271 FAPI functions to invoke SetAppData either as one-call or in an asynchronous manner. 1272 \{ 1273 \fn Fapi_SetAppData(FAPI_CONTEXT *context, char const *path, uint8_t const *appData, size_t appDataSize) 1274 \fn Fapi_SetAppData_Async(FAPI_CONTEXT *context, char const *path, uint8_t const *appData, size_t appDataSize) 1275 \fn Fapi_SetAppData_Finish(FAPI_CONTEXT *context) 1276 \} 1277 \defgroup Fapi_GetAppData Fapi_GetAppData 1278 FAPI functions to invoke GetAppData either as one-call or in an asynchronous manner. 1279 \{ 1280 \fn Fapi_GetAppData(FAPI_CONTEXT *context, char const *path, uint8_t **appData, size_t *appDataSize) 1281 \fn Fapi_GetAppData_Async(FAPI_CONTEXT *context, char const *path) 1282 \fn Fapi_GetAppData_Finish(FAPI_CONTEXT *context, uint8_t **appData, size_t *appDataSize) 1283 \} 1284 \defgroup Fapi_GetTpmBlobs Fapi_GetTpmBlobs 1285 FAPI functions to invoke GetTPMBlobs either as one-call or in an asynchronous manner. 1286 \{ 1287 \fn Fapi_GetTpmBlobs(FAPI_CONTEXT *context, char const *path, uint8_t **tpm2bPublic, size_t *tpm2bPublicSize, uint8_t **tpm2bPrivate, size_t *tpm2bPrivateSize, char **policy) 1288 \fn Fapi_GetTpmBlobs_Async(FAPI_CONTEXT *context, char const *path) 1289 \fn Fapi_GetTpmBlobs_Finish(FAPI_CONTEXT *context, uint8_t **tpm2bPublic, size_t *tpm2bPublicSize, uint8_t **tpm2bPrivate, size_t *tpm2bPrivateSize, char **policy) 1290 \} 1291 \defgroup Fapi_CreateKey Fapi_CreateKey 1292 FAPI functions to invoke CreateKey either as one-call or in an asynchronous manner. 1293 \{ 1294 \fn Fapi_CreateKey(FAPI_CONTEXT *context, char const *path, char const *type, char const *policyPath, char const *authvalue) 1295 \fn Fapi_CreateKey_Async(FAPI_CONTEXT *context, char const *keyPath, char const *type, char const *policyPath, char const *authvalue) 1296 \fn Fapi_CreateKey_Finish(FAPI_CONTEXT *context) 1297 \} 1298 \defgroup Fapi_Sign Fapi_Sign 1299 FAPI functions to invoke Sign either as one-call or in an asynchronous manner. 1300 \{ 1301 \fn Fapi_Sign(FAPI_CONTEXT *context, char const *keyPath, char const *padding, uint8_t const *digest, size_t digestSize, uint8_t **signature, size_t *signatureSize, char **publicKey, char **certificate) 1302 \fn Fapi_Sign_Async(FAPI_CONTEXT *context, char const *keyPath, char const *padding, uint8_t const *digest, size_t digestSize) 1303 \fn Fapi_Sign_Finish(FAPI_CONTEXT *context, uint8_t **signature, size_t *signatureSize, char **publicKey, char **certificate) 1304 \} 1305 \defgroup Fapi_VerifySignature Fapi_VerifySignature 1306 FAPI functions to invoke VerifySignature either as one-call or in an asynchronous manner. 1307 \{ 1308 \fn Fapi_VerifySignature(FAPI_CONTEXT *context, char const *keyPath, uint8_t const *digest, size_t digestSize, uint8_t const *signature, size_t signatureSize) 1309 \fn Fapi_VerifySignature_Async(FAPI_CONTEXT *context, char const *keyPath, uint8_t const *digest, size_t digestSize, uint8_t const *signature, size_t signatureSize) 1310 \fn Fapi_VerifySignature_Finish(FAPI_CONTEXT *context) 1311 \} 1312 \defgroup Fapi_Encrypt Fapi_Encrypt 1313 FAPI functions to invoke Encrypt either as one-call or in an asynchronous manner. 1314 \{ 1315\fn TSS2_RC Fapi_Encrypt( 1316 FAPI_CONTEXT *context, 1317 char const *keyPath, 1318 uint8_t const *plainText, 1319 size_t plainTextSize, 1320 uint8_t **cipherText, 1321 size_t *cipherTextSize) 1322 1323\fn TSS2_RC Fapi_Encrypt_Async( 1324 FAPI_CONTEXT *context, 1325 char const *keyPath, 1326 uint8_t const *plainText, 1327 size_t plainTextSize) 1328 1329\fn TSS2_RC Fapi_Encrypt_Finish( 1330 FAPI_CONTEXT *context, 1331 uint8_t **cipherText, 1332 size_t *cipherTextSize ) 1333 1334 \} 1335 \defgroup Fapi_Decrypt Fapi_Decrypt 1336 FAPI functions to invoke Decrypt either as one-call or in an asynchronous manner. 1337 \{ 1338\fn TSS2_RC Fapi_Decrypt( 1339 FAPI_CONTEXT *context, 1340 char const *keyPath, 1341 uint8_t const *cipherText, 1342 size_t cipherTextSize, 1343 uint8_t **plainText, 1344 size_t *plainTextSize) 1345 1346\fn TSS2_RC Fapi_Decrypt_Async( 1347 FAPI_CONTEXT *context, 1348 char const *keyPath, 1349 uint8_t const *cipherText, 1350 size_t cipherTextSize); 1351 1352\fn TSS2_RC Fapi_Decrypt_Finish( 1353 FAPI_CONTEXT *context, 1354 uint8_t **plainText, 1355 size_t *plainTextSize) 1356 \} 1357 \defgroup Fapi_SetCertificate Fapi_SetCertificate 1358 FAPI functions to invoke SetCertificate either as one-call or in an asynchronous manner. 1359 \{ 1360\fn TSS2_RC Fapi_SetCertificate( 1361 FAPI_CONTEXT *context, 1362 char const *path, 1363 char const *x509certData) 1364 1365\fn TSS2_RC Fapi_SetCertificate_Async( 1366 FAPI_CONTEXT *context, 1367 char const *path, 1368 char const *x509certData) 1369 1370\fn TSS2_RC Fapi_SetCertificate_Finish( 1371 FAPI_CONTEXT *context) 1372 \} 1373 \defgroup Fapi_GetCertificate Fapi_GetCertificate 1374 FAPI functions to invoke GetCertificate either as one-call or in an asynchronous manner. 1375 \{ 1376\fn TSS2_RC Fapi_GetCertificate( 1377 FAPI_CONTEXT *context, 1378 char const *path, 1379 char **x509certData) 1380 1381\fn TSS2_RC Fapi_GetCertificate_Async( 1382 FAPI_CONTEXT *context, 1383 char const *path) 1384 1385\fn TSS2_RC Fapi_GetCertificate_Finish( 1386 FAPI_CONTEXT *context, 1387 char **x509certData) 1388 \} 1389 \defgroup Fapi_ExportKey Fapi_ExportKey 1390 FAPI functions to invoke ExportKey either as one-call or in an asynchronous manner. 1391 \{ 1392 \fn Fapi_ExportKey(FAPI_CONTEXT *context, char const *pathOfKeyToDuplicate, char const *pathToPublicKeyOfNewParent, char **exportedData) 1393 \fn Fapi_ExportKey_Async(FAPI_CONTEXT *context, char const *pathOfKeyToDuplicate, char const *pathToPublicKeyOfNewParent) 1394 \fn Fapi_ExportKey_Finish(FAPI_CONTEXT *context, char **exportedData) 1395 \} 1396 \defgroup Fapi_CreateSeal Fapi_CreateSeal 1397 FAPI functions to invoke CreateSeal either as one-call or in an asynchronous manner. 1398 \{ 1399 \fn Fapi_CreateSeal(FAPI_CONTEXT *context, char const *path, char const *type, size_t size, char const *policyPath, char const *authValue, uint8_t const *data) 1400 \fn Fapi_CreateSeal_Async(FAPI_CONTEXT *context, char const *path, char const *type, size_t size, char const *policyPath, char const *authValue, uint8_t const *data) 1401 \fn Fapi_CreateSeal_Finish(FAPI_CONTEXT *context) 1402 \} 1403 \defgroup Fapi_Unseal Fapi_Unseal 1404 FAPI functions to invoke Unseal either as one-call or in an asynchronous manner. 1405 \{ 1406 \fn Fapi_Unseal(FAPI_CONTEXT *context, char const *path, uint8_t **data, size_t *size) 1407 \fn Fapi_Unseal_Async(FAPI_CONTEXT *context, char const *path) 1408 \fn Fapi_Unseal_Finish(FAPI_CONTEXT *context, uint8_t **data, size_t *size) 1409 \} 1410 \defgroup Fapi_ExportPolicy Fapi_ExportPolicy 1411 FAPI functions to invoke ExportPolicy either as one-call or in an asynchronous manner. 1412 \{ 1413 \fn Fapi_ExportPolicy(FAPI_CONTEXT *context, char const *path, char **jsonPolicy) 1414 \fn Fapi_ExportPolicy_Async(FAPI_CONTEXT *context, char const *path) 1415 \fn Fapi_ExportPolicy_Finish(FAPI_CONTEXT *context, char **jsonPolicy) 1416 \} 1417 \defgroup Fapi_AuthorizePolicy Fapi_AuthorizePolicy 1418 FAPI functions to invoke AuthorizePolicy either as one-call or in an asynchronous manner. 1419 \{ 1420 \fn Fapi_AuthorizePolicy(FAPI_CONTEXT *context, char const *policyPath, char const *keyPath, uint8_t const *policyRef, size_t policyRefSize) 1421 \fn Fapi_AuthorizePolicy_Async(FAPI_CONTEXT *context, char const *policyPath, char const *keyPath, uint8_t const *policyRef, size_t policyRefSize) 1422 \fn Fapi_AuthorizePolicy_Finish(FAPI_CONTEXT *context) 1423 \} 1424 \defgroup Fapi_WriteAuthorizeNv Fapi_WriteAuthorizeNv 1425 FAPI functions to invoke WriteAuthorizeNv either as one-call or in an asynchronous manner. 1426 \{ 1427 \fn Fapi_WriteAuthorizeNv(FAPI_CONTEXT *context, char const *nvPath, char const *policyPath) 1428 \fn Fapi_WriteAuthorizeNv_Async(FAPI_CONTEXT *context, char const *nvPath, char const *policyPath) 1429 \fn Fapi_WriteAuthorizeNv_Finish(FAPI_CONTEXT *context) 1430 \} 1431 \defgroup Fapi_PcrRead Fapi_PcrRead 1432 FAPI functions to invoke PcrRead either as one-call or in an asynchronous manner. 1433 \{ 1434 \fn Fapi_PcrRead(FAPI_CONTEXT *context, uint32_t pcrIndex, uint8_t **pcrValue, size_t *pcrValueSize, char **pcrLog) 1435 \fn Fapi_PcrRead_Async(FAPI_CONTEXT *context, uint32_t pcrIndex) 1436 \fn Fapi_PcrRead_Finish(FAPI_CONTEXT *context, uint8_t **pcrValue, size_t *pcrValueSize, char **pcrLog) 1437 \} 1438 \defgroup Fapi_PcrExtend Fapi_PcrExtend 1439 FAPI functions to invoke PcrExtend either as one-call or in an asynchronous manner. 1440 \{ 1441 \fn Fapi_PcrExtend(FAPI_CONTEXT *context, uint32_t pcr, uint8_t const *data, size_t dataSize, char const *logData) 1442 \fn Fapi_PcrExtend_Async(FAPI_CONTEXT *context, uint32_t pcr, uint8_t const *data, size_t dataSize, char const *logData) 1443 \fn Fapi_PcrExtend_Finish(FAPI_CONTEXT *context) 1444 \} 1445 \defgroup Fapi_Quote Fapi_Quote 1446 FAPI functions to invoke Quote either as one-call or in an asynchronous manner. 1447 \{ 1448 \fn Fapi_Quote(FAPI_CONTEXT *context, uint32_t *pcrList, size_t pcrListSize, char const *keyPath, char const *quoteType, uint8_t const *qualifyingData, size_t qualifyingDataSize, char **quoteInfo, uint8_t **signature, size_t *signatureSize, char **pcrLog, char **certificate) 1449 \fn Fapi_Quote_Async(FAPI_CONTEXT *context, uint32_t *pcrList, size_t pcrListSize, char const *keyPath, char const *quoteType, uint8_t const *qualifyingData, size_t qualifyingDataSize) 1450 \fn Fapi_Quote_Finish(FAPI_CONTEXT *context, char **quoteInfo, uint8_t **signature, size_t *signatureSize, char **pcrLog, char **certificate) 1451 \} 1452 \defgroup Fapi_VerifyQuote Fapi_VerifyQuote 1453 FAPI functions to invoke VerifyQuote either as one-call or in an asynchronous manner. 1454 \{ 1455\fn TSS2_RC Fapi_VerifyQuote( 1456 FAPI_CONTEXT *context, 1457 char const *publicKeyPath, 1458 uint8_t const *qualifyingData, 1459 size_t qualifyingDataSize, 1460 char const *quoteInfo, 1461 uint8_t const *signature, 1462 size_t signatureSize, 1463 char const *pcrLog) 1464 1465\fn TSS2_RC Fapi_VerifyQuote_Async( 1466 FAPI_CONTEXT *context, 1467 char const *publicKeyPath, 1468 uint8_t const *qualifyingData, 1469 size_t qualifyingDataSize, 1470 char const *quoteInfo, 1471 uint8_t const *signature, 1472 size_t signatureSize, 1473 char const *pcrLog) 1474 1475\fn TSS2_RC Fapi_VerifyQuote_Finish( 1476 FAPI_CONTEXT *context) 1477 \} 1478 \defgroup Fapi_CreateNv Fapi_CreateNv 1479 FAPI functions to invoke CreateNv either as one-call or in an asynchronous manner. 1480 \{ 1481 \fn Fapi_CreateNv(FAPI_CONTEXT *context, char const *path, char const *type, size_t size, char const *policyPath, char const *authValue) 1482 \fn Fapi_CreateNv_Async(FAPI_CONTEXT *context, char const *path, char const *type, size_t size, char const *policyPath, char const *authValue) 1483 \fn Fapi_CreateNv_Finish(FAPI_CONTEXT *context) 1484 \} 1485 \defgroup Fapi_NvRead Fapi_NvRead 1486 FAPI functions to invoke NvRead either as one-call or in an asynchronous manner. 1487 \{ 1488\fn TSS2_RC Fapi_NvRead( 1489 FAPI_CONTEXT *context, 1490 char const *path, 1491 uint8_t **data, 1492 size_t *size, 1493 char **logData) 1494 1495\fn TSS2_RC Fapi_NvRead_Async( 1496 FAPI_CONTEXT *context, 1497 char const *path) 1498 1499\fn TSS2_RC Fapi_NvRead_Finish( 1500 FAPI_CONTEXT *context, 1501 uint8_t **data, 1502 size_t *size, 1503 char **logData) 1504 \} 1505 \defgroup Fapi_NvWrite Fapi_NvWrite 1506 FAPI functions to invoke NvWrite either as one-call or in an asynchronous manner. 1507 \{ 1508 \fn Fapi_NvWrite(FAPI_CONTEXT *context, char const *path, uint8_t const *data, size_t size) 1509 \fn Fapi_NvWrite_Async(FAPI_CONTEXT *context, char const *path, uint8_t const *data, size_t size) 1510 \fn Fapi_NvWrite_Finish(FAPI_CONTEXT *context) 1511 \} 1512 \defgroup Fapi_NvExtend Fapi_NvExtend 1513 FAPI functions to invoke NvExtend either as one-call or in an asynchronous manner. 1514 \{ 1515 \fn TSS2_RC Fapi_NvExtend( 1516 FAPI_CONTEXT *context, 1517 char const *path, 1518 uint8_t const *data, 1519 size_t size, 1520 char const *logData); 1521 1522 \fn TSS2_RC Fapi_NvExtend_Async( 1523 FAPI_CONTEXT *context, 1524 char const *path, 1525 uint8_t const *data, 1526 size_t size, 1527 char const *logData); 1528 1529\fn TSS2_RC Fapi_NvExtend_Finish( 1530 FAPI_CONTEXT *context); 1531 \} 1532 \defgroup Fapi_NvIncrement Fapi_NvIncrement 1533 FAPI functions to invoke NvIncrement either as one-call or in an asynchronous manner. 1534 \{ 1535 \fn Fapi_NvIncrement(FAPI_CONTEXT *context, char const *path) 1536 \fn Fapi_NvIncrement_Async(FAPI_CONTEXT *context, char const *path) 1537 \fn Fapi_NvIncrement_Finish(FAPI_CONTEXT *context) 1538 \} 1539 \defgroup Fapi_NvSetBits Fapi_NvSetBits 1540 FAPI functions to invoke NvSetBits either as one-call or in an asynchronous manner. 1541 \{ 1542 \fn Fapi_NvSetBits(FAPI_CONTEXT *context, char const *path, uint64_t bitmap) 1543 \fn Fapi_NvSetBits_Async(FAPI_CONTEXT *context, char const *path, uint64_t bitmap) 1544 \fn Fapi_NvSetBits_Finish(FAPI_CONTEXT *context) 1545 \} 1546 \defgroup Fapi_SetAuthCB Fapi_SetAuthCB 1547 FAPI functions to invoke SetAuthCB. 1548 \{ 1549 \fn Fapi_SetAuthCB(FAPI_CONTEXT *context, Fapi_CB_Auth callback, void *userData) 1550 \typedef (*Fapi_CB_Auth)(FAPI_CONTEXT *context, char const *description, char **auth, void *userData) 1551 \} 1552 \defgroup Fapi_SetBranchCB Fapi_SetBranchCB 1553 FAPI functions to invoke SetBranchCB. 1554 \{ 1555 \fn Fapi_SetBranchCB(FAPI_CONTEXT *context, Fapi_CB_Branch callback, void *userData) 1556 \typedef (*Fapi_CB_Branch)(FAPI_CONTEXT *context, char const *description, char const **branchNames, size_t numBranches, size_t *selectedBranch, void *userData) 1557 \} 1558 \defgroup Fapi_SetSignCB Fapi_SetSignCB 1559 FAPI functions to invoke SetSignCB. 1560 \{ 1561 \fn Fapi_SetSignCB(FAPI_CONTEXT *context, Fapi_CB_Sign callback, void *userData) 1562 \typedef (*Fapi_CB_Sign)(FAPI_CONTEXT *context, char const *description, char const *publicKey, char const *publicKeyHint, uint32_t hashAlg, uint8_t const *dataToSign, size_t dataToSignSize, uint8_t **signature, size_t *signatureSize, void *userData) 1563 \} 1564 \} 1565*/ 1566 1567/*! 1568 \defgroup ifapi Internals of Feature API 1569 \ingroup fapi 1570 This module holds internal APIs of the FAPI implementation. 1571 1572 Async programming style: 1573 1574 The tss2-fapi implementation uses an asynchronous programming style internally. 1575 This means that whenever a piece of code performs a potentially blocking operation 1576 it will instead return TSS2_FAPI_RC_TRY_AGAIN (similarly to ESAPI). Then this function 1577 is called again once the Poll returns ok. 1578 In order to carry the state of execution information over between the different invocation 1579 of the same function, the current state is stored in a state variable and all variables 1580 are stored in some kind of context variables. 1581 On the next entry to the function the state is evaluated using a swtich() statement and 1582 execution is resumed. 1583 1584 In order to understand the functional flow of code in FAPI, one can read the functions 1585 continuously over all fallthrough; and statecase(); statements. The statecase 1586 statements are the re-entry points of each function. The return_try_again() and FAPI_SYNC() 1587 statements are the preempt statements. 1588 \{ 1589 \} 1590*/ 1591 1592/*! 1593 \defgroup fapi_crypto Internal Cryptographic Backend 1594 \ingroup ifapi 1595 The types and functions used internally by FAPI for cryptographic operations. 1596 Multiple implementations of these functions for different 1597 cryptographic backends may exist. 1598 \{ 1599\fn static TSS2_RC ecdsa_verify_signature( 1600 EVP_PKEY *publicKey, 1601 const uint8_t *signature, 1602 size_t signatureSize, 1603 const uint8_t *digest, 1604 size_t digestSize) 1605\fn TSS2_RC get_crl_from_cert(X509 *cert, X509_CRL **crl) 1606\fn static TSS2_RC get_ecc_tpm2b_public_from_evp( 1607 EVP_PKEY *publicKey, 1608 TPM2B_PUBLIC *tpmPublic) 1609\fn static ENGINE * get_engine() 1610\fn static const EVP_MD * get_hash_md(TPM2_ALG_ID hashAlgorithm) 1611\fn static const EVP_MD * get_ossl_hash_md(TPM2_ALG_ID hashAlgorithm) 1612\fn static TSS2_RC get_rsa_tpm2b_public_from_evp( 1613 EVP_PKEY *publicKey, 1614 TPM2B_PUBLIC *tpmPublic) 1615\fn static int get_sig_scheme(TPM2_ALG_ID signatureScheme) 1616\fn static int ifapi_bn2binpad(const BIGNUM *bn, unsigned char *bin, int binSize) 1617\fn TSS2_RC ifapi_cert_to_pem( 1618 const uint8_t *certBuffer, 1619 size_t certBufferSize, 1620 char **pemCert, 1621 TPM2_ALG_ID *certAlgorithmId, 1622 TPM2B_PUBLIC *tpmPublic) 1623\fn void ifapi_crypto_hash_abort(IFAPI_CRYPTO_CONTEXT_BLOB **context) 1624\fn TSS2_RC ifapi_crypto_hash_finish(IFAPI_CRYPTO_CONTEXT_BLOB **context, 1625 uint8_t *digest, size_t *digestSize) 1626\fn TSS2_RC ifapi_crypto_hash_start(IFAPI_CRYPTO_CONTEXT_BLOB **context, 1627 TPM2_ALG_ID hashAlgorithm) 1628\fn TSS2_RC ifapi_crypto_hash_update(IFAPI_CRYPTO_CONTEXT_BLOB *context, 1629 const uint8_t *buffer, size_t size) 1630\fn TSS2_RC ifapi_der_sig_to_tpm( 1631 const TPMT_PUBLIC *tpmPublic, 1632 const unsigned char *signature, 1633 size_t signatureSize, 1634 TPMI_ALG_HASH hashAlgorithm, 1635 TPMT_SIGNATURE *tpmSignature) 1636\fn static TSS2_RC ifapi_ecc_der_sig_to_tpm( 1637 const unsigned char *signature, 1638 size_t signatureSize, 1639 int keySize, 1640 TPMI_ALG_HASH hashAlgorithm, 1641 TPMT_SIGNATURE *tpmSignature) 1642\fn static TSS2_RC ifapi_get_evp_from_pem(const char *pemKey, EVP_PKEY **publicKey) 1643\fn TSS2_RC ifapi_get_hash_alg_for_size(uint16_t size, TPMI_ALG_HASH *hashAlgorithm) 1644\fn TPM2_RC ifapi_get_profile_sig_scheme( 1645 const IFAPI_PROFILE *profile, 1646 const TPMT_PUBLIC *tpmPublic, 1647 TPMT_SIG_SCHEME *signatureScheme) 1648\fn TSS2_RC ifapi_get_public_from_pem_cert(const char* pem_cert, TPM2B_PUBLIC *tpm_public) 1649\fn TPM2_ALG_ID ifapi_get_signature_algorithm_from_pem(const char *pemKey) 1650\fn TSS2_RC ifapi_get_tpm2b_public_from_pem( 1651 const char *pemKey, 1652 TPM2B_PUBLIC *tpmPublic) 1653\fn TSS2_RC ifapi_get_tpm_key_fingerprint( 1654 const TPM2B_PUBLIC *tpmPublicKey, 1655 TPMI_ALG_HASH hashAlg, 1656 TPM2B_DIGEST *fingerprint) 1657\fn size_t ifapi_hash_get_digest_size(TPM2_ALG_ID hashAlgorithm) 1658\fn TSS2_RC ifapi_initialize_sign_public(TPM2_ALG_ID signatureAlgorithm, 1659 TPM2B_PUBLIC *public) 1660\fn TSS2_RC ifapi_pub_pem_key_from_tpm( 1661 const TPM2B_PUBLIC *tpmPublicKey, 1662 char **pemKey, 1663 int *pemKeySize) 1664\fn TSS2_RC ifapi_tpm_ecc_sig_to_der( 1665 const TPMT_SIGNATURE *tpmSignature, 1666 uint8_t **signature, 1667 size_t *signatureSize) 1668\fn TSS2_RC ifapi_verify_ek_cert( 1669 char* root_cert_pem, 1670 char* intermed_cert_pem, 1671 char* ek_cert_pem) 1672\fn TSS2_RC ifapi_verify_signature( 1673 const IFAPI_OBJECT *keyObject, 1674 const uint8_t *signature, 1675 size_t signatureSize, 1676 const uint8_t *digest, 1677 size_t digestSize) 1678\fn TSS2_RC ifapi_verify_signature_quote( 1679 const IFAPI_OBJECT *keyObject, 1680 const uint8_t *signature, 1681 size_t signatureSize, 1682 const uint8_t *digest, 1683 size_t digestSize, 1684 const TPMT_SIG_SCHEME *signatureScheme) 1685\fn static TSS2_RC ossl_ecc_pub_from_tpm(const TPM2B_PUBLIC *tpmPublicKey, EVP_PKEY *evpPublicKey) 1686\fn static TSS2_RC ossl_rsa_pub_from_tpm(const TPM2B_PUBLIC *tpmPublicKey, EVP_PKEY *evpPublicKey) 1687\fn static TSS2_RC rsa_verify_signature( 1688 EVP_PKEY *publicKey, 1689 const uint8_t *signature, 1690 size_t signatureSize, 1691 const uint8_t *digest, 1692 size_t digestSize) 1693\} 1694*/ 1695 1696/*! 1697 \defgroup ifapi_policy_intantiate Policy instantiation module 1698 \ingroup ifapi 1699 Provides functions for instantiation of the policies. The defaults will be initialized according to the given values. 1700 \{ 1701\fn static TSS2_RC get_policy_elements(TPML_POLICYELEMENTS *policy, NODE_OBJECT_T **policy_element_list) 1702\fn TSS2_RC ifapi_policyeval_instantiate_async( 1703 IFAPI_POLICY_EVAL_INST_CTX *context, 1704 TPMS_POLICY *policy, 1705 ifapi_policyeval_INST_CB *callbacks) 1706\fn TSS2_RC ifapi_policyeval_instantiate_finish( 1707 IFAPI_POLICY_EVAL_INST_CTX *context) 1708 \} 1709*/ 1710 1711 /*! 1712 \defgroup ifapi_policy Policy calculation module 1713 \ingroup ifapi 1714 Provides functions for policy calculation (without TPM). 1715 \{ 1716 1717\fn TSS2_RC ifapi_calculate_tree( 1718 FAPI_CONTEXT *context, 1719 const char *policyPath, 1720 TPMS_POLICY *policy, 1721 TPMI_ALG_HASH hash_alg, 1722 size_t *digest_idx, 1723 size_t *hash_size) 1724 1725\fn static TSS2_RC calculate_policy_key_param( 1726 TPM2_CC command_code, 1727 TPM2B_NAME *name, 1728 TPM2B_NONCE *policyRef, 1729 size_t hash_size, 1730 TPMI_ALG_HASH current_hash_alg, 1731 TPMU_HA *digest) 1732\fn static void copy_policy_digest(TPML_DIGEST_VALUES *dest, TPML_DIGEST_VALUES *src, 1733 size_t digest_idx, size_t hash_size, char *txt) 1734\fn TSS2_RC ifapi_calculate_policy( 1735 TPML_POLICYELEMENTS *policy, 1736 TPML_DIGEST_VALUES *policyDigests, 1737 TPMI_ALG_HASH hash_alg, 1738 size_t hash_size, 1739 size_t digest_idx) 1740\fn TSS2_RC ifapi_calculate_policy_auth_value( 1741 TPMS_POLICYAUTHVALUE *policy, 1742 TPML_DIGEST_VALUES *current_digest, 1743 TPMI_ALG_HASH current_hash_alg) 1744\fn TSS2_RC ifapi_calculate_policy_authorize( 1745 TPMS_POLICYAUTHORIZE *policy, 1746 TPML_DIGEST_VALUES *current_digest, 1747 TPMI_ALG_HASH current_hash_alg) 1748\fn TSS2_RC ifapi_calculate_policy_authorize_nv( 1749 TPMS_POLICYAUTHORIZENV *policy, 1750 TPML_DIGEST_VALUES *current_digest, 1751 TPMI_ALG_HASH current_hash_alg) 1752\fn TSS2_RC ifapi_calculate_policy_command_code( 1753 TPMS_POLICYCOMMANDCODE *policy, 1754 TPML_DIGEST_VALUES *current_digest, 1755 TPMI_ALG_HASH current_hash_alg) 1756\fn TSS2_RC ifapi_calculate_policy_counter_timer( 1757 TPMS_POLICYCOUNTERTIMER *policy, 1758 TPML_DIGEST_VALUES *current_digest, 1759 TPMI_ALG_HASH current_hash_alg) 1760\fn TSS2_RC ifapi_calculate_policy_cp_hash( 1761 TPMS_POLICYCPHASH *policy, 1762 TPML_DIGEST_VALUES *current_digest, 1763 TPMI_ALG_HASH current_hash_alg) 1764\fn TSS2_RC ifapi_calculate_policy_digest_hash( 1765 TPM2B_DIGEST *digest, 1766 TPML_DIGEST_VALUES *current_digest, 1767 TPMI_ALG_HASH current_hash_alg, 1768 TPM2_CC command_code) 1769\fn TSS2_RC ifapi_calculate_policy_duplicate( 1770 TPMS_POLICYDUPLICATIONSELECT *policy, 1771 TPML_DIGEST_VALUES *current_digest, 1772 TPMI_ALG_HASH current_hash_alg) 1773\fn TSS2_RC ifapi_calculate_policy_locality( 1774 TPMS_POLICYLOCALITY *policy, 1775 TPML_DIGEST_VALUES *current_digest, 1776 TPMI_ALG_HASH current_hash_alg) 1777\fn TSS2_RC ifapi_calculate_policy_name_hash( 1778 TPMS_POLICYNAMEHASH *policy, 1779 TPML_DIGEST_VALUES *current_digest, 1780 TPMI_ALG_HASH current_hash_alg) 1781\fn TSS2_RC ifapi_calculate_policy_nv( 1782 TPMS_POLICYNV *policy, 1783 TPML_DIGEST_VALUES *current_digest, 1784 TPMI_ALG_HASH current_hash_alg) 1785\fn TSS2_RC ifapi_calculate_policy_nv_written( 1786 TPMS_POLICYNVWRITTEN *policy, 1787 TPML_DIGEST_VALUES *current_digest, 1788 TPMI_ALG_HASH current_hash_alg) 1789\fn TSS2_RC ifapi_calculate_policy_or( 1790 TPMS_POLICYOR *policyOr, 1791 TPML_DIGEST_VALUES *current_digest, 1792 TPMI_ALG_HASH hash_alg, 1793 size_t hash_size, 1794 size_t digest_idx) 1795\fn TSS2_RC ifapi_calculate_policy_password( 1796 TPMS_POLICYPASSWORD *policy, 1797 TPML_DIGEST_VALUES *current_digest, 1798 TPMI_ALG_HASH current_hash_alg) 1799\fn TSS2_RC ifapi_calculate_policy_physical_presence( 1800 TPMS_POLICYPHYSICALPRESENCE *policy, 1801 TPML_DIGEST_VALUES *current_digest, 1802 TPMI_ALG_HASH current_hash_alg) 1803\fn TSS2_RC ifapi_calculate_policy_secret( 1804 TPMS_POLICYSECRET *policy, 1805 TPML_DIGEST_VALUES *current_digest, 1806 TPMI_ALG_HASH current_hash_alg) 1807\fn TSS2_RC ifapi_calculate_policy_signed( 1808 TPMS_POLICYSIGNED *policy, 1809 TPML_DIGEST_VALUES *current_digest, 1810 TPMI_ALG_HASH current_hash_alg) 1811\fn TSS2_RC ifapi_calculate_simple_policy( 1812 TPM2_CC command_code1, 1813 TPM2_CC command_code2, 1814 TPML_DIGEST_VALUES *current_digest, 1815 TPMI_ALG_HASH current_hash_alg) 1816\fn TSS2_RC ifapi_compute_policy_pcr( 1817 TPMS_POLICYPCR *policy, 1818 TPML_DIGEST_VALUES *current_digest, 1819 TPMI_ALG_HASH current_hash_alg) 1820\fn static void log_policy_digest(TPML_DIGEST_VALUES *dest, size_t digest_idx, size_t hash_size, 1821 char *txt) 1822 1823 \} 1824*/ 1825 1826/*! 1827 \defgroup ifapi_policy_callbacks Policy callback functions. 1828 \ingroup ifapi 1829 Provides internal callbacks functions for policy execution. 1830 \{ 1831\fn static void cleanup_policy_list(struct POLICY_LIST * list) 1832\fn static TSS2_RC compare_policy_digest( 1833 TPMS_POLICY *policy, 1834 void *authPolicyVoid, 1835 void *nameAlgVoid, 1836 bool *equal) 1837\fn static TSS2_RC equal_policy_authorization( 1838 TPMS_POLICY *policy, 1839 void *publicVoid, 1840 void *nameAlgVoid, 1841 bool *equal) 1842\fn static void get_nv_auth_object( 1843 IFAPI_OBJECT *nv_object, 1844 ESYS_TR nv_index, 1845 IFAPI_OBJECT *auth_object, 1846 ESYS_TR *auth_index) 1847\fn static TSS2_RC get_policy_digest(TPMS_POLICY *policy, 1848 TPMI_ALG_HASH hashAlg, 1849 TPM2B_DIGEST *digest) 1850\fn static TSS2_RC get_policy_signature( 1851 TPMS_POLICY *policy, 1852 TPMT_PUBLIC *public, 1853 TPMT_SIGNATURE *signature) 1854\fn TSS2_RC ifapi_branch_selection( 1855 TPML_POLICYBRANCHES *branches, 1856 size_t *branch_idx, 1857 void *userdata) 1858\fn TSS2_RC ifapi_exec_auth_nv_policy( 1859 TPM2B_NV_PUBLIC *nv_public, 1860 TPMI_ALG_HASH hash_alg, 1861 void *userdata) 1862\fn TSS2_RC ifapi_exec_auth_policy( 1863 TPMT_PUBLIC *key_public, 1864 TPMI_ALG_HASH hash_alg, 1865 TPM2B_DIGEST *digest, 1866 TPMT_SIGNATURE *signature, 1867 void *userdata) 1868\fn TSS2_RC ifapi_get_duplicate_name( 1869 TPM2B_NAME *name, 1870 void *userdata) 1871\fn TSS2_RC ifapi_get_key_public( 1872 const char *path, 1873 TPMT_PUBLIC *public, 1874 void *ctx) 1875\fn TSS2_RC ifapi_get_nv_public( 1876 const char *path, 1877 TPM2B_NV_PUBLIC *nv_public, 1878 void *ctx) 1879\fn TSS2_RC ifapi_get_object_name( 1880 const char *path, 1881 TPM2B_NAME *name, 1882 void *ctx) 1883\fn TSS2_RC ifapi_policy_action( 1884 const char *action, 1885 void *userdata) 1886\fn TSS2_RC ifapi_policyeval_cbauth( 1887 TPM2B_NAME *name, 1888 ESYS_TR *object_handle, 1889 ESYS_TR *auth_handle, 1890 ESYS_TR *authSession, 1891 void *userdata) 1892\fn TSS2_RC ifapi_read_pcr( 1893 TPMS_PCR_SELECT *pcr_select, 1894 TPML_PCR_SELECTION *pcr_selection, 1895 TPML_PCRVALUES **pcr_values, 1896 void *ctx) 1897\fn TSS2_RC ifapi_sign_buffer( 1898 char *key_pem, 1899 char *public_key_hint, 1900 TPMI_ALG_HASH key_pem_hash_alg, 1901 uint8_t *buffer, 1902 size_t buffer_size, 1903 uint8_t **signature, 1904 size_t *signature_size, 1905 void *userdata) 1906\fn static TSS2_RC search_policy( 1907 FAPI_CONTEXT *context, 1908 Policy_Compare_Object compare, 1909 bool all_objects, 1910 void *object1, 1911 void *object2, 1912 struct POLICY_LIST **policy_found) 1913 1914 \} 1915*/ 1916 1917/*! 1918 \defgroup ifapi_policy_execution Policy execution functions. 1919 \ingroup ifapi 1920 Provides internal functions for policy execution. 1921 \{ 1922\fn static TSS2_RC compute_or_digest_list( 1923 TPML_POLICYBRANCHES *branches, 1924 TPMI_ALG_HASH current_hash_alg, 1925 TPML_DIGEST *digest_list) 1926\fn static TSS2_RC compute_policy_list( 1927 IFAPI_POLICY_EXEC_CTX *pol_ctx, 1928 TPML_POLICYELEMENTS *elements) 1929\fn static TSS2_RC execute_policy_action( 1930 ESYS_CONTEXT *esys_ctx, 1931 TPMS_POLICYACTION *policy, 1932 IFAPI_POLICY_EXEC_CTX *current_policy) 1933\fn static TSS2_RC execute_policy_auth_value( 1934 ESYS_CONTEXT *esys_ctx, 1935 TPMS_POLICYAUTHVALUE *policy, 1936 IFAPI_POLICY_EXEC_CTX *current_policy) 1937\fn static TSS2_RC execute_policy_authorize( 1938 ESYS_CONTEXT *esys_ctx, 1939 TPMS_POLICYAUTHORIZE *policy, 1940 TPMI_ALG_HASH hash_alg, 1941 IFAPI_POLICY_EXEC_CTX *current_policy) 1942\fn static TSS2_RC execute_policy_authorize_nv( 1943 ESYS_CONTEXT *esys_ctx, 1944 TPMS_POLICYAUTHORIZENV *policy, 1945 TPMI_ALG_HASH hash_alg, 1946 IFAPI_POLICY_EXEC_CTX *current_policy) 1947\fn static TSS2_RC execute_policy_command_code( 1948 ESYS_CONTEXT *esys_ctx, 1949 TPMS_POLICYCOMMANDCODE *policy, 1950 IFAPI_POLICY_EXEC_CTX *current_policy) 1951\fn static TSS2_RC execute_policy_counter_timer( 1952 ESYS_CONTEXT *esys_ctx, 1953 TPMS_POLICYCOUNTERTIMER *policy, 1954 IFAPI_POLICY_EXEC_CTX *current_policy) 1955\fn static TSS2_RC execute_policy_cp_hash( 1956 ESYS_CONTEXT *esys_ctx, 1957 TPMS_POLICYCPHASH *policy, 1958 IFAPI_POLICY_EXEC_CTX *current_policy) 1959\fn static TSS2_RC execute_policy_duplicate( 1960 ESYS_CONTEXT *esys_ctx, 1961 TPMS_POLICYDUPLICATIONSELECT *policy, 1962 IFAPI_POLICY_EXEC_CTX *current_policy) 1963\fn static TSS2_RC execute_policy_element( 1964 ESYS_CONTEXT *esys_ctx, 1965 TPMT_POLICYELEMENT *policy, 1966 TPMI_ALG_HASH hash_alg, 1967 IFAPI_POLICY_EXEC_CTX *current_policy) 1968\fn static TSS2_RC execute_policy_locality( 1969 ESYS_CONTEXT *esys_ctx, 1970 TPMS_POLICYLOCALITY *policy, 1971 IFAPI_POLICY_EXEC_CTX *current_policy) 1972\fn static TSS2_RC execute_policy_name_hash( 1973 ESYS_CONTEXT *esys_ctx, 1974 TPMS_POLICYNAMEHASH *policy, 1975 IFAPI_POLICY_EXEC_CTX *current_policy) 1976\fn static TSS2_RC execute_policy_nv( 1977 ESYS_CONTEXT *esys_ctx, 1978 TPMS_POLICYNV *policy, 1979 IFAPI_POLICY_EXEC_CTX *current_policy) 1980\fn static TSS2_RC execute_policy_nv_written( 1981 ESYS_CONTEXT *esys_ctx, 1982 TPMS_POLICYNVWRITTEN *policy, 1983 IFAPI_POLICY_EXEC_CTX *current_policy) 1984\fn static TSS2_RC execute_policy_or( 1985 ESYS_CONTEXT *esys_ctx, 1986 TPMS_POLICYOR *policy, 1987 TPMI_ALG_HASH current_hash_alg, 1988 IFAPI_POLICY_EXEC_CTX *current_policy) 1989\fn static TSS2_RC execute_policy_password( 1990 ESYS_CONTEXT *esys_ctx, 1991 TPMS_POLICYPASSWORD *policy, 1992 IFAPI_POLICY_EXEC_CTX *current_policy) 1993\fn static TSS2_RC execute_policy_pcr( 1994 ESYS_CONTEXT *esys_ctx, 1995 TPMS_POLICYPCR *policy, 1996 TPMI_ALG_HASH current_hash_alg, 1997 IFAPI_POLICY_EXEC_CTX *current_policy) 1998\fn static TSS2_RC execute_policy_physical_presence( 1999 ESYS_CONTEXT *esys_ctx, 2000 TPMS_POLICYPHYSICALPRESENCE *policy, 2001 IFAPI_POLICY_EXEC_CTX *current_policy) 2002\fn static TSS2_RC execute_policy_secret( 2003 ESYS_CONTEXT *esys_ctx, 2004 TPMS_POLICYSECRET *policy, 2005 TPMI_ALG_HASH hash_alg, 2006 IFAPI_POLICY_EXEC_CTX *current_policy) 2007\fn static TSS2_RC execute_policy_signed( 2008 ESYS_CONTEXT *esys_ctx, 2009 TPMS_POLICYSIGNED *policy, 2010 IFAPI_POLICY_EXEC_CTX *current_policy) 2011\fn TSS2_RC get_policy_digest_idx(TPML_DIGEST_VALUES *digest_values, TPMI_ALG_HASH hashAlg, 2012 size_t *idx) 2013\fn TSS2_RC ifapi_extend_authorization( 2014 TPMS_POLICY *policy, 2015 TPMS_POLICYAUTHORIZATION *authorization) 2016\fn TSS2_RC ifapi_policyeval_execute( 2017 ESYS_CONTEXT *esys_ctx, 2018 IFAPI_POLICY_EXEC_CTX *current_policy) 2019\fn TSS2_RC ifapi_policyeval_execute_prepare( 2020 IFAPI_POLICY_EXEC_CTX *pol_ctx, 2021 TPMI_ALG_HASH hash_alg, 2022 TPMS_POLICY *policy) 2023 2024 \} 2025*/ 2026 2027/*! 2028 \defgroup ifapi_policy_util_exec Policy utilitiy module 2029 \ingroup ifapi 2030 Provides functions for the execution of policies for object authorization. 2031\{ 2032 2033\fn static void clear_all_policies(FAPI_CONTEXT *context) 2034\fn static TSS2_RC clear_current_policy(FAPI_CONTEXT *context) 2035\fn static TSS2_RC create_session( 2036 FAPI_CONTEXT *context, 2037 ESYS_TR *session, 2038 TPMI_ALG_HASH hash_alg) 2039\fn TSS2_RC ifapi_policyutil_execute(FAPI_CONTEXT *context, ESYS_TR *session) 2040\fn TSS2_RC ifapi_policyutil_execute_prepare( 2041 FAPI_CONTEXT *context, 2042 TPMI_ALG_HASH hash_alg, 2043 TPMS_POLICY *policy) 2044\fn static TSS2_RC new_policy( 2045 FAPI_CONTEXT *context, 2046 TPMS_POLICY *policy, 2047 IFAPI_POLICYUTIL_STACK **current_policy) 2048 2049\} 2050 */ 2051 2052 /*! 2053 \defgroup ifapi_helper Helper functions module 2054 \ingroup ifapi 2055 Provides helper functions. 2056 \{ 2057\fn bool add_string_to_list(NODE_STR_T *str_list, char *string) 2058\fn TSS2_RC append_object_to_list(void *object, NODE_OBJECT_T **object_list) 2059\fn static void cleanup_policy_element(TPMT_POLICYELEMENT *policy) 2060\fn static void cleanup_policy_elements(TPML_POLICYELEMENTS *policy) 2061\fn static void cleanup_policy_object(POLICY_OBJECT * object) 2062\fn static TSS2_RC copy_policy(TPMS_POLICY * dest, 2063 const TPMS_POLICY * src) 2064\fn static TPML_POLICYBRANCHES * copy_policy_branches(const TPML_POLICYBRANCHES *from_branches) 2065\fn static TSS2_RC copy_policy_element(const TPMT_POLICYELEMENT *from_policy, TPMT_POLICYELEMENT *to_policy) 2066\fn static TPML_POLICYELEMENTS * copy_policy_elements(const TPML_POLICYELEMENTS *from_policy) 2067\fn static TSS2_RC copy_policy_object(POLICY_OBJECT * dest, const POLICY_OBJECT * src) 2068\fn static TSS2_RC copy_policyauthorization(TPMS_POLICYAUTHORIZATION * dest, 2069 const TPMS_POLICYAUTHORIZATION * src) 2070\fn static TSS2_RC create_dirs(const char *supdir, NODE_STR_T *dir_list, mode_t mode) 2071\fn void free_string_list(NODE_STR_T *node) 2072\fn char * get_description(IFAPI_OBJECT *object) 2073\fn bool ifapi_TPM2B_DIGEST_cmp(TPM2B_DIGEST *in1, TPM2B_DIGEST *in2) 2074\fn bool ifapi_TPM2B_ECC_PARAMETER_cmp(TPM2B_ECC_PARAMETER *in1, 2075 TPM2B_ECC_PARAMETER *in2) 2076\fn bool ifapi_TPM2B_PUBLIC_KEY_RSA_cmp(TPM2B_PUBLIC_KEY_RSA *in1, 2077 TPM2B_PUBLIC_KEY_RSA *in2) 2078\fn bool ifapi_TPMS_ECC_POINT_cmp(TPMS_ECC_POINT *in1, TPMS_ECC_POINT *in2) 2079\fn bool ifapi_TPMT_PUBLIC_cmp(TPMT_PUBLIC *in1, TPMT_PUBLIC *in2) 2080\fn bool ifapi_TPMU_PUBLIC_ID_cmp(TPMU_PUBLIC_ID *in1, UINT32 selector1, 2081 TPMU_PUBLIC_ID *in2, UINT32 selector2) 2082\fn TSS2_RC ifapi_asprintf(char **str, const char *fmt, ...) 2083\fn TSS2_RC ifapi_calculate_pcr_digest( 2084 json_object *jso_event_list, 2085 const FAPI_QUOTE_INFO *quote_info, 2086 TPM2B_DIGEST *pcr_digest) 2087\fn TSS2_RC ifapi_check_profile_pcr_selection( 2088 const TPML_PCR_SELECTION *pcr_profile, 2089 const TPML_PCR_SELECTION *pcr_capablity) 2090\fn void ifapi_cleanup_policy(TPMS_POLICY *policy) 2091\fn bool ifapi_cmp_public_key( 2092 TPM2B_PUBLIC *key1, 2093 TPM2B_PUBLIC *key2) 2094\fn TSS2_RC ifapi_compute_policy_digest( 2095 TPML_PCRVALUES *pcrs, 2096 TPML_PCR_SELECTION *pcr_selection, 2097 TPMI_ALG_HASH hash_alg, 2098 TPM2B_DIGEST *pcr_digest) 2099\fn TSS2_RC ifapi_compute_quote_info( 2100 IFAPI_OBJECT *sig_key_object, 2101 TPM2B_ATTEST *tpm_quoted, 2102 char **quoteInfo) 2103\fn TPMS_POLICY * ifapi_copy_policy( 2104 const TPMS_POLICY *from_policy) 2105\fn TSS2_RC ifapi_create_dirs(const char *supdir, const char *path) 2106\fn TSS2_RC ifapi_extend_vpcr( 2107 TPM2B_DIGEST *vpcr, 2108 TPMI_ALG_HASH bank, 2109 const IFAPI_EVENT *event) 2110\fn TSS2_RC ifapi_filter_pcr_selection_by_index( 2111 TPML_PCR_SELECTION *pcr_selection, 2112 const TPM2_HANDLE *pcr_index, 2113 size_t pcr_count) 2114\fn void ifapi_free_node_list(NODE_OBJECT_T *node) 2115\fn void ifapi_free_object_list(NODE_OBJECT_T *node) 2116\fn int ifapi_get_curl_buffer(unsigned char * url, unsigned char ** buffer, 2117 size_t *buffer_size) 2118\fn ESYS_TR ifapi_get_hierary_handle(const char *path) 2119\fn TSS2_RC ifapi_get_name(TPMT_PUBLIC *publicInfo, TPM2B_NAME *name) 2120\fn TSS2_RC ifapi_get_nv_start_index(const char *path, TPM2_HANDLE *start_nv_index) 2121\fn TSS2_RC ifapi_get_quote_info( 2122 char const *quoteInfo, 2123 TPM2B_ATTEST *tpm_quoted, 2124 FAPI_QUOTE_INFO *fapi_quote_info) 2125\fn bool ifapi_hierarchy_path_p(const char *path) 2126\fn void ifapi_init_hierarchy_object( 2127 IFAPI_OBJECT *hierarchy, 2128 ESYS_TR esys_handle) 2129\fn TSS2_RC ifapi_nv_get_name(TPM2B_NV_PUBLIC *publicInfo, TPM2B_NAME *name) 2130\fn TSS2_RC ifapi_object_cmp_name(IFAPI_OBJECT *object, void *name, bool *equal) 2131\fn TSS2_RC ifapi_object_cmp_nv_public(IFAPI_OBJECT *object, void *nv_public, bool *equal) 2132\fn size_t ifapi_path_length(NODE_STR_T *node) 2133\fn TSS2_RC ifapi_path_string(char **dest, const char *supdir, NODE_STR_T *node, char *name) 2134\fn TSS2_RC ifapi_path_string_n(char **dest, const char *supdir, NODE_STR_T *node, char *name, 2135 size_t n) 2136\fn bool ifapi_path_type_p(const char *path, const char *type) 2137\fn TSS2_RC ifapi_set_key_flags(const char *type, bool policy, IFAPI_KEY_TEMPLATE *template) 2138\fn TSS2_RC ifapi_set_nv_flags(const char *type, IFAPI_NV_TEMPLATE *template, 2139 const char *policy) 2140\fn TSS2_RC ifapi_tpm_to_fapi_signature( 2141 IFAPI_OBJECT *sig_key_object, 2142 TPMT_SIGNATURE *tpm_signature, 2143 uint8_t **signature, 2144 size_t *signatureSize) 2145\fn NODE_STR_T * init_string_list(const char *string) 2146\fn bool object_with_auth(IFAPI_OBJECT *object) 2147\fn static size_t path_str_length(NODE_STR_T *node, int delim_length) 2148\fn TSS2_RC push_object_to_list(void *object, NODE_OBJECT_T **object_list) 2149\fn NODE_STR_T * split_string(const char *string, char *delimiter) 2150\fn int vasprintf(char **str, const char *fmt, va_list args) 2151\fn static size_t write_curl_buffer_cb(void *contents, size_t size, size_t nmemb, void *userp) 2152 2153 \} 2154*/ 2155 2156 /*! 2157 \defgroup ifapi_utility Utility module 2158 \ingroup ifapi 2159 Provides internal utility functions. 2160 \{ 2161\fn static void full_path_to_fapi_path(IFAPI_KEYSTORE *keystore, char *path) 2162\fn static TSS2_RC get_explicit_key_path( 2163 IFAPI_KEYSTORE *keystore, 2164 const char *ipath, 2165 NODE_STR_T **result) 2166\fn static size_t get_name_alg(FAPI_CONTEXT *context, IFAPI_OBJECT *object) 2167\fn TSS2_RC ifapi_authorize_object(FAPI_CONTEXT *context, IFAPI_OBJECT *object, ESYS_TR *session) 2168\fn TPM2_RC ifapi_capability_get(FAPI_CONTEXT *context, TPM2_CAP capability, 2169 UINT32 count, TPMS_CAPABILITY_DATA **capability_data) 2170\fn TPM2_RC ifapi_capability_init(FAPI_CONTEXT *context) 2171\fn TSS2_RC ifapi_change_auth_hierarchy( 2172 FAPI_CONTEXT *context, 2173 ESYS_TR handle, 2174 IFAPI_OBJECT *hierarchy_object, 2175 TPM2B_AUTH *newAuthValue) 2176\fn TSS2_RC ifapi_change_policy_hierarchy( 2177 FAPI_CONTEXT *context, 2178 ESYS_TR handle, 2179 IFAPI_OBJECT *hierarchy_object, 2180 TPMS_POLICY *policy) 2181\fn TSS2_RC ifapi_cleanup_session(FAPI_CONTEXT *context) 2182\fn TSS2_RC ifapi_esys_serialize_object(ESYS_CONTEXT *ectx, IFAPI_OBJECT *object) 2183\fn TSS2_RC ifapi_flush_object(FAPI_CONTEXT *context, ESYS_TR handle) 2184\fn void ifapi_flush_policy_session(FAPI_CONTEXT *context, ESYS_TR session, TSS2_RC r) 2185\fn void ifapi_free_object(FAPI_CONTEXT *context, IFAPI_OBJECT **object) 2186\fn void ifapi_free_objects(FAPI_CONTEXT *context) 2187\fn TSS2_RC ifapi_get_certificates( 2188 FAPI_CONTEXT *context, 2189 UINT32 min_handle, 2190 UINT32 max_handle, 2191 NODE_OBJECT_T **cert_list) 2192\fn TSS2_RC ifapi_get_description(IFAPI_OBJECT *object, char **description) 2193\fn TSS2_RC ifapi_get_free_handle_async(FAPI_CONTEXT *fctx, TPM2_HANDLE *handle) 2194\fn TSS2_RC ifapi_get_free_handle_finish(FAPI_CONTEXT *fctx, TPM2_HANDLE *handle, 2195 TPM2_HANDLE max) 2196\fn TSS2_RC ifapi_get_json(FAPI_CONTEXT *context, IFAPI_OBJECT *object, char **json_string) 2197\fn TSS2_RC ifapi_get_random(FAPI_CONTEXT *context, size_t numBytes, uint8_t **data) 2198\fn TSS2_RC ifapi_get_session_async(ESYS_CONTEXT *esys, ESYS_TR saltkey, const IFAPI_PROFILE *profile, 2199 TPMI_ALG_HASH hashAlg) 2200\fn TSS2_RC ifapi_get_session_finish(ESYS_CONTEXT *esys, ESYS_TR *session, 2201 TPMA_SESSION flags) 2202\fn TSS2_RC ifapi_get_sessions_async(FAPI_CONTEXT *context, 2203 IFAPI_SESSION_TYPE session_flags, 2204 TPMA_SESSION attribute_flags1, 2205 TPMA_SESSION attribute_flags2) 2206\fn TSS2_RC ifapi_get_sessions_finish( 2207 FAPI_CONTEXT *context, 2208 const IFAPI_PROFILE *profile, 2209 TPMI_ALG_HASH hash_alg) 2210\fn TSS2_RC ifapi_get_sig_scheme( 2211 FAPI_CONTEXT *context, 2212 IFAPI_OBJECT *object, 2213 char const *padding, 2214 TPM2B_DIGEST *digest, 2215 TPMT_SIG_SCHEME *sig_scheme) 2216\fn TSS2_RC ifapi_init_primary_async(FAPI_CONTEXT *context, TSS2_KEY_TYPE ktype) 2217\fn TSS2_RC ifapi_init_primary_finish(FAPI_CONTEXT *context, TSS2_KEY_TYPE ktype) 2218\fn TSS2_RC ifapi_initialize_object( 2219 ESYS_CONTEXT *ectx, 2220 IFAPI_OBJECT *object) 2221\fn TSS2_RC ifapi_key_create( 2222 FAPI_CONTEXT *context, 2223 IFAPI_KEY_TEMPLATE *template) 2224\fn TSS2_RC ifapi_key_create_prepare( 2225 FAPI_CONTEXT *context, 2226 char const *keyPath, 2227 char const *policyPath) 2228\fn TSS2_RC ifapi_key_create_prepare_auth( 2229 FAPI_CONTEXT *context, 2230 char const *keyPath, 2231 char const *policyPath, 2232 char const *authValue) 2233\fn TSS2_RC ifapi_key_create_prepare_sensitive( 2234 FAPI_CONTEXT *context, 2235 char const *keyPath, 2236 char const *policyPath, 2237 size_t dataSize, 2238 char const *authValue, 2239 uint8_t const *data) 2240\fn TSS2_RC ifapi_key_sign( 2241 FAPI_CONTEXT *context, 2242 IFAPI_OBJECT *sig_key_object, 2243 char const *padding, 2244 TPM2B_DIGEST *digest, 2245 TPMT_SIGNATURE **tpm_signature, 2246 char **publicKey, 2247 char **certificate) 2248\fn TSS2_RC ifapi_load_key( 2249 FAPI_CONTEXT *context, 2250 char const *keyPath, 2251 IFAPI_OBJECT **key_object) 2252\fn TSS2_RC ifapi_load_key_async(FAPI_CONTEXT *context, size_t position) 2253\fn TSS2_RC ifapi_load_key_finish(FAPI_CONTEXT *context, bool flush_parent) 2254\fn TSS2_RC ifapi_load_keys_async(FAPI_CONTEXT *context, char const *keyPath) 2255\fn TSS2_RC ifapi_load_keys_finish( 2256 FAPI_CONTEXT *context, 2257 bool flush_parent, 2258 ESYS_TR *handle, 2259 IFAPI_OBJECT **key_object) 2260\fn TSS2_RC ifapi_load_primary_async(FAPI_CONTEXT *context, char *path) 2261\fn TSS2_RC ifapi_load_primary_finish(FAPI_CONTEXT *context, ESYS_TR *handle) 2262\fn TSS2_RC ifapi_merge_profile_into_nv_template( 2263 FAPI_CONTEXT *context, 2264 IFAPI_NV_TEMPLATE *template) 2265\fn TSS2_RC ifapi_merge_profile_into_template( 2266 const IFAPI_PROFILE *profile, 2267 IFAPI_KEY_TEMPLATE *template) 2268\fn TSS2_RC ifapi_non_tpm_mode_init(FAPI_CONTEXT *context) 2269\fn TSS2_RC ifapi_nv_read( 2270 FAPI_CONTEXT *context, 2271 uint8_t **data, 2272 size_t *size) 2273\fn TSS2_RC ifapi_nv_write( 2274 FAPI_CONTEXT *context, 2275 char *nvPath, 2276 size_t param_offset, 2277 uint8_t const *data, 2278 size_t size) 2279\fn void ifapi_primary_clean(FAPI_CONTEXT *context) 2280\fn void ifapi_session_clean(FAPI_CONTEXT *context) 2281\fn TSS2_RC ifapi_session_init(FAPI_CONTEXT *context) 2282\fn TSS2_RC ifapi_set_auth( 2283 FAPI_CONTEXT *context, 2284 IFAPI_OBJECT *auth_object, 2285 const char *description) 2286\fn void ifapi_set_description(IFAPI_OBJECT *object, char *description) 2287\fn static TSS2_RC init_explicit_key_path( 2288 const char *context_profile, 2289 const char *ipath, 2290 NODE_STR_T **list_node1, 2291 NODE_STR_T **current_list_node, 2292 NODE_STR_T **result) 2293\fn static size_t policy_digest_size(IFAPI_OBJECT *object) 2294\fn static TSS2_RC pop_object_from_list(FAPI_CONTEXT *context, NODE_OBJECT_T **object_list) 2295\fn static TSS2_RC push_object_with_size_to_list(void *object, size_t size, NODE_OBJECT_T **object_list) 2296 2297 \} 2298*/ 2299 2300/*! 2301 \defgroup ifapi_io Basic IO module 2302 \ingroup ifapi 2303 Provides internal basic IO functions for policy and key store module. 2304 \{ 2305\fn static TSS2_RC dirfiles_all(const char *dir_name, NODE_OBJECT_T **list, size_t *n) 2306\fn TSS2_RC ifapi_io_check_create_dir( 2307 const char *dirname) 2308\fn TSS2_RC ifapi_io_check_file_writeable( 2309 const char *file) 2310\fn TSS2_RC ifapi_io_dirfiles( 2311 const char *dirname, 2312 char ***files, 2313 size_t *numfiles) 2314\fn TSS2_RC ifapi_io_dirfiles_all( 2315 const char *searchPath, 2316 char ***pathlist, 2317 size_t *numPaths) 2318\fn bool ifapi_io_path_exists(const char *path) 2319\fn TSS2_RC ifapi_io_poll(IFAPI_IO * io) 2320\fn TSS2_RC ifapi_io_poll_handles(IFAPI_IO *io, FAPI_POLL_HANDLE **handles, size_t *num_handles) 2321\fn TSS2_RC ifapi_io_read_async( 2322 struct IFAPI_IO *io, 2323 const char *filename) 2324\fn TSS2_RC ifapi_io_read_finish( 2325 struct IFAPI_IO *io, 2326 uint8_t **buffer, 2327 size_t *length) 2328\fn TSS2_RC ifapi_io_remove_directories( 2329 const char *dirname) 2330\fn TSS2_RC ifapi_io_remove_file(const char *file) 2331\fn TSS2_RC ifapi_io_write_async( 2332 struct IFAPI_IO *io, 2333 const char *filename, 2334 const uint8_t *buffer, 2335 size_t length) 2336\fn TSS2_RC ifapi_io_write_finish( 2337 struct IFAPI_IO *io) 2338 2339 \} 2340*/ 2341 2342/*! 2343 \defgroup ifapi_keystore Key store module 2344 \ingroup ifapi 2345 Provides internal fapi functions for reading and writing to the key store. 2346 \{ 2347\fn static TSS2_RC copy_uint8_ary(UINT8_ARY *dest, const UINT8_ARY * src) 2348\fn static TSS2_RC expand_directory(IFAPI_KEYSTORE *keystore, const char *path, char **directory_name) 2349\fn static TSS2_RC expand_path(IFAPI_KEYSTORE *keystore, const char *path, char **file_name) 2350\fn static TSS2_RC expand_path_to_object( 2351 IFAPI_KEYSTORE *keystore, 2352 const char *path, 2353 const char *dir, 2354 char **file_name) 2355\fn void full_path_to_fapi_path(IFAPI_KEYSTORE *keystore, char *path) 2356\fn static TSS2_RC get_explicit_key_path( 2357 IFAPI_KEYSTORE *keystore, 2358 const char *ipath, 2359 NODE_STR_T **result) 2360\fn void ifapi_cleanup_ifapi_duplicate(IFAPI_DUPLICATE * duplicate) 2361\fn void ifapi_cleanup_ifapi_ext_pub_key(IFAPI_EXT_PUB_KEY * key) 2362\fn void ifapi_cleanup_ifapi_hierarchy(IFAPI_HIERARCHY * hierarchy) 2363\fn void ifapi_cleanup_ifapi_key(IFAPI_KEY * key) 2364\fn void ifapi_cleanup_ifapi_keystore(IFAPI_KEYSTORE * keystore) 2365\fn void ifapi_cleanup_ifapi_nv(IFAPI_NV * nv) 2366\fn void ifapi_cleanup_ifapi_object( 2367 IFAPI_OBJECT * object) 2368\fn TSS2_RC ifapi_copy_ifapi_key(IFAPI_KEY * dest, const IFAPI_KEY * src) 2369\fn TSS2_RC ifapi_copy_ifapi_key_object(IFAPI_OBJECT * dest, const IFAPI_OBJECT * src) 2370\fn TSS2_RC ifapi_keystore_check_overwrite( 2371 IFAPI_KEYSTORE *keystore, 2372 IFAPI_IO *io, 2373 const char *path) 2374\fn TSS2_RC ifapi_keystore_check_writeable( 2375 IFAPI_KEYSTORE *keystore, 2376 IFAPI_IO *io, 2377 const char *path) 2378\fn TSS2_RC ifapi_keystore_delete( 2379 IFAPI_KEYSTORE * keystore, 2380 char *path) 2381\fn TSS2_RC ifapi_keystore_initialize( 2382 IFAPI_KEYSTORE *keystore, 2383 const char *config_systemdir, 2384 const char *config_userdir, 2385 const char *config_defaultprofile) 2386\fn TSS2_RC ifapi_keystore_list_all( 2387 IFAPI_KEYSTORE *keystore, 2388 const char *searchpath, 2389 char ***results, 2390 size_t *numresults) 2391\fn TSS2_RC ifapi_keystore_load_async( 2392 IFAPI_KEYSTORE *keystore, 2393 IFAPI_IO *io, 2394 const char *path) 2395\fn TSS2_RC ifapi_keystore_load_finish( 2396 IFAPI_KEYSTORE *keystore, 2397 IFAPI_IO *io, 2398 IFAPI_OBJECT *object) 2399\fn TSS2_RC ifapi_keystore_remove_directories(IFAPI_KEYSTORE *keystore, const char *dir_name) 2400\fn TSS2_RC ifapi_keystore_search_nv_obj( 2401 IFAPI_KEYSTORE *keystore, 2402 IFAPI_IO *io, 2403 TPM2B_NV_PUBLIC *nv_public, 2404 char **found_path) 2405\fn TSS2_RC ifapi_keystore_search_obj( 2406 IFAPI_KEYSTORE *keystore, 2407 IFAPI_IO *io, 2408 TPM2B_NAME *name, 2409 char **found_path) 2410\fn TSS2_RC ifapi_keystore_store_async( 2411 IFAPI_KEYSTORE *keystore, 2412 IFAPI_IO *io, 2413 const char *path, 2414 const IFAPI_OBJECT *object) 2415\fn TSS2_RC ifapi_keystore_store_finish( 2416 IFAPI_KEYSTORE *keystore, 2417 IFAPI_IO *io) 2418\fn static TSS2_RC initialize_explicit_key_path( 2419 const char *context_profile, 2420 const char *ipath, 2421 NODE_STR_T **list_node1, 2422 NODE_STR_T **current_list_node, 2423 NODE_STR_T **result) 2424\fn static TSS2_RC keystore_list_all_abs( 2425 IFAPI_KEYSTORE *keystore, 2426 const char *searchpath, 2427 char ***results, 2428 size_t *numresults) 2429\fn static TSS2_RC keystore_search_obj( 2430 IFAPI_KEYSTORE *keystore, 2431 IFAPI_IO *io, 2432 void *cmp_object, 2433 ifapi_keystore_object_cmp cmp_function, 2434 char **found_path) 2435\fn static TSS2_RC rel_path_to_abs_path( 2436 IFAPI_KEYSTORE *keystore, 2437 const char *rel_path, 2438 char **abs_path) 2439 2440 \} 2441*/ 2442 2443/*! 2444 \defgroup ifapi_policy_store Policy store module 2445 \ingroup ifapi 2446 Provides internal fapi functions for reading and writing to the policy store. 2447 \{ 2448\fn TSS2_RC ifapi_policy_delete( 2449 IFAPI_POLICY_STORE * pstore, 2450 char *path) 2451\fn TSS2_RC ifapi_policy_store_initialize( 2452 IFAPI_POLICY_STORE *pstore, 2453 const char *config_policydir) 2454\fn TSS2_RC ifapi_policy_store_load_async( 2455 IFAPI_POLICY_STORE *pstore, 2456 IFAPI_IO *io, 2457 const char *path) 2458\fn TSS2_RC ifapi_policy_store_load_finish( 2459 IFAPI_POLICY_STORE *pstore, 2460 IFAPI_IO *io, 2461 TPMS_POLICY *policy) 2462\fn TSS2_RC ifapi_policy_store_store_async( 2463 IFAPI_POLICY_STORE *pstore, 2464 IFAPI_IO *io, 2465 const char *path, 2466 const TPMS_POLICY *policy) 2467\fn TSS2_RC ifapi_policy_store_store_finish( 2468 IFAPI_POLICY_STORE *pstore, 2469 IFAPI_IO *io) 2470\fn static TSS2_RC policy_rel_path_to_abs_path( 2471 IFAPI_POLICY_STORE *pstore, 2472 const char *rel_path, 2473 char **abs_path) 2474 2475 \} 2476*/ 2477 2478/*! 2479 \defgroup ifapi_configuration Configuration utilities. 2480 \ingroup ifapi 2481 Provides internal fapi functions for deserialization of the configuration data and 2482 the initialization of the configuration. 2483 \{ 2484 2485\fn static TSS2_RC ifapi_json_IFAPI_CONFIG_deserialize(json_object *jso, IFAPI_CONFIG *out) 2486\fn TSS2_RC ifapi_config_initialize_async(IFAPI_IO *io) 2487\fn TSS2_RC ifapi_config_initialize_finish(IFAPI_IO *io, IFAPI_CONFIG *config) 2488\fn static TSS2_RC ifapi_json_IFAPI_CONFIG_deserialize(json_object *jso, IFAPI_CONFIG *out) 2489 2490 \} 2491*/ 2492 2493/*! 2494 \defgroup ifapi_eventlog Event log utilities. 2495 \ingroup ifapi 2496 Provides internal fapi functions for the handling of event logs 2497\{ 2498\fn void ifapi_cleanup_event(IFAPI_EVENT * event) 2499\fn TSS2_RC ifapi_eventlog_append_async( 2500 IFAPI_EVENTLOG *eventlog, 2501 IFAPI_IO *io, 2502 const IFAPI_EVENT *event) 2503\fn TSS2_RC ifapi_eventlog_append_finish( 2504 IFAPI_EVENTLOG *eventlog, 2505 IFAPI_IO *io) 2506\fn TSS2_RC ifapi_eventlog_get_async( 2507 IFAPI_EVENTLOG *eventlog, 2508 IFAPI_IO *io, 2509 const TPM2_HANDLE *pcrList, 2510 size_t pcrListSize) 2511\fn TSS2_RC ifapi_eventlog_get_finish( 2512 IFAPI_EVENTLOG *eventlog, 2513 IFAPI_IO *io, 2514 char **log) 2515\fn TSS2_RC ifapi_eventlog_initialize( 2516 IFAPI_EVENTLOG *eventlog, 2517 const char *log_dir) 2518 \} 2519*/ 2520 2521/*! 2522 \defgroup ifapi_profile Profile module 2523 \ingroup ifapi 2524 Provides functions for the handling of profiles stored in the object store. 2525\{ 2526 2527\fn static TSS2_RC ifapi_profile_checkpcrs(const TPML_PCR_SELECTION *pcr_profile) 2528\fn static TSS2_RC ifapi_profile_json_deserialize( 2529 json_object *jso, 2530 IFAPI_PROFILE *out) 2531\fn void ifapi_profiles_finalize( 2532 IFAPI_PROFILES *profiles) 2533\fn TSS2_RC ifapi_profiles_get( 2534 const IFAPI_PROFILES *profiles, 2535 const char *name, 2536 const IFAPI_PROFILE **profile) 2537\fn TSS2_RC ifapi_profiles_initialize_async( 2538 IFAPI_PROFILES *profiles, 2539 IFAPI_IO *io, 2540 const char *profilesdir, 2541 const char *defaultprofile) 2542\fn TSS2_RC ifapi_profiles_initialize_finish( 2543 IFAPI_PROFILES *profiles, 2544 IFAPI_IO *io) 2545 2546\} 2547*/ 2548 2549/*! 2550 \defgroup ifapi_serialization FAPI object serialization module 2551 \ingroup ifapi 2552 Provides functions for the serialization of FAPI objects to JSON. 2553 \{ 2554\fn TSS2_RC ifapi_json_FAPI_QUOTE_INFO_serialize(const FAPI_QUOTE_INFO *in, 2555 json_object **jso) 2556\fn TSS2_RC ifapi_json_IFAPI_CAP_INFO_serialize(const IFAPI_CAP_INFO *in, json_object **jso) 2557\fn TSS2_RC ifapi_json_IFAPI_DUPLICATE_serialize(const IFAPI_DUPLICATE *in, 2558 json_object **jso) 2559\fn TSS2_RC ifapi_json_IFAPI_EVENT_TYPE_serialize(const IFAPI_EVENT_TYPE in, 2560 json_object **jso) 2561\fn TSS2_RC ifapi_json_IFAPI_EVENT_TYPE_serialize_txt( 2562 const IFAPI_EVENT_TYPE in, 2563 json_object **str_jso) 2564\fn TSS2_RC ifapi_json_IFAPI_EVENT_UNION_serialize(const IFAPI_EVENT_UNION *in, 2565 UINT32 selector, json_object **jso) 2566\fn TSS2_RC ifapi_json_IFAPI_EVENT_serialize(const IFAPI_EVENT *in, json_object **jso) 2567\fn TSS2_RC ifapi_json_IFAPI_EXT_PUB_KEY_serialize(const IFAPI_EXT_PUB_KEY *in, 2568 json_object **jso) 2569\fn TSS2_RC ifapi_json_IFAPI_HIERARCHY_serialize(const IFAPI_HIERARCHY *in, json_object **jso) 2570\fn TSS2_RC ifapi_json_IFAPI_IMA_EVENT_serialize(const IFAPI_IMA_EVENT *in, 2571 json_object **jso) 2572\fn TSS2_RC ifapi_json_IFAPI_INFO_serialize(const IFAPI_INFO *in, json_object **jso) 2573\fn TSS2_RC ifapi_json_IFAPI_KEY_serialize(const IFAPI_KEY *in, json_object **jso) 2574\fn TSS2_RC ifapi_json_IFAPI_NV_serialize(const IFAPI_NV *in, json_object **jso) 2575\fn TSS2_RC ifapi_json_IFAPI_OBJECT_TYPE_CONSTANT_serialize(const IFAPI_OBJECT_TYPE_CONSTANT 2576 in, json_object **jso) 2577\fn TSS2_RC ifapi_json_IFAPI_OBJECT_serialize(const IFAPI_OBJECT *in, 2578 json_object **jso) 2579\fn TSS2_RC ifapi_json_IFAPI_TSS_EVENT_serialize(const IFAPI_TSS_EVENT *in, 2580 json_object **jso) 2581\fn TSS2_RC ifapi_json_UINT8_ARY_serialize(const UINT8_ARY *in, json_object **jso) 2582\fn TSS2_RC ifapi_json_char_serialize( 2583 const char *in, 2584 json_object **jso) 2585\fn TSS2_RC ifapi_json_INT32_serialize(const INT32 in, json_object **jso) 2586\fn TSS2_RC ifapi_json_TPM2B_CREATION_DATA_serialize(const TPM2B_CREATION_DATA *in, json_object **jso) 2587\fn TSS2_RC ifapi_json_TPM2B_DATA_serialize(const TPM2B_DATA *in, json_object **jso) 2588\fn TSS2_RC ifapi_json_TPM2B_DIGEST_serialize(const TPM2B_DIGEST *in, json_object **jso) 2589\fn TSS2_RC ifapi_json_TPM2B_ECC_PARAMETER_serialize(const TPM2B_ECC_PARAMETER *in, json_object **jso) 2590\fn TSS2_RC ifapi_json_TPM2B_ENCRYPTED_SECRET_serialize(const TPM2B_ENCRYPTED_SECRET *in, json_object **jso) 2591\fn TSS2_RC ifapi_json_TPM2B_EVENT_serialize(const TPM2B_EVENT *in, json_object **jso) 2592\fn TSS2_RC ifapi_json_TPM2B_MAX_NV_BUFFER_serialize(const TPM2B_MAX_NV_BUFFER *in, json_object **jso) 2593\fn TSS2_RC ifapi_json_TPM2B_NAME_serialize(const TPM2B_NAME *in, json_object **jso) 2594\fn TSS2_RC ifapi_json_TPM2B_NONCE_serialize(const TPM2B_NONCE *in, json_object **jso) 2595\fn TSS2_RC ifapi_json_TPM2B_NV_PUBLIC_serialize(const TPM2B_NV_PUBLIC *in, json_object **jso) 2596\fn TSS2_RC ifapi_json_TPM2B_OPERAND_serialize(const TPM2B_OPERAND *in, json_object **jso) 2597\fn TSS2_RC ifapi_json_TPM2B_PRIVATE_serialize(const TPM2B_PRIVATE *in, json_object **jso) 2598\fn TSS2_RC ifapi_json_TPM2B_PUBLIC_KEY_RSA_serialize(const TPM2B_PUBLIC_KEY_RSA *in, json_object **jso) 2599\fn TSS2_RC ifapi_json_TPM2B_PUBLIC_serialize(const TPM2B_PUBLIC *in, json_object **jso) 2600\fn TSS2_RC ifapi_json_TPM2_ALG_ID_serialize(const TPM2_ALG_ID in, json_object **jso) 2601\fn TSS2_RC ifapi_json_TPM2_CAP_serialize(const TPM2_CAP in, json_object **jso) 2602\fn TSS2_RC ifapi_json_TPM2_CC_serialize(const TPM2_CC in, json_object **jso) 2603\fn TSS2_RC ifapi_json_TPM2_ECC_CURVE_serialize(const TPM2_ECC_CURVE in, json_object **jso) 2604\fn TSS2_RC ifapi_json_TPM2_EO_serialize(const TPM2_EO in, json_object **jso) 2605\fn TSS2_RC ifapi_json_TPM2_GENERATED_serialize(const TPM2_GENERATED in, json_object **jso) 2606\fn TSS2_RC ifapi_json_TPM2_HANDLE_serialize(const TPM2_HANDLE in, json_object **jso) 2607\fn TSS2_RC ifapi_json_TPM2_NT_serialize(const TPM2_NT in, json_object **jso) 2608\fn TSS2_RC ifapi_json_TPM2_PT_PCR_serialize(const TPM2_PT_PCR in, json_object **jso) 2609\fn TSS2_RC ifapi_json_TPM2_PT_serialize(const TPM2_PT in, json_object **jso) 2610\fn TSS2_RC ifapi_json_TPM2_ST_serialize(const TPM2_ST in, json_object **jso) 2611\fn TSS2_RC ifapi_json_TPMA_ALGORITHM_serialize(const TPMA_ALGORITHM in, json_object **jso) 2612\fn TSS2_RC ifapi_json_TPMA_CC_serialize(const TPMA_CC in, json_object **jso) 2613\fn TSS2_RC ifapi_json_TPMA_LOCALITY_serialize(const TPMA_LOCALITY in, json_object **jso) 2614\fn TSS2_RC ifapi_json_TPMA_NV_serialize(const TPMA_NV in, json_object **jso) 2615\fn TSS2_RC ifapi_json_TPMA_OBJECT_serialize(const TPMA_OBJECT in, json_object **jso) 2616\fn TSS2_RC ifapi_json_TPMI_AES_KEY_BITS_serialize(const TPMI_AES_KEY_BITS in, json_object **jso) 2617\fn TSS2_RC ifapi_json_TPMI_ALG_ASYM_SCHEME_serialize(const TPMI_ALG_ASYM_SCHEME in, json_object **jso) 2618\fn TSS2_RC ifapi_json_TPMI_ALG_ECC_SCHEME_serialize(const TPMI_ALG_ECC_SCHEME in, json_object **jso) 2619\fn TSS2_RC ifapi_json_TPMI_ALG_HASH_serialize(const TPMI_ALG_HASH in, json_object **jso) 2620\fn TSS2_RC ifapi_json_TPMI_ALG_KDF_serialize(const TPMI_ALG_KDF in, json_object **jso) 2621\fn TSS2_RC ifapi_json_TPMI_ALG_KEYEDHASH_SCHEME_serialize(const TPMI_ALG_KEYEDHASH_SCHEME in, json_object **jso) 2622\fn TSS2_RC ifapi_json_TPMI_ALG_PUBLIC_serialize(const TPMI_ALG_PUBLIC in, json_object **jso) 2623\fn TSS2_RC ifapi_json_TPMI_ALG_RSA_SCHEME_serialize(const TPMI_ALG_RSA_SCHEME in, json_object **jso) 2624\fn TSS2_RC ifapi_json_TPMI_ALG_SIG_SCHEME_serialize(const TPMI_ALG_SIG_SCHEME in, 2625 json_object **jso) 2626\fn TSS2_RC ifapi_json_TPMI_ALG_SYM_MODE_serialize(const TPMI_ALG_SYM_MODE in, 2627 json_object **jso) 2628\fn TSS2_RC ifapi_json_TPMI_ALG_SYM_OBJECT_serialize(const TPMI_ALG_SYM_OBJECT in, 2629 json_object **jso) 2630\fn TSS2_RC ifapi_json_TPMI_ECC_CURVE_serialize(const TPMI_ECC_CURVE in, json_object **jso) 2631\fn TSS2_RC ifapi_json_TPMI_RH_HIERARCHY_serialize(const TPMI_RH_HIERARCHY in, 2632 json_object **jso) 2633\fn TSS2_RC ifapi_json_TPMI_RH_NV_INDEX_serialize(const TPMI_RH_NV_INDEX in, 2634 json_object **jso) 2635\fn TSS2_RC ifapi_json_TPMI_RSA_KEY_BITS_serialize(const TPMI_RSA_KEY_BITS in, json_object **jso) 2636\fn TSS2_RC ifapi_json_TPMI_ST_ATTEST_serialize(const TPMI_ST_ATTEST in, json_object **jso) 2637\fn TSS2_RC ifapi_json_TPMI_YES_NO_serialize(const TPMI_YES_NO in, json_object **jso) 2638\fn TSS2_RC ifapi_json_TPML_ALG_PROPERTY_serialize(const TPML_ALG_PROPERTY *in, json_object **jso) 2639\fn TSS2_RC ifapi_json_TPML_CCA_serialize(const TPML_CCA *in, json_object **jso) 2640\fn TSS2_RC ifapi_json_TPML_CC_serialize(const TPML_CC *in, json_object **jso) 2641\fn TSS2_RC ifapi_json_TPML_DIGEST_VALUES_serialize(const TPML_DIGEST_VALUES *in, json_object **jso) 2642\fn TSS2_RC ifapi_json_TPML_ECC_CURVE_serialize(const TPML_ECC_CURVE *in, json_object **jso) 2643\fn TSS2_RC ifapi_json_TPML_HANDLE_serialize(const TPML_HANDLE *in, json_object **jso) 2644\fn TSS2_RC ifapi_json_TPML_PCR_SELECTION_serialize(const TPML_PCR_SELECTION *in, json_object **jso) 2645\fn TSS2_RC ifapi_json_TPML_TAGGED_PCR_PROPERTY_serialize(const TPML_TAGGED_PCR_PROPERTY *in, json_object **jso) 2646\fn TSS2_RC ifapi_json_TPML_TAGGED_TPM_PROPERTY_serialize(const TPML_TAGGED_TPM_PROPERTY *in, json_object **jso) 2647\fn TSS2_RC ifapi_json_TPMS_ALG_PROPERTY_serialize(const TPMS_ALG_PROPERTY *in, json_object **jso) 2648\fn TSS2_RC ifapi_json_TPMS_ASYM_PARMS_serialize(const TPMS_ASYM_PARMS *in, json_object **jso) 2649\fn TSS2_RC ifapi_json_TPMS_ATTEST_serialize(const TPMS_ATTEST *in, json_object **jso) 2650\fn TSS2_RC ifapi_json_TPMS_CAPABILITY_DATA_serialize(const TPMS_CAPABILITY_DATA *in, json_object **jso) 2651\fn TSS2_RC ifapi_json_TPMS_CERTIFY_INFO_serialize(const TPMS_CERTIFY_INFO *in, json_object **jso) 2652\fn TSS2_RC ifapi_json_TPMS_CLOCK_INFO_serialize(const TPMS_CLOCK_INFO *in, json_object **jso) 2653\fn TSS2_RC ifapi_json_TPMS_COMMAND_AUDIT_INFO_serialize(const TPMS_COMMAND_AUDIT_INFO *in, json_object **jso) 2654\fn TSS2_RC ifapi_json_TPMS_CREATION_DATA_serialize(const TPMS_CREATION_DATA *in, json_object **jso) 2655\fn TSS2_RC ifapi_json_TPMS_CREATION_INFO_serialize(const TPMS_CREATION_INFO *in, json_object **jso) 2656\fn TSS2_RC ifapi_json_TPMS_ECC_PARMS_serialize(const TPMS_ECC_PARMS *in, json_object **jso) 2657\fn TSS2_RC ifapi_json_TPMS_ECC_POINT_serialize(const TPMS_ECC_POINT *in, json_object **jso) 2658\fn TSS2_RC ifapi_json_TPMS_EMPTY_serialize(const TPMS_EMPTY *in, json_object **jso) 2659\fn TSS2_RC ifapi_json_TPMS_ENC_SCHEME_OAEP_serialize(const TPMS_ENC_SCHEME_OAEP *in, json_object **jso) 2660\fn TSS2_RC ifapi_json_TPMS_ENC_SCHEME_RSAES_serialize(const TPMS_ENC_SCHEME_RSAES *in, json_object **jso) 2661\fn TSS2_RC ifapi_json_TPMS_KEYEDHASH_PARMS_serialize(const TPMS_KEYEDHASH_PARMS *in, json_object **jso) 2662\fn TSS2_RC ifapi_json_TPMS_KEY_SCHEME_ECDH_serialize(const TPMS_KEY_SCHEME_ECDH *in, json_object **jso) 2663\fn TSS2_RC ifapi_json_TPMS_NV_CERTIFY_INFO_serialize(const TPMS_NV_CERTIFY_INFO *in, json_object **jso) 2664\fn TSS2_RC ifapi_json_TPMS_NV_PUBLIC_serialize(const TPMS_NV_PUBLIC *in, json_object **jso) 2665\fn TSS2_RC ifapi_json_TPMS_PCR_SELECTION_serialize(const TPMS_PCR_SELECTION *in, 2666 json_object **jso) 2667\fn TSS2_RC ifapi_json_TPMS_PCR_SELECT_serialize(const TPMS_PCR_SELECT *in, 2668 json_object **jso) 2669\fn TSS2_RC ifapi_json_TPMS_QUOTE_INFO_serialize(const TPMS_QUOTE_INFO *in, json_object **jso) 2670\fn TSS2_RC ifapi_json_TPMS_RSA_PARMS_serialize(const TPMS_RSA_PARMS *in, json_object **jso) 2671\fn TSS2_RC ifapi_json_TPMS_SCHEME_ECDAA_serialize(const TPMS_SCHEME_ECDAA *in, json_object **jso) 2672\fn TSS2_RC ifapi_json_TPMS_SCHEME_HASH_serialize(const TPMS_SCHEME_HASH *in, json_object **jso) 2673\fn TSS2_RC ifapi_json_TPMS_SCHEME_HMAC_serialize(const TPMS_SCHEME_HMAC *in, json_object **jso) 2674\fn TSS2_RC ifapi_json_TPMS_SCHEME_KDF1_SP800_108_serialize(const TPMS_SCHEME_KDF1_SP800_108 *in, json_object **jso) 2675\fn TSS2_RC ifapi_json_TPMS_SCHEME_KDF1_SP800_56A_serialize(const TPMS_SCHEME_KDF1_SP800_56A *in, json_object **jso) 2676\fn TSS2_RC ifapi_json_TPMS_SCHEME_MGF1_serialize(const TPMS_SCHEME_MGF1 *in, json_object **jso) 2677\fn TSS2_RC ifapi_json_TPMS_SCHEME_XOR_serialize(const TPMS_SCHEME_XOR *in, json_object **jso) 2678\fn TSS2_RC ifapi_json_TPMS_SESSION_AUDIT_INFO_serialize(const TPMS_SESSION_AUDIT_INFO *in, json_object **jso) 2679\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_ECC_serialize(const TPMS_SIGNATURE_ECC *in, json_object **jso) 2680\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_ECDAA_serialize(const TPMS_SIGNATURE_ECDAA *in, json_object **jso) 2681\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_ECDSA_serialize(const TPMS_SIGNATURE_ECDSA *in, json_object **jso) 2682\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_ECSCHNORR_serialize(const TPMS_SIGNATURE_ECSCHNORR *in, json_object **jso) 2683\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_RSAPSS_serialize(const TPMS_SIGNATURE_RSAPSS *in, json_object **jso) 2684\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_RSASSA_serialize(const TPMS_SIGNATURE_RSASSA *in, json_object **jso) 2685\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_RSA_serialize(const TPMS_SIGNATURE_RSA *in, json_object **jso) 2686\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_SM2_serialize(const TPMS_SIGNATURE_SM2 *in, json_object **jso) 2687\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_ECDAA_serialize(const TPMS_SIG_SCHEME_ECDAA *in, json_object **jso) 2688\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_ECDSA_serialize(const TPMS_SIG_SCHEME_ECDSA *in, json_object **jso) 2689\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_ECSCHNORR_serialize(const TPMS_SIG_SCHEME_ECSCHNORR *in, json_object **jso) 2690\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_RSAPSS_serialize(const TPMS_SIG_SCHEME_RSAPSS *in, json_object **jso) 2691\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_RSASSA_serialize(const TPMS_SIG_SCHEME_RSASSA *in, json_object **jso) 2692\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_SM2_serialize(const TPMS_SIG_SCHEME_SM2 *in, json_object **jso) 2693\fn TSS2_RC ifapi_json_TPMS_SYMCIPHER_PARMS_serialize(const TPMS_SYMCIPHER_PARMS *in, json_object **jso) 2694\fn TSS2_RC ifapi_json_TPMS_TAGGED_PCR_SELECT_serialize(const TPMS_TAGGED_PCR_SELECT *in, 2695 json_object **jso) 2696\fn TSS2_RC ifapi_json_TPMS_TAGGED_PROPERTY_serialize(const TPMS_TAGGED_PROPERTY *in, json_object **jso) 2697\fn TSS2_RC ifapi_json_TPMS_TIME_ATTEST_INFO_serialize(const TPMS_TIME_ATTEST_INFO *in, json_object **jso) 2698\fn TSS2_RC ifapi_json_TPMS_TIME_INFO_serialize(const TPMS_TIME_INFO *in, json_object **jso) 2699\fn TSS2_RC ifapi_json_TPMT_ASYM_SCHEME_serialize(const TPMT_ASYM_SCHEME *in, json_object **jso) 2700\fn TSS2_RC ifapi_json_TPMT_ECC_SCHEME_serialize(const TPMT_ECC_SCHEME *in, json_object **jso) 2701\fn TSS2_RC ifapi_json_TPMT_HA_serialize(const TPMT_HA *in, json_object **jso) 2702\fn TSS2_RC ifapi_json_TPMT_KDF_SCHEME_serialize(const TPMT_KDF_SCHEME *in, json_object **jso) 2703\fn TSS2_RC ifapi_json_TPMT_KEYEDHASH_SCHEME_serialize(const TPMT_KEYEDHASH_SCHEME *in, json_object **jso) 2704\fn TSS2_RC ifapi_json_TPMT_PUBLIC_serialize(const TPMT_PUBLIC *in, json_object **jso) 2705\fn TSS2_RC ifapi_json_TPMT_RSA_SCHEME_serialize(const TPMT_RSA_SCHEME *in, json_object **jso) 2706\fn TSS2_RC ifapi_json_TPMT_SIGNATURE_serialize(const TPMT_SIGNATURE *in, json_object **jso) 2707\fn TSS2_RC ifapi_json_TPMT_SIG_SCHEME_serialize(const TPMT_SIG_SCHEME *in, json_object **jso) 2708\fn TSS2_RC ifapi_json_TPMT_SYM_DEF_OBJECT_serialize(const TPMT_SYM_DEF_OBJECT *in, json_object **jso) 2709\fn TSS2_RC ifapi_json_TPMT_TK_CREATION_serialize(const TPMT_TK_CREATION *in, json_object **jso) 2710\fn TSS2_RC ifapi_json_TPMU_ASYM_SCHEME_serialize(const TPMU_ASYM_SCHEME *in, UINT32 selector, json_object **jso) 2711\fn TSS2_RC ifapi_json_TPMU_ATTEST_serialize(const TPMU_ATTEST *in, UINT32 selector, json_object **jso) 2712\fn TSS2_RC ifapi_json_TPMU_CAPABILITIES_serialize(const TPMU_CAPABILITIES *in, UINT32 selector, json_object **jso) 2713\fn TSS2_RC ifapi_json_TPMU_HA_serialize(const TPMU_HA *in, UINT32 selector, 2714 json_object **jso) 2715\fn TSS2_RC ifapi_json_TPMU_KDF_SCHEME_serialize(const TPMU_KDF_SCHEME *in, UINT32 selector, json_object **jso) 2716\fn TSS2_RC ifapi_json_TPMU_PUBLIC_ID_serialize(const TPMU_PUBLIC_ID *in, UINT32 selector, json_object **jso) 2717\fn TSS2_RC ifapi_json_TPMU_PUBLIC_PARMS_serialize(const TPMU_PUBLIC_PARMS *in, UINT32 selector, json_object **jso) 2718\fn TSS2_RC ifapi_json_TPMU_SCHEME_KEYEDHASH_serialize(const TPMU_SCHEME_KEYEDHASH *in, UINT32 selector, json_object **jso) 2719\fn TSS2_RC ifapi_json_TPMU_SIGNATURE_serialize(const TPMU_SIGNATURE *in, UINT32 selector, json_object **jso) 2720\fn TSS2_RC ifapi_json_TPMU_SIG_SCHEME_serialize(const TPMU_SIG_SCHEME *in, UINT32 selector, json_object **jso) 2721\fn TSS2_RC ifapi_json_TPMU_SYM_KEY_BITS_serialize(const TPMU_SYM_KEY_BITS *in, UINT32 selector, json_object **jso) 2722\fn TSS2_RC ifapi_json_TPMU_SYM_MODE_serialize(const TPMU_SYM_MODE *in, UINT32 selector, json_object **jso) 2723\fn TSS2_RC ifapi_json_UINT16_serialize(const UINT16 in, json_object **jso) 2724\fn TSS2_RC ifapi_json_UINT32_serialize(const UINT32 in, json_object **jso) 2725\fn TSS2_RC ifapi_json_UINT64_serialize(UINT64 in, json_object **jso) 2726\fn TSS2_RC ifapi_json_pcr_select_serialize( 2727 const UINT8 sizeofSelect, 2728 const BYTE pcrSelect[], 2729 json_object **jso) 2730 \fn TSS2_RC ifapi_json_TPMI_POLICYTYPE_serialize(const TPMI_POLICYTYPE in, 2731 json_object **jso) 2732\fn TSS2_RC ifapi_json_TPMI_POLICYTYPE_serialize_txt( 2733 const TPMI_POLICYTYPE in, 2734 json_object **str_jso) 2735\fn TSS2_RC ifapi_json_TPML_PCRVALUES_serialize(const TPML_PCRVALUES *in, json_object **jso) 2736\fn TSS2_RC ifapi_json_TPML_POLICYAUTHORIZATIONS_serialize(const TPML_POLICYAUTHORIZATIONS 2737 *in, json_object **jso) 2738\fn TSS2_RC ifapi_json_TPML_POLICYBRANCHES_serialize(const TPML_POLICYBRANCHES *in, 2739 json_object **jso) 2740\fn TSS2_RC ifapi_json_TPML_POLICYELEMENTS_serialize(const TPML_POLICYELEMENTS *in, 2741 json_object **jso) 2742\fn TSS2_RC ifapi_json_TPMS_PCRVALUE_serialize(const TPMS_PCRVALUE *in, json_object **jso) 2743\fn TSS2_RC ifapi_json_TPMS_POLICYACTION_serialize(const TPMS_POLICYACTION *in, 2744 json_object **jso) 2745\fn TSS2_RC ifapi_json_TPMS_POLICYAUTHORIZATION_serialize( 2746 const TPMS_POLICYAUTHORIZATION *in, 2747 json_object **jso) 2748\fn TSS2_RC ifapi_json_TPMS_POLICYAUTHORIZENV_serialize(const TPMS_POLICYAUTHORIZENV *in, 2749 json_object **jso) 2750\fn TSS2_RC ifapi_json_TPMS_POLICYAUTHORIZE_serialize(const TPMS_POLICYAUTHORIZE *in, 2751 json_object **jso) 2752\fn TSS2_RC ifapi_json_TPMS_POLICYAUTHVALUE_serialize(const TPMS_POLICYAUTHVALUE *in, 2753 json_object **jso) 2754\fn TSS2_RC ifapi_json_TPMS_POLICYBRANCH_serialize(const TPMS_POLICYBRANCH *in, 2755 json_object **jso) 2756\fn TSS2_RC ifapi_json_TPMS_POLICYCOMMANDCODE_serialize(const TPMS_POLICYCOMMANDCODE *in, 2757 json_object **jso) 2758\fn TSS2_RC ifapi_json_TPMS_POLICYCOUNTERTIMER_serialize(const TPMS_POLICYCOUNTERTIMER *in, 2759 json_object **jso) 2760\fn TSS2_RC ifapi_json_TPMS_POLICYCPHASH_serialize(const TPMS_POLICYCPHASH *in, 2761 json_object **jso) 2762\fn TSS2_RC ifapi_json_TPMS_POLICYDUPLICATIONSELECT_serialize(const 2763 TPMS_POLICYDUPLICATIONSELECT *in, json_object **jso) 2764\fn TSS2_RC ifapi_json_TPMS_POLICYLOCALITY_serialize(const TPMS_POLICYLOCALITY *in, 2765 json_object **jso) 2766\fn TSS2_RC ifapi_json_TPMS_POLICYNAMEHASH_serialize(const TPMS_POLICYNAMEHASH *in, 2767 json_object **jso) 2768\fn TSS2_RC ifapi_json_TPMS_POLICYNVWRITTEN_serialize(const TPMS_POLICYNVWRITTEN *in, 2769 json_object **jso) 2770\fn TSS2_RC ifapi_json_TPMS_POLICYNV_serialize(const TPMS_POLICYNV *in, json_object **jso) 2771\fn TSS2_RC ifapi_json_TPMS_POLICYOR_serialize(const TPMS_POLICYOR *in, json_object **jso) 2772\fn TSS2_RC ifapi_json_TPMS_POLICYPASSWORD_serialize(const TPMS_POLICYPASSWORD *in, 2773 json_object **jso) 2774\fn TSS2_RC ifapi_json_TPMS_POLICYPCR_serialize(const TPMS_POLICYPCR *in, json_object **jso) 2775\fn TSS2_RC ifapi_json_TPMS_POLICYPHYSICALPRESENCE_serialize(const 2776 TPMS_POLICYPHYSICALPRESENCE *in, json_object **jso) 2777\fn TSS2_RC ifapi_json_TPMS_POLICYSECRET_serialize(const TPMS_POLICYSECRET *in, 2778 json_object **jso) 2779\fn TSS2_RC ifapi_json_TPMS_POLICYSIGNED_serialize(const TPMS_POLICYSIGNED *in, 2780 json_object **jso) 2781\fn TSS2_RC ifapi_json_TPMS_POLICYTEMPLATE_serialize(const TPMS_POLICYTEMPLATE *in, 2782 json_object **jso) 2783\fn TSS2_RC ifapi_json_TPMS_POLICY_serialize(const TPMS_POLICY *in, 2784 json_object **jso) 2785\fn TSS2_RC ifapi_json_TPMT_POLICYELEMENT_serialize(const TPMT_POLICYELEMENT *in, 2786 json_object **jso) 2787\fn TSS2_RC ifapi_json_TPMU_POLICYELEMENT_serialize(const TPMU_POLICYELEMENT *in, 2788 UINT32 selector, json_object **jso) 2789\fn static TSS2_RC ifapi_json_char_serialize( 2790 const char *in, 2791 json_object **jso) 2792 2793 2794 \} 2795*/ 2796 2797 2798/*! 2799 \defgroup ifapi_deserialization FAPI object deserialization module 2800 \ingroup ifapi 2801 Provides functions for the deserialization from JSON to FAPI objects. 2802 \{ 2803\fn static bool get_number(const char *token, int64_t *num) 2804\fn static int get_token_start_idx(const char *token) 2805\fn TSS2_RC ifapi_json_FAPI_QUOTE_INFO_deserialize(json_object *jso, FAPI_QUOTE_INFO *out) 2806\fn TSS2_RC ifapi_json_IFAPI_DUPLICATE_deserialize(json_object *jso, IFAPI_DUPLICATE *out) 2807\fn TSS2_RC ifapi_json_IFAPI_EVENT_TYPE_deserialize(json_object *jso, IFAPI_EVENT_TYPE *out) 2808\fn TSS2_RC ifapi_json_IFAPI_EVENT_TYPE_deserialize_txt(json_object *jso, 2809 IFAPI_EVENT_TYPE *out) 2810\fn TSS2_RC ifapi_json_IFAPI_EVENT_UNION_deserialize( 2811 UINT32 selector, 2812 json_object *jso, 2813 IFAPI_EVENT_UNION *out) 2814\fn TSS2_RC ifapi_json_IFAPI_EVENT_deserialize(json_object *jso, IFAPI_EVENT *out) 2815\fn TSS2_RC ifapi_json_IFAPI_EXT_PUB_KEY_deserialize(json_object *jso, 2816 IFAPI_EXT_PUB_KEY *out) 2817\fn TSS2_RC ifapi_json_IFAPI_HIERARCHY_deserialize(json_object *jso, IFAPI_HIERARCHY *out) 2818\fn TSS2_RC ifapi_json_IFAPI_IMA_EVENT_deserialize(json_object *jso, IFAPI_IMA_EVENT *out) 2819\fn TSS2_RC ifapi_json_IFAPI_KEY_deserialize(json_object *jso, IFAPI_KEY *out) 2820\fn TSS2_RC ifapi_json_IFAPI_NV_deserialize(json_object *jso, IFAPI_NV *out) 2821\fn TSS2_RC ifapi_json_IFAPI_OBJECT_TYPE_CONSTANT_deserialize(json_object *jso, 2822 IFAPI_OBJECT_TYPE_CONSTANT *out) 2823\fn TSS2_RC ifapi_json_IFAPI_OBJECT_deserialize(json_object *jso, IFAPI_OBJECT *out) 2824\fn TSS2_RC ifapi_json_IFAPI_TSS_EVENT_deserialize(json_object *jso, IFAPI_TSS_EVENT *out) 2825\fn TSS2_RC ifapi_json_char_deserialize( 2826 json_object *jso, 2827 char **out) 2828\fn static TSS2_RC get_boolean_from_json(json_object *jso, TPMI_YES_NO *value) 2829\fn static bool get_number(const char *token, int64_t *num) 2830\fn static TSS2_RC get_number_from_json(json_object *jso, int64_t *num) 2831\fn bool ifapi_get_sub_object(json_object *jso, char *name, json_object **sub_jso) 2832\fn static TSS2_RC ifapi_hex_to_byte_ary(const char hex[], UINT32 vlen, BYTE val[]) 2833\fn TSS2_RC ifapi_json_BYTE_array_deserialize(size_t max, json_object *jso, BYTE *out) 2834\fn TSS2_RC ifapi_json_BYTE_deserialize(json_object *jso, BYTE *out) 2835\fn TSS2_RC ifapi_json_TPM2B_CREATION_DATA_deserialize(json_object *jso, 2836 TPM2B_CREATION_DATA *out) 2837\fn TSS2_RC ifapi_json_TPM2B_DATA_deserialize(json_object *jso, TPM2B_DATA *out) 2838\fn TSS2_RC ifapi_json_TPM2B_DIGEST_deserialize(json_object *jso, TPM2B_DIGEST *out) 2839\fn TSS2_RC ifapi_json_TPM2B_ECC_PARAMETER_deserialize(json_object *jso, 2840 TPM2B_ECC_PARAMETER *out) 2841\fn TSS2_RC ifapi_json_TPM2B_ENCRYPTED_SECRET_deserialize(json_object *jso, 2842 TPM2B_ENCRYPTED_SECRET *out) 2843\fn TSS2_RC ifapi_json_TPM2B_EVENT_deserialize(json_object *jso, TPM2B_EVENT *out) 2844\fn TSS2_RC ifapi_json_TPM2B_MAX_NV_BUFFER_deserialize(json_object *jso, 2845 TPM2B_MAX_NV_BUFFER *out) 2846\fn TSS2_RC ifapi_json_TPM2B_NAME_deserialize(json_object *jso, TPM2B_NAME *out) 2847\fn TSS2_RC ifapi_json_TPM2B_NONCE_deserialize(json_object *jso, TPM2B_NONCE *out) 2848\fn TSS2_RC ifapi_json_TPM2B_NV_PUBLIC_deserialize(json_object *jso, TPM2B_NV_PUBLIC *out) 2849\fn TSS2_RC ifapi_json_TPM2B_OPERAND_deserialize(json_object *jso, TPM2B_OPERAND *out) 2850\fn TSS2_RC ifapi_json_TPM2B_PRIVATE_deserialize(json_object *jso, TPM2B_PRIVATE *out) 2851\fn TSS2_RC ifapi_json_TPM2B_PUBLIC_KEY_RSA_deserialize(json_object *jso, 2852 TPM2B_PUBLIC_KEY_RSA *out) 2853\fn TSS2_RC ifapi_json_TPM2B_PUBLIC_deserialize(json_object *jso, TPM2B_PUBLIC *out) 2854\fn TSS2_RC ifapi_json_TPM2_ALG_ID_deserialize(json_object *jso, TPM2_ALG_ID *out) 2855\fn TSS2_RC ifapi_json_TPM2_CC_deserialize(json_object *jso, TPM2_CC *out) 2856\fn TSS2_RC ifapi_json_TPM2_ECC_CURVE_deserialize(json_object *jso, TPM2_ECC_CURVE *out) 2857\fn TSS2_RC ifapi_json_TPM2_EO_deserialize(json_object *jso, TPM2_EO *out) 2858\fn TSS2_RC ifapi_json_TPM2_GENERATED_deserialize(json_object *jso, TPM2_GENERATED *out) 2859\fn TSS2_RC ifapi_json_TPM2_HANDLE_deserialize(json_object *jso, TPM2_HANDLE *out) 2860\fn TSS2_RC ifapi_json_TPM2_NT_deserialize(json_object *jso, TPM2_NT *out) 2861\fn TSS2_RC ifapi_json_TPM2_PT_PCR_deserialize(json_object *jso, TPM2_PT_PCR *out) 2862\fn TSS2_RC ifapi_json_TPM2_ST_deserialize(json_object *jso, TPM2_ST *out) 2863\fn TSS2_RC ifapi_json_TPMA_LOCALITY_deserialize(json_object *jso, TPMA_LOCALITY *out) 2864\fn TSS2_RC ifapi_json_TPMA_NV_deserialize(json_object *jso, TPMA_NV *out) 2865\fn TSS2_RC ifapi_json_TPMA_OBJECT_deserialize(json_object *jso, TPMA_OBJECT *out) 2866\fn TSS2_RC ifapi_json_TPMI_AES_KEY_BITS_deserialize(json_object *jso, TPMI_AES_KEY_BITS *out) 2867\fn TSS2_RC ifapi_json_TPMI_ALG_ECC_SCHEME_deserialize(json_object *jso, 2868 TPMI_ALG_ECC_SCHEME *out) 2869\fn TSS2_RC ifapi_json_TPMI_ALG_HASH_deserialize(json_object *jso, TPMI_ALG_HASH *out) 2870\fn TSS2_RC ifapi_json_TPMI_ALG_KDF_deserialize(json_object *jso, TPMI_ALG_KDF *out) 2871\fn TSS2_RC ifapi_json_TPMI_ALG_KEYEDHASH_SCHEME_deserialize(json_object *jso, 2872 TPMI_ALG_KEYEDHASH_SCHEME *out) 2873\fn TSS2_RC ifapi_json_TPMI_ALG_PUBLIC_deserialize(json_object *jso, TPMI_ALG_PUBLIC *out) 2874\fn TSS2_RC ifapi_json_TPMI_ALG_RSA_DECRYPT_deserialize(json_object *jso, 2875 TPMI_ALG_RSA_DECRYPT *out) 2876\fn TSS2_RC ifapi_json_TPMI_ALG_RSA_SCHEME_deserialize(json_object *jso, 2877 TPMI_ALG_RSA_SCHEME *out) 2878\fn TSS2_RC ifapi_json_TPMI_ALG_SIG_SCHEME_deserialize(json_object *jso, 2879 TPMI_ALG_SIG_SCHEME *out) 2880\fn TSS2_RC ifapi_json_TPMI_ALG_SYM_MODE_deserialize(json_object *jso, 2881 TPMI_ALG_SYM_MODE *out) 2882\fn TSS2_RC ifapi_json_TPMI_ALG_SYM_OBJECT_deserialize(json_object *jso, 2883 TPMI_ALG_SYM_OBJECT *out) 2884\fn TSS2_RC ifapi_json_TPMI_ALG_SYM_deserialize(json_object *jso, TPMI_ALG_SYM *out) 2885\fn TSS2_RC ifapi_json_TPMI_ECC_CURVE_deserialize(json_object *jso, TPMI_ECC_CURVE *out) 2886\fn TSS2_RC ifapi_json_TPMI_RH_HIERARCHY_deserialize(json_object *jso, 2887 TPMI_RH_HIERARCHY *out) 2888\fn TSS2_RC ifapi_json_TPMI_RH_NV_INDEX_deserialize(json_object *jso, TPMI_RH_NV_INDEX *out) 2889\fn TSS2_RC ifapi_json_TPMI_RSA_KEY_BITS_deserialize(json_object *jso, 2890 TPMI_RSA_KEY_BITS *out) 2891\fn TSS2_RC ifapi_json_TPMI_ST_ATTEST_deserialize(json_object *jso, TPMI_ST_ATTEST *out) 2892\fn TSS2_RC ifapi_json_TPMI_YES_NO_deserialize(json_object *jso, TPMI_YES_NO *out) 2893\fn TSS2_RC ifapi_json_TPML_DIGEST_VALUES_deserialize(json_object *jso, 2894 TPML_DIGEST_VALUES *out) 2895\fn TSS2_RC ifapi_json_TPML_PCR_SELECTION_deserialize(json_object *jso, 2896 TPML_PCR_SELECTION *out) 2897\fn TSS2_RC ifapi_json_TPMS_ATTEST_deserialize(json_object *jso, TPMS_ATTEST *out) 2898\fn TSS2_RC ifapi_json_TPMS_CERTIFY_INFO_deserialize(json_object *jso, 2899 TPMS_CERTIFY_INFO *out) 2900\fn TSS2_RC ifapi_json_TPMS_CLOCK_INFO_deserialize(json_object *jso, TPMS_CLOCK_INFO *out) 2901\fn TSS2_RC ifapi_json_TPMS_COMMAND_AUDIT_INFO_deserialize(json_object *jso, 2902 TPMS_COMMAND_AUDIT_INFO *out) 2903\fn TSS2_RC ifapi_json_TPMS_CREATION_DATA_deserialize(json_object *jso, 2904 TPMS_CREATION_DATA *out) 2905\fn TSS2_RC ifapi_json_TPMS_CREATION_INFO_deserialize(json_object *jso, 2906 TPMS_CREATION_INFO *out) 2907\fn TSS2_RC ifapi_json_TPMS_ECC_PARMS_deserialize(json_object *jso, TPMS_ECC_PARMS *out) 2908\fn TSS2_RC ifapi_json_TPMS_ECC_POINT_deserialize(json_object *jso, TPMS_ECC_POINT *out) 2909\fn TSS2_RC ifapi_json_TPMS_EMPTY_deserialize(json_object *jso, TPMS_EMPTY *out) 2910\fn TSS2_RC ifapi_json_TPMS_ENC_SCHEME_OAEP_deserialize(json_object *jso, 2911 TPMS_ENC_SCHEME_OAEP *out) 2912\fn TSS2_RC ifapi_json_TPMS_ENC_SCHEME_RSAES_deserialize(json_object *jso, 2913 TPMS_ENC_SCHEME_RSAES *out) 2914\fn TSS2_RC ifapi_json_TPMS_KEYEDHASH_PARMS_deserialize(json_object *jso, 2915 TPMS_KEYEDHASH_PARMS *out) 2916\fn TSS2_RC ifapi_json_TPMS_KEY_SCHEME_ECDH_deserialize(json_object *jso, 2917 TPMS_KEY_SCHEME_ECDH *out) 2918\fn TSS2_RC ifapi_json_TPMS_NV_CERTIFY_INFO_deserialize(json_object *jso, 2919 TPMS_NV_CERTIFY_INFO *out) 2920\fn TSS2_RC ifapi_json_TPMS_NV_PUBLIC_deserialize(json_object *jso, TPMS_NV_PUBLIC *out) 2921\fn TSS2_RC ifapi_json_TPMS_PCR_SELECTION_deserialize(json_object *jso, 2922 TPMS_PCR_SELECTION *out) 2923\fn TSS2_RC ifapi_json_TPMS_PCR_SELECT_deserialize(json_object *jso, TPMS_PCR_SELECT *out) 2924\fn TSS2_RC ifapi_json_TPMS_QUOTE_INFO_deserialize(json_object *jso, TPMS_QUOTE_INFO *out) 2925\fn TSS2_RC ifapi_json_TPMS_RSA_PARMS_deserialize(json_object *jso, TPMS_RSA_PARMS *out) 2926\fn TSS2_RC ifapi_json_TPMS_SCHEME_ECDAA_deserialize(json_object *jso, 2927 TPMS_SCHEME_ECDAA *out) 2928\fn TSS2_RC ifapi_json_TPMS_SCHEME_HASH_deserialize(json_object *jso, 2929 TPMS_SCHEME_HASH *out) 2930\fn TSS2_RC ifapi_json_TPMS_SCHEME_HMAC_deserialize(json_object *jso, TPMS_SCHEME_HMAC *out) 2931\fn TSS2_RC ifapi_json_TPMS_SCHEME_KDF1_SP800_108_deserialize(json_object *jso, 2932 TPMS_SCHEME_KDF1_SP800_108 *out) 2933\fn TSS2_RC ifapi_json_TPMS_SCHEME_KDF1_SP800_56A_deserialize(json_object *jso, 2934 TPMS_SCHEME_KDF1_SP800_56A *out) 2935\fn TSS2_RC ifapi_json_TPMS_SCHEME_MGF1_deserialize(json_object *jso, TPMS_SCHEME_MGF1 *out) 2936\fn TSS2_RC ifapi_json_TPMS_SCHEME_XOR_deserialize(json_object *jso, TPMS_SCHEME_XOR *out) 2937\fn TSS2_RC ifapi_json_TPMS_SESSION_AUDIT_INFO_deserialize(json_object *jso, 2938 TPMS_SESSION_AUDIT_INFO *out) 2939\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_ECC_deserialize(json_object *jso, 2940 TPMS_SIGNATURE_ECC *out) 2941\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_ECDAA_deserialize(json_object *jso, 2942 TPMS_SIGNATURE_ECDAA *out) 2943\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_ECDSA_deserialize(json_object *jso, 2944 TPMS_SIGNATURE_ECDSA *out) 2945\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_ECSCHNORR_deserialize(json_object *jso, 2946 TPMS_SIGNATURE_ECSCHNORR *out) 2947\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_RSAPSS_deserialize(json_object *jso, 2948 TPMS_SIGNATURE_RSAPSS *out) 2949\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_RSASSA_deserialize(json_object *jso, 2950 TPMS_SIGNATURE_RSASSA *out) 2951\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_RSA_deserialize(json_object *jso, 2952 TPMS_SIGNATURE_RSA *out) 2953\fn TSS2_RC ifapi_json_TPMS_SIGNATURE_SM2_deserialize(json_object *jso, 2954 TPMS_SIGNATURE_SM2 *out) 2955\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_ECDAA_deserialize(json_object *jso, 2956 TPMS_SIG_SCHEME_ECDAA *out) 2957\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_ECDSA_deserialize(json_object *jso, 2958 TPMS_SIG_SCHEME_ECDSA *out) 2959\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_ECSCHNORR_deserialize(json_object *jso, 2960 TPMS_SIG_SCHEME_ECSCHNORR *out) 2961\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_RSAPSS_deserialize(json_object *jso, 2962 TPMS_SIG_SCHEME_RSAPSS *out) 2963\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_RSASSA_deserialize(json_object *jso, 2964 TPMS_SIG_SCHEME_RSASSA *out) 2965\fn TSS2_RC ifapi_json_TPMS_SIG_SCHEME_SM2_deserialize(json_object *jso, 2966 TPMS_SIG_SCHEME_SM2 *out) 2967\fn TSS2_RC ifapi_json_TPMS_SYMCIPHER_PARMS_deserialize(json_object *jso, 2968 TPMS_SYMCIPHER_PARMS *out) 2969\fn TSS2_RC ifapi_json_TPMS_TIME_ATTEST_INFO_deserialize(json_object *jso, 2970 TPMS_TIME_ATTEST_INFO *out) 2971\fn TSS2_RC ifapi_json_TPMS_TIME_INFO_deserialize(json_object *jso, TPMS_TIME_INFO *out) 2972\fn TSS2_RC ifapi_json_TPMT_ECC_SCHEME_deserialize(json_object *jso, TPMT_ECC_SCHEME *out) 2973\fn TSS2_RC ifapi_json_TPMT_HA_deserialize(json_object *jso, TPMT_HA *out) 2974\fn TSS2_RC ifapi_json_TPMT_KDF_SCHEME_deserialize(json_object *jso, TPMT_KDF_SCHEME *out) 2975\fn TSS2_RC ifapi_json_TPMT_KEYEDHASH_SCHEME_deserialize(json_object *jso, 2976 TPMT_KEYEDHASH_SCHEME *out) 2977\fn TSS2_RC ifapi_json_TPMT_PUBLIC_deserialize(json_object *jso, TPMT_PUBLIC *out) 2978\fn TSS2_RC ifapi_json_TPMT_RSA_DECRYPT_deserialize(json_object *jso, 2979 TPMT_RSA_DECRYPT *out) 2980\fn TSS2_RC ifapi_json_TPMT_RSA_SCHEME_deserialize(json_object *jso, TPMT_RSA_SCHEME *out) 2981\fn TSS2_RC ifapi_json_TPMT_SIGNATURE_deserialize(json_object *jso, TPMT_SIGNATURE *out) 2982\fn TSS2_RC ifapi_json_TPMT_SIG_SCHEME_deserialize(json_object *jso, TPMT_SIG_SCHEME *out) 2983\fn TSS2_RC ifapi_json_TPMT_SYM_DEF_OBJECT_deserialize(json_object *jso, 2984 TPMT_SYM_DEF_OBJECT *out) 2985\fn TSS2_RC ifapi_json_TPMT_SYM_DEF_deserialize(json_object *jso, TPMT_SYM_DEF *out) 2986\fn TSS2_RC ifapi_json_TPMT_TK_CREATION_deserialize(json_object *jso, 2987 TPMT_TK_CREATION *out) 2988\fn TSS2_RC ifapi_json_TPMT_TK_VERIFIED_deserialize(json_object *jso, 2989 TPMT_TK_VERIFIED *out) 2990\fn TSS2_RC ifapi_json_TPMU_ASYM_SCHEME_deserialize( 2991 UINT32 selector, 2992 json_object *jso, 2993 TPMU_ASYM_SCHEME *out) 2994\fn TSS2_RC ifapi_json_TPMU_ATTEST_deserialize( 2995 UINT32 selector, 2996 json_object *jso, 2997 TPMU_ATTEST *out) 2998\fn TSS2_RC ifapi_json_TPMU_HA_deserialize( 2999 UINT32 selector, 3000 json_object *jso, 3001 TPMU_HA *out) 3002\fn TSS2_RC ifapi_json_TPMU_KDF_SCHEME_deserialize( 3003 UINT32 selector, 3004 json_object *jso, 3005 TPMU_KDF_SCHEME *out) 3006\fn TSS2_RC ifapi_json_TPMU_PUBLIC_ID_deserialize( 3007 UINT32 selector, 3008 json_object *jso, 3009 TPMU_PUBLIC_ID *out) 3010\fn TSS2_RC ifapi_json_TPMU_PUBLIC_PARMS_deserialize( 3011 UINT32 selector, 3012 json_object *jso, 3013 TPMU_PUBLIC_PARMS *out) 3014\fn TSS2_RC ifapi_json_TPMU_SCHEME_KEYEDHASH_deserialize( 3015 UINT32 selector, 3016 json_object *jso, 3017 TPMU_SCHEME_KEYEDHASH *out) 3018\fn TSS2_RC ifapi_json_TPMU_SIGNATURE_deserialize( 3019 UINT32 selector, 3020 json_object *jso, 3021 TPMU_SIGNATURE *out) 3022\fn TSS2_RC ifapi_json_TPMU_SIG_SCHEME_deserialize( 3023 UINT32 selector, 3024 json_object *jso, 3025 TPMU_SIG_SCHEME *out) 3026\fn TSS2_RC ifapi_json_TPMU_SYM_KEY_BITS_deserialize( 3027 UINT32 selector, 3028 json_object *jso, 3029 TPMU_SYM_KEY_BITS *out) 3030\fn TSS2_RC ifapi_json_TPMU_SYM_MODE_deserialize( 3031 UINT32 selector, 3032 json_object *jso, 3033 TPMU_SYM_MODE *out) 3034\fn TSS2_RC ifapi_json_UINT16_deserialize(json_object *jso, UINT16 *out) 3035\fn TSS2_RC ifapi_json_UINT32_deserialize(json_object *jso, UINT32 *out) 3036\fn TSS2_RC ifapi_json_UINT64_deserialize(json_object *jso, UINT64 *out) 3037\fn TSS2_RC ifapi_json_UINT8_ARY_deserialize( 3038 json_object *jso, 3039 UINT8_ARY *out) 3040\fn TSS2_RC ifapi_json_UINT8_deserialize(json_object *jso, UINT8 *out) 3041\fn TSS2_RC ifapi_json_byte_deserialize( 3042 json_object *jso, 3043 UINT32 max, 3044 BYTE *out, 3045 UINT16 *out_size) 3046\fn TSS2_RC ifapi_json_pcr_selection_deserialize( 3047 json_object *jso, 3048 UINT8 *sizeofSelect, 3049 BYTE pcrSelect[]) 3050\fn static const char * strip_prefix(const char *in, ...) 3051 \fn static bool get_number(const char *token, int64_t *num) 3052\fn static int get_token_start_idx(const char *token) 3053\fn TSS2_RC ifapi_json_TPMI_POLICYTYPE_deserialize(json_object *jso, TPMI_POLICYTYPE *out) 3054\fn TSS2_RC ifapi_json_TPMI_POLICYTYPE_deserialize_txt(json_object *jso, 3055 TPMI_POLICYTYPE *out) 3056\fn TSS2_RC ifapi_json_TPML_PCRVALUES_deserialize(json_object *jso, TPML_PCRVALUES **out) 3057\fn TSS2_RC ifapi_json_TPML_POLICYAUTHORIZATIONS_deserialize(json_object *jso, 3058 TPML_POLICYAUTHORIZATIONS **out) 3059\fn TSS2_RC ifapi_json_TPML_POLICYBRANCHES_deserialize(json_object *jso, 3060 TPML_POLICYBRANCHES **out) 3061\fn TSS2_RC ifapi_json_TPML_POLICYELEMENTS_deserialize(json_object *jso, 3062 TPML_POLICYELEMENTS **out) 3063\fn TSS2_RC ifapi_json_TPMS_PCRVALUE_deserialize(json_object *jso, TPMS_PCRVALUE *out) 3064\fn TSS2_RC ifapi_json_TPMS_POLICYACTION_deserialize(json_object *jso, 3065 TPMS_POLICYACTION *out) 3066\fn TSS2_RC ifapi_json_TPMS_POLICYAUTHORIZATION_deserialize(json_object *jso, 3067 TPMS_POLICYAUTHORIZATION *out) 3068\fn TSS2_RC ifapi_json_TPMS_POLICYAUTHORIZENV_deserialize(json_object *jso, 3069 TPMS_POLICYAUTHORIZENV *out) 3070\fn TSS2_RC ifapi_json_TPMS_POLICYAUTHORIZE_deserialize(json_object *jso, 3071 TPMS_POLICYAUTHORIZE *out) 3072\fn TSS2_RC ifapi_json_TPMS_POLICYAUTHVALUE_deserialize(json_object *jso, 3073 TPMS_POLICYAUTHVALUE *out) 3074\fn TSS2_RC ifapi_json_TPMS_POLICYBRANCH_deserialize(json_object *jso, 3075 TPMS_POLICYBRANCH *out) 3076\fn TSS2_RC ifapi_json_TPMS_POLICYCOMMANDCODE_deserialize(json_object *jso, 3077 TPMS_POLICYCOMMANDCODE *out) 3078\fn TSS2_RC ifapi_json_TPMS_POLICYCOUNTERTIMER_deserialize(json_object *jso, 3079 TPMS_POLICYCOUNTERTIMER *out) 3080\fn TSS2_RC ifapi_json_TPMS_POLICYCPHASH_deserialize(json_object *jso, 3081 TPMS_POLICYCPHASH *out) 3082\fn TSS2_RC ifapi_json_TPMS_POLICYDUPLICATIONSELECT_deserialize(json_object *jso, 3083 TPMS_POLICYDUPLICATIONSELECT *out) 3084\fn TSS2_RC ifapi_json_TPMS_POLICYLOCALITY_deserialize(json_object *jso, 3085 TPMS_POLICYLOCALITY *out) 3086\fn TSS2_RC ifapi_json_TPMS_POLICYNAMEHASH_deserialize(json_object *jso, 3087 TPMS_POLICYNAMEHASH *out) 3088\fn TSS2_RC ifapi_json_TPMS_POLICYNVWRITTEN_deserialize(json_object *jso, 3089 TPMS_POLICYNVWRITTEN *out) 3090\fn TSS2_RC ifapi_json_TPMS_POLICYNV_deserialize(json_object *jso, TPMS_POLICYNV *out) 3091\fn TSS2_RC ifapi_json_TPMS_POLICYOR_deserialize(json_object *jso, TPMS_POLICYOR *out) 3092\fn TSS2_RC ifapi_json_TPMS_POLICYPASSWORD_deserialize(json_object *jso, 3093 TPMS_POLICYPASSWORD *out) 3094\fn TSS2_RC ifapi_json_TPMS_POLICYPCR_deserialize(json_object *jso, TPMS_POLICYPCR *out) 3095\fn TSS2_RC ifapi_json_TPMS_POLICYPHYSICALPRESENCE_deserialize(json_object *jso, 3096 TPMS_POLICYPHYSICALPRESENCE *out) 3097\fn TSS2_RC ifapi_json_TPMS_POLICYSECRET_deserialize(json_object *jso, 3098 TPMS_POLICYSECRET *out) 3099\fn TSS2_RC ifapi_json_TPMS_POLICYSIGNED_deserialize(json_object *jso, 3100 TPMS_POLICYSIGNED *out) 3101\fn TSS2_RC ifapi_json_TPMS_POLICYTEMPLATE_deserialize(json_object *jso, 3102 TPMS_POLICYTEMPLATE *out) 3103\fn TSS2_RC ifapi_json_TPMS_POLICY_deserialize(json_object *jso, 3104 TPMS_POLICY *out) 3105\fn TSS2_RC ifapi_json_TPMT_POLICYELEMENT_deserialize(json_object *jso, 3106 TPMT_POLICYELEMENT *out) 3107\fn TSS2_RC ifapi_json_TPMU_POLICYELEMENT_deserialize( 3108 UINT32 selector, 3109 json_object *jso, 3110 TPMU_POLICYELEMENT *out) 3111 3112 3113 \} 3114*/ 3115 3116/*! 3117 \defgroup ifapi_vendor Vendor specific module 3118 \ingroup ifapi 3119\{ 3120 Provides functions implementing vendor specific extensions. 3121\fn TSS2_RC ifapi_get_intl_ek_certificate(FAPI_CONTEXT *context, TPM2B_PUBLIC *ek_public, 3122 unsigned char ** cert_buffer, size_t *cert_size) 3123 3124 3125\} 3126*/ 3127 3128/*! 3129 \defgroup FapiTestgroup Fapi-Testing 3130 Testing of FAPI functionality. The tested FAPI functions are listed in each 3131 of the testcase functions' descriptions. 3132 \ingroup Testgroup 3133 \{ 3134 \fn test_fapi_data_crypt(FAPI_CONTEXT *context) 3135 \fn test_fapi_duplicate(FAPI_CONTEXT *context) 3136 \fn test_fapi_ext_public_key(FAPI_CONTEXT *context) 3137 \fn test_fapi_get_random(FAPI_CONTEXT *context) 3138 \fn test_fapi_info(FAPI_CONTEXT *context) 3139 \fn test_fapi_key_change_auth(FAPI_CONTEXT *context) 3140 \fn test_fapi_key_create_ckda_sign(FAPI_CONTEXT *context) 3141 \fn test_fapi_key_create_policies_sign(FAPI_CONTEXT *context) 3142 \fn test_fapi_key_create_policy_authorize_nv(FAPI_CONTEXT *context) 3143 \fn test_fapi_key_create_policy_authorize_sign(FAPI_CONTEXT *context) 3144 \fn test_fapi_key_create_policy_nv_sign(FAPI_CONTEXT *context) 3145 \fn test_fapi_key_create_policy_or_sign(FAPI_CONTEXT *context) 3146 \fn test_fapi_key_create_policy_password_sign(FAPI_CONTEXT *context) 3147 \fn test_fapi_key_create_policy_pcr_sign(FAPI_CONTEXT *context) 3148 \fn test_fapi_key_create_policy_secret_nv_sign(FAPI_CONTEXT *context) 3149 \fn test_fapi_key_create_policy_signed(FAPI_CONTEXT *context) 3150 \fn test_fapi_key_create_sign(FAPI_CONTEXT *context) 3151 \fn test_fapi_key_create_sign_password_provision(FAPI_CONTEXT *context) 3152 \fn test_fapi_key_create_sign_policy_provision(FAPI_CONTEXT *context) 3153 \fn test_fapi_nv_extend(FAPI_CONTEXT *context) 3154 \fn test_fapi_nv_increment(FAPI_CONTEXT *context) 3155 \fn test_fapi_nv_ordinary(FAPI_CONTEXT *context) 3156 \fn test_fapi_nv_set_bits(FAPI_CONTEXT *context) 3157 \fn test_fapi_nv_written_policy(FAPI_CONTEXT *context) 3158 \fn test_fapi_pcr_test(FAPI_CONTEXT *context) 3159 \fn test_fapi_platform_certificates(FAPI_CONTEXT *context) 3160 \fn test_fapi_quote(FAPI_CONTEXT *context) 3161 \fn test_fapi_unseal(FAPI_CONTEXT *context) 3162 \} 3163*/ 3164