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 Functions API Functions
go to previous page: EncryptDataP EncryptDataP
go to next page: FreeKeyFreeKey
end of book navigation links


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

NAME

EncryptDataUpdate: CSSM_EncryptDataUpdate, CSP_EncryptDataUpdate - Continue the staged encryption process (CDSA)

SYNOPSIS  

# include <cssm.h>

API:
CSSM_RETURN CSSMAPI CSSM_EncryptDataUpdate
(CSSM_CC_HANDLE CCHandle,
const CSSM_DATA *ClearBufs,
uint32 ClearBufCount,
CSSM_DATA_PTR CipherBufs,
uint32 CipherBufCount,
uint32 *bytesEncrypted)
SPI:
CSSM_RETURN CSSMCSPI CSP_EncryptDataUpdate
(CSSM_CSP_HANDLE CSPHandle,
CSSM_CC_HANDLE CCHandle,
const CSSM_DATA *ClearBufs,
uint32 ClearBufCount,
CSSM_DATA_PTR CipherBufs,
uint32 CipherBufCount,
uint32 *bytesEncrypted)


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 cryptographic operation used to link to the CSP-managed information.
ClearBufs (input)
 A pointer to a vector of CSSM_DATA structures that contain the data to be operated on.
ClearBufCount (input)
 The number of ClearBufs.
CipherBufs (output)
 A pointer to a vector of CSSM_DATA structures that contain the encrypted data resulting from the encryption operation.
CipherBufCount (input)
 The number of CipherBufs.
bytesEncrypted (output)
 A pointer to uint32 for the size of the encrypted data in bytes.


return to top SPI PARAMETERS  

CSPHandle (input)
 The handle that describes the add-in Cryptographic Service Provider module used to perform calls to CSSM for the memory functions managed by CSSM.


return to top DESCRIPTION  

This function continues the staged encryption process over all data in the set of input buffers. There can be algorithm-specific and token-specific rules restricting the lengths of data in CSSM_EncryptUpdate() calls, but multiple input buffers are supported. The minimum number of buffers required to contain the resulting cipher text is produced as output. Excess output buffer space is not remembered across staged encryption calls. Each staged call begins filling one or more new output buffers. The CSSM_QuerySize() function can be used to estimate the output buffer size required for each update call.


return to top 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.


return to top ERRORS  

Errors are described in the CDSA Technical Standard.

None specific to this call.


return to top NOTES FOR API  

The output is returned to the caller either by filling the caller-specified buffer or by using the application's declared memory allocation functions to allocate buffer space. To specify a specific, preallocated output buffer, the caller must provide an array of one or more CSSM_DATA structures, each containing a Length field value greater than zero and a non-NULL Data pointer field value. To specify automatic output buffer allocation by the CSP, the caller must provide an array of one or more CSSM_DATA structures, each containing a Length field value equal to zero and a NULL data pointer field value. The application is always responsible for deallocating the memory when it is no longer needed. In-place encryption can be 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 Buffer Management for Cryptographic Services.


return to top SEE ALSO  

Books

Intel CDSA Application Developer's Guide

Online Help

Functions for the CSSM API:

CSSM_QuerySize, CSSM_DecryptData, CSSM_EncryptDataInit, CSSM_EncryptDataUpdate, CSSM_EncryptDataFinal, CSSM_EncryptDataP, CSSM_EncryptDataInitP, CSSM_DecryptP, CSSM_DecryptDataInitP

Functions for the CSP SPI:

CSP_QuerySize, CSP_DecryptData, CSP_EncryptDataInit, CSP_EncryptDataFinal


go to previous page: EncryptDataP EncryptDataP
go to next page: FreeKeyFreeKey