NAME

TP_CertReclaimAbort, CSSM_TP_CertReclaimAbort − Terminate the process of reclaiming certificates (CDSA)

SYNOPSIS

# include <cdsa/cssm.h>

API:
CSSM_RETURN CSSMAPI CSSM_TP_CertReclaimAbort
(CSSM_TP_HANDLE TPHandle,
CSSM_LONG_HANDLE KeyCacheHandle)
SPI:
CSSM_RETURN CSSMTPI TP_CertReclaimAbort
(CSSM_TP_HANDLE TPHandle,
CSSM_LONG_HANDLE KeyCacheHandle)

LIBRARY

Common Security Services Manager library (libcssm.so)

PARAMETERS

TPHandle (input)
The handle that describes the service provider module used to perform this function.

KeyCacheHandle (input)
An opaque handle that identifies the cache of protected private keys reclaimed from a certificate authority for potentially recovery on the local system.

DESCRIPTION

This function terminates the iterative process of reclaiming certificates and recovering their associated private keys from a protected key cache. This function must be called even if all private keys are recovered from the cache.  This function destroys all intermediate state and secret information used during the reclamation process. At completion of this function, the cache handle is invalid. 

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_intro(3). 

CSSMERR_TP_INVALID_KEYCACHE_HANDLE

SEE ALSO

Books

Intel CDSA Application Developer’s Guide (see CDSA_intro(3))

Reference Pages

Functions for the CSSM API:

CSSM_TP_CertReclaimKey(3)

Functions for the TP SPI:

TP_CertReclaimKey(3)