CL_CrlCache

NAME

  CL_CrlCache,
  CSSM_CL_CrlCache - Cache a copy of a certificate revocation
                     list (CDSA)

SYNOPSIS

  # include <cssm.h>

   API:
       CSSM_RETURN CSSMAPI CSSM_CL_CrlCache
       (CSSM_CL_HANDLE CLHandle,
       const CSSM_DATA *Crl,
       CSSM_HANDLE_PTR CrlHandle)

   SPI:
       CSSM_RETURN CSSMCLI CL_CrlCache
       (CSSM_CL_HANDLE CLHandle,
       const CSSM_DATA *Crl,
       CSSM_HANDLE_PTR CrlHandle)

LIBRARY

  Common Security Services Manager library (CDSA$INCSSM300_SHR.EXE)

PARAMETERS

  CLHandle (input)
          The handle that describes the certificate library module used
          to perform this function.

  Crl (input)
          A pointer to the CSSM_DATA structure containing the encoded
          CRL.

  CrlHandle (output)
          A pointer to the CSSM_HANDLE that should be used in all future
          references to the cached CRL.

DESCRIPTION

  This function caches a copy of a CertificateRevocationList (CRL) for
  subsequent accesses using the functions CSSM_CL_CrlGetFirstFieldValue()
  and CSSM_CL_CrlGetNextFieldValue() (or their CL SPI equivalents).

  The input CRL must be in an encoded representation. The Certificate
  Library module can cache the CRL in any appropriate internal
  representation.  Parsed or incrementally parsed representations are
  common. The selected representation is opaque to the caller.

  The application must call CSSM_CL_CrlCacheAbort() (CSSM API), or
  CL_CrlCacheAbort() (CL SPI), to remove the cached copy when additional
  get operations will not be performed on the cached CRL.

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_CL_INVALID_CRL_POINTER
       CSSMERR_CL_UNKNOWN_FORMAT

SEE ALSO

  Books

  Intel CDSA Application Developer's Guide (see CDSA)

  Other Help Topics

  Functions for the CSSM API:

      CSSM_CL_CrlGetFirstCachedFieldValue
      CSSM_CL_CrlGetNextCachedFieldValue
      CSSM_CL_IsCertInCachedCrl
      CSSM_CL_CrlAbortQuery
      CSSM_CL_CrlAbortCache

  Functions for the CLI SPI:

      CL_CrlGetFirstCachedFieldValue
      CL_CrlGetNextCachedFieldValue
      CL_IsCertInCachedCrl
      CL_CrlAbortQuery
      CL_CrlAbortCache