|
 HP Open Source Security for OpenVMS Volume 1:... |
 API Functions |
|
|
| |
| Library Description Errors | Parameters Return Value See Also |
API:CSSM_RETURN CSSMAPI CSSM_CL_CrlGetFirstCachedFieldValue(CSSM_CL_HANDLE CLHandle,CSSM_HANDLE CrlHandle,const CSSM_DATA *CrlRecordIndex,const CSSM_OID *CrlField,CSSM_HANDLE_PTR ResultsHandle,uint32 *NumberOfMatchedFields,CSSM_DATA_PTR *FieldValue)SPI:CSSM_RETURN CSSMCLI CL_CrlGetFirstCachedFieldValue(CSSM_CL_HANDLE CLHandle,CSSM_HANDLE CrlHandle,const CSSM_DATA *CrlRecordIndex,const CSSM_OID *CrlField,CSSM_HANDLE_PTR ResultsHandle,uint32 *NumberOfMatchedFields,CSSM_DATA_PTR *FieldValue)
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. | |
CrlHandle (input) | ||
| A handle identifying a CRL that the applicationhas temporarily cached with the Certificate Library module. Thereferenced CRL is searched for the field values identified by CrlField. | |
CrlRecordIndex (input/optional) | ||
| An index value identifying a particular revocationrecord in a cached CRL. If an index value is supplied, the scanfor the field values identified by CrlField islimited to the preselected revocation record. | |
CrlField (input) | ||
| A pointer to an object identifier that identifiesthe field value to be extracted from the CRL. | |
ResultsHandle (output) | ||
| A pointer to the CSSM_HANDLE that should be usedto obtain any additional matching fields. | |
NumberOfMatchedFields (output) | ||
| The total number of fields that match the CrlField OID.This count includes the first match, which was returned by thisfunction. | |
FieldValue (output) | ||
| A pointer to the structure containing the valueof the requested field. The structure and the field at I"(*FieldValue)->Data" are allocated by the serviceprovider. The CSSM_CL_FreeFieldValue() (CSSM API), or CL_FreeFieldValue() (CL SPI), function can be used to deallocate *FieldValue and (*FieldValue)->Data. | |
DESCRIPTION This function returns a single structure containing a setof field values from the cached CRL identified by CrlHandle parameter.The selected fields are designated by the CSSM_OID CrlField parameterand returned in the output parameter FieldValue.The OID also identifies the data format of the values returned tothe caller. If multiple OIDs designate the same CRL field, theneach such OID defines a distinct data format for the returned values.The function CSSM_CL_CrlDescribeFormat() (CSSM API), or CL_CrlDescribeFormat() (CL SPI), provides a list of all CSSM_OID values supportedby a CL module for naming fields of a CRL.The search can be limited to a particular revocation recordwithin the CRL. A single record is identified by the CrlRecordIndex parameter,which is returned by the function CSSM_CL_IsCertInCachedCrl() (CSSM API), or CL_IsCertInCachedCrl() (CL SPI). If no record index is supplied, the searchis initiated from the beginning of the CRL.
The CRL can be signed or unsigned. This function does notperform any signature verification on the CRL fields or the CRLrecords. Each CRL record can be digitally signed when it is addedto the CRL using the function CSSM_CL_CrlAddCert() (CSSM API), or CL_CrlAddCert() (CL SPI). The caller can examine fields in the CRL andCRL records at any time using this function.
The CrlField OID can identify a singleoccurrence of a set of CRL fields or multiple occurrences of a setof CRL fields. If the CrlField OID matches morethan one occurrence, this function outputs the total number of matchesand a ResultsHandle to be used as input to CSSM_CrlGetNextFieldValue() (CSSM API), or CrlGetNextFieldValue() (CL SPI), to retrieve the remaining matches. The firstmatch is returned as the return value of this function.
This function determines the complete set of matches. Thenumber of matches and the selected field values do not change betweenthis function and subsequent calls to CSSM_CL_CrlGetNextFieldValue() (CSSM API), or CL_CrlGetNextFieldValue() (CL SPI).
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_CACHE_HANDLECSSMERR_CL_INVALID_CRL_INDEXCSSMERR_CL_UNKNOWN_TAGCSSMERR_CL_NO_FIELD_VALUES
SEE ALSO BooksIntel CDSA Application Developer's Guide
Functions for the CSSM API:
CSSM_CL_CrlGetNextCachedFieldValue, CSSM_CL_IsCertInCachedCrl, CSSM_CL_CrlAbortQuery, CSSM_CL_CrlCache, CSSM_CL_CrlAbortCache, CSSM_CL_CrlDescribeFormat, CSSM_CL_FreeFieldValue
Functions for the CLI SPI:
CL_CrlGetNextCachedFieldValue, CL_IsCertInCachedCrl, CL_CrlAbortQuery, CL_CrlCache, CL_CrlAbortCache, CL_CrlDescribeFormat, CL_FreeFieldValue
|
|