fix(kafka): register SCRAMClientGeneratorFunc for SCRAM-SHA-256/512 auth#789
Open
AuburyEssentian wants to merge 1 commit intoethpandaops:masterfrom
Open
fix(kafka): register SCRAMClientGeneratorFunc for SCRAM-SHA-256/512 auth#789AuburyEssentian wants to merge 1 commit intoethpandaops:masterfrom
AuburyEssentian wants to merge 1 commit intoethpandaops:masterfrom
Conversation
SCRAM authentication requires sarama's SCRAMClientGeneratorFunc to be set in addition to the mechanism name. Without it, the mechanism is declared but the actual SCRAM handshake is never performed, causing authentication to always fail. Add an xdgSCRAMClient implementation backed by github.com/xdg-go/scram (already an indirect dependency via sarama) and wire it up for both SCRAM-SHA-256 and SCRAM-SHA-512 in InitSaramaConfig. Add test assertions to verify SCRAMClientGeneratorFunc is non-nil for SCRAM mechanisms and nil for all others. Fixes ethpandaops#726
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
1 participant
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.
Problem
Closes #726.
When configuring the Kafka output with
SCRAM-SHA-256orSCRAM-SHA-512SASL authentication,InitSaramaConfigsets the mechanism name on the sarama config but never setsSCRAMClientGeneratorFunc. Sarama requires this function to perform the SCRAM challenge-response handshake — without it, the connection attempt fails with an authentication error even though the config looks correct.Fix
Add an
xdgSCRAMClientstruct that wrapsgithub.com/xdg-go/scram(already an indirect dependency) and implements thesarama.SCRAMClientinterface (Begin,Step,Done). Wire up generator functions for SHA-256 and SHA-512 inside theSCRAM-SHA-256/SCRAM-SHA-512switch cases inInitSaramaConfig.github.com/xdg-go/scramis promoted from indirect to direct ingo.modsince it is now explicitly used by this package.Tests
Updated
TestInitSaramaConfig/SASL mechanismsto assert that:SCRAMClientGeneratorFuncis non-nil for SCRAM-SHA-256 and SCRAM-SHA-512SCRAMClientGeneratorFuncis nil for all other mechanisms (PLAIN, OAUTH, GSSAPI)sarama.SCRAMClient