Esys_MakeCredential - The ESAPI function for the
TPM2_MakeCredential command.
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)
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)
TSS2_RC Esys_MakeCredential_Finish (ESYS_CONTEXT *esysContext,
TPM2B_ID_OBJECT **credentialBlob, TPM2B_ENCRYPTED_SECRET **secret)
ESAPI function to invoke the TPM2_MakeCredential command either as
a one-call or in an asynchronous manner.
One-Call function for TPM2_MakeCredential
This function invokes the TPM2_MakeCredential command in a
one-call variant. This means the function will block until the TPM response
is available. All input parameters are const. The memory for non-simple
output parameters is allocated by the function implementation.
Parameters
esysContext The ESYS_CONTEXT.
handle Loaded public area, used to encrypt the sensitive area containing
the credential key.
shandle1 First session handle.
shandle2 Second session handle.
shandle3 Third session handle.
credential The credential information.
objectName Name of the object to which the credential applies.
credentialBlob The credential. (callee-allocated)
secret Handle algorithm-dependent data that wraps the key that encrypts
credentialBlob. (callee-allocated)
Return values
TSS2_RC_SUCCESS if the function call was a
success.
TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input pointers
or required output handle references are NULL.
TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for
internal operations or return parameters.
TSS2_ESYS_RC_BAD_SEQUENCE if the context has an asynchronous operation
already pending.
TSS2_ESYS_RC_INSUFFICIENT_RESPONSE if the TPM's response does not at
least contain the tag, response length, and response code.
TSS2_ESYS_RC_MALFORMED_RESPONSE if the TPM's response is corrupted.
TSS2_ESYS_RC_RSP_AUTH_FAILED if the response HMAC from the TPM did not
verify.
TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS if more than one session has the
'decrypt' attribute bit set.
TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS if more than one session has the
'encrypt' attribute bit set.
TSS2_ESYS_RC_BAD_TR if any of the ESYS_TR objects are unknown to the
ESYS_CONTEXT or are of the wrong type or if required ESYS_TR objects
are ESYS_TR_NONE.
TSS2_RCs produced by lower layers of the software stack may be returned
to the caller unaltered unless handled internally.
Asynchronous function for TPM2_MakeCredential
This function invokes the TPM2_MakeCredential command in a
asynchronous variant. This means the function will return as soon as the
command has been sent downwards the stack to the TPM. All input parameters
are const. In order to retrieve the TPM's response call
Esys_MakeCredential_Finish.
Parameters
esysContext The ESYS_CONTEXT.
handle Loaded public area, used to encrypt the sensitive area containing
the credential key.
shandle1 First session handle.
shandle2 Second session handle.
shandle3 Third session handle.
credential The credential information.
objectName Name of the object to which the credential applies.
Return values
ESYS_RC_SUCCESS if the function call was a
success.
TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input pointers
or required output handle references are NULL.
TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for
internal operations or return parameters.
TSS2_RCs produced by lower layers of the software stack may be returned
to the caller unaltered unless handled internally.
TSS2_ESYS_RC_MULTIPLE_DECRYPT_SESSIONS if more than one session has the
'decrypt' attribute bit set.
TSS2_ESYS_RC_MULTIPLE_ENCRYPT_SESSIONS if more than one session has the
'encrypt' attribute bit set.
TSS2_ESYS_RC_BAD_TR if any of the ESYS_TR objects are unknown to the
ESYS_CONTEXT or are of the wrong type or if required ESYS_TR objects
are ESYS_TR_NONE.
Asynchronous finish function for TPM2_MakeCredential
This function returns the results of a TPM2_MakeCredential command
invoked via Esys_MakeCredential_Finish. All non-simple output parameters are
allocated by the function's implementation. NULL can be passed for every
output parameter if the value is not required.
Parameters
esysContext The ESYS_CONTEXT.
credentialBlob The credential. (callee-allocated)
secret Handle algorithm-dependent data that wraps the key that encrypts
credentialBlob. (callee-allocated)
Return values
TSS2_RC_SUCCESS on success
ESYS_RC_SUCCESS if the function call was a success.
TSS2_ESYS_RC_BAD_REFERENCE if the esysContext or required input pointers
or required output handle references are NULL.
TSS2_ESYS_RC_BAD_CONTEXT if esysContext corruption is detected.
TSS2_ESYS_RC_MEMORY if the ESAPI cannot allocate enough memory for
internal operations or return parameters.
TSS2_ESYS_RC_BAD_SEQUENCE if the context has an asynchronous operation
already pending.
TSS2_ESYS_RC_TRY_AGAIN if the timeout counter expires before the TPM
response is received.
TSS2_ESYS_RC_INSUFFICIENT_RESPONSE if the TPM's response does not at
least contain the tag, response length, and response code.
TSS2_ESYS_RC_RSP_AUTH_FAILED if the response HMAC from the TPM did not
verify.
TSS2_ESYS_RC_MALFORMED_RESPONSE if the TPM's response is corrupted.
TSS2_RCs produced by lower layers of the software stack may be returned
to the caller unaltered unless handled internally.
Generated automatically by Doxygen for tpm2-tss from the source
code.