CL_IsCertInCachedCrl

If both a Table of Contents and Search form are not displayed in separate frames along with this one, you may wish to redisplay this book in a frameset, beginning with the first page.

HP Open Source Security for OpenVMS Volume 1:...

API Functions

CL_FreeFieldValue

CL_IsCertInCrl

CL_IsCertInCachedCrl

Library
Description
Errors

Parameters
Return Value
See Also

NAME

CL_IsCertInCachedCrl: CSSM_CL_IsCertInCachedCrl - Search cached CRL for a record (CDSA)

SYNOPSIS

# include <cssm.h>

API:CSSM_RETURN CSSMAPI CSSM_CL_IsCertInCachedCrl(CSSM_CL_HANDLE CLHandle,const CSSM_DATA *Cert,CSSM_HANDLE CrlHandle,CSSM_BOOL *CertFound,CSSM_DATA_PTR CrlRecordIndex)SPI:CSSM_RETURN CSSMCLI CL_IsCertInCachedCrl(CSSM_CL_HANDLE CLHandle,const CSSM_DATA *Cert,CSSM_HANDLE CrlHandle,CSSM_BOOL *CertFound,CSSM_DATA_PTR CrlRecordIndex)

LIBRARY

Common Security Services Manager library (cdsa$incssm300_shr.exe)

PARAMETERS

`CLHandle` (input)
		The handle that describes the add-in CertificateLibrary module used to perform this function.
`Cert` (input)		A pointer to the CSSM_DATA structure containingan encoded, packed certificate.
`CrlHandle` (input)
		A handle identifying a CRL that the applicationhas temporarily cached with the Certificate Library module. Thereferenced CRL is searched for a revocation record matching the specified `Cert`.
`CertFound` (output)
		A pointer to a CSSM_BOOL indicating success or failurein finding the specified certificate in the CRL. CSSM_TRUE signifiesthat the certificate was found in the CRL. CSSM_FALSE indicatesthat the certificate was not found in the CRL.
`CrlRecordIndex` (output)
		A pointer to a CSSM_DATA structure containing anindex descriptor for direct access to the located CRL record. `CrlRecordIndex->Data` isallocated by the service provider and must be deallocated by theapplication.

DESCRIPTION

This function searches the cached CRL for a record correspondingto the certificate. The result of the search is returned in CertFound.The CRL and the records within the CRL must be digitally signed.This function does not verify either signature. The caller shoulduse CSSM_TP_CrlVerify() or CSSM_CL_CrlVerify() (or their SPI equivalents) before invoking this function.Once the CRL has been verified, the caller can invoke this functionrepeatedly without repeating the verification process.

If the certificate is found in the CRL, the CL module returnsan index descriptor CrlRecordIndex for use withother Certificate Library CRL functions. The index provides moredirect access to the selected CRL record.

RETURN VALUE

A CSSM_RETURN value indicating success or specifying a particularerror condition. The value CSSM_OK indicates success. All othervalues represent an error condition.

ERRORS

Errors are described in the CDSA Technical Standard.

CSSMERR_CL_INVALID_CERT_POINTERCSSMERR_CL_UNKNOWN_FORMATCSSMERR_CL_INVALID_CACHE_HANDLE