RSA Security logo

RSA BSAFE Cert-C
API Reference

pkicfmsg.h File Reference

This file defines the PKI certificate confirmation object.

#include "basetype.h"
#include "bsafe.h"
#include "certext.h"
#include "certapi.h"
#include "certalg.h"
#include "pkistinf.h"
#include "pkimsg.h"

Go to the source code of this file.

Defines

#define PKI_CERT_CONF_ACCEPT
 Value 0. More...

#define PKI_CERT_CONF_REJECT
 Value 1. More...


Typedefs

typedef POINTER PKI_CERT_CONF_REQ_OBJ
 Represents a confirmation to the CA/RA to accept or reject an issued certificate. More...

typedef POINTER PKI_CERT_CONF_RESP_OBJ
 Represents a confirmation to the client to indicate acceptance of the certificate confirmation request. More...


Functions

int C_CreatePKICertConfReqObject (CERTC_CTX ctx, PKI_CERT_CONF_REQ_OBJ *pPKICertConfReqObj)
 Creates a certificate confirmation request object. More...

void C_DestroyPKICertConfReqObject (PKI_CERT_CONF_REQ_OBJ *pPKICertConfReqObj)
 Frees memory used by a certificate confirmation request object. More...

int C_SetPKICertConfReqConfirmStatus (PKI_CERT_CONF_REQ_OBJ PKICertConfReqObj, int confirmStatus)
 Sets the confirmation status of a Certificate Confirmation Request Object. More...

int C_GetPKICertConfReqConfirmStatus (PKI_CERT_CONF_REQ_OBJ PKICertConfReqObj, int *pConfirmStatus)
 Gets the confirmation status from a certificate confirmation request object. More...

int C_SetPKICertConfReqStatus (PKI_CERT_CONF_REQ_OBJ PKICertConfReqObj, PKI_STATUS_INFO_OBJ PKIStatusObj)
 Sets the status information of a certificate confirmation request oObject. More...

int C_GetPKICertConfReqStatus (PKI_CERT_CONF_REQ_OBJ PKICertConfReqObj, PKI_STATUS_INFO_OBJ *pPKIStatusObj)
 Gets status information from a certificate confirmation request object. More...

int C_SetPKICertConfReqCertReqId (PKI_CERT_CONF_REQ_OBJ PKICertConfReqObj, ITEM *pCertReqID)
 Sets the certificate request ID of a certificate confirmation request object. More...

int C_GetPKICertConfReqCertReqId (PKI_CERT_CONF_REQ_OBJ PKICertConfReqObj, ITEM *pCertReqId)
 Gets the certificate request ID from a certificate confirmation request object. More...

int C_SetPKICertConfReqCert (PKI_CERT_CONF_REQ_OBJ PKICertConfReqObj, CERT_OBJ certObj)
 Sets the certificate to confirm in a certificate confirmation request object. More...

int C_GetPKICertConfReqCert (PKI_CERT_CONF_REQ_OBJ PKICertConfReqObj, CERT_OBJ *pCertObj)
 Gets the certificate needed to confirm from a certificate confirmation request object. More...

int C_CreatePKICertConfRespObject (CERTC_CTX ctx, PKI_CERT_CONF_RESP_OBJ *pPKICertConfRespObj)
 Creates a certificate confirmation response object. More...

void C_DestroyPKICertConfRespObject (PKI_CERT_CONF_RESP_OBJ *pPKICertConfRespObj)
 Frees memory used by a certificate confirmation response object. More...

Define Documentation

#define PKI_CERT_CONF_ACCEPT
 

Value 0. Indicates confirmation acceptance.

#define PKI_CERT_CONF_REJECT
 

Value 1. Indicates confirmation rejection.

Typedef Documentation

typedef POINTER PKI_CERT_CONF_REQ_OBJ
 

Represents a confirmation to the CA/RA to accept or reject an issued certificate. Use a Cert-C function to view or modify information in a PKI_CERT_CONF_REQ_OBJ object. Do not assume that the PKI_CERT_CONF_REQ_OBJ object points to any specific information. Some examples of the functions that Cert-C provides to work with a PKI certificate-confirmation request object are listed in the following table.

Function Description
C_CreatePKICertConfReqObject() Creates a certificate-confirmation request object.
C_DestroyPKICertConfReqObject() Destroys the PKI certificate-confirmation request object and frees any memory associated with it.
C_SetPKICertConfReqCert() Sets the certificate to confirm in a certificate-confirmation request object.
C_SetPKICertConfReqCertReqId() Sets the certificate-request ID of a certificate-confirmation request object.
C_SetPKICertConfReqConfirmStatus() Sets the confirmation status of a certificate-confirmation request object.
C_SetPKICertConfReqStatus() Sets the status information of a certificate-confirmation request object.
C_GetPKICertConfReqCert() Gets the certificate needed to confirm from a certificate-confirmation request object.
C_GetPKICertConfReqCertReqId() Gets the certificate-request ID from a certificate-confirmation request object.
C_GetPKICertConfReqConfirmStatus() Gets the confirmation status from a certificate-confirmation request object.
C_GetPKICertConfReqStatus() Gets status info from a certificate-confirmation request object.

typedef POINTER PKI_CERT_CONF_RESP_OBJ
 

Represents a confirmation to the client to indicate acceptance of the certificate confirmation request. In Cert-C 2.5, supported certificate confirmation response messages do not actually contain any information. Use a Cert-C function to view or modify information in a PKI_CERT_CONF_RESP_OBJ object. Do not assume that the PKI_CERT_CONF_RESP_OBJ object points to any specific information. Some examples of the functions that Cert-C provides to work with a PKI certificate-confirmation response object are listed in the following table.

Function Description
C_CreatePKICertConfRespObject() Creates a certificate-confirmation response object.
C_DestroyPKICertConfRespObject() Destroys the PKI certificate-confirmation response object and frees any memory associated with it.

Function Documentation

int C_CreatePKICertConfReqObject (  CERTC_CTX    ctx,
PKI_CERT_CONF_REQ_OBJ *    pPKICertConfReqObj
)  ;
 

Creates a certificate confirmation request object.

Parameters:
ctx This input parameter is the Cert-C context.
pPKICertConfReqObj This input/output parameter is a pointer to the PKI certificate confirmation request object.
Returns:
If successful, returns 0. If not, returns a Cert-C error code.

int C_CreatePKICertConfRespObject (  CERTC_CTX    ctx,
PKI_CERT_CONF_RESP_OBJ *    pPKICertConfRespObj
)  ;
 

Creates a certificate confirmation response object.

Parameters:
ctx This input parameter is the Cert-C context.
pPKICertConfRespObj This input/output parameter is a pointer to the PKI certificate confirmation response object.
Returns:
If successful, returns 0. If not, returns a Cert-C error code.

void C_DestroyPKICertConfReqObject (  PKI_CERT_CONF_REQ_OBJ *    pPKICertConfReqObj )  ;
 

Frees memory used by a certificate confirmation request object.

Parameters:
pPKICertConfReqObj This input/output parameter is a pointer to the PKI certificate confirmation request object.
Returns:
None.

void C_DestroyPKICertConfRespObject (  PKI_CERT_CONF_RESP_OBJ *    pPKICertConfRespObj )  ;
 

Frees memory used by a certificate confirmation response object.

Parameters:
pPKICertConfRespObj This input/output parameter is a pointer to the PKI certificate confirmation response object to destroy.
Returns:
None.

int C_GetPKICertConfReqCert (  PKI_CERT_CONF_REQ_OBJ    PKICertConfReqObj,
CERT_OBJ *    pCertObj
)  ;
 

Gets the certificate needed to confirm from a certificate confirmation request object.

Parameters:
PKICertConfReqObj This input parameter is the PKI certificate confirmation request object.
pCertObj This output parameter is the certificate to confirm.
Returns:
If successful, returns 0. If not, returns a Cert-C error code.

int C_GetPKICertConfReqCertReqId (  PKI_CERT_CONF_REQ_OBJ    PKICertConfReqObj,
ITEM *    pCertReqId
)  ;
 

Gets the certificate request ID from a certificate confirmation request object.

Parameters:
PKICertConfReqObj This input parameter is the PKI certificate confirmation request object.
pCertReqId This output parameter is the certificate request ID.
Returns:
If successful, returns 0. If not, returns a Cert-C error code.

int C_GetPKICertConfReqConfirmStatus (  PKI_CERT_CONF_REQ_OBJ    PKICertConfReqObj,
int *    pConfirmStatus
)  ;
 

Gets the confirmation status from a certificate confirmation request object.

Parameters:
PKICertConfReqObj This input parameter is the PKI certificate confirmation request object.
pConfirmStatus This output parameter is a pointer to the confirmation status.
Returns:
If successful, returns 0. If not, returns a Cert-C error code.

int C_GetPKICertConfReqStatus (  PKI_CERT_CONF_REQ_OBJ    PKICertConfReqObj,
PKI_STATUS_INFO_OBJ *    pPKIStatusObj
)  ;
 

Gets status information from a certificate confirmation request object.

Parameters:
PKICertConfReqObj This input parameter is the PKI certificate confirmation request object.
pPKIStatusObj This output parameter is a pointer to the PKI status information object.
Returns:
If successful, returns 0. If not, returns a Cert-C error code.

int C_SetPKICertConfReqCert (  PKI_CERT_CONF_REQ_OBJ    PKICertConfReqObj,
CERT_OBJ    certObj
)  ;
 

Sets the certificate to confirm in a certificate confirmation request object.

Parameters:
PKICertConfReqObj This input/output parameter is the PKI certificate confirmation request object.
certObj This input parameter is the certificate to confirm.
Returns:
If successful, returns 0. If not, returns a Cert-C error code.

int C_SetPKICertConfReqCertReqId (  PKI_CERT_CONF_REQ_OBJ    PKICertConfReqObj,
ITEM *    pCertReqID
)  ;
 

Sets the certificate request ID of a certificate confirmation request object.

Parameters:
PKICertConfReqObj This input/output parameter is the PKI certificate confirmation request object.
pCertReqID This input parameter is a pointer to the certificate request ID.
Returns:
If successful, returns 0. If not, returns a Cert-C error code.

int C_SetPKICertConfReqConfirmStatus (  PKI_CERT_CONF_REQ_OBJ    PKICertConfReqObj,
int    confirmStatus
)  ;
 

Sets the confirmation status of a Certificate Confirmation Request Object.

Parameters:
PKICertConfReqObj This input/output parameter is a pointer to the PKI certificate confirmation request object.
confirmStatus This input parameter is the confirmation status.
Returns:
If successful, returns 0. If not, returns a Cert-C error code.

int C_SetPKICertConfReqStatus (  PKI_CERT_CONF_REQ_OBJ    PKICertConfReqObj,
PKI_STATUS_INFO_OBJ    PKIStatusObj
)  ;
 

Sets the status information of a certificate confirmation request oObject.

Parameters:
PKICertConfReqObj This input/output parameter is the PKI certificate confirmation request object.
PKIStatusObj This input parameter is the PKI status information object.
Returns:
If successful, returns 0. If not, returns a Cert-C error code.


RSA BSAFE® Cert-C 2.7 API Reference