Index for Section 3

Alphabetical listing for E

Bottom of page

EncryptDataFinal(3)
NAME
  EncryptDataFinal, CSSM_EncryptDataFinal, CSP_EncryptDataFinal - Finalize
  staged encryption process (CDSA)

SYNOPSIS
  # include <cdsa/cssm.h>

       API:
       CSSM_RETURN CSSMAPI CSSM_EncryptDataFinal
       (CSSM_CC_HANDLE CCHandle,
       CSSM_DATA_PTR RemData)
       SPI:
       CSSM_RETURN CSSMCSPI CSP_EncryptDataFinal
       (CSSM_CSP_HANDLE CSPHandle,
       CSSM_CC_HANDLE CCHandle,
       CSSM_DATA_PTR RemData)

LIBRARY
  Common Security Services Manager library (libcssm.so)

API PARAMETERS
  CCHandle (input)
	  The handle that describes the context of this cryptographic
	  operation used to link to the CSP-managed information.

  RemData (output)
	  A pointer to the CSSM_DATA structure for the last encrypted block
	  containing padded data, if necessary.

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.

DESCRIPTION
  This function finalizes the staged encryption process by returning any
  remaining cipher text not returned in the previous staged encryption call.
  The cipher text is returned in a single buffer.

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.

NOTES FOR SPI
  The output is returned to the caller as specified in	Buffer Management for
  Cryptographic Services.

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.	See CDSA_intro(3).

       CSSMERR_CSP_BLOCK_SIZE_MISMATCH
       CSSMERR_CSP_OUTPUT_LENGTH_ERROR

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_EncryptDataP(3),
  CSSM_EncryptDataInitP(3), CSSM_DecryptP(3), CSSM_DecryptDataInitP(3)

  Functions for the CSP SPI:

  CSP_EncryptData(3), CSP_EncryptDataInit(3), CSP_EncryptDataUpdate(3)

Index for Section 3

Alphabetical listing for E

Top of page