|
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) |
|
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) |
|
TSS2_RC | Esys_RSA_Encrypt_Finish (ESYS_CONTEXT *esysContext, TPM2B_PUBLIC_KEY_RSA **outData) |
|
ESAPI function to invoke the TPM2_RSA_Encrypt command either as a one-call or in an asynchronous manner.
◆ Esys_RSA_Encrypt()
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 |
|
) |
| |
One-Call function for TPM2_RSA_Encrypt
This function invokes the TPM2_RSA_Encrypt 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
-
[in,out] | esysContext | The ESYS_CONTEXT. |
[in] | keyHandle | Reference to public portion of RSA key to use for encryption. |
[in] | shandle1 | First session handle. |
[in] | shandle2 | Second session handle. |
[in] | shandle3 | Third session handle. |
[in] | message | Message to be encrypted. |
[in] | inScheme | TPM2_The padding scheme to use if scheme associated with keyHandle is TPM2_ALG_NULL. |
[in] | label | Optional label L to be associated with the message. |
[out] | outData | Encrypted output. (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. |
◆ Esys_RSA_Encrypt_Async()
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 |
|
) |
| |
Asynchronous function for TPM2_RSA_Encrypt
This function invokes the TPM2_RSA_Encrypt 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_RSA_Encrypt_Finish.
- Parameters
-
[in,out] | esysContext | The ESYS_CONTEXT. |
[in] | keyHandle | Reference to public portion of RSA key to use for encryption. |
[in] | shandle1 | First session handle. |
[in] | shandle2 | Second session handle. |
[in] | shandle3 | Third session handle. |
[in] | message | Message to be encrypted. |
[in] | inScheme | TPM2_The padding scheme to use if scheme associated with keyHandle is TPM2_ALG_NULL. |
[in] | label | Optional label L to be associated with the message. |
- 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. |
◆ Esys_RSA_Encrypt_Finish()
TSS2_RC Esys_RSA_Encrypt_Finish |
( |
ESYS_CONTEXT * |
esysContext, |
|
|
TPM2B_PUBLIC_KEY_RSA ** |
outData |
|
) |
| |
Asynchronous finish function for TPM2_RSA_Encrypt
This function returns the results of a TPM2_RSA_Encrypt command invoked via Esys_RSA_Encrypt_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
-
[in,out] | esysContext | The ESYS_CONTEXT. |
[out] | outData | Encrypted output. (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. |