Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Vert.x Gatway Docs [Keycloak - Security] #2579

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve Vert.x Gatway Docs [Keycloak - Security] #2579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1bd21c
docs: remove deprecated property `realm-public-key`
volkflo Aug 10, 2023
4601f40
chore(configs): remove deprecated property `realm-public-key`
volkflo Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions CHANGELOG.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ All notable changes to Apiman will be documented here (as of Apiman 3).

=== Removed

* [docs]: removed deprecated documentation for `realm-public-key` in vert.x gateway auth config

=== Fixed

// end::3.2.0-SNAPSHOT[]
Expand All @@ -20,14 +22,14 @@ All notable changes to Apiman will be documented here (as of Apiman 3).

=== Added

* [gateway-vertx]: you can add a list of additional `allowed-issuers` in your Gateway API Keycloak Authentication config.
* [gateway-vertx]: you can add a list of additional `allowed-issuers` in your Gateway API Keycloak Authentication config.
This better supports situations where your Keycloak server returns multiple different issuers, for example for internal vs external domains, Docker, K8s, etc. By https://github.com/msavy[Marc Savy (@msavy)^].

=== Changed

* A large number of dependencies have been updated across the Apiman codebase in order to improve security. By https://github.com/msavy[Marc Savy (@msavy)^].

* [containers/docker-compose]: to support a change in Keycloak's behaviour, we now set `allowed-issuers` in the Vert.x
* [containers/docker-compose]: to support a change in Keycloak's behaviour, we now set `allowed-issuers` in the Vert.x
Gateway API authentication configuration to allow both internal and external issuers. By https://github.com/msavy[Marc Savy (@msavy)^].

=== Removed
Expand Down
1 change: 0 additions & 1 deletion containers/vertx-standalone/examples/configs/conf-standalone.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,6 @@
"requiredRole": "realm:apipublisher",
// Paste and overwrite your Keycloak config here.
"realm": "apiman",
"realm-public-key": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxyG61ohrfJQKNmDA/ePZtqZVpPXjwn3k3T+iWiTvMsxW2+WlnqIEmL5qZ09DMhBH9r50WZRO2gVoCb657Er9x0vfD6GNf/47XU2y33TX8axhP+hSwkv/VViaDlu4jQrfgPWz/FXMjWIZxg1xQS+nOBF2ScCRYWNQ/ZnUNnvrq8dGC2/AlyeYcgDUOdwlJuvgkGlF0QoVPQiRPurR3RwlG+BjL8JB3hbaAZhdJqwqApmGQbcpgLj2tODnlrZnEAp5cPPU/lgqCE1OOp78BAEiE91ZLPl/+D8qDHk+Maz0Io3bkeRZMXPpvtbL3qN+3GlF8Yz264HDSsTNrH+nd19tFQIDAQAB",
"auth-server-url": "http://localhost:8080/auth",
"ssl-required": "none",
"resource": "apiman-gateway-api",
Expand Down
8 changes: 0 additions & 8 deletions docs/installation/modules/ROOT/pages/gateway/security.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,6 @@ a| Keycloak secret credential for the Apiman Gateway API (`apiman-gateway-api` c

* *Default Value*: password

a| * System property: apiman.auth.realm-public-key
* Env var: APIMAN_AUTH_REALM_PUBLIC_KEY
| String
a| Public key for Apiman realm (only needed on Vert.x Gateway).

* *Default Value*: example Apiman realm key

|===

WARNING: Please change default secrets and keys before deploying Apiman to production.
Expand Down Expand Up @@ -170,7 +163,6 @@ You can change your client type to `confidential`, or simply provide a dummy `cr
"requiredRole": "realm:apipublisher",
// Paste and overwrite your Keycloak config here.
"realm": "apiman",
"realm-public-key": "<snip>",
"auth-server-url": "http://localhost:8080/auth",
"ssl-required": "none",
"resource": "apiman-gateway-api",
Expand Down
8 changes: 0 additions & 8 deletions docs/installation/modules/ROOT/pages/keycloak.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,6 @@ a| Keycloak secret credential for the Apiman Gateway API (`apiman-gateway-api` c

* *Default Value*: password

a| * System property: `apiman.auth.realm-public-key`
* Env var: `APIMAN_AUTH_REALM_PUBLIC_KEY`
| String
a| Public key for Apiman realm. Get this from your Keycloak realm.

* *Default Value*: Apiman will retrieve this from your Keycloak server's `.well-known` endpoint automatically.

|===

WARNING: Please change default secrets and keys before deploying Apiman to production.
Expand Down Expand Up @@ -343,7 +336,6 @@ You can change your client type to `confidential`, or simply provide a dummy `cr
"requiredRole": "realm:apipublisher",
// Paste and overwrite your Keycloak config here. <1>
"realm": "apiman",
"realm-public-key": "<snip>",
"auth-server-url": "http://localhost:8080/auth",
"ssl-required": "none",
"resource": "apiman-gateway-api",
Expand Down
1 change: 0 additions & 1 deletion docs/installation/modules/ROOT/pages/registries-and-components/headless.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ IMPORTANT: Due to a current limitation in the underlying OAuth2 library you may
"password": "bar",
// Start paste & replace your Keycloak config here.
"realm": "apiman",
"realm-public-key": "< snip >",
"auth-server-url": "http://localhost:8080/auth",
"ssl-required": "none",
"resource": "apiman-gateway-api",
Expand Down