RSA BSAFE Cert-C

PKI_RECIPIENT_INFO Struct Reference

This includes the information needed to determine or obtain the key used to encrypt a content-encryption key. This structure supports two sources of recipient information - either PKI_KEY_TRANSPORT_INFO or GENERAL_NAME_KEYID. Use PKI_RECIPIENT_INFO with the C_SetPKIMsgRecipient() or C_GetPKIMsgRecipient() functions:

Getting recipient information: When calling the C_GetPKIMsgRecipient() function, Cert-C uses internal objects and structures to fill in this structure. It is not necessary to create or allocate the internal objects or pointers before you pass this structure to the C_GetPKIMsgRecipient() function.

Setting recipient information: Because of the large number of fields (and subfields of these fields) in this structure, it is likely that a number of fields are optional for any given service provider. If the PKI_RECIPIENT_INFO structure has not been initialized with a prior call to the C_GetPKIMsgRecipient() function, then call T_memset before calling the C_SetPKIMsgRecipient() function, to ensure that all unused fields are initialized to zero (0).

Data Fields

type

An int value that identifies the type of data structure in the info union. Cert-C supports the following PKI recipient identifier types:

PKI Recipient Identifier Type	Description
`PKI_RECIPIENT_KEY_TRANSPORT`	PKI recipient identified by a message- protection key.
`PKI_RECIPIENT_GENERALNAME_KEYID`	PKI recipient identified by a general name and key identifier.

contentEncryptionAlgorithmId An ALGORITHM_IDENTIFIER structure that identifies the content-encryption algorithm under which the message data is encrypted. If this field is optional for a given service provider, set contentEncryptionAlgorithmId.algorithmId to zero (0).

info A union that contains a PKI recipient identifier in the format specified by type.
keyTrans - A PKI_KEY_TRANSPORT_INFO structure. .
generalNameKeyId - A GENERAL_NAME_KEYID structure.

#include <pkimsg.h>

01239 typedef struct {
01240   int type;                      /* one of PKI_RECIPIENT_* */
01241   ALGORITHM_IDENTIFIER     contentEncryptionAlgorithmId;
01242   union {
01243     PKI_KEY_TRANSPORT_INFO keyTrans;
01244     GENERAL_NAME_KEYID     generalNameKeyId;
01245   } info;
01246 } PKI_RECIPIENT_INFO;