EncryptDataFinal

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

SYNOPSIS
  # include <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 (CDSA$INCSSM300_SHR.EXE)

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.

       CSSMERR_CSP_BLOCK_SIZE_MISMATCH
       CSSMERR_CSP_OUTPUT_LENGTH_ERROR

SEE ALSO
  Books

  Intel CDSA Application Developer's Guide (see CDSA)

  Other Help Topics

  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_EncryptData
      CSP_EncryptDataInit
      CSP_EncryptDataUpdate