Me_AqCInitRes

NAME: Me_AqCInitRes - SET Me_AqCInitRes message data structures and routines

SYNOPSIS

#include <set_msg.h>

typedef struct Me_AqCInitRes_ {
    asn1set__MessageWrapper       messageWrapper;
    asn1set__Me_AqCInitResTBS     me_AqCInitResTBS;
    cert_identity                 caSignatureCID;
} *Me_AqCInitRes;

Me_AqCInitRes safe_cast_Me_AqCInitRes(msg)
    set_msg            msg;             /* IN */

DESCRIPTION: Me_AqCInitRes contains the data from a SET Me_AqCInitRes 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.
Me_AqCInitRes message objects of type set_msg may be cast to type Me_AqCInitRes using the safe_cast_Me_AqCInitRes() routine.

FIELDS

Before calling make_set_msg(), software must insert the following state into the cache_ctx:

 *    STATE_LOCALID_CA

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
 *    me_AqCInitResTBS.rrpid
 *    me_AqCInitResTBS.lid_EE
 *    me_AqCInitResTBS.chall_EE
 *    me_AqCInitResTBS.chall_CA
 *    me_AqCInitResTBS.requestType
 *    me_AqCInitResTBS.brandCRLIdentifer (optional)
 *    me_AqCInitResTBS.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(), software must (at a minimum) fill in the following required fields:

 *    me_AqCInitResTBS.regFormOrReferral
 *    caSignatureCID

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

 *    me_AqCInitResTBS.caeThumb (optional)

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

CACHING

Certification Authority

      STATE_CHALL_CA                 put
      STATE_CHALL_EE                 get
      STATE_LOCALID_CA               put
      STATE_LOCALID_EE               get
      STATE_ME_AQCINITREQ_RRPID      get
      STATE_REQUESTTYPE              get
      STATE_THUMBS                   get

Merchant, Payment Gateway

      STATE_CAETHUMB                 put
      STATE_CHALL_CA                 put
      STATE_CHALL_EE                 get
      STATE_LOCALID_CA               put
      STATE_ME_AQCINITREQ_RRPID      get
      STATE_THUMBS                   get

RETURN VALUES: On success, safe_cast_Me_AqCInitRes() returns a pointer to an Me_AqCInitRes data structure. Objects of type set_msg that were not created with message type asn1set__Message__me_AqCInitRes will cause safe_cast_Me_AqCInitRes() to fail. On failure, safe_cast_Me_AqCInitRes() 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__me_AqCInitRes;
    status = make_set_msg(response, app_ctx, &msg_cache[0], msg_type);
    assert(status == NO_ERROR);

    me_AqCInitRes = safe_cast_Me_AqCInitRes(response);
    assert(me_AqCInitRes != 0);
   
    me_AqCInitRes->caSignatureCID = mca_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.