Copyright Digital Equipment Corp. All rights reserved.

EncryptDataInit

NAME
  EncryptDataInit,
  CSSM_EncryptDataInit,
  CSP_EncryptDataInit  - Initialize the staged encrypt funciton (CDSA)

SYNOPSIS
  # include <cssm.h>

   API:
       CSSM_RETURN CSSMAPI CSSM_EncryptDataInit
       (CSSM_CC_HANDLE CCHandle)
   SPI:
       CSSM_RETURN CSSMCSPI CSP_EncryptDataInit
       (CSSM_CSP_HANDLE CSPHandle,
       CSSM_CC_HANDLE CCHandle,
       const CSSM_CONTEXT *Context,
       CSSM_PRIVILEGE Privilege)

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.

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.

  Context (input)
          Pointer to CSSM_CONTEXT structure that describes the
          attributes with this context.

  Privilege (input)
          The export privilege to be applied during the cryptographic
          operation. This parameter is forwarded to the CSP after CSSM
          verifies the caller and service provider privilege set
          includes the specified PRIVILEGE.

DESCRIPTION
  This function initializes the staged encrypt function. There may be
  algorithm-specific and token-specific rules restricting the lengths
  of data following data update calls making use of these parameters.

  The CSP can require that the cryptographic context include access
  credentials for authentication and authorization checks when using
  a private key or a secret key.

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.

  None specific to this call.

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_QuerySize
      CSP_DecryptData
      CSP_EncryptDataInit
      CSP_EncryptDataUpdate
      CSP_EncryptDataFinal