HP Open Source Security for OpenVMS Volume 1: Common Data Security Architecture > CDSA API Functions

CL_CertCache

 » Table of Contents

 » Glossary

 » Index

NAME

CSSM_CL_CertCache — Cache a copy of a certificate (CDSA)

SYNOPSIS

# include <cssm.h>
API:
CSSM_RETURN CSSMAPI CSSM_CL_CertCache
(CSSM_CL_HANDLE CLHandle,
const CSSM_DATA *Cert,
CSSM_HANDLE_PTR CertHandle)
SPI:
CSSM_RETURN CSSMAPI CSSM_CL_CertCache
(CSSM_CL_HANDLE CLHandle,
const CSSM_DATA *Cert,
CSSM_HANDLE_PTR CertHandle)

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.

Cert (input) 

A pointer to the CSSM_DATA structure containing the encoded certificate.

CertHandle (output)
  

A pointer to the CSSM_HANDLE that should be used in all future references to the cached certificate.

DESCRIPTION

This function caches a copy of a certificate for subsequent accesses using the functions CSSM_CL_CertGetFirstCachedFieldValue() (CSSM API), or CL_CertGetFirstCachedFieldValue() (CL SPI), and CSSM_CL_CertGetNextCachedFieldValue() (CSSM API), or CL_CertGetNextCachedFieldValue() (CL SPI).

The input certificate must be in an encoded representation. The Certificate Library module can cache the certificate 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_CertAbortCache() (CSSM API), or CL_CertAbortCache() (CL SPI), to remove the cached copy when additional get operations will not be performed on the cached certificate.

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.

CSSMERR_CL_INVALID_CERT_POINTER
CSSMERR_CL_UNKNOWN_FORMAT

SEE ALSO

Books

Intel CDSA Application Developer's Guide

Online Help

Functions for the CSSM API:

CSSM_CL_CertGetFirstCachedFieldValue, CSSM_CL_CertGetNextCachedFieldValue, CSSM_CL_CertAbortQuery, CSSM_CL_CertAbortCache

Functions for the CLI SPI:

CL_CertGetFirstCachedFieldValue, CL_CertGetNextCachedFieldValue, CL_CertAbortQuery, CL_CertAbortCache