PassThrough

NAME

CSSM_CSP_PassThrough, CSP_PassThrough — Extend crypto functionality (CDSA)

SYNOPSIS

# include <cssm.h>

API:
CSSM_RETURN CSSMAPI CSSM_CSP_PassThrough
(CSSM_CC_HANDLE CCHandle,
uint32 PassThroughId,
const void *InData,
void **OutData)
SPI:
CSSM_RETURN CSSMCSPI CSP_PassThrough
(CSSM_CSP_HANDLE CSPHandle,
CSSM_CC_HANDLE CCHandle,
const CSSM_CONTEXT *Context,
uint32 PassThroughId,
const void *InData,
void **OutData)

LIBRARY

Common Security Services Manager library (cdsa$incssm300_shr.exe)

API PARAMETERS

`CCHandle` (`input`)		The handle that describes the context of this cryptographic operation.
`PassThroughId` (`input`)
		An identifier specifying the custom function to be performed.
`InData` (`input`)		A pointer to a module, implementation-specific structure containing the input data.
`OutData` (`output`)		A pointer to a module, implementation-specific structure containing the output data. The service provider will allocate the memory for this structure. The application should free the memory for the structure.

SPI PARAMETERS

`CSPHandle` (`input`)
		Handle of the CSP supporting the `PassThrough` function.
`Context` (`input`)		Pointer to CSSM_CONTEXT structure that describes the attributes with this custom context structure.

DESCRIPTION

The CSSM_CSP_PassThrough() (CSSM API), or CSP_PassThrough() (CSP SPI), function is provided to allow CSP developers to extend the crypto functionality of the CSSM API.

NOTES

The CSP_EventNotify() function is used by the CSSM Core to interact with the CSP module.

Because this function is only exposed to CSSM as a function pointer, the function name internal to the CSP can be assigned at the discretion of the CSP module developer. However, the parameter list and return value types must match those defined for this function.

The error codes given in this section constitute the generic error codes, which may be used by all CSP libraries to describe common error conditions. CSP module developers may also define their own module-specific error codes.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particular error condition. The value CSSM_OK indicates success. All other values represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_CSP_INVALID_PASSTHROUGH_ID

PassThrough

» Table of Contents

» Glossary

» Index