EncryptDataUpdate(3)EncryptDataUpdate(3)NAME
EncryptDataUpdate, CSSM_EncryptDataUpdate, CSP_EncryptDataUpdate - Con‐
tinue the staged encryption process (CDSA)
SYNOPSIS
# include <cdsa/cssm.h>
API: CSSM_RETURN CSSMAPI CSSM_EncryptDataUpdate (CSSM_CC_HANDLE CCHan‐
dle, 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 ClearBuf‐
Count, CSSM_DATA_PTR CipherBufs, uint32 CipherBufCount, uint32 *bytes‐
Encrypted)
LIBRARY
Common Security Services Manager library (libcssm.so)
API PARAMETERS
The handle that describes the context of this cryptographic operation
used to link to the CSP-managed information. A pointer to a vector of
CSSM_DATA structures that contain the data to be operated on. The num‐
ber of ClearBufs. A pointer to a vector of CSSM_DATA structures that
contain the encrypted data resulting from the encryption operation.
The number of CipherBufs. A pointer to uint32 for the size of the
encrypted data in bytes.
SPI PARAMETERS
The handle that describes the add-in cryptographic service provider
module used to perform calls to CSSM for the memory functions managed
by CSSM.
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 out‐
put buffers. The CSSM_QuerySize() function can be used to estimate the
output buffer size required for each update call.
RETURN VALUE
A CSSM_RETURN value indicating success or specifying a particular error
condition. The value CSSM_OK indicates success. All other values repre‐
sent an error condition.
ERRORS
Errors are described in the CDSA technical standard. See
CDSA_intro(3).
None specific to this call.
NOTES FOR API
The output is returned to the caller either by filling the caller-spec‐
ified 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 out‐
put 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.
NOTES FOR SPI
The output is returned to the caller as specified in Buffer Management
for Cryptographic Services.
SEE ALSO
Books
Intel CDSA Application Developer's Guide (see CDSA_intro(3))
Reference Pages
Functions for the CSSM API:
CSSM_QuerySize(3), CSSM_DecryptData(3), CSSM_EncryptDataInit(3),
CSSM_EncryptDataUpdate(3), CSSM_EncryptDataFinal(3), CSSM_Encrypt‐
DataP(3), CSSM_EncryptDataInitP(3), CSSM_DecryptP(3), CSSM_Decrypt‐
DataInitP(3)
Functions for the CSP SPI:
CSP_QuerySize(3), CSP_DecryptData(3), CSP_EncryptDataInit(3),
CSP_EncryptDataFinal(3)EncryptDataUpdate(3)