NAME

CSSM_KR_PassThrough

SYNOPSIS

CSSM_DATA_PTR CSSMAPI CSSM_KR_PassThrough
    (CSSM_KR_HANDLE KRSPHandle,
    CSSM_CC_HANDLE KeyRecoveryContext,
    CSSM_CC_HANDLE CryptoContext,
    uint32 PassThroughId,
    const CSSM_DATA_PTR InputParams)

DESCRIPTION

This function allows applications to call key recovery module-specific operations that have been exported. Such operations may include queries or services specific to the recovery mechanism implemented by the KR module.

PARAMETERS

KRSPHandle (input)

The handle of the KR module to perform this operation.

KeyRecoveryContext (input/optional)

The handle that describes the context for the key recovery operation.

CryptoContext (input/optional)

The handle that describes the context for a cryptographic operation. The cryptographic context specifies the handle of the cryptographic service provider (CSP) that must be used to perform the operation. If no cryptographic context is specified, the KR module uses an assumed context, if required.

PassThroughId (input)

An identifier assigned by the KR module to indicate the exported function to perform.

InputParams (input)

A pointer to the CSSM_DATA structure containing parameters to be interpreted in a function-specific manner by the requested KR module. This parameter can be used as a pointer to an array of CSSM_DATA_PTRs.

RETURN VALUES

A pointer to the CSSM_DATA structure containing the output from the pass-through function. The output data must be interpreted by the calling application based on externally available information. If the pointer is NULL, an error has occurred.

ERRORS

CSSM_INVALID_KR_HANDLE

Invalid KR handle.

CSSM_KR_INVALID_CC_HANDLE

Invalid crypto context handle.

CSSM_KR_INVALID_KRC_HANDLE

Invalid key recovery context handle.

CSSM_KR_INVALID_OP_ID

Invalid operation ID.

CSSM_KR_INVALID_POINTER

Invalid pointer to input data.

CSSM_MEMORY_ERROR

Error in allocating memory.

CSSM_KR_PASS_THROUGH_FAIL

Unable to perform pass through.

CSSM_FUNCTION_NOT_IMPLEMENTED

Function not implemented.