The security routine parameter block

This topic contains Product-sensitive Programming Interface and Associated Guidance Information.

To map the security routine parameter block, you can use the EYUBXESV copy book provided in CICSTS31.CPSM.SEYUMAC. Figure 1 illustrates the layout of the EYUBXESV parameter block.
Figure 1. The EYUBXESV parameter block
*---------------------------------------------------------------------*
*                                                                     *
* COPY BOOK NAME = EYUBXESV                                           *
*                                                                     *
* DESCRIPTIVE NAME = %PRODUCT Site Security user validation exit      *
*                    parameter block                                  *
*                                                                     *
*    COPYRIGHT = Licensed Materials - Property of IBM                 *
*                5695-081                                             *
*                (C) Copyright IBM Corp. 1995, 1997                   *
*                All Rights Reserved                                  *
*                                                                     *
*                US Government Users Restricted Rights - Use,         *
*                duplication or disclosure restricted by GSA ADP      *
*                Schedule Contract with IBM Corp.                     *
*                                                                     *
* STATUS = %CP00                                                      *
*                                                                     *
* FUNCTION =                                                          *
*       Parameter block passed to the Site Security user validation   *
*       exit program (EYU9XESV)                                       *
*                                                                     *
* LIFETIME =                                                          *
*       The site Security user validation exit parameter block is     *
*       obtained and released by the caller of the site security      *
*       user validation exit program caller                           *
*                                                                     *
* STORAGE CLASS =                                                     *
*       The XESV is acquired from private storage in the address space*
*       from which the call to the site security user validation exit *
*       program is made                                               *
*       It is key 0 storage acquired from subpool 252                 *
*                                                                     *
* LOCATION =                                                          *
*       Register 1 on entry to the site security user validation exit *
*       program                                                       *
*                                                                     *
* NOTES :                                                             *
*   DEPENDENCIES = S/370                                              *
*   RESTRICTIONS = None                                               *
*   MODULE TYPE = Control Block Definition                            *
*   PROCESSOR = Assembler                                             *
*                                                                     *
*---------------------------------------------------------------------*
*                                                                     *
* CHANGE ACTIVITY :                                                   *
*                                                                     *
*      $SEG(EYUBXESV),COMP(ENVIR),PROD(%PRODUCT):                     *
*                                                                     *
*   PN= REASON REL YYMMDD BDXIII : REMARKS                            *
*   $L0 SM1    %S0 950406 BDEJWB : BASE RELEASE                       *
*                                                                     *
*---------------------------------------------------------------------*
EYUBXESV            DSECT ,
XESV_PREFIX         DS   0CL20         Prefix
XESV_SLENGTH        DS   AL2           Structure Length
XESV_ARROW          DS   C             ">" delimiter
XESV_NAME           DS   CL8           "EYUBXESV"
XESV_BLANK          DS   C             " "
XESV_PGMNAME        DS   CL8           "EYU9XESV"
XESV_PFX_LEN        EQU  *-XESV_PREFIX Length of prefix
XESV_FUNCTION       DS   XL1           Function Code
XESV_FUNC_CONN      EQU  1              Exit Called during Connect
XESV_FUNC_DSCO      EQU  2              Exit called during Disconnect
                    DS   XL3           Reserved
XESV_RESPONSE       DS   F             Response Code
XESV_RESP_OK        EQU  0              Good response code
XESV_RESP_REJECT    EQU  4              Exit rejects Connect
XESV_RESP_ERROR     EQU  8              Error in Connect/Disconnect
XESV_REASON         DS   F             Reason Codes
*---------------------------------------------------------------------*
*  Reasons for a Response of Connect REJECT                           *
*---------------------------------------------------------------------*
XESV_REAS_APIUSER   EQU  4              Connect Invalid API_UID
XESV_REAS_APIDATA   EQU  8              Connect Invalid API_DATA
XESV_REAS_APIEXP    EQU  12             Connect API_UID expired
*---------------------------------------------------------------------*
*  Reasons for a Response of Connect/Disconnect ERROR                 *
*---------------------------------------------------------------------*
XESV_REAS_NOSTG     EQU  4              Exit could not obtain storage
XESV_PARAMETERS     DS   0C
*---------------------------------------------------------------------*
*  The Connection Parameters are as follows                           *
*---------------------------------------------------------------------*
XESV_CONN_TYPE      DS   XL1           Connector Environment type
XESV_CONN_LMAS      EQU  1              LMAS
XESV_CONN_TSOE      EQU  2              TSO/E Address Space
XESV_CONN_BATCH     EQU  3              BATCH or STC Address Space
XESV_CONN_OS2RMAS   EQU  4              OS/2 RMAS
                    DS   XL3           Reserved
*---------------------------------------------------------------------*
*  For All Connectors, the following fields apply                     *
*---------------------------------------------------------------------*
XESV_CONN_TOKEN     DS   XL4           The unique Connection Token for x
                                       the connecting application
XESV_CONN_API_UID   DS   CL8           Userid specified on the API     X
                                       CONNECT verb (zeros if none)
XESV_CONN_API_DATA  DS   CL8           User Data specified on the API  X
                                       CONNECT verb in the Signonparm  X
                                       parameter (zeros if none)
XESV_CONN_DFLT_UID  DS   CL8           Default Userid specified for theX
                                       CMAS
*---------------------------------------------------------------------*
*  For MAS connectors, the following fields apply                     *
*---------------------------------------------------------------------*
XESV_CONN_SYSID     DS   CL4           MAS SYSID
XESV_CONN_TASKN     DS   PL4           Task Number of Task issuing the x
                                       Connect
XESV_CONN_TERMID    DS   CL4           If A terminal facility, the     x
                                       CICS TERMID of the facility
*---------------------------------------------------------------------*
*  For OS2/RMAS Connectors, the following fields apply                *
*---------------------------------------------------------------------*
XESV_CONN_LINKU     DS   CL8           Userid Associated with CMAS to  x
                                       RMAS Communications Link.  Blankx
                                       if none
*---------------------------------------------------------------------*
*  For ESA connectors, the following fields apply                     *
*---------------------------------------------------------------------*
XESV_CONN_JOBNAME   DS   CL8           Job Name
*---------------------------------------------------------------------*
*  One of the following two fields must be set by the exit program.   *
*  Their values are undefined on input for Connect validation.        *
*                                                                     *
*  The CONN_SECENV field, if set, must contain the address of the     *
*  accessor environment element (ACEE) as an output of the Connect    *
*  Validation.                                                        *
*                                                                     *
*  The CONN_USERID field, if set, must contain the Userid to use      *
*  as an output of the Connect Validation.                            *
*                                                                     *
*  If both fields are set by connect validation, the SECENV address   *
*  will be used                                                       *
*                                                                     *
*  If neither of the fields is set by connect validation, the         *
*  connection will be rejected.                                       *
*                                                                     *
*  The CONN_UTOKEN field may be set to a token provided by the        *
*  user exit program.  Its contents will be provided as input to      *
*  the disconnect function.  If the exit creates resources, for       *
*  example, an ACEE, this token might be used as a resource referent  *
*  so that the resources may be released during the disconnect        *
*  call.                                                              *
*---------------------------------------------------------------------*
XESV_CONN_SECENV    DS   A             Accessor Environment Element    X
                                       (ACEE)
XESV_CONN_USERID    DS   CL8           Userid of Connected User
XESV_CONN_UTOKEN    DS   XL4           Usertoken provided by exit      x
                                       program.
                    ORG  XESV_PARAMETERS
*---------------------------------------------------------------------*
*  The Disconnect Parameters are as follows                           *
*---------------------------------------------------------------------*
XESV_DSCO_USERID    DS   CL8           The USERID of the disconnection x
                                       application
XESV_DSCO_TOKEN     DS   XL4           The unique Connection Token for x
                                       the Disconnecting application
XESV_DSCO_UTOKEN    DS   XL4           UserToken provided by exit      x
                                       program on the Connect call.
                    ORG  ,
XESV_SIZE           EQU  *-EYUBXESV    Length of structure