RSA BSAFE Cert-C API Reference

pkikumsg.h File Reference

This file defines PKI key update objects.

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

Go to the source code of this file.

Typedefs
typedef PKI_CERT_REQ_OBJ	PKI_KEY_UPDATE_REQ_OBJ
	Represents a key update request for a certificate to a CA/RA. More...
typedef PKI_CERT_RESP_OBJ	PKI_KEY_UPDATE_RESP_OBJ
	Represents the response back to the client after the client has sent a key update request. More...
Functions
int	C_CreatePKIKeyUpdateReqObject (CERTC_CTX ctx, PKI_KEY_UPDATE_REQ_OBJ *pPKIKeyUpdateReqObj)
	Creates and initializes a PKI key update request object. More...
void	C_DestroyPKIKeyUpdateReqObject (PKI_KEY_UPDATE_REQ_OBJ *pPKIKeyUpdateReqObj)
	Destroys a PKI key update request object. More...
int	C_CreatePKIKeyUpdateRespObject (CERTC_CTX ctx, PKI_KEY_UPDATE_RESP_OBJ *pPKIKeyUpdateRespObj)
	Creates and initializes a PKI key update response object. More...
void	C_DestroyPKIKeyUpdateRespObject (PKI_KEY_UPDATE_RESP_OBJ *pPKIKeyUpdateRespObj)
	Destroys a PKI key update response object. More...

---

Typedef Documentation

typedef PKI_CERT_REQ_OBJ PKI_KEY_UPDATE_REQ_OBJ

Represents a key update request for a certificate to a CA/RA. Use a Cert-C function to view or modify information in a PKI_KEY_UPDATE_REQ_OBJ object. Do not assume that the PKI_KEY_UPDATE_REQ_OBJ object points to any specific information. PKI_CERT_REQ_OBJ is the parent of PKI_KEY_UPDATE_REQ_OBJ. All Set and Get APIs that apply to PKI_CERT_REQ_OBJ also apply to PKI_KEY_UPDATE_REQ_OBJ. Some examples of the functions that Cert-C provides to work with a PKI key-update request object are listed in the following table. Function Description C_CreatePKIKeyUpdateReqObject() Creates and initializes a PKI key-update request object. C_DestroyPKIKeyUpdateReqObject() Destroys the PKI key-update request object and frees any memory associated with it.

typedef PKI_CERT_RESP_OBJ PKI_KEY_UPDATE_RESP_OBJ

Represents the response back to the client after the client has sent a key update request. Use this object to parse the key-update response received from the certificate server. PKI_CERT_RESP_OBJ is the parent of PKI_KEY_UPDATE_RESP_OBJ. All Set and Get APIs that apply to PKI_CERT_RESP_OBJ also apply to PKI_KEY_UPDATE_RESP_OBJ. Use a Cert-C function to view or modify information in a PKI_KEY_UPDATE_RESP_OBJ object. Do not assume that the PKI_KEY_UPDATE_RESP_OBJ object points to any specific information. Some examples of the functions that Cert-C provides to work with a PKI key-update response object are listed in the following table. Function Description C_CreatePKIKeyUpdateRespObject() Creates and initializes a PKI key-update response object. C_DestroyPKIKeyUpdateRespObject() Destroys the PKI key-update response object and frees any memory associated with it.

---

Function Documentation

int C_CreatePKIKeyUpdateReqObject (  CERTC_CTX    ctx, PKI_KEY_UPDATE_REQ_OBJ *    pPKIKeyUpdateReqObj )  ;

Creates and initializes a PKI key update request object. PKI_CERT_REQ_OBJ is the parent of PKI_KEY_UPDATE_REQ_OBJ. All Set and Get APIs that apply to PKI_CERT_REQ_OBJ also apply to PKI_KEY_UPDATE_REQ_OBJ. Parameters: ctx This input parameter is the Cert-C context. pPKIKeyUpdateReqObj This input/output parameter contains the key update request object. Returns: If successful, returns 0. If not, returns a Cert-C error code.

int C_CreatePKIKeyUpdateRespObject (  CERTC_CTX    ctx, PKI_KEY_UPDATE_RESP_OBJ *    pPKIKeyUpdateRespObj )  ;

Creates and initializes a PKI key update response object. PKI_CERT_RESP_OBJ is the parent of PKI_KEY_UPDATE_RESP_OBJ. All Set and Get APIs that apply to PKI_CERT_RESP_OBJ also apply to PKI_KEY_UPDATE_RESP_OBJ. Parameters: ctx This input parameter is the Cert-C context. pPKIKeyUpdateRespObj This input/output parameter contains the key update respond object. Returns: If successful, returns 0. If not, returns a Cert-C error code.

void C_DestroyPKIKeyUpdateReqObject (  PKI_KEY_UPDATE_REQ_OBJ *    pPKIKeyUpdateReqObj )  ;

Destroys a PKI key update request object. Parameters: pPKIKeyUpdateReqObj This input/output parameter contains the key update request object. Returns: None.

void C_DestroyPKIKeyUpdateRespObject (  PKI_KEY_UPDATE_RESP_OBJ *    pPKIKeyUpdateRespObj )  ;

Destroys a PKI key update response object. Parameters: pPKIKeyUpdateRespObj This input/output parameter contains the key update respond object. Returns: None.

---

RSA BSAFE^® Cert-C 2.7 API Reference