Skip to content

Commit

Permalink
Merge pull request #3612 from zowe/janan07-add-apiml-security-overvie…
Browse files Browse the repository at this point in the history
…w-in-sidebar

Add API ML security overview to sidebar
  • Loading branch information
janan07 authored Apr 18, 2024
2 parents abce8ad + da4c064 commit 3138a38
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Review this article to learn about topics which address security features in Zow
- [Zowe API ML services](#zowe-api-ml-services)
- [Zowe API ML TLS requirements](#zowe-api-ml-tls-requirements)
- [Setting ciphers for API ML services](#setting-ciphers-for-api-ml-services)
- [JSON Web Token(JWT)](#json-web-tokenjwt)
- [JSON Web Token (JWT)](#json-web-tokenjwt)
- [z/OSMF JSON Web Tokens Support](#zosmf-json-web-tokens-support)

## How API ML transport security works
Expand Down Expand Up @@ -118,7 +118,9 @@ The API ML TLS requires servers to provide HTTPS ports. Each API ML service has

You can override ciphers that are used by the HTTPS servers in API ML services by configuring properties of the Gateway, Discovery Service, and API Catalog.

**Note:** You do not need to rebuild JAR files when you override the default values in shell scripts.
:::note
You do not need to rebuild JAR files when you override the default values in shell scripts.
:::

The default value for each service can be found in the [application.yml](https://github.com/zowe/api-layer/blob/master/gateway-service/src/main/resources/application.yml) file. The default configuration is packed in .jar files. On z/OS, you can override the default configuration in `<RUNTIME_DIR>/components/<APIML_COMPONENT>/bin/start.sh`.
Add the launch parameter of the shell script to set a cipher:
Expand All @@ -131,7 +133,9 @@ On localhost, you can override the default configuration in [config/local/gatewa

The following list shows the default ciphers. API ML services use the following cipher order:

**Note:** Ensure that the version of Java you use is compatible with the default cipherset.
:::note
Ensure that the version of Java you use is compatible with the default cipherset.
:::

```
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,
Expand All @@ -152,7 +156,6 @@ You can also use the `/gateway/api/v1/auth/keys/public` endpoint to obtain a pub

## z/OSMF JSON Web Tokens Support


Your z/OSMF instance can be enabled to support JWTs as described in [Enabling JSON Web Token support](https://www.ibm.com/support/knowledgecenter/SSLTBW_2.4.0/com.ibm.zos.v2r4.izua300/izuconfig_EnableJSONWebTokens.htm).
In such cases, the Zowe API ML uses this JWT and does not generate its own Zowe JWT. All authentication APIs, such as `/gateway/api/v1/login` and `/gateway/api/v1/check` function in the same way as without z/OSMF JWT.
The Gateway service endpoint `/gateway/api/v1/auth/keys/public` serves the z/OSMF JWK that can be used for JWT signature validation.
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -682,6 +682,7 @@ module.exports = {
label: "Developing for Zowe API Mediation Layer",
items: [
"extend/extend-apiml/onboard-overview",
"extend/extend-apiml/zowe-api-mediation-layer-security-overview",
{
type: "category",
label: "API Mediation Layer Quick start for development",
Expand Down

0 comments on commit 3138a38

Please sign in to comment.