NMSAF Public Correlator › $NMUCORH Macro

$NMUCORH Macro

With the NMSAF security facility, you can use the $NMUCORH macro to map the area pointed to by the security correlator field provided in many exits in your product region.

The first part of the area is regarded as public but is read-only. Each logged on user has a separate area (if a user ID is logged on more than once, each instance has a separate area).

Important! Do not alter any of the fields.

DSECTs in the $NMUCORH Macro

The $NMUCORH macro expands into two DSECTs:

• A UCOR DSECT (if you place a label on the macro request, that label is used as the DSECT name instead of UCOR)
• A UGIN DSECT, which maps the global information area (see below)

Fields in the UCOR DSECT

The UCOR (or renamed) DSECT contains the following fields. For more information about these fields, including equated values, see the source code of the $NMUCORH macro.

Important! This list shows only the public header portion of the area. Other fields follow the header. However, they are not documented and must not be altered.

UCOREYEC

Specifies an eye catcher.

Type: Character

UCORUID

Specifies the user ID.

Type: Character

UCORSUID

Specifies the SAF user ID, which is normally UCRUID, except when a system region and a common SAF user ID is used, or when system regions are not SAF validated (in which case this field is blank).

Type: Character

UCORUTYP

Specifies the user logon type. It can have various equated values.

Type: Number

UCOR@ACE

Specifies the address of the SAF ACEE for this user (0 if no SAF user ID).

Type: Address

UCOR@TOK

Specifies the address of the UTOKEN area (generally provided as a parameter to the exit as well).

Type: Address

UCORUGIN

Specifies the address of the UGIN global area. This is a constant value and points to the area mapped by the UGIN DSECT.

Type: Address

UCOR@USX

Specifies the address of a site-specific extension area. It is initially zero.

Type: Address

UCORLUSX

Specifies the length of a site-specific extension area. It is initially zero.

Type: Number

UCORUSER

Specifies anything that can be used by user exits.

Limits: Six full words (24 bytes)

Type: *

You can use the UCOR@USX and UCORLUSX fields to provide the address and length of a site-specific extension:

• If they are both set, then the NMSAF exit issues a FREEMAIN when the user correlator is freed (during logoff processing). The storage must be allocated in your product region shared subpool (SP 50).
• Setting only the address does not cause a FREEMAIN; this is handy for anchoring, for example, some global area.

More information:

Fields in the UGIN DSECT

Fields in the UGIN DSECT

The UGIN DSECT contains the following fields. This is a common area that contains global information. Some of it is system information and some is available for your use.

UGINEYEC

Is an eye catcher.

Type: Character

UGINSFLG

Is the system flag area (eight flags).

Type: Bits

UGINSFL1 to UGINSFL8

Are the system flags.

Type: Bits

UGINSCFL

Is the system character field area (8-byte fields).

Type: Character

UGINSCF1 to UGINSCF8

Are the character fields.

Type: Character

UGINUPT1 to UGINUPT4

Are the pointer fields (4-byte fields) that are available for installation use (any storage anchored must be obtained in SP 50).

Type: Pointer

UGINUFL1 to UGINUFL8

Are eight user flags set by the USERFLAGn input file statements in SXCTL (corresponding to the 8 bits in the byte 80..01).

Type: Bits

UGINUCF1 to UGINUCF8

Are the eight-character fields that can be set by SXCTL for input file statements by using NMSAF.

UGINUCF1 to UGINUCF4 are user names, as set by USERNAMEn.

UGINUCF5 to UGINUCF8 are user IDs, as set by USERUIDn.