Version: v3.0.x LTS

Addressing z/OS requirements for Zowe

Last updated

: 11/13/2024|

... min read

Edit this page

Open doc issue

Addressing z/OS requirements for Zowe

As a security administrator it is necessary to configure the z/OS system for Zowe. Review the following article to learn about z/OS prerequisites, and z/OS configuration requirements for specific settings.

Required role: security administrator

z/OS prerequisites

Be sure your z/OS system meets the following prerequisites:

z/OS version is in active support, such as Version 2.3, Version 2.4, Version 2.5 and Version 3.1

note
z/OS V2.2 reached end of support on 30 September, 2020. For more information, see the z/OS v2.2 lifecycle details https://www.ibm.com/support/lifecycle/details?q45=Z497063S01245B61.
zFS volume has at least 833 mb of free space for Zowe server components, their keystore, instance configuration files and logs, and third-party plug-ins.
(Optional, recommended) z/OS OpenSSH V2.2.0 or later

Some features of Zowe require SSH, such as the Desktop's SSH terminal. Install and manage Zowe via SSH, as an alternative to OMVS over TN3270.
(Optional, recommended) Parallel Sysplex.

To deploy Zowe for high availability, a Parallel Sysplex environment is recommended. For more information, see Configuring Sysplex for high availability.

Settings specific configuration requirements

Configuration of your z/OS system is dependent on the specific Zowe features and functionalities you would like to employ with your Zowe installation. Review the following table to determine which configuration steps are required based on your Zowe use case.

Purpose	Configuration step
Set the names for the different z/OS UNIX address spaces for the Zowe runtime components. Important: This configuration step is required.	Configure address space job naming
To use Zowe desktop. This step generates random numbers for zssServer that the Zowe desktop uses.	Configure an ICSF cryptographic services environment
To allow users to log on to the Zowe desktop through impersonation.	Configure security environment switching
Required for TSS only. A TSS FACILITY needs to be defined and assigned to the `ZWESLSTC` started task.	Configure multi-user address space for TSS only
Required if you have not run `ZWESECUR` and are manually creating the user ID and groups in your z/OS environment.	Configure user IDs and groups for the Zowe started tasks
Required if you have not run `ZWESECUR` and are configuring your z/OS environment manually. This step describes how to configure the started task ZWESLSTC to run under the correct user ID and group.	Configure ZWESLSTC to run Zowe high availability instances under ZWESVUSR user ID
Required if you have not run `ZWESECUR` and are configuring your z/OS environment manually. This step describes how to configure the cross memory server for SAF to guard against access by non-privileged clients.	Configure the cross memory server for SAF
Required for API Mediation Layer to map a client certificate to a z/OS identity.	Configure main Zowe server to use client certificate identity mapping
Required for API ML to map the association between a z/OS user ID and a distributed user identity.	Configure main Zowe server to use distributed identity mapping
To configure SAF Identity tokens on z/OS so that they can be used by Zowe components like zss or API Mediation Layer.	Configure signed SAF Identity tokens IDT
Required for API Mediation Layer to issue SMF records.	Configure the main Zowe server to issue SMF records
To use multi-factor authentication (MFA)	Multi-Factor Authentication (MFA)
To use Single Sign-On (SSO)	Single Sign-On (SSO)
To use OIDC Authentication with API Mediation Layer	API Mediation Layer OIDC Authentication

Configure an ICSF cryptographic services environment

The zssServer uses cookies that require random number generation for security. To learn more about the zssServer, see the Zowe architecture. Integrated Cryptographic Service Facility (ICSF) is a secure way to generate random numbers.

If you have not configured your z/OS environment for ICSF, see Cryptographic Services ICSF: System Programmer's Guide for more information. To see whether ICSF has been started, check whether the started task ICSF or CSF is active.

If you run Zowe high availability on a Sysplex, ICSF needs to be configured in a Sysplex environment to share KDS data sets across systems in a Sysplex. For detailed information, see Running in a Sysplex Environment

The Zowe z/OS environment configuration JCL member ZWESECUR does not perform any steps related to ICSF that is required for zssServer that the Zowe desktop uses. Therefore, if you want to use Zowe desktop, you must perform the steps that are described in this section manually.

To generate symmetric keys, the ZWESVUSR user who runs Zowe server started task requires READ access to CSFRNGL in the CSFSERV class.

Define or check the following configurations depending on whether ICSF is already installed:

The ICSF or CSF job that runs on your z/OS system.
The configuration of ICSF options in SYS1.PARMLIB(CSFPRM00), SYS1.SAMPLIB, SYS1.PROCLIB.
Create CKDS, PKDS, TKDS VSAM data sets.
Define and activate the CSFSERV class:

Click here for command details for RACF.

If you use RACF, issue the following commands:

RDEFINE CSFSERV profile-name UACC(NONE)

PERMIT profile-name CLASS(CSFSERV) ID(tcpip-stackname) ACCESS(READ)

PERMIT profile-name CLASS(CSFSERV) ID(userid-list)   ... [for 
userids IKED, NSSD, and Policy Agent]

SETROPTS CLASSACT(CSFSERV)

SETROPTS RACLIST(CSFSERV) REFRESH

Click here for command details for ACF2.

If you use ACF2, issue the following commands (note that profile-prefix and profile-suffix are user-defined):

SET CONTROL(GSO)

INSERT CLASMAP.CSFSERV RESOURCE(CSFSERV) RSRCTYPE(CSF)

F ACF2,REFRESH(CLASMAP)

SET RESOURCE(CSF)

RECKEY profile-prefix ADD(profile-suffix uid(UID string for tcpip-stackname) SERVICE(READ) ALLOW)

RECKEY profile-prefix ADD(profile-suffix uid(UID string for IZUSVR) SERVICE(READ) ALLOW)

(repeat for userids IKED, NSSD, and Policy Agent)

F ACF2,REBUILD(CSF)

Click here for command details for Top Secret

If you use Top Secret, issue the following command (note that profile-prefix and profile-suffix are user defined):

TSS ADDTO(owner-acid) RESCLASS(CSFSERV)

TSS ADD(owner-acid) CSFSERV(profile-prefix.)

TSS PERMIT(tcpip-stackname) CSFSERV(profile-prefix.profile-suffix) ACCESS(READ)

TSS PERMIT(user-acid) CSFSERV(profile-prefix.profile-suffix) ACCESS(READ)

(repeat for user-acids IKED, NSSD, and Policy Agent)

Notes

Determine whether you want SAF authorization checks against CSFSERV and set CSF.CSFSERV.AUTH.CSFRNG.DISABLE accordingly.
Refer to the z/OS 2.3.0 z/OS Cryptographic Services ICSF System Programmer's Guide: Installation, initialization, and customization.
CCA and/or PKCS #11 coprocessor for random number generation.
Enable FACILITY IRR.PROGRAM.SIGNATURE.VERIFICATION and RDEFINE CSFINPV2 if required.

Configure security environment switching

Typically, the user ZWESVUSR that the Zowe server started task runs under needs to be able to change the security environment of its process to allow API requests to be issued on behalf of the logged on TSO user ID, rather than the server's user ID. This capability provides the functionality that allows users to log on to the Zowe desktop and use apps such as the File Editor to list data sets or USS files that the logged on user is authorized to view and edit, rather than the user ID running the Zowe server. This technique is known as impersonation.

To enable impersonation, you must grant the user ID ZWESVUSR associated with the Zowe server started task UPDATE access to the BPX.SERVER and BPX.DAEMON profiles in the FACILITY class.

You can issue the following commands first to check whether you already have the impersonation profiles defined as part of another server configuration, such as the FTPD daemon. Review the output to confirm that the two impersonation profiles exist and the user ZWESVUSR who runs the Zowe server started task has UPDATE access to both profiles.

Click here for command details for RACF.

If you use RACF, issue the following commands:

RLIST FACILITY BPX.SERVER AUTHUSER

RLIST FACILITY BPX.DAEMON AUTHUSER

Click here for command details for Top Secret.

If you use Top Secret, issue the following commands:

TSS WHOHAS IBMFAC(BPX.SERVER)

TSS WHOHAS IBMFAC(BPX.DAEMON)

Click here for command details for ACF2.

If you use ACF2, issue the following commands:

SET RESOURCE(FAC)

LIST BPX

If the user ZWESVUSR who runs the Zowe server started task does not have UPDATE access to both profiles follow the instructions below.

Click here for procedure details for RACF.

If you use RACF, complete the following steps:

Activate and RACLIST the FACILITY class. This may have already been done on the z/OS environment if another z/OS server has been previously configured to take advantage of the ability to change its security environment, such as the FTPD daemon that is included with z/OS Communications Server TCP/IP services.

SETROPTS GENERIC(FACILITY)
SETROPTS CLASSACT(FACILITY) RACLIST(FACILITY)

Define the impersonation profiles. This may have already been done on behalf of another server such as the FTPD daemon.

RDEFINE FACILITY BPX.SERVER UACC(NONE)

RDEFINE FACILITY BPX.DAEMON UACC(NONE)

Having activated and RACLIST the FACILITY class, the user ID ZWESVUSR who runs the Zowe server started task must be given update access to the BPX.SERVER and BPX.DAEMON profiles in the FACILITY class.

PERMIT BPX.SERVER CLASS(FACILITY) ID(<zowe_stc_user>) ACCESS(UPDATE)

PERMIT BPX.DAEMON CLASS(FACILITY) ID(<zowe_stc_user>) ACCESS(UPDATE)

where:

<zowe_stc_user> is ZWESVUSR unless a different user ID is being used for the z/OS environment.

/* Activate these changes */

SETROPTS RACLIST(FACILITY) REFRESH

Issue the following commands to check whether permission has been successfully granted:

RLIST FACILITY BPX.SERVER AUTHUSER

RLIST FACILITY BPX.DAEMON AUTHUSER

Click here for procedure details for Top Secret.

If you use Top Secret, complete the following steps:

Define the BPX Resource and access for <zowe_stc_user>.

TSS ADD(`owner-acid`) IBMFAC(BPX.)

TSS PERMIT(<zowe_stc_user>) IBMFAC(BPX.SERVER) ACCESS(UPDATE)

TSS PERMIT(<zowe_stc_user>) IBMFAC(BPX.DAEMON) ACCESS(UPDATE)

where <zowe_stc_user> is ZWESVUSR unless a different user ID is being used for the z/OS environment.

Issue the following commands and review the output to check whether permission has been successfully granted:

TSS WHOHAS IBMFAC(BPX.SERVER)

TSS WHOHAS IBMFAC(BPX.DAEMON)

Click here for procedure details for ACF2.

If you use ACF2, complete the following steps:

Define the BPX Resource and access for <zowe_stc_user>.

SET RESOURCE(FAC)

RECKEY BPX ADD(SERVER ROLE(<zowe_stc_user>) SERVICE(UPDATE) ALLOW)

RECKEY BPX ADD(DAEMON ROLE(<zowe_stc_user>) SERVICE(UPDATE) ALLOW)

where <zowe_stc_user> is ZWESVUSR unless a different user ID is being used for the z/OS environment.

F ACF2,REBUILD(FAC)

Issue the following commands and review the output to check whether permission has been successfully granted:

SET RESOURCE(FAC)

LIST BPX

You must also grant READ access to the OMVSAPPL profile in the APPL class to the Zowe STC user as well as all other Zowe users using various Zowe features. Skip the following steps when the OMVSAPPL profile is not defined in your environment.

Click here for procedure details for RACF.

If you use RACF, complete the following steps:

Check if you already have the required access defined as part of the environment configuration. Skip the following steps if access is already granted.

RLIST APPL OMVSAPPL AUTHUSER

Issue the following commands and review the output to check if permission has been successfully granted:

PERMIT OMVSAPPL CLASS(APPL) ID(<zowe_user>) ACCESS(READ)
SETROPTS RACLIST(APPL) REFRESH

Click here for procedure details for Top Secret.

If you use Top Secret, complete the following steps:

Check if you already have the required access as part of the environment configuration. Skip the following steps if access is already granted.

TSS WHOHAS APPL(OMVSAPPL)

Issue the following commands and review the output to check if permission has been successfully granted:

TSS PERMIT(<zowe_user>) APPL(OMVSAPPL)

Click here for procedure details for ACF2.

If you use ACF2, complete the following steps:

Check if you already have the required access defined as part of the environment configuration. Skip the following steps if access is already granted.

SET RESOURCE(APL)
LIST OMVSAAPL

Issue the following commands and review the output to check if permission has been successfully granted:

SET RESOURCE(APL)
RECKEY OMVSAPPL ADD(SERVICE(READ) ROLE(<zowe_user>) ALLOW)
F ACF2,REBUILD(APL)

Configure address space job naming

The user ID ZWESVUSR that is associated with the Zowe started task must have READ permission for the BPX.JOBNAME profile in the FACILITY class. This is to allow setting of the names for the different z/OS UNIX address spaces for the Zowe runtime components.

note

This procedure may require security administrator authorization. Consult with your security administrator.

To display who is authorized to the profile, issue the following command:

RLIST FACILITY BPX.JOBNAME AUTHUSER

Additionally, you need to activate facility class, permit BPX.JOBNAME, and refresh facility class:

SETROPTS CLASSACT(FACILITY) RACLIST(FACILITY)
PERMIT BPX.JOBNAME CLASS(FACILITY) ID(ZWESVUSR) ACCESS(READ)
SETROPTS RACLIST(FACILITY) REFRESH

For more information, see Setting up the UNIX-related FACILITY and SURROGAT class profiles in the "z/OS UNIX System Services" documentation.

Configure multi-user address space (for TSS only)

The Zowe server started task ZWESLSTC is multi-user address space, and therefore a TSS FACILITY needs to be defined and assigned to the started task. Then, all acids signing on to the started task will need to be authorized to the FACILITY.

The following example shows how to create a new TSS FACILITY.

Example:

In the TSSPARMS, add the following lines to create the new FACILITY:

FACILITY(USER11=NAME=ZOWE)
FACILITY(ZOWE=MODE=FAIL)
FACILITY(ZOWE=RES) 

For more information about how to administer Facility Matrix Table, see How to Perform Facility Matrix Table Administration.

To assign the FACILITY to the started task, issue the following command:

TSS ADD(ZWESVUSR) MASTFAC(ZOWE)

To authorize a user to sign on to the FACILITY, issues the following command:

TSS ADD(user_acid) FAC(ZOWE)

Configure user IDs and groups for the Zowe started tasks

Zowe requires a user ID ZWESVUSR to execute its main z/OS runtime started task. This user ID must have a valid OMVS segment.

Zowe requires a user ID ZWESIUSR to execute the cross memory server started task ZWESISTC. This user ID must have a valid OMVS segment.

Zowe requires a group ZWEADMIN that both ZWESVUSR and ZWESIUSR should belong to. This group must have a valid OMVS segment.

If you have run ZWESECUR, you do not need to perform the steps described in this section, because the TSO commands to create the user IDs and groups are executed during the JCL sections of ZWESECUR.

/* group for started tasks                          */
...
/* userid for ZOWE main server                      */
...
/* userid for XMEM cross memory server              */
...

If you have not run ZWESECUR and are manually creating the user ID and groups in your z/OS environment, the commands are described below for reference.

To create the ZWEADMIN group, issue the following command according to your ESM:

Click here for command details for RACF.

RACF:

ADDGROUP ZWEADMIN OMVS(AUTOGID) -
DATA('STARTED TASK GROUP WITH OMVS SEGEMENT')

Click here for command details for Top Secret.

TSS:

TSS CREATE(<ZWEADMIN>) TYPE(GROUP) +
  NAME('ZOWE ADMINISTRATORS') +
  DEPT(<ADMIN_DEPARTMENT>)
TSS ADD(<ZWEADMIN>) GID(<ADMIN_GROUP_ID>)

Click here for command details for ACF2.

ACF2:

SET PROFILE(GROUP) DIV(OMVS)
INSERT <ZWEADMIN> AUTOGID
F ACF2,REBUILD(GRP),CLASS(P)

To create the ZWESVUSR user ID for the main Zowe started task, issue the following command:

Click here for command details for RACF.

RACF:

ADDUSER  <ZWESVUSR> -
NOPASSWORD -
DFLTGRP(<ZWEADMIN>) -
OMVS(HOME(/tmp) PROGRAM(/bin/sh) AUTOUID) -
NAME('ZOWE SERVER') -
DATA('ZOWE MAIN SERVER')

Click here for command details for Top Secret.

TSS:

TSS CREATE(<ZWESVUSR>) TYPE(USER) PROTECTED +
NAME('ZOWE MAIN SERVER') +
DEPT(<STC_USER_DEPARTMENT>)
TSS ADD(<ZWESVUSR>) GROUP(<ZWEADMIN>) +
DFLTGRP(<ZWEADMIN>) +
HOME(/tmp) OMVSPGM(/bin/sh) UID(<ZOWE_USER_UID>)

Click here for command details for ACF2.

ACF2:

SET LID
INSERT <ZWESVUSR> STC GROUP(<ZWEADMIN>)
SET PROFILE(USER) DIV(OMVS)
INSERT <ZWESVUSR> AUTOUID HOME(/tmp) OMVSPGM(/bin/sh)
F ACF2,REBUILD(USR),CLASS(P),DIVISION(OMVS)

To create the ZWESIUSR group for the Zowe cross memory server started task, issue the following command:

Click here for command details for RACF.

RACF:

ADDUSER <ZWESIUSR> -
NOPASSWORD -
DFLTGRP(<ZWEADMIN>) -
OMVS(HOME(/tmp) PROGRAM(/bin/sh) AUTOUID) -
NAME('ZOWE XMEM SERVER') -
DATA('ZOWE XMEM CROSS MEMORY SERVER')

Click here for command details for Top Secret.

TSS:

TSS CREATE(<ZWESIUSR>) TYPE(USER) PROTECTED +
NAME('ZOWE ZIS CROSS MEMORY SERVER') +
DEPT(<STC_USER_DEPARTMENT>)
TSS ADD(<ZWESIUSR>) GROUP(<ZWEADMIN>) +
DFLTGRP(<ZWEADMIN>) +
HOME(/tmp) OMVSPGM(/bin/sh) UID(&ZISUID.)

Click here for command details for ACF2.

ACF2:

SET LID
INSERT <ZWESIUSR> STC GROUP(<ZWEADMIN>)
SET PROFILE(USER) DIV(OMVS)
INSERT <ZWESIUSR> AUTOUID HOME(/tmp) OMVSPGM(/bin/sh)
F ACF2,REBUILD(USR),CLASS(P),DIVISION(OMVS)

Configure ZWESLSTC to run Zowe high availability instances under ZWESVUSR user ID

You need Zowe started task ZWESLSTC for Zowe high availability. When the Zowe started task ZWESLSTC is started, it must be associated with the user ID ZWESVUSR and group ZWEADMIN. A different user ID and group can be used if required to conform with existing naming standards.

If you have run ZWESECUR, you do not need to perform the steps described in this section, because they are executed during the JCL section of ZWESECUR.

/* started task for ZOWE Launcher in high availability               */
...

If you have not run ZWESECUR and are configuring your z/OS environment manually, the following steps describe how to configure the started task ZWESLSTC to run under the correct user ID and group.

Click here for command details for RACF.

If you use RACF, issue the following commands:

RDEFINE STARTED ZWESLSTC.* UACC(NONE) STDATA(USER(ZWESVUSR) GROUP(ZWEADMIN) PRIVILEGED(NO) TRUSTED(NO) TRACE(YES))  
SETROPTS REFRESH RACLIST(STARTED)

Click here for command details for ACF2.

If you use ACF2, issue the following commands:

SET CONTROL(GSO)
INSERT STC.ZWESLSTC LOGONID(ZWESVUSR) GROUP(ZWEADMIN) STCID(ZWESLSTC)
F ACF2,REFRESH(STC)

Click here for command details for Top Secret.

If you use Top Secret, issue the following commands:

TSS ADDTO(STC) PROCNAME(ZWESLSTC) ACID(ZWESVUSR)

Configure the cross memory server for SAF

Zowe has a cross memory server that runs as an APF-authorized program with key 4 storage. Client processes accessing the cross memory server's services must have READ access to a security profile ZWES.IS in the FACILITY class. This authorization step is used to guard against access by non-priviledged clients.

If you have run ZWESECUR you do not need to perform the steps described in this section.

/* permit Zowe main server to use XMEM cross memory server       */
...

If you have not run ZWESECUR and are configuring your z/OS environment manually, the following steps describe how to configure the cross memory server for SAF.

Activate the FACILITY class, define a ZWES.IS profile, and grant READ access to the user ID ZWESVUSR. This is the user ID that the main Zowe started task runs under.

To do this, issue the following commands that are also included in the ZWESECUR JCL member. The commands assume that you run the Zowe server under the ZWESVUSR user.

Click here for command details for RACF.

If you use RACF, issue the following commands:

To see the current class settings, use:
```
SETROPTS LIST
```

To define and activate the FACILITY class, use:

SETROPTS GENERIC(FACILITY)
SETROPTS CLASSACT(FACILITY)

To RACLIST the FACILITY class, use:
```
SETROPTS RACLIST(FACILITY)
```
To define the ZWES.IS profile in the FACILITY class and grant Zowe's started task userid READ access, issue the following commands:
```
RDEFINE FACILITY ZWES.IS UACC(NONE)
```
```
PERMIT ZWES.IS CLASS(FACILITY) ID(<zowe_stc_user>) ACCESS(READ)
```
where <zowe_stc_user> is the user ID ZWESVUSR under which the Zowe server started task runs.
```
SETROPTS RACLIST(FACILITY) REFRESH
```
To check whether the permission has been successfully granted, issue the following command:
```
RLIST FACILITY ZWES.IS AUTHUSER
```
This shows the user IDs who have access to the ZWES.IS class, which should include Zowe's started task user ID with READ access.

Click here for command details for ACF2.

If you use ACF2, issue the following commands:

SET RESOURCE(FAC)

RECKEY ZWES ADD(IS ROLE(IZUSVR) SERVICE(READ) ALLOW)

F ACF2,REBUILD(FAC)

Click here for command details for Top Secret.

If you use Top Secret, issue the following commands, where owner-acid can be IZUSVR or a different ACID:

TSS ADD(`owner-acid`) IBMFAC(ZWES.)

TSS PERMIT(ZWESVUSR) IBMFAC(ZWES.IS) ACCESS(READ)

Notes

The cross memory server treats "no decision" style SAF return codes as failures. If there is no covering profile for the ZWES.IS resource in the FACILITY class, the request will be denied.
Cross memory server clients other than Zowe might have additional SAF security requirements. For more information, see the documentation for the specific client.

Configure main Zowe server to use client certificate identity mapping

This security configuration is necessary for API ML to be able to map client certificate to a z/OS identity. A user running API Gateway must have read access to the SAF resource IRR.RUSERMAP in the FACILITY class. To set up this security configuration, submit the ZWESECUR JCL member. For users upgrading from version 1.18 and lower use the following configuration steps.

Click here for procedure details for RACF.

If you use RACF, verify and update permission in the FACILITY class.

Follow these steps:

Verify user ZWESVUSR has read access.
```
RLIST FACILITY IRR.RUSERMAP AUTHUSER
```

Add user ZWESVUSR permission to read.

PERMIT IRR.RUSERMAP CLASS(FACILITY) ACCESS(READ) ID(ZWESVUSR)

Activate changes.
```
SETROPTS RACLIST(FACILITY) REFRESH
```

Click here for procedure details for ACF2.

If you use ACF2, verify and update permission in the FACILITY class.

Follow these steps:

Verify user ZWESVUSR has read access.
```
SET RESOURCE(FAC) 
LIST LIKE(IRR-)
```

Add user ZWESVUSR permission to read.

RECKEY IRR.RUSERMAP ADD(SERVICE(READ) ROLE(&STCGRP.) ALLOW)

Activate changes.
```
F ACF2,REBUILD(FAC)
```

Click here for procedure details for Top Secret.

If you use TSS, verify and update permission in FACILITY class.

Follow these steps:

Verify user ZWESVUSR has read access.
```
TSS WHOHAS IBMFAC(IRR.RUSERMAP)
```

Add user ZWESVUSR permission to read.

TSS PER(ZWESVUSR) IBMFAC(IRR.RUSERMAP) ACCESS(READ)

Configure main Zowe server to use distributed identity mapping

This security configuration is necessary for API ML to be able to map the association between a z/OS user ID and a distributed user identity. A user running the API Gateway must have read access to the SAF resource IRR.IDIDMAP.QUERY in the FACILITY class. To set up this security configuration, submit the ZWESECUR JCL member. For users upgrading from version 1.28 and lower, use the following configuration steps.

Click here for procedure details for RACF.

If you use RACF, verify and update permission in the FACILITY class.

Follow these steps:

Verify that user ZWESVUSR has read access.

RLIST FACILITY IRR.IDIDMAP.QUERY AUTHUSER

Activate the IDIDMAP class:

SETROPTS CLASSACT(IDIDMAP) RACLIST(IDIDMAP)

Define the IRR.IDIDMAP.QUERY profile in the FACILITY class.
```
RDEFINE FACILITY IRR.IDIDMAP.QUERY
```

Add user ZWESVUSR permission to with READ access.

PERMIT IRR.IDIDMAP.QUERY CLASS(FACILITY) ACCESS(READ) ID(ZWESVUSR)

Activate changes.
```
SETROPTS RACLIST(FACILITY) REFRESH
```

Click here for procedure details for ACF2.

If you use ACF2, verify and update permission in the FACILITY class.

Follow these steps:

Verify that user ZWESVUSR has READ access.
```
SET RESOURCE(FAC) 
LIST LIKE(IRR-)
```

Add user ZWESVUSR permission with READ access.

RECKEY IRR.IDIDMAP.QUERY ADD(SERVICE(READ) ROLE(&STCGRP.) ALLOW)

Activate changes.
```
F ACF2,REBUILD(FAC)
```

Click here for procedure details for Top Secret.

If you use TSS, verify and update permission in FACILITY class.

Follow these steps:

Verify that user ZWESVUSR has READ access.
```
TSS WHOHAS IBMFAC(IRR.IDIDMAP.QUERY)
```

Add user ZWESVUSR permission with READ access.

TSS PER(ZWESVUSR) IBMFAC(IRR.IDIDMAP.QUERY) ACCESS(READ)

Configure signed SAF Identity tokens (IDT)

This section provides a brief description of how to configure SAF Identity tokens on z/OS so that they can be used by Zowe components like zss or API Mediation layer (Implement a new SAF IDT provider)

Follow these steps:

Create PKCS#11 token
Generate a secret key for the PKCS#11 token (you can use the sample program ZWESECKG in the SZWESAMP dataset)
Define a SAF resource profile under the IDTDATA SAF resource class

Details with examples can be found in documentation of external security products:

RACF - Signed and Unsigned Identity Tokens and IDT Configuration subsections in z/OS Security Server RACROUTE Macro Reference in the article Activating and using the IDTA parameter in RACROUTE REQUEST=VERIFY.
Top Secret - Maintain Identity Token (IDT) Records subsection in Administrating chapter, in the article Maintain Identity Token (IDT) Records.
ACF2 - IDTDATA Profile Records subsection in Administrating chapter, in the article IDTDATA Profile Records.

A part of the Signed SAF Identity token configuration is a nontrivial step that has to generate a secret key for the PKCS#11 token. The secret key is generated in ICSF by calling the PKCS#11 Generate Secret Key (CSFPGSK) or Token Record Create (CSFPTRC) callable services. An example of the CSFPGSK callable service can be found in the SZWESAMP dataset as the ZWESECKG job.

Configure the main Zowe server to issue SMF records

This security configuration is necessary for API ML to be able to issue SMF records. A user running the API Gateway must have READ access to the RACF general resource IRR.RAUDITX in the FACILITY class. To set up this security configuration, submit the ZWESECUR JCL member. For users upgrading from version 1.18 and lower, use the configuration steps that correspond to the ESM.

To check whether you already have the auditing profile defined, issue the following command and review the output to confirm that the profile exists and that the user ZWESVUSR who runs the ZWESLSTC started task has READ access to this profile.
Click here for command details for RACF.
If you use RACF, issue the following command:
RLIST FACILITY IRR.RAUDITX AUTHUSER
Click here for command details for Top Secret.
If you use Top Secret, issue the following command:
TSS WHOHAS IBMFAC(IRR.RAUDITX)
Click here for command details for ACF2.
If you use ACF2, issue the following commands:
SET RESOURCE(FAC)
LIST LIKE(IRR-)
If the user ZWESVUSR who runs the ZWESLSTC started task does not have READ access to this profile, follow the procedure that corresponds to your ESM:
Click here for procedure details for RACF.
If you use RACF, update permission in the FACILITY class.
Follow these steps:
1. Add user ZWESVUSR permission to READ.
PERMIT IRR.RAUDITX CLASS(FACILITY) ACCESS(READ) ID(ZWESVUSR)
1. Activate changes.
SETROPTS RACLIST(FACILITY) REFRESH
Click here for command details for Top Secret.
If you use Top Secret, add user ZWESVUSR permission to READ. Issue the following command:
TSS PER(ZWESVUSR) IBMFAC(IRR.RAUDITX) ACCESS(READ)
Click here for command details for ACF2.
If you use ACF2, add user ZWESVUSR permission to READ. Issue the following commands:
SET RESOURCE(FAC)
RECKEY IRR ADD(RAUDITX ROLE(&STCGRP.) SERVICE(READ) ALLOW)
F ACF2,REBUILD(FAC)

For more information about SMF records, see SMF records in the Using Zowe API Mediation Layer documentation.

Multi-Factor Authentication (MFA)

Multi-factor authentication is supported for several components, such as the Desktop and API Mediation Layer. Multi-factor authentication is provided by third-party products which Zowe is compatible with. The following are known to work:

Notes

To support the multi-factor authentication, it is necessary to apply z/OSMF APAR PH39582.
MFA must work with Single-Sign-On (SSO). Make sure that SSO is configured before you use MFA in Zowe.

Single Sign-On (SSO)

Zowe has an SSO scheme with the goal that each time you use multiple Zowe components you should only be prompted to login once.

Requirements:

IBM z/OS Management Facility (z/OSMF)

API Mediation Layer OIDC Authentication

Zowe requires ACF2 APAR LU01316 to be applied when using the ACF2 security manager.

z/OS prerequisites​

Settings specific configuration requirements ​

Configure an ICSF cryptographic services environment​

Configure security environment switching​

Configure address space job naming​

Configure multi-user address space (for TSS only)​

Configure user IDs and groups for the Zowe started tasks​

Configure ZWESLSTC to run Zowe high availability instances under ZWESVUSR user ID​

Configure the cross memory server for SAF​

Configure main Zowe server to use client certificate identity mapping​

Configure main Zowe server to use distributed identity mapping​

Configure signed SAF Identity tokens (IDT)​

Configure the main Zowe server to issue SMF records​

Multi-Factor Authentication (MFA)​

Single Sign-On (SSO)​

API Mediation Layer OIDC Authentication​

z/OS prerequisites

Settings specific configuration requirements

Configure an ICSF cryptographic services environment

Configure security environment switching

Configure address space job naming

Configure multi-user address space (for TSS only)

Configure user IDs and groups for the Zowe started tasks

Configure ZWESLSTC to run Zowe high availability instances under ZWESVUSR user ID

Configure the cross memory server for SAF

Configure main Zowe server to use client certificate identity mapping

Configure main Zowe server to use distributed identity mapping

Configure signed SAF Identity tokens (IDT)

Configure the main Zowe server to issue SMF records

Multi-Factor Authentication (MFA)

Single Sign-On (SSO)

API Mediation Layer OIDC Authentication