CardCInitRes

NAME: CardCInitRes - SET CardCInitRes message data structures and routines

SYNOPSIS

#include <set_msg.h>

typedef struct CardCInitRes_ {
    asn1set__MessageWrapper       messageWrapper;
    asn1set__CardCInitResTBS      cardCInitResTBS;
    cert_identity                 caSignatureCID;
} *CardCInitRes;

CardCInitRes safe_cast_CardCInitRes(msg)
    set_msg            msg;             /* IN */

DESCRIPTION: CardCInitRes contains the data from a SET CardCInitRes message in native C form. See the asn_types.h and asn1set.h header files for the declarations of the various types. See the SET specification for a description of individual fields.
CardCInitRes message objects of type set_msg may be cast to type CardCInitRes using the safe_cast_CardCInitRes() routine.

FIELDS

A call to make_set_msg() results in the protocol layer filling in the following fields:

 *    messageWrapper.messageHeader.version
 *    messageWrapper.messageHeader.date
 *    messageWrapper.messageHeader.rrPID
 *    messageWrapper.messageHeader.swIdent
 *    messageWrapper.message._choice
 *    cardCInitResTBS.rrpid
 *    cardCInitResTBS.lid_EE
 *    cardCInitResTBS.chall_EE
 *    cardCInitResTBS.brandCRLIdentifier (optional)
 *    cardCInitResTBS.thumbs (optional)

It is unwise for users to change the contents of the fields filled in by the protocol layer.

After calling make_set_msg(), CA software must (at a minimum) fill in the following required fields:

 *    caSignatureCID

A call to send_set_msg() results in the protocol layer filling in the following fields:

 *    caeThumb

Non-required fields may be left empty at the discretion of the CA application, subject to any business constraints placed on the application.

CACHING

Cardholder

      STATE_CAETHUMB                 put
      STATE_CARDCINITREQ_RRPID       get
      STATE_CHALL_EE                 get
      STATE_LOCALID_CA               put
      STATE_THUMBS                   get

Certification Authority

      STATE_CARDCINITREQ_RRPID       get
      STATE_CHALL_EE                 get
      STATE_LOCALID_EE               get
      STATE_THUMBS                   get

RETURN VALUES: On success, safe_cast_CardCInitRes() returns a pointer to an CardCInitRes data structure. Objects of type set_msg that were not created with message type asn1set__Message__cardCInitRes will cause safe_cast_CardCInitRes() to fail. On failure, safe_cast_CardCInitRes() returns a null pointer.

SEE ALSO: set_msg

NOTES: There is a difference between non-required and optional. Non-required fields may be omitted according to the SET protocol. Optional fields may be omitted according to ASN.1 encoding rules. In some messages, a field may be optional according to ASN.1, but still required by the SET protocol. In these cases, the application must fill in these fields.
Optional fields that are filled in require an application of the SET_PRESENT() macro. See documentation on ASN.1/DER runtime types for additional information.

EXAMPLE

A more complete, explicated example is provided in the Implementor's Guide.

    msg_type = asn1set__Message__cardCInitRes;
    status = make_set_msg(response, app_ctx, &msg_cache[0], msg_type);
    assert(status == NO_ERROR);

    cardCInitRes = safe_cast_CardCInitRes(response);
    assert(cardCInitRes != 0);

    cardCInitRes->caSignatureCID = &cca_s_dn;

    status = send_set_msg(response, app_ctx, &msg_cache[0], outstream);
    assert(status == NO_ERROR);

BUGS: This document describes a beta implementation. The information contained in this document may be incomplete and is subject to change.