skip book previous and next navigation links
go up to top of book: HP Open Source Security for OpenVMS Volume 1:... HP Open Source Security for OpenVMS Volume 1:...
go to beginning of reference: API FunctionsAPI Functions
go to previous page: DecryptDataPDecryptDataP
go to next page: DeriveKeyDeriveKey
end of book navigation links


DecryptDataUpdate
Library
Spi Parameter
Notes For Api
Return Value
See Also
 Api Parameters
Description
Notes For Spi
Errors

NAME

DecryptDataUpdate: CSSM_DecryptDataUpdate, CSP_DecryptDataUpdate - Continue the staged decryption process (CDSA)

SYNOPSIS  

# include <cssm.h>

API:CSSM_RETURN CSSMAPI CSSM_DecryptDataUpdate(CSSM_CC_HANDLE CCHandle,const CSSM_DATA *CipherBufs,uint32 CipherBufCount,CSSM_DATA_PTR ClearBufs,uint32 ClearBufCount,uint32 *bytesDecrypted)SPI:CSSM_RETURN CSSMCSPI CSP_DecryptDataUpdate(CSSM_CSP_HANDLE CSPHandle,CSSM_CC_HANDLE CCHandle,const CSSM_DATA *CipherBufs,uint32 CipherBufCount,CSSM_DATA_PTR ClearBufs,uint32 ClearBufCount,uint32 *bytesDecrypted)


return to top LIBRARY  

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


return to top API PARAMETERS  

CCHandle (input)
 The handle that describes the context of this cryptographicoperation used to link to the CSP-managed information.
CipherBufs (input)
 A pointer to a vector of CSSM_DATA structures thatcontain the data to be operated on.
CipherBufCount (input)
 The number of CipherBufs.
ClearBufs (output)
 A pointer to a vector of CSSM_DATA structures thatcontain the decrypted data resulting from the decryption operation.
ClearBufCount (input)
 The number of ClearBufs.
bytesDecrypted (output)
 A pointer to uint32 for the sizeof the decrypted data in bytes.


return to top SPI PARAMETER  

CSPHandle (input)
 The handle that describes the add-in CryptographicService Provider module used to perform calls to CSSM for the memoryfunctions managed by CSSM.


return to top DESCRIPTION  

This function continues the staged decryption process overall data in the set of input buffers. There can be algorithm-specificand token-specific rules restricting the lengths of data in CSSM_DecryptUpdate() calls, but multiple input buffers are supported. Theminimum number of buffers required to contain the resulting plain textis produced as output. Excess output buffer space is not rememberedacross staged decryption calls. Each staged call begins fillingone or more new output buffers. The CSSM_QuerySize() (CSSM API), or CSP_QuerySize() (CSP SPI), function can be used to estimate the outputbuffer size required for each update call.


return to top NOTES FOR API  

The output is returned to the caller either by filling thecaller-specified buffer or by using the application's declared memoryallocation functions to allocate buffer space. To specify a specific,preallocated output buffer, the caller must provide an array ofone or more CSSM_DATA structures, each containing a Length fieldvalue greater than zero and a non-NULL data pointer field value.To specify automatic output buffer allocation by the CSP, the callermust provide an array of one or more CSSM_DATA structures, eachcontaining a Length field value equal to zero and a NULL data pointerfield value. The application is always responsible for deallocatingthe memory when it is no longer needed. In-place decryption canbe done by supplying the same input and output buffers.


return to top NOTES FOR SPI  

The output is returned to the caller as specified in BufferManagement for Cryptographic Services.


return to top RETURN VALUE  

A CSSM_RETURN value indicating success or specifying a particularerror condition. The value CSSM_OK indicates success. All othervalues represent an error condition.


return to top ERRORS  

Errors are described in the CDSA Technical Standard.

None specific to this call.


return to top SEE ALSO  

Books

Intel CDSA Application Developer's Guide

Online Help

Functions for the CSSM API:

CSSM_QuerySize, CSSM_DecryptData, CSSM_DecryptDataInit, CSSM_DecryptDataFinal

Functions for the CSP SPI:

CSP_QuerySize, CSP_DecryptData, CSP_DecryptDataInit, CSP_DecryptDataFinal


go to previous page: DecryptDataPDecryptDataP
go to next page: DeriveKeyDeriveKey