NAME

KRSP_RegistrationRequest

SYNOPSIS

CSSM_RETURN CSSMKRSPI KRSP_RegistrationRequest
    (CSSM_KRSP_HANDLE KRSPHandle,
    CSSM_CC_HANDLE KRRegistrationContextHandle,
    const CSSM_CONTEXT_PTR KRRegistrationContext,
    CSSM_DATA_PTR KRInData,
    CSSM_CRYPTO_DATA_PTR UserCallback,
    uint8 KRFlags,
    uint32 *EstimatedTime
    CSSM_HANDLE_PTR ReferenceHandle )

DESCRIPTION

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

PARAMETERS

KRSPHandle (input)

The handle that describes the add-in key recovery service provider module used to perform up calls to CSSM for the memory functions managed by CSSM.

KRRegistrationContextHandle (input)

The handle that describes the context of this key recovery operation used to link to the KRSP-managed information.

KRRegistrationContext (input)

Pointer to CSSM_CONTEXT structure that describes the attributes with this key recovery context.

KRInData (input)

Input data for key recovery registration.

UserCallback (input)

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

KRFlags (input)

Flag values for recovery registration. Defined values are:

• KR_INDIV-signifies that the registration is for the IND scenario.

• KR_ENT-signifies that the registration is for the ENT scenario.

• KR_LE-signifies that the registration is for the LE scenario.

EstimatedTime (output)

The estimated time after which the CSSM_KR_RegistrationRetrieve call should be invoked to obtain registration results.

ReferenceHandle (output)

The handle to use to invoke the CSSM_KR_RegistrationRetrieve function.

RETURN VALUE

A CSSM return value. This function returns CSSM_OK if successful and returns an error code if an error has occurred.

ERRORS

CSSM_KR_INVALID_HANDLE

Invalid registration handle.

CSSM_KR_INVALID_POINTER

Invalid pointer.

CSSM_MEMORY_ERROR

Memory error.