Repository navigation
Mask secrets in client installations when view-only permissions are used - #53758
Merged
mposolda merged 3 commits intoOct 19, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Nested client-secret-jwt credentials remain exposed to view-only callers.
1 open finding
What changed in this PR
Adds permission-aware secret masking to client installation configurations.
Changes:
- Propagates
includeSecretsthrough installation providers. - Masks OIDC secrets and stored SAML private keys for view-only callers.
- Adds regression tests and upgrade documentation.
| File | Description |
|---|---|
tests/base/src/test/java/org/keycloak/tests/client/AdapterInstallationConfigTest.java |
Tests registration endpoint masking. |
tests/base/src/test/java/org/keycloak/tests/admin/ClientSecretVisibilityTest.java |
Tests OIDC and SAML visibility. |
services/src/main/java/org/keycloak/services/resources/admin/ClientResource.java |
Derives secret access from management permission. |
services/src/main/java/org/keycloak/services/managers/ClientManager.java |
Applies permission-aware credential generation. |
services/src/main/java/org/keycloak/services/managers/ClientInstallationUtils.java |
Centralizes OIDC secret masking. |
services/src/main/java/org/keycloak/services/clientregistration/AdapterInstallationClientRegistrationProvider.java |
Masks view-only registration responses. |
services/src/main/java/org/keycloak/protocol/saml/installation/SamlSPDescriptorClientInstallation.java |
Adopts the provider signature. |
services/src/main/java/org/keycloak/protocol/saml/installation/ModAuthMellonClientInstallation.java |
Masks exported signing keys. |
services/src/main/java/org/keycloak/protocol/saml/installation/KeycloakSamlSubsystemInstallation.java |
Propagates secret visibility. |
services/src/main/java/org/keycloak/protocol/saml/installation/KeycloakSamlSubsystemCliInstallation.java |
Masks CLI private keys. |
services/src/main/java/org/keycloak/protocol/saml/installation/KeycloakSamlClientInstallation.java |
Masks XML private keys. |
services/src/main/java/org/keycloak/protocol/oidc/installation/KeycloakOIDCJbossSubsystemClientInstallation.java |
Applies OIDC masking to XML. |
services/src/main/java/org/keycloak/protocol/oidc/installation/KeycloakOIDCJbossSubsystemClientCliInstallation.java |
Applies OIDC masking to CLI output. |
services/src/main/java/org/keycloak/protocol/oidc/installation/KeycloakOIDCClientInstallation.java |
Applies masking to JSON output. |
services/src/main/java/org/keycloak/protocol/docker/installation/DockerVariableOverrideInstallationProvider.java |
Adopts the provider signature. |
services/src/main/java/org/keycloak/protocol/docker/installation/DockerRegistryConfigFileInstallationProvider.java |
Adopts the provider signature. |
services/src/main/java/org/keycloak/protocol/docker/installation/DockerComposeYamlInstallationProvider.java |
Adopts the provider signature. |
server-spi-private/src/main/java/org/keycloak/protocol/ClientInstallationProvider.java |
Adds the includeSecrets contract. |
docs/documentation/upgrading/topics/changes/changes-26_8_1.adoc |
Documents masking and API changes. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
vmuzikar
force-pushed
the
fix/53751-installation-secret-disclosure
branch
from
October 8, 2026 17:35
0945e43 to
b9b47b6
Compare
vmuzikar
marked this pull request as ready for review
October 8, 2026 18:57
vmuzikar
force-pushed
the
fix/53751-installation-secret-disclosure
branch
from
October 8, 2026 19:07
b9b47b6 to
f9a3ca7
Compare
mposolda
reviewed
Oct 13, 2026
Contributor
There was a problem hiding this comment.
@vmuzikar Thanks! I've added 2 minor comments inline.
Moreover, can you please double-check if we don't have some other "alternative" way how only guys with permissions to "view clients" can obtain client secrets? As otherwise, we would have another CVE report for the same thing soon :-) Feel free to use some AI tool or whatever. Please confirm if you already did this and that this point is fine now.
Contributor
Author
|
@mposolda Thanks for the review! I removed the Upgrading Guide note.
Yes, I poked around also with Fable 5.1, and even that thinks the fix is complete. Only thing I missed was a dead code that could reveal the secrets but it was not used and I removed it in the last commit. |
vmuzikar
force-pushed
the
fix/53751-installation-secret-disclosure
branch
from
October 13, 2026 16:04
f9a3ca7 to
fbca6e7
Compare
vmuzikar
force-pushed
the
fix/53751-installation-secret-disclosure
branch
from
October 13, 2026 18:22
f4e304f to
fd3623d
Compare
Contributor
|
this issue is partially related to -> #49240 |
Contributor
Author
Yes but that's not for Client Installations. I'd tackle that in a separate PR. |
Closes keycloak#53751 Signed-off-by: Václav Muzikář <vmuzikar@ibm.com>
Signed-off-by: Václav Muzikář <vmuzikar@ibm.com>
Signed-off-by: Václav Muzikář <vmuzikar@ibm.com>
mposolda
force-pushed
the
fix/53751-installation-secret-disclosure
branch
from
October 19, 2026 13:25
fd3623d to
71a1f77
Compare
vmuzikar
added a commit
to vmuzikar/keycloak
that referenced
this pull request
Oct 20, 2026
…sed (keycloak#53758) Closes keycloak#53751 Signed-off-by: Václav Muzikář <vmuzikar@ibm.com> (cherry picked from commit 32d8958) Signed-off-by: Václav Muzikář <vmuzikar@ibm.com>
PadzerButch
pushed a commit
to PadzerButch/-50764_test_migration_keycloak
that referenced
this pull request
Oct 22, 2026
…sed (keycloak#53758) Closes keycloak#53751 Signed-off-by: Václav Muzikář <vmuzikar@ibm.com>
PadzerButch
pushed a commit
to PadzerButch/-50764_test_migration_keycloak
that referenced
this pull request
Oct 23, 2026
…sed (keycloak#53758) Closes keycloak#53751 Signed-off-by: Václav Muzikář <vmuzikar@ibm.com>
vmuzikar
added a commit
that referenced
this pull request
Nov 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This also extends the masking to SAML private keys. Those are not persisted any more (see #49239) but existing clients still could contain those.
Closes #53751