NAME

TP_PassThrough

SYNOPSIS

void * CSSMTPI TP_PassThrough
    (CSSM_TP_HANDLE TPHandle,
    CSSM_CL_HANDLE CLHandle,
    CSSM_CSP_HANDLE CSPHandle,
    const CSSM_DL_DB_LIST_PTR DBList,
    uint32 PassThroughId,
    const void * InputParams)

DESCRIPTION

This function allows clients to call Trust Policy module-specific operations that have been exported. Such operations may include queries or services specific to the domain represented by the TP module.

PARAMETERS

TPHandle (input)

The handle that describes the add-in trust policy module used to perform this function.

CLHandle (input/optional)

The handle that describes the add-in certificate library module used to perform this function.

CSPHandle (input/optional)

The handle that describes the add-in cryptographic service provider module used to perform this function.

DBList (input/optional)

A list of certificate databases containing certificates that may be used by the pass through operation.

PassThroughId (input)

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

InputParams (input/optional)

A pointer to the CSSM_DATA structure containing parameters to be interpreted in a function-specific manner by the TP module. If the passthrough function requires access to a private key located in the CSP referenced by CSPHandle, then the InputParams should contain a passphrase, callback or cryptographic context.

RETURN VALUE

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-defined information provided by the trust policy module vendor. If the pointer is NULL, an error has occurred. This function can also return errors specific to CSP, CL, and DL modules.

ERRORS

CSSM_INVALID_TP_HANDLE

Invalid handle.

CSSM_INVALID_CL_HANDLE

Invalid handle.

CSSM_INVALID_DL_HANDLE

Invalid handle.

CSSM_INVALID_DB_HANDLE

Invalid handle.

CSSM_TP_INVALID_DATA_POINTER

Invalid pointer for input data.

CSSM_TP_INVALID_ID

Invalid pass through ID.

CSSM_TP_MEMORY_ERROR

Error in allocating memory.

CSSM_TP_PASS_THROUGH_FAIL

Unable to perform pass-through.

CSSM_FUNCTION_NOT_IMPLEMENTED

Function not implemented.