Repository navigation
fix(hmac): don't include the HMAC key in the invalid key exception - #2100
Open
ratomirjovanovic wants to merge 1 commit into
Open
ratomirjovanovic wants to merge 1 commit into
ratomirjovanovic wants to merge 1 commit into
Conversation
calculateHMAC put the rejected key into the IllegalArgumentException message. A key usually fails hex decoding because of quotes or a stray character around the real key, so the message carried the secret into logs. Describe the expected format instead.
Contributor
There was a problem hiding this comment.
Code Review
This pull request improves security by ensuring that the HMAC key is not leaked in exception messages when a DecoderException occurs during HMAC calculation. The exception message now uses a generic error description instead of appending the invalid key. Corresponding unit tests have been updated and added to verify this behavior. I have no further feedback to provide as the changes are correct and well-tested.
This branch has not been deployed
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.
HMACValidator.calculateHMACthrowsInvalid Hex HMAC key: <key>when the key isn't valid hex. A key usually fails that check because of quotes or a stray character around the real key, so the message carries the secret into logs and error trackers.This replaces it with
Invalid Hex HMAC key: it must be a hexadecimal string with an even number of characters. The prefix stays the same.Tests: updated
testCalculateHMACInvalidKeyFormatfor the new message and addedtestCalculateHMACInvalidKeyIsNotInMessage(a quoted key, checks the message doesn't contain it). Ranmvn clean teston JDK 21 (661 tests pass) andspotless:check, which is clean for the changed files.Same change for PHP in Adyen/adyen-php-api-library#976.