|
1 | 1 | :_mod-docs-content-type: ASSEMBLY |
2 | 2 |
|
3 | 3 | [id='assembly-oauth-security-{context}'] |
4 | | -= Enabling OAuth 2.0 token-based access |
| 4 | += Configuring OAuth 2.0 token-based security |
5 | 5 |
|
6 | 6 | [role="_abstract"] |
7 | | -Strimzi supports OAuth 2.0 for securing Kafka clusters by integrating with an OAuth 2.0 authorization server. |
8 | | -Kafka brokers and clients both need to be configured to use OAuth 2.0. |
| 7 | +Strimzi supports OAuth 2.0 token-based authentication and authorization for securing Kafka clusters and Kafka-related components. |
9 | 8 |
|
10 | | -OAuth 2.0 enables standardized token-based authentication and authorization between applications, using a central authorization server to issue tokens that grant limited access to resources. |
11 | | -You can define specific scopes for fine-grained access control. |
12 | | -Scopes correspond to different levels of access to Kafka topics or operations within the cluster. |
| 9 | +With OAuth 2.0 integration you can: |
13 | 10 |
|
14 | | -OAuth 2.0 also supports single sign-on and integration with identity providers. |
| 11 | +* Enable token-based authentication on Kafka brokers |
| 12 | +* Configure Kafka components, such as Kafka Connect, MirrorMaker 2, and the Kafka Bridge, to authenticate using access tokens |
| 13 | +* Use token claims or Keycloak Authorization Services to perform fine-grained authorization |
15 | 14 |
|
16 | | -NOTE: The authentication type `oauth` and `keycloak` authorization type are deprecated and will be removed in a future release. |
17 | | -Use the `custom` authentication and authorization type to configure token-based security on listeners and components. |
18 | | -This content is currently being updated to reflect the transition to the `custom` authentication type. |
| 15 | +OAuth 2.0 provides centralized identity and access control using access tokens issued by an authorization server. |
| 16 | +Kafka brokers validate these tokens when clients connect, and authorization providers can use token claims to make access decisions. |
19 | 17 |
|
20 | | -ifdef::Section[] |
21 | | -For more information on using OAuth 2.0, see the link:https://github.com/strimzi/strimzi-kafka-oauth[Strimzi OAuth 2.0 for Apache Kafka project^]. |
22 | | -endif::Section[] |
| 18 | +This section describes the minimal configuration required to deploy a Kafka cluster and clients with token-based authentication and authorization. |
23 | 19 |
|
24 | | -//setting up oauth server |
25 | | -include::../../modules/oauth/proc-oauth-server-config.adoc[leveloffset=+1] |
| 20 | +//migration |
| 21 | +include::../../modules/oauth/con-oauth-migration.adoc[leveloffset=+1] |
26 | 22 |
|
27 | | -//oauth authentication |
28 | | -include::../oauth/assembly-oauth-authentication.adoc[leveloffset=+1] |
| 23 | +//oauth-project |
| 24 | +include::../../modules/oauth/con-oauth-project.adoc[leveloffset=+1] |
29 | 25 |
|
30 | | -//oauth authorization |
31 | | -include::../oauth/assembly-oauth-authorization.adoc[leveloffset=+1] |
| 26 | +//server-side config |
| 27 | +include::../../modules/oauth/con-oauth-server-config.adoc[leveloffset=+1] |
32 | 28 |
|
33 | | -//keycloak authorization |
34 | | -include::../oauth/assembly-managing-policies-permissions-keycloak.adoc[leveloffset=+1] |
| 29 | +//client-side config |
| 30 | +include::../../modules/oauth/con-oauth-client-config.adoc[leveloffset=+1] |
35 | 31 |
|
| 32 | +//enabling authorization |
| 33 | +include::../../modules/oauth/con-oauth-authz-config.adoc[leveloffset=+1] |
| 34 | + |
| 35 | +//using keycloak |
| 36 | +include::../../modules/oauth/con-oauth-keycloak-config.adoc[leveloffset=+1] |
0 commit comments