table of contents
| Esys_CreatePrimary(3) | tpm2-tss | Esys_CreatePrimary(3) |
NAME¶
Esys_CreatePrimary - The ESAPI function for the TPM2_CreatePrimary command.
SYNOPSIS¶
Functions¶
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)
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)
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)
Detailed Description¶
ESAPI function to invoke the TPM2_CreatePrimary command either as a one-call or in an asynchronous manner.
Function Documentation¶
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)¶
One-Call function for TPM2_CreatePrimary
This function invokes the TPM2_CreatePrimary 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
primaryHandle TPM2_RH_ENDORSEMENT, TPM2_RH_OWNER, TPM2_RH_PLATFORM+{PP}, or TPM2_RH_NULL.
shandle1 Session handle for authorization of primaryHandle
shandle2 Second session handle.
shandle3 Third session handle.
inSensitive The sensitive data, see TPM 2.0 Part 1 Sensitive Values.
inPublic The public template.
outsideInfo Data that will be included in the creation data for this object to provide permanent, verifiable linkage between this object and some object owner data.
creationPCR PCR that will be used in creation data.
outPublic The public portion of the created object. (callee-allocated)
creationData Contains a TPMT_CREATION_DATA. (callee-allocated)
creationHash Digest of creationData using nameAlg of outPublic. (callee-allocated)
creationTicket Ticket used by TPM2_CertifyCreation() to validate that the creation data was produced by the TPM. (callee-allocated)
objectHandle ESYS_TR handle of ESYS resource for TPM2_HANDLE.
Return values
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.
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)¶
Asynchronous function for TPM2_CreatePrimary
This function invokes the TPM2_CreatePrimary 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_CreatePrimary_Finish.
Parameters
primaryHandle TPM2_RH_ENDORSEMENT, TPM2_RH_OWNER, TPM2_RH_PLATFORM+{PP}, or TPM2_RH_NULL.
shandle1 Session handle for authorization of primaryHandle
shandle2 Second session handle.
shandle3 Third session handle.
inSensitive The sensitive data, see TPM 2.0 Part 1 Sensitive Values.
inPublic The public template.
outsideInfo Data that will be included in the creation data for this object to provide permanent, verifiable linkage between this object and some object owner data.
creationPCR PCR that will be used in creation data.
Return values
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.
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)¶
Asynchronous finish function for TPM2_CreatePrimary
This function returns the results of a TPM2_CreatePrimary command invoked via Esys_CreatePrimary_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
outPublic The public portion of the created object. (callee-allocated)
creationData Contains a TPMT_CREATION_DATA. (callee-allocated)
creationHash Digest of creationData using nameAlg of outPublic. (callee-allocated)
creationTicket Ticket used by TPM2_CertifyCreation() to validate that the creation data was produced by the TPM. (callee-allocated)
objectHandle ESYS_TR handle of ESYS resource for TPM2_HANDLE.
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_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.
Author¶
Generated automatically by Doxygen for tpm2-tss from the source code.
| Mon Jul 3 2023 | Version 3.2.2 |