This function performs a key recovery request operation. The KRInData contains known input parameters for the recovery request operation. A UserCallback function may be supplied to allow the recovery operation to interact with the user interface, if necessary. If the recovery request operation is successful, a ReferenceHandle and an EstimatedTime parameter are returned; the ReferenceHandle will be used to invoke the CSSM_KR_RecoveryRetrieve function, after the EstimatedTime in seconds.

CSSM_RETURN CSSMAPI CSSM_KR_RecoveryRequest
               (CSSM_CC_HANDLE RecoveryRequestContext,
               const CSSM_DATA_PTR KRInData,
               const CSSM_CRYPTO_DATA_PTR UserCallback,
               unit32 *EstimatedTime,
               const CSSM_HANDLE_PTR ReferenceHandle)

Input

RecoveryRequestContext

The handle to the key recovery request context.

KRInData

Input data for key recovery requests. For encapsulation schemes, the KRFs are included in this parameter.

UserCallBack

A callback function that may be used to collect further information from the user interface.

Output

ReferenceHandle

Handle returned when recovery request is successful. This handle may be used to invoke the CSSM_KR_RecoveryRetrieve function.

EstimatedTime

The estimated time after which the CSSM_KR_RecoveryRetrieve call should be invoked to obtain recovery results.

CSSM_OK if successful, CSSM_FAIL if an error occurred. Use CSSM_GetError to determine the exact error.