Skip to content
Open
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
6cdbfed
initial draft
MarkAckert Jan 21, 2026
720a121
checkpoint doc changes for certs
MarkAckert Jan 23, 2026
03b8dc5
Merge branch 'docs-staging' into user/markackert/cert-scenarios
MarkAckert Jan 23, 2026
fd0f267
Fix typos in certificates configuration documentation
Martin-Zeithaml Jan 26, 2026
d3280b6
Fix typos in generate-certificates.md
Martin-Zeithaml Jan 26, 2026
d776cbc
Correct formatting in certificates configuration guide
Martin-Zeithaml Jan 26, 2026
24a1a50
code review updates
MarkAckert Jan 28, 2026
2c2c66d
better glossary info, code review feedback
MarkAckert Jan 28, 2026
c9a5355
fix review steps after configuring certs
MarkAckert Jan 28, 2026
fc12b3e
remove generate certificates article, and rewire markdown links
MarkAckert Jan 29, 2026
6831adb
re-structure off-platform article a little bit
MarkAckert Jan 29, 2026
4e44d4e
few more touches for clarity
MarkAckert Jan 29, 2026
30d8bde
fix some broken links
MarkAckert Jan 30, 2026
ab6aee3
Make a quick note that keyrings and AT-TLS go together in the glossary
MarkAckert Jan 30, 2026
1c8fed6
Update docs/appendix/zowe-security-glossary.md
MarkAckert Feb 2, 2026
9ccf429
Apply suggestions from code review
MarkAckert Feb 2, 2026
a37317a
key ring format
MarkAckert Feb 2, 2026
dcc5568
code review comments, fix broken links
MarkAckert Feb 2, 2026
143ce6b
Update docs/user-guide/configuring-at-tls-for-zowe-server-single-serv…
MarkAckert Feb 2, 2026
871324a
Update docs/user-guide/certificates-trust-off-platform.md
MarkAckert Feb 2, 2026
cbb4337
Update docs/user-guide/certificates-trust-off-platform.md
MarkAckert Feb 2, 2026
31b9289
Update docs/user-guide/certificates-trust-off-platform.md
MarkAckert Feb 2, 2026
e1c4ec0
add admonition
MarkAckert Feb 2, 2026
2a0f1c4
changes from code review comments
MarkAckert Feb 2, 2026
cd1f5fe
one more suggested change
MarkAckert Feb 2, 2026
db102ac
Keyring to key ring
Martin-Zeithaml Feb 3, 2026
0800dcf
Typos
Martin-Zeithaml Feb 3, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 9 additions & 16 deletions docs/appendix/zowe-security-glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ If you do not yet have certificates, Zowe can create self-signed certificates fo
- [Extended key usage](#extended-key-usage)
- [Hostname validity](#hostname-validity)
- [z/OSMF access](#zosmf-access)

### Extended key usage
Zowe server certificates must either not have the `Extended Key Usage` (EKU) attribute, or have both the `TLS Web Server Authentication (1.3.6.1.5.5.7.3.1)` and `TLS Web Client Authentication (1.3.6.1.5.5.7.3.2)` values present within.

Expand All @@ -88,29 +89,21 @@ The z/OSMF certificate is verified according to Zowe [Certificate verification s


## Certificate setup types
Whether importing or letting Zowe generate certificates, the setup for Zowe certificate automation and the configuration to use an existing keystore and truststore depends upon the content format: file-based (`PKCS12`) or z/OS key ring-based.
Zowe requires certificates in one of two formats: file-based (`PKCS12`) or z/OS key ring-based. If you are bringing your own previously defined certificates to Zowe, you can configure `zowe.certificate` with this information directly. Key rings are required for Zowe AT-TLS configurations. If you are not bringing your own certificates, [Zowe can assist](../user-guide/certificates-configuration-scenarios.md) with certificate generation.

- [File-based (PKCS12) certificate setup](#file-based-pkcs12-certificate-setup)
- [z/OS key ring-based certificate setup](#zos-key-ring-based-certificate-setup)

### File-based (PKCS12) certificate setup

Zowe is able to use PKCS12 certificates that are stored in USS. Zowe uses a `keystore` directory to contain its certificates primarily in PKCS12 (`.p12`, `.pfx`) file format, but also in PEM (`.pem`) format. The truststore is in the `truststore` directory that holds the public keys and CA chain of servers which Zowe communicates with (for example z/OSMF).

### z/OS key ring-based certificate setup

Zowe is able to work with certificates held in a **z/OS Key ring**.
Generating PKCS12 certificates is covered in [Certificate configuration scenarios](../user-guide/certificates-configuration-scenarios.md) Scenario 1 and Scenario 2.
Configuring PKCS12 certificates is covered in [Finalize certificate configuration](../user-guide/certificates-finalize-configuration.md).

The JCL member `.SZWESAMP(ZWEKRING)` contains security commands to create a SAF keyring. By default, this key ring is named `ZoweKeyring`. You can use the security commands in this JCL member to generate a Zowe certificate authority (CA) and sign the server certificate with this CA. The JCL contains commands for all three z/OS security managers: RACF, TopSecret, and ACF2.

There are two ways to configure and submit `ZWEKRING`:

- Copy the JCL `ZWEKRING` member and customize its values.
- Customize the `zowe.setup.certificate` section in `zowe.yaml` and use the `zwe init certificate` command.

You can also use the `zwe init certificate` command to prepare a customized JCL member using `ZWEKRING` as a template.
### z/OS key ring-based certificate setup

A number of key ring scenarios are supported:
Zowe is able to work with certificates held in a **z/OS key ring**.

- Creation of a local certificate authority (CA) which is used to sign a locally generated certificate. Both the CA and the certificate are placed in the `ZoweKeyring`.
- Import of an existing certificate already held in z/OS to the `ZoweKeyring` for use by Zowe.
- Creation of a locally generated certificate and signed by an existing certificate authority. The certificate is placed in the key ring.
Generating key rings with certificates is covered in [Certificate configuration scenarios](../user-guide/certificates-configuration-scenarios.md), Scenarios 3-5.
Configuring key rings with certificates is covered in [Finalize certificate configuration](../user-guide/certificates-finalize-configuration.md).
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ There are two ways to set up certificates on a z/OS machine:
- [Certificates in SAF keyring](#api-ml-saf-keyring)

For detailed instructions about how to set up certificates during installation, see the following articles:
* [Use PKCS12 certificates](../../user-guide/use-certificates.md#use-pkcs12-certificates)
* [Use JCERACFS certificates](../../user-guide/use-certificates.md#use-jceracfks-certificates) in a keyring
* [Use PKCS12 certificates](../../user-guide/certificates-configuration-scenarios.md#scenario-overview)
* [Use JCERACFS certificates](../../user-guide/certificates-configuration-scenarios.md#scenario-overview) in a keyring

Follow the procedure in the applicable section in this article during installation.

Expand Down
2 changes: 0 additions & 2 deletions docs/getting-started/zowe-certificates-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,6 @@ X.509 Digital certificates are primarly used to implement the following function
Zowe uses digital certificates as a foundational element for both communication and for identity security.
Additionally, Zowe provides a client identity validation functionality based on the ownership of the provided x.509 client certificate and the mainframe security authentication mechanism.

For more information about how Zowe leverages certificates, see [Zowe certificate usage](../user-guide/use-certificates.md).

To review the various Zowe certificate configuration options, see the [Zowe certificate configuration overview](../user-guide/configure-certificates.md).

## Public key infrastructure
Expand Down
7 changes: 2 additions & 5 deletions docs/getting-started/zowe-security-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,7 @@ Review digital certificates terminology in the [Zowe security glossary](../appen
Zowe uses digital certificates to secure the communication channel between Zowe components as well as between Zowe clients and Zowe services. Digital client certificates can also be used to validate that the identity of a client-user (the service user) is known to the mainframe security facility.

**Next Steps:**
- For more information about the mechanics of digital certificate, see [Using certificates](../user-guide/use-certificates.md).
- To learn more about the various options for Zowe certificate configuration, see [Zowe certificate configuration overview](../user-guide/configure-certificates.md) under the _Use_ tab.
- To learn more about the various options for Zowe certificate configuration, see [Zowe certificate configuration overview](../user-guide/configure-certificates.md).

## User Authentication
Zowe always authenticates the users accessing its interfaces and services.
Expand Down Expand Up @@ -82,8 +81,6 @@ For more information about the SAF resource check, see [Configuring SAF resource
## Additional resources
For more information about getting started with certificates including determining your certificate configuration use case, importing certificates, generating certificates and using certificates, see the following resources:

- [Certificate configuration scenarios](../user-guide/certificate-configuration-scenarios.md)
- [Generating a certificate](../user-guide/generate-certificates.md)
- [Importing and configuring a certificate](../user-guide/import-certificates.md)
- [Certificate configuration scenarios](../user-guide/certificates-configuration-scenarios.md)
- [Configuring certificates](../user-guide/configure-certificates.md)

2 changes: 1 addition & 1 deletion docs/troubleshoot/known-issues-with-apiml.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,6 @@ Request a new certificate that contains a valid z/OSMF host name in the subject

### Re-create the Zowe keystore

Re-create the Zowe keystore by deleting it and re-creating it. For more information, see [Importing a file-based PKCS12 certificate](../user-guide/import-certificates.md#importing-an-existing-pkcs12-certificate). The Zowe keystore directory is the value of the `KEYSTORE_DIRECTORY` variable in the `zowe.yaml` file that is used to launch Zowe.
Recreate the Zowe keystore by deleting it and recreating it. For more information, see [Scenario 2: Importing a file-based PKCS12 certificate](../user-guide/certificates-configuration-scenarios.md#scenario-2-use-a-file-based-pkcs12-keystore-and-import-a-certificate-generated-by-another-ca). The Zowe keystore directory is the value of the `KEYSTORE_DIRECTORY` variable in the `zowe.yaml` file that is used to launch Zowe.


Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ The following steps are only required if the ZSS hostname or default Zowe user n
:::

* **components.gateway.apiml.security.x509.externalMapperUser**
To authenticate to the mapping API, a JWT is sent with the request. The token represents the user that is configured with this property. The user authorization is required to use the `IRR.RUSERMAP` resource within the `FACILITY` class. The default value is `ZWESVUSR`. Permissions are set up during installation with the `ZWESECUR` JCL or workflow.
To authenticate to the mapping API, a JWT is sent with the request. The token represents the user that is configured with this property. The user authorization is required to use the `IRR.RUSERMAP` resource within the `FACILITY` class. The default value is: `ZWESVUSR`. Permissions are set up during installation with the `ZWESECUR` JCL or workflow.

If you customized the `ZWESECUR` JCL or workflow (the customization of zowe runtime user: `// SET ZOWEUSER=ZWESVUSR * userid for Zowe started task`) and changed the default USERID, create the `components.gateway.apiml.security.x509.externalMapperUser` property and set the value by adding a new line as in the following example:

Expand Down
Loading
Loading