PInitReq

NAME: PInitReq - SET PInitReq message data structures and routines

SYNOPSIS

#include <set_msg.h>

typedef struct PInitReq_ {
    asn1set__MessageWrapper    messageWrapper;
} *PInitReq;

PInitReq safe_cast_PInitReq(msg)
    set_msg           msg;             /* IN */

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

FIELDS

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

 *      STATE_LOCALID_C

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

 *    messageWrapper.messageHeader.version
 *    messageWrapper.messageHeader.date
 *    messageWrapper.messageHeader.messageIDs
 *    messageWrapper.messageHeader.rrPID
 *    messageWrapper.messageHeader.swIdent
 *    messageWrapper.message._choice
 *    messageWrapper.message.u.pInitReq.rrpid
 *    messageWrapper.message.u.pInitReq.localID_C
 *    messageWrapper.message.u.pInitReq.chall_C
 *    messageWrapper.message.u.pInitReq.thumbs

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

After calling make_set_msg(), cardholder software must fill in the following required fields:

 *      messageWrapper.message.u.pInitReq.bin
 *      messageWrapper.message.u.pInitReq.brandID
 *      messageWrapper.message.u.pInitReq.language

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

CACHING

Cardholder

      STATE_CHALL_C                  put
      STATE_LANGUAGE                 put
      STATE_LOCALID_C                get
      STATE_LOCALID_M                get
      STATE_PINITREQ_RRPID           put
      STATE_THUMBS                   put

Merchant

      STATE_CHALL_C                  put
      STATE_LANGUAGE                 put
      STATE_LOCALID_C                put
      STATE_PINITREQ_RRPID           put
      STATE_THUMBS                   put

RETURN VALUES: On success, safe_cast_PInitReq() returns a pointer to a PInitReq data structure. Objects of type set_msg that were not created with message type asn1set__Message__pInitReq will cause safe_cast_PInitReq() to fail. On failure, safe_cast_PInitReq() returns a 0 pointer.

SEE ALSO: set_msg, AuthReq, AuthRes, CapReq, CapRes, PInitRes, PReq, PRes

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, it is incumbent on the application to 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.

    pInitReq = safe_cast_PInitReq(request);
    assert(pInitReq != 0);
   
    pInitReq->messageWrapper.messageHeader.swIdent._choice = asn1set__SWIdent__visibleString;
    pInitReq->messageWrapper.messageHeader.swIdent.u.visibleString = "WebTerm v7.2.3alpha";

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