Previous Topic: Resource Access ExitsNext Topic: TSSVM MACLIB


Standards and Format

Linkage into the exit follows standard O/S coding conventions. On entry, R13 contains the address of an 80-byte register save area, R14 contains the return address, R15 contains the entry point address, and R1 contains the address of the Installation Exit parameter list (#INSTXPL). While there are some fields which are constant across calls, the format of the parameter list and return codes to be used by the exit are dependent upon the function. The return code from the exit must be placed in R15 before returning. The Installation Exit must be written using re-entrant coding techniques. As a reminder, the server machine runs in its own operating system and does not use CMS. Therefore, no CMS functions (SVC 202, called routines, etc.) are available. Under no circumstances should the Installation Exit, including the Application Interface function, issue any form of the security diagnose (X'A0') with the exception of subcode zero (0). IUCV recursion and server “hang” will result. A list of system macros that can be used are given in the Appendix “TSSVM MACLIB.” These macros can be found in the TSSVM MACLIB included on the installation tape.

The following is a list of parameters that are static across all exit functions. Each field in the #INSTXPL (with the exception of TXAWORK) is a full word containing the address of the field.

TXAWORK

This is a workarea, 15 doublewords in size, which may be used for any purpose by the exit.

TXA#DWRD

The address of a static user doubleword. The address in this field is constant across all exit calls. You may wish to use this field as an anchor point for dynamic tables.

TXAFUNC

The function for which the exit has been invoked.

TXA#ACID

The ACIDNAME of the accessor in control at the time of the exit invocation.

TXA#USER

The name of the virtual machine under which the session was initiated.

TXA#TERM

The terminal ID, BATCH, AUTOLOG, or DISC for the user.

TXA#FACM

The systems facility matrix entry for the user. A mapping of this field may be found in the #FACMATX macro in TSSVM MACLIB.

TXA#MODE

The mode of the user. For pre-initiation and undefined user calls, this byte contains the facility mode. For all other calls, the byte contains the mode of the user.

TXA#FLAG

Flags which may be set by the Installation Exit follow:

TXA#LANG

The one byte language preference code associated with the ACID or attached profile.

TXA#DRC

The most recent detail error reason code.

The following is a list of fields unique to pre-initiation, post-initiation, undefined ACID validation, password change, and password phrase change:

TXA#PASS

The old and new (if provided) password for the ACID.

TXAIPHRA

@ Old password phrase followed by new password phrase in 256 character areas.

TXAIGRP

@ Group assigned by job or sign on process prior to actual initiation of sign on.

TXA#AISS

For autolog, the issuer of the AUTOLOG command. Additionally, the following settings exist for TXA#FLAG for pre and post-initiation calls:

The following is a list of fields unique to minidisk, O/S data set, O/S volume, SFSDIR, general resource, post validation exits and ACTION(EXIT):

TXA#MDSK

The name of the minidisk for which a link is being attempted. The format is USERID.CUU for the minidisk name.

TXA#RESN

The name of the resource to which the ACID is trying to obtain access.

TXA#VMUS

The target VM userid for a CP command or diagnose.

TXA#DSN

The name of the O/S data set the ACID is trying to access.

TXA#VOL

The volume on which the data set in TXA#DSN may be found.

TXA#ACC

The requested access to the resource. For resource types which are included with CA Top Secret, these access levels are documented in the #AFLAGS macro. For site defined resources, a TSS LIS(RDT) RESCL(xxxxxxxx) shows the settings for resource access levels.

TXA#SFSD

SFS Directory Name Address.

TXA#SFSP

SFS Filepool Name Address.

TXA#SFSF

SFS CMS File Name Address.

TXA#RTYP

The type of resource which is being accessed. The resource types are documented in the #AFLAGS macro or may be listed by a TSS LIS(RDT) RESCL(xxxxxxxx).

TXARTYP2

@ 2-Byte Resource type (rescode from RDT). This parameter only exists when TXA#RTYP points to a x'FF' value.

The following is a list of fields unique to message and violation processing:

TXA#FLOG

The violation fast logging buffer. A mapping of this buffer may be found in the #FLOG macro in TSSVM MACLIB.

TXA#MBUF

A copy of the message to be issued. Each message contains the following format:

+0(1)-Real length of message text

+1(3)-Reserved

+4(x)-Variable message text

TXA#DRCE

The detail error reason code element mapping. The field is set by the DRC control option. A mapping of this field may be found in the #DRCD macro in TSSVM MACLIB.

TXA#MSGE

The message attribute element mapping. The field is set by the MSG control option. A mapping of this field can be found in the #MSGE macro in TSSVM MACLIB and can be listed by a TSS LIS(RDT) RESCL(xxxxxxxx).

The following is a list of fields unique to change processing:

TXA#RBUF

The change buffer. This field is valid only for TSS commands, when it points to the text of the TSS command issued. It should not be referenced for any other types of security file changes. To determine the type of security file change, check the CHGPTYPE field in the change parameter list (see TXA#CPL below).

TXA#CPL

The change parameter list. A mapping of this parameter list may be found in the #CHGPL macro in TSSVM MACLIB.