diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
index f4ef01ab71..335faa4f66 100644
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/build-docs.yml
@@ -30,7 +30,11 @@ jobs:
- name: Checkout
uses: actions/checkout@v4
with:
- fetch-depth: 0
+ # Fetches all commit history for a single branch. We need commit
+ # history for accurate "last updated" dates on each page, but fetch
+ # depth of 0 would fetch all branches which is slow.
+ # https://github.com/actions/checkout/issues/520#issuecomment-1320838255
+ fetch-depth: 2147483647
- name: Use Node.js LTS
uses: actions/setup-node@v3
@@ -43,7 +47,7 @@ jobs:
env:
TAR_OPTIONS: "--remove-files"
with:
- path: node_modules/.cache/webpack
+ path: node_modules/.cache/rspack
key: cache-webpack-${{ github.base_ref || github.ref_name }}
- name: Install Dependencies
diff --git a/docs/user-guide/authenticating-with-client-certificates.md b/docs/user-guide/authenticating-with-client-certificates.md
index 3245730850..7c47d9e19d 100644
--- a/docs/user-guide/authenticating-with-client-certificates.md
+++ b/docs/user-guide/authenticating-with-client-certificates.md
@@ -3,17 +3,18 @@
:::info Required roles: system administrator, security administrator
:::
-Authentication for integration with API Mediation Layer (API ML) can also be performed by the client when the service endpoint is called through
+Authentication for integration with API Mediation Layer (API ML) can also be performed by the client when the service endpoint is called through
the API ML Gateway with client certificates. This method of authentication requires client certification to be enabled and configured. For details about this configuration, see [Enabling single sign on for clients via client certificate configuration](./api-mediation/configuration-client-certificates.md).
:::note Notes:
+
* When calling the login endpoint with basic authentication credentials, as well as with client certificate, the basic
- authentication credentials take precedence and the client certificate is ignored.
+ authentication credentials take precedence and the client certificate is ignored.
* If you are calling a specific endpoint on one of the onboarded services, API Mediation Layer ignores Basic authentication. In this case, the Basic authentication is not part of the authenticated request.
:::
-## How the Gateway resolves authentication
+## How the Gateway resolves authentication
When sending a request to a service with a client certificate, the Gateway performs the following process to resolve authentication:
@@ -30,11 +31,12 @@ When sending a request to the login endpoint with a client certificate, the Gate
4. The Gateway then performs the login of the mapped user and returns a valid JWT token.
:::note Notes:
+
* As of Zowe release 3.0.0, the Internal API ML Mapper is the default API that provides this mapping between the public part of the client certificate and SAF user ID. Alternatively, you can use Z Secure Services (ZSS) to provide this API for API ML, with the noted exception when using ACF2, although we recommend using the internal API ML mapper.
* For information about ZSS, see the section Zowe runtime in the [Zowe server-side installation overview](./install-zos.md).
:::
-The following diagram shows how routing works with ZSS, in the case where the ZSS API is used for the identity mapping.
+The following diagram shows how routing works with ZSS, in the case where the ZSS API is used for the identity mapping.
@@ -42,24 +44,41 @@ The following diagram shows how routing works with ZSS, in the case where the ZS
For more information, see the Medium blog post [Zowe client certificate authentication](https://medium.com/zowe/zowe-client-certificate-authentication-5f1c7d4d579).
:::
-## Configure your z/OS system to support client certificate authentication for a specific user
+## Configure your z/OS system to support client certificate authentication for specific users
+
+Register the client certificate with the user IDs in your ESM.
+
+The following commands show options for both the internal API ML mapper and ZSS.
+
+:::note
-Register the client certificate with the user ID in your ESM. The following commands apply to both the internal API ML mapper and ZSS.
+If using the internal API ML mapper (default from Zowe v3) and the MAP / CERTMAP option with distinguished name filters, use the `CHCKCERT` or equivalent command on the certificate to use the same order and format of the certificate's distinguished name as displayed.
+:::
-**RACF**
+**RACF**
-Click here for an example command in RACF.
+Click here for an example command in RACF.
- ```
- RACDCERT ADD() ID() WITHLABEL('') TRUST
- SETROPTS RACLIST(DIGTCERT, DIGTRING) REFRESH
+ Activate the `DIGTNMAP` class:
+
+ ```racf
+ SETROPTS CLASSACT(DIGTNMAP) RACLIST(DIGTNMAP)
```
-Alternatively, if you are using the internal API ML mapper, use the following command:
- ```
+ Create the mapping for the user and a distinguished name filter:
+
+ ```racf
RACDCERT ID() MAP
SDNFILTER('')
WITHLABEL('')
+ SETROPTS RACLIST(DIGTMAP) REFRESH
+ ```
+
+ Alternatively, if you disabled the internal API ML mapper, use the following command to add the certificate to an ACID:
+
+ ```racf
+ RACDCERT ADD() ID() WITHLABEL('') TRUST
+ SETROPTS RACLIST(DIGTCERT, DIGTRING) REFRESH
```
@@ -69,11 +88,9 @@ Alternatively, if you are using the internal API ML mapper, use the following co
Click here for an example command in ACF2.
- `INSERT . DSNAME('') LABEL() TRUST`
+ Create the mapping for the user and a distinguished name filter:
-Alternatively, if you are using the internal API ML mapper, use the following command:
-
- ```
+ ```acf2
CERTMAP.
SDNFILTR()
LABEL()
@@ -81,30 +98,40 @@ Alternatively, if you are using the internal API ML mapper, use the following co
TRUST
```
-
-
+ Alternatively, if you disabled the internal API ML mapper, use the following command to add the certificate to an ACID
-**Top Secret**
+ ```acf2
+ INSERT . DSNAME('') LABEL() TRUST
+ ```
-
-Click here for an example command in Top Secret.
+
- `TSS ADDTO() DIGICERT() LABLCERT('') DCDSN('') TRUST`
+**Top Secret**
-Alternatively, if you are using the internal API ML mapper, use the following command:
+
+Click here for an example command in Top Secret.
- ```
+ Create the mapping for the user and a distinguished name filter:
+
+ ```tss
TSS ADDT0() CERTMAP()
SDNFILTR('')
USERID()
TRUST
```
-
+ Alternatively, if you disabled the internal API ML mapper, use the following command to add the certificate to an ACID:
+
+ ```tss
+ TSS ADDTO() DIGICERT() LABLCERT('') DCDSN('') TRUST
+ ```
+
+
Additional details are likely described in your security system documentation.
:::note Notes
+
* The alternative ESM map commands allow mapping a certificate to a user without adding the X.509 certificate to the ESM database. While this approach is more convenient, it could be considered less secure than adding the certificate to the ACID, which offers better control and protection.
* Ensure that you have the Issuer certificate imported in the truststore or in the SAF keyring. Alternatively, you can generate these certificates in SAF.
* Ensure that the client certificate has the following `Extended Key Usage` metadata:
@@ -112,16 +139,27 @@ Additional details are likely described in your security system documentation.
This metadata can be used for TLS client authentication.
:::
-
## Validate the client certificate functionality
-To validate that the client certificate functionality works properly, call the login endpoint with the certificate that was set up using the steps in [Configure your z/OS system to support client certificate authentication for a specific user](#configure-your-zos-system-to-support-client-certificate-authentication-for-a-specific-user) described previously in this article.
+To validate that the client certificate functionality works properly, call the login endpoint with the certificate that was set up using the steps in [Configure your z/OS system to support client certificate authentication for a specific user](#configure-your-zos-system-to-support-client-certificate-authentication-for-specific-users) described previously in this article.
Validate using _CURL_, a command line utility that runs on Linux based systems:
**Example:**
+
+```bash
+curl -X POST \
+--cert /path/to/cert.pem \
+--key /path/to/key.pem \
+https://api-mediation-layer:7554/gateway/api/v1/auth/login -v
```
-curl --cert /path/to/cert.pem --key /path/to/key.pem https://api-mediation-layer:7554/gateway/api/v1/login
-```
-Your Zowe instance is configured to accept x.509 client certificates authentication.
+Where:
+
+* `cert`: Specifies the certificate location
+* `key`: Path to the private key
+* `7554`: Replace with the configured API Gateway port in the intance
+
+x.509 Client Certificate authentication is correctly configured if the result of the request is HTTP 200 with an `apimlAuthenticationToken` cookie generated.
+
+Your Zowe instance is configured to accept x.509 client certificates authentication.
diff --git a/docs/user-guide/cli-configuringcli-ev.md b/docs/user-guide/cli-configuringcli-ev.md
index f9a627604d..9761370094 100644
--- a/docs/user-guide/cli-configuringcli-ev.md
+++ b/docs/user-guide/cli-configuringcli-ev.md
@@ -74,3 +74,13 @@ Use the `--show-inputs-only` option in a Zowe CLI command to view the property v
| Environment variable | Description | Values | Default |
| ---------------------- | ----------- |------- | ------- |
| `ZOWE_SHOW_SECURE_ARGS` | Displays secure property values used by a Zowe CLI command | `TRUE`, `FALSE` | `FALSE` |
+
+## Using Zowe CLI with a proxy
+
+If your network configuration requires communication with the mainframe to be performed through a proxy server, set environment variables to route Zowe CLI traffic through an HTTP/HTTPS proxy.
+
+| Environment Variable | Description | Example Value |
+| - | - | - |
+| `HTTPS_PROXY`, `https_proxy` | Use an `https` proxy to route communication to the mainframe when your proxy server supports `https`. | If authentication required:
Click here for command details for RACF.
- ```
+ ``` racf
RACDCERT ADD() ID() WITHLABEL('') TRUST
SETROPTS RACLIST(DIGTCERT, DIGTRING) REFRESH
```
- Alternatively, if you are using the internal API ML mapper, you can use the following command:
+
+ Alternatively, if you are using the internal API ML mapper, you can use the following commands:
+
+ Activate the `DIGTNMAP` class:
+ ```racf
+ SETROPTS CLASSACT(DIGTNMAP) RACLIST(DIGTNMAP)
```
+
+ Add mapping to the user:
+
+ ```racf
RACDCERT ID() MAP
SDNFILTER('')
WITHLABEL('')
```
+
**Note:** The `RACDCERT MAP` command allows mapping a certificate to a user without adding the X.509 certificate to the ESM database. While this approach is more convenient, it could be considered less secure than adding the certificate to the ACID, which offers better control and protection.
- **ACF2**
+ **ACF2**
Click here for command details for ACF2.
- `INSERT . DSNAME('') LABEL() TRUST`
+ ```acf2
+ INSERT . DSNAME('') LABEL() TRUST
+ ```
Alternatively, if you are using the internal API ML mapper, you can use the following command:
- ```
+ ```acf2
CERTMAP.
SDNFILTR()
LABEL()
@@ -94,11 +113,13 @@ Register the client certificate with the user ID in your ESM. The following comm
Click here for command details for Top Secret.
-`TSS ADDTO() DIGICERT() LABLCERT('') DCDSN('') TRUST`
+```
+TSS ADDTO() DIGICERT() LABLCERT('') DCDSN('') TRUST
+```
Alternatively, in case you are using the internal API ML mapper, you can use the following command:
- ```
+ ```tss
TSS ADDT0() CERTMAP()
SDNFILTR('')
USERID()
@@ -110,6 +131,7 @@ Alternatively, in case you are using the internal API ML mapper, you can use the
Additional details are likely described in your security system documentation.
:::note Notes
+
* ZSS is currently the default API that provides this mapping between the public part of the client certificate and SAF user ID. Using the internal API ML mapper is, however, the recommended method.
* The alternative ESM map commands allow mapping a certificate to a user without adding the X.509 certificate to the ESM database. While this approach is more convenient, it could be considered less secure than adding the certificate to the ACID, which offers better control and protection.
* Ensure that you have the Issuer certificate imported in the truststore or in the SAF keyring. Alternatively, you can generate these certificates in SAF.
@@ -118,7 +140,6 @@ Alternatively, in case you are using the internal API ML mapper, you can use the
This metadata can be used for TLS client authentication.
:::
-
## Validate the client certificate functionality
To validate that the client certificate functionality works properly, call the login endpoint with the certificate that was set up using the steps in [Configure your z/OS system to support client certificate authentication for a specific user](#configure-your-zos-system-to-support-client-certificate-authentication-for-a-specific-user) described previously in this article.
@@ -126,8 +147,20 @@ To validate that the client certificate functionality works properly, call the l
Validate using _CURL_, a command line utility that runs on Linux based systems:
**Example:**
+
+```bash
+curl -X POST \
+--cert /path/to/cert.pem \
+--key /path/to/key.pem \
+https://api-mediation-layer:7554/gateway/api/v1/auth/login -v
```
-curl --cert /path/to/cert.pem --key /path/to/key.pem https://api-mediation-layer:7554/gateway/api/v1/login
-```
-Your Zowe instance is configured to accept x.509 client certificates authentication.
+Where:
+
+* `cert`: Specifies the certificate location
+* `key`: Path to the private key
+* `7554`: Replace with the configured API Gateway port in the intance
+
+x.509 Client Certificate authentication is correctly configured if the result of the request is HTTP 200 with an `apimlAuthenticationToken` cookie generated.
+
+Your Zowe instance is configured to accept x.509 client certificates authentication.