RSA BSAFE Cert-C

RSA BSAFE Cert-C
API Reference

Cert-C Objects

Cert-C uses objects to store application information internally and to pass this information as arguments to callable Cert-C functions. The Cert-C objects are defined as pointers; they serve as abstractions for various collections of information. Although the details of an object are maintained internally by Cert-C, Cert-C API functions can be used to manipulate the information in the object. For example, without knowing how a certificate object, CERT_OBJ, is represented internally in the Cert-C library, the Cert-C API functions that operate on the CERT_OBJ object can be used to set and get information about the certificate.

The documentation for an object explains the nature of the object and how to use it. The documentation also describes some of the Cert-C API functions that operate on the object.

Cert-C objects usage follows a general pattern.

Create an object by calling one of the related functions.
Set the object with the desired information, or get information about an object that has already been set by either the application or by Cert-C.
Destroy the object when the object is no longer needed.

Refer to the individual function descriptions for an object’s value at the time of each function’s execution.

To get or set information about an object, use a C_Get* or C_Set* function. These functions enable access to an object’s information. Do not make any assumptions about the format of the data in a Cert-C object.

The following list is a quick guide to several common Cert-C objects. Click on an object name for detailed information.

Object Header File Summary

ATTRIBUTES_OBJ basetype.h Represents extra information about the certificate subject in a certification request. It is also used as a general mechanism for storing attribute types and values.

CERT_OBJ basetype.h Represents certificate information.

CRL_ENTRIES_OBJ basetype.h The part of the CRL_OBJ that represents the serial numbers, revocation times, and X.509 v3 CRL Entry extensions for each rovoked certificate.

CRL_OBJ basetype.h Represents Certificate Revocation List (CRL) information.

C_CMS_OBJ cmsobj.h Represents CMS message object.

EXTENSIONS_OBJ basetype.h Represents an X.509 v3 extension set that contains one or more extension entries.

LIST_OBJ basetype.h Represents a collection of abstract data types, including types defined by Cert-C and types defined by an application. For example, this object can contain a list of certificate objects or ITEMs.

NAME_OBJ basetype.h Represents the names of entities involved in a PKI.

PKCS10_OBJ pkcs10.h Represents PKCS #10 certificate request information.

PKI_CERT_CONF_REQ_OBJ pkicfmsg.h Represents a confirmation to the Ca/RA to accept or reject an issued certificate.

PKI_CERT_CONF_RESP_OBJ pkicfmsg.h Represents a confirmation to the client to indicate acceptance of the certificate confirmation request. In Cert-C 2.7, supported certificate confirmation response messages do not actually contain any information.

PKI_CERT_REQ_OBJ pkicrmsg.h Represents an initialization request or certificate request to a CA/Ra to request a certificate.

PKI_CERT_RESP_OBJ pkicrmsg.h Represents the initialization response or certification response back to the client.

PKI_CERT_TEMPLATE_OBJ pkictmsg.h Represents the template that specifies the information that goes into a certificate in the certificate request process.

PKI_ERROR_MSG_OBJ pkiermsg.h Represents PKI messaging error information.

PKI_KEY_UPDATE_REQ_OBJ pkikumsg.h Represents a key update request for a certificate to a CA/RA.

PKI_KEY_UPDATE_RESP_OBJ pkikumsg.h Represents the response back to the client after the client has sent a key update request.

PKI_MSG_OBJ pkimsg.h Represents certification, key update, certificate revocation, and key archival requests and responses, and any other information that might pass between a certification-requesting application and a CA or RA.

PKI_REVOKE_REQ_OBJ pkirvmsg.h Represents a revocation request to a CA/RA to revoke one or more certificates.

PKI_REVOKE_RESP_OBJ pkirvmsg.h Represents a response back to the client when the client has sent a revoke certificate request.

PKI_STATUS_INFO_OBJ pkistinf.h Reprsents encapsulated provider-specific status and failure information.

Object	Header File	Summary
ATTRIBUTES_OBJ	basetype.h	Represents extra information about the certificate subject in a certification request. It is also used as a general mechanism for storing attribute types and values.
CERT_OBJ	basetype.h	Represents certificate information.
CRL_ENTRIES_OBJ	basetype.h	The part of the `CRL_OBJ` that represents the serial numbers, revocation times, and X.509 v3 CRL Entry extensions for each rovoked certificate.
CRL_OBJ	basetype.h	Represents Certificate Revocation List (CRL) information.
C_CMS_OBJ	cmsobj.h	Represents CMS message object.
EXTENSIONS_OBJ	basetype.h	Represents an X.509 v3 extension set that contains one or more extension entries.
LIST_OBJ	basetype.h	Represents a collection of abstract data types, including types defined by Cert-C and types defined by an application. For example, this object can contain a list of certificate objects or `ITEM`s.
NAME_OBJ	basetype.h	Represents the names of entities involved in a PKI.
PKCS10_OBJ	pkcs10.h	Represents PKCS #10 certificate request information.
PKI_CERT_CONF_REQ_OBJ	pkicfmsg.h	Represents a confirmation to the Ca/RA to accept or reject an issued certificate.
PKI_CERT_CONF_RESP_OBJ	pkicfmsg.h	Represents a confirmation to the client to indicate acceptance of the certificate confirmation request. In Cert-C 2.7, supported certificate confirmation response messages do not actually contain any information.
PKI_CERT_REQ_OBJ	pkicrmsg.h	Represents an initialization request or certificate request to a CA/Ra to request a certificate.
PKI_CERT_RESP_OBJ	pkicrmsg.h	Represents the initialization response or certification response back to the client.
PKI_CERT_TEMPLATE_OBJ	pkictmsg.h	Represents the template that specifies the information that goes into a certificate in the certificate request process.
PKI_ERROR_MSG_OBJ	pkiermsg.h	Represents PKI messaging error information.
PKI_KEY_UPDATE_REQ_OBJ	pkikumsg.h	Represents a key update request for a certificate to a CA/RA.
PKI_KEY_UPDATE_RESP_OBJ	pkikumsg.h	Represents the response back to the client after the client has sent a key update request.
PKI_MSG_OBJ	pkimsg.h	Represents certification, key update, certificate revocation, and key archival requests and responses, and any other information that might pass between a certification-requesting application and a CA or RA.
PKI_REVOKE_REQ_OBJ	pkirvmsg.h	Represents a revocation request to a CA/RA to revoke one or more certificates.
PKI_REVOKE_RESP_OBJ	pkirvmsg.h	Represents a response back to the client when the client has sent a revoke certificate request.
PKI_STATUS_INFO_OBJ	pkistinf.h	Reprsents encapsulated provider-specific status and failure information.

RSA BSAFE^® Cert-C 2.7 API Reference