Mask private client keys in logs - #538
Open
frankii91 wants to merge 1 commit into
Open
Conversation
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.
Summary
Mask
privateClientKeyvalues before privacyIDEA Authenticator writes or printslog messages.
Problem
SecureTokenContainerRepositorylogs container state while loading and savingcontainers. A finalized container's generated
toString()includes itsprivateClientKey. The logger already redacts several sensitive parameternames, but
privateClientKeywas not in that filter list, so exported errorlogs could contain the complete private client key.
These logs can be attached to support emails or shared for troubleshooting,
which makes the unredacted value a credential-disclosure risk.
Fix
Add
privateClientKeyto the logger's existing case-insensitive sensitiveparameter filter. This keeps the current centralized filtering behavior and
does not change container persistence, cryptography, or synchronization.
The public client key and other non-sensitive diagnostic context remain
available in the log.
Tests
key is present.
the public key preserved.
dart analyze lib/utils/logger.dart test/unit_test/utils/logger_test.dartreports only three pre-existing
prefer_initializing_formalsinfo messagesin
logger.dart; the new test has no diagnostics.