NAME

CSSM_KR_CreateRecoveryEnablementContext

SYNOPSIS

CSSM_CC_HANDLE CSSMAPI CSSM_KR_CreateRecoveryEnablementContext
    (CSSM_KRSP_HANDLE KRSPHandle,
    const CSSM_KR_PROFILE LocalProfile,
    const CSSM_KR_PROFILE RemoteProfile)

DESCRIPTION

This call creates a key recovery enablement context based on a KRSP handle (which determines the key recovery mechanism that is in use), and key recovery profiles for the local and remote parties involved in a cryptographic exchange. A handle to the key recovery enablement context is returned. It is expected that the LocalProfile will contain sufficient information to perform LE, ENT and IND key recovery enablement, whereas the RemoteProfile will contain information to perform LE and ENT key recovery enablement only. However, any and all of the fields within the profiles may be set to NULL-in this case, default values for these fields are to be used when performing the recovery enablement operations.

PARAMETERS

KRSPHandle (input)

The handle to the KRSP that is to be used.

LocalProfile (input)

The key recovery profile for the local client.

RemoteProfile (input)

The key recovery profile for the remote client.

RETURN VALUES

A handle to the key recovery enablement context is returned. If the handle is NULL, it signifies that an error has occurred.

ERRORS

CSSM_INVALID_KR_HANDLE

Invalid handle.

CSSM_KR_INVALID_PROFILE

Invalid profile structure.

CSSM_KR_INVALID_PTR

Bad pointer.

CSSM_MEMORY_ERROR

Memory error.