Skip to content

Commit

Permalink
Merge pull request #4024 from zowe/reboot/oidc-doc-update
Browse files Browse the repository at this point in the history
refresh multi tenancy and OIDC doc
  • Loading branch information
janan07 authored Dec 9, 2024
2 parents e8d3493 + fd059f3 commit 08f3dc4
Show file tree
Hide file tree
Showing 149 changed files with 566 additions and 585 deletions.
40 changes: 24 additions & 16 deletions docs/diagrams/apiml-oidc-auth-seq.puml
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,40 @@
autonumber
actor User
actor "User Agent" as Agent
actor "Client App" as Client
actor OIDC as OIDC
actor "API ML GW" as GW

User -> Agent: Do stuff
Agent -> Client: Open Client App
Client -> OIDC: Initiate OIDC flow [client_id, client_secret]
loop [MFA]
Agent -> GW: /gateway/oauth2/authorization/<provider-id>
GW -> OIDC: Initiate OIDC flow [client_id, client_secret]
group MFA
OIDC -> Agent: Request user credentials
User <-> Agent: Provide credentials
Agent -> OIDC: Validate credentials
end
OIDC --> Client: Return Auth Code / JWTs[access,refresh,identity]
Client -> GW: Request resources [JWT AT]
group validate
GW -> GW: Validate AT
GW -> OIDC: Validate AT
end
alt Validation success
GW -> GW: Cache AT validity
OIDC --> GW: Return Auth Code / JWTs[access,refresh,identity]
GW -> Agent: Set-cookie access token
Agent -> GW: Request resources [access token]
GW -> GW: Validate access token
GW -> GW: Cache access token validity
group map user
GW -> SAF: Map distributed ID to mainframe ID
end
alt mapping success
GW -> GW: Create Zowe JWT
GW -> Service: call API service
Service --> GW: return Response
GW -> Service: Call API service with Zowe JWT
Service -> Service: Validate JWT
Service --> GW: Return Response
autonumber 14 1
else mapping failure

GW -> Service: call API service with access token
note left: Step 13 Create Zowe JWT was skipped
Service -> Service: Validate access token
Service --> GW: Return Response
end
GW --> Client: Response
Client --> Agent: Response
autonumber 17 1
GW --> Agent: Response


@enduml
250 changes: 158 additions & 92 deletions docs/extend/extend-apiml/api-mediation-oidc-authentication.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The following list shows the default ciphers. API ML services use the following
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_AES_128_GCM_SHA256,TLS_AES_256_GCM_SHA384
```

Only IANA ciphers names are supported. For more information, see [Cipher Suites](https://wiki.mozilla.org/Security/Server_Side_TLS#Cipher_suites) or [List of Ciphers](https://testssl.net/openssl-iana.mapping.html).
Only IANA ciphers names are supported. For more information, see [Cipher Suites](https://wiki.mozilla.org/Security/Server_Side_TLS#Cipher_suites) or [List of Ciphers](https://testssl.sh/openssl-iana.mapping.html).

## JSON Web Token (JWT)

Expand Down
4 changes: 2 additions & 2 deletions docs/extend/zowe-conformance-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ As vendors, you are invited to submit conformance testing results for review and

To participate in the Zowe Conformance Program, follow the process on the [Zowe Conformance Program website](https://openmainframeproject.org/our-projects/zowe-conformance-program/). You can also find a list of products that have earned Zowe Conformant status.

To learn the criteria of achieving Zowe conformance for an offering, see [Zowe Conformance Criteria](https://github.com/openmainframeproject/foundation/tree/master/zowe_conformance).
To learn the criteria of achieving Zowe conformance for an offering, see [Zowe Conformance Criteria](https://github.com/openmainframeproject/foundation/blob/main/zowe_conformance/test_evaluation_guide_table.md).

## How to suggest updates to the Zowe conformance program

The Zowe conformance criteria is available as a table in [a Markdown file](https://github.com/openmainframeproject/foundation/blob/master/zowe_conformance/test_evaluation_guide_table.md) in the Open Mainframe Project's GitHub repo. If you find a mistake with the Zowe conformance documents, or you are a Zowe squad lead and want to make an amendment to the criteria, you can update that Markdown file. The same information is also held in another document [Zowe Conformance Test Evaluation Guide](https://github.com/openmainframeproject/foundation/blob/master/zowe_conformance/test_evaluation_guide.md) that has history going back to Zowe 2019 conformance and allows easy change history comparison.
The Zowe conformance criteria is available as a table in [a Markdown file](https://github.com/openmainframeproject/foundation/blob/master/zowe_conformance/test_evaluation_guide_table.md) in the Open Mainframe Project's GitHub repo. If you find a mistake with the Zowe conformance documents, or you are a Zowe squad lead and want to make an amendment to the criteria, you can update that Markdown file. The same information is also held in another document [Zowe Conformance Test Evaluation Guide](https://github.com/openmainframeproject/foundation/blob/main/zowe_conformance/test_evaluation_guide_table.md) that has history going back to Zowe 2019 conformance and allows easy change history comparison.

To submit a proposal to update the conformance criteria, fork the OMP's `foundation` repository at [https://github.com/openmainframeproject/foundation](https://github.com/openmainframeproject/foundation) and make a pull request. Flag the Pull Request to the attention of GitHub user ID `@mertic`, and also reach out to the Zowe onboarding squad in the [#zowe-onboarding](https://openmainframeproject.slack.com/archives/CC60ALD61) Slack channel. If you are not already signed up to Zowe Slack community, you can sign up at [https://slack.openmainframeproject.org](https://slack.openmainframeproject.org/) first.

2 changes: 1 addition & 1 deletion docs/getting-started/user-roadmap-apiml.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The following definition of skill levels about Zowe assist you with gathering th

Join the #zowe-api Slack channel to ask questions about Zowe API ML, propose new ideas, and interact with the Zowe community.

- [**Zowe API ML squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar)
- [**Zowe API ML squad meetings**](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe)

You can join one of the Zowe API ML squad meetings to get involved.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/user-roadmap-app-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ The following definition of skill levels about Zowe will help you gather most re

Join the Slack channel to ask questions, propose new ideas, and interact with the Zowe community. <!--which slack channel is appropriate?-->

- [**Zowe WebUI squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar)
- [**Zowe WebUI squad meetings**](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe)

You can join one of the Zowe WebUI squad meetings to get involved.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/user-roadmap-client-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The following definition of skill levels about Zowe will help you gather most re

Join the #zowe-cli Slack channel to ask questions about Zowe CLI and Zowe SDKs, propose new ideas, and interact with the Zowe community.

- [**Zowe CLI squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar)
- [**Zowe CLI squad meetings**](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe)

You can join one of the Zowe CLI squad meetings to discuss Zowe SDKs issues and contibute to Zowe SDKs.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/user-roadmap-zowe-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ To identify the resources most relevant for you, use the following definitions o

Join the `# zowe-explorer` Slack channel to ask questions, propose new ideas, and interact with the Zowe community.

* [**Zowe Explorer squad meetings**](https://lists.openmainframeproject.org/g/zowe-dev/calendar)
* [**Zowe Explorer squad meetings**](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe)

You can join one of the Zowe Explorer squad meetings to get involved.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/zowe-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The [OMP Youtube channel](https://www.youtube.com/channel/UC-WTXQQtz2m5iTflJLK59

**Connect with the community through meetings**

- [Zowe meeting calendar](https://lists.openmainframeproject.org/g/zowe-dev/calendar)
- [Zowe meeting calendar](https://zoom-lfx.platform.linuxfoundation.org/meetings/zowe)

You can join one of the Zowe meetings to get latest Zowe updates and get involved in different squads and initiatives.

Expand Down
Binary file modified docs/images/api-mediation/apiml-oidc-auth-seq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 08f3dc4

Please sign in to comment.