[Networking] Enhance Gossipsub Resilience: Configurable Threshold for Invalid Topic IDs in Control Messages #5391
Conversation
This file contains 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
peterargue
approved these changes
Feb 15, 2024
yhassanzadeh13
approved these changes
Feb 17, 2024
| c.metrics.OnInvalidTopicIdDetectedForControlMessage(p2pmsg.CtrlMsgGraft) | ||
| return err, ctrlMsgType | ||
| if totalInvalidTopicIdErrs > c.config.GraftPrune.InvalidTopicIdThreshold { | ||
| return err, ctrlMsgType |
There was a problem hiding this comment.
Consider returning a specific error type (e.g., ErrInvalidTopicIdExceedThreshold) instead of using the generic error from validateTopics. This approach provides clearer context, indicating misbehavior from exceeding the threshold, rather than signaling a single invalid topic. This also aligns with our general approach on returning an error when exceeding threshold, e.g., for duplicate topic ids we already have:
if totalDuplicateTopicIds > c.config.GraftPrune.DuplicateTopicIdThreshold {
c.metrics.OnGraftDuplicateTopicIdsExceedThreshold()
return NewDuplicateTopicErr(topic.String(), totalDuplicateTopicIds, p2pmsg.CtrlMsgGraft), p2p.CtrlMsgNonClusterTopicType
}| c.metrics.OnInvalidTopicIdDetectedForControlMessage(p2pmsg.CtrlMsgPrune) | ||
| return err, ctrlMsgType | ||
| if totalInvalidTopicIdErrs > c.config.GraftPrune.InvalidTopicIdThreshold { | ||
| return err, ctrlMsgType |
| c.metrics.OnInvalidTopicIdDetectedForControlMessage(p2pmsg.CtrlMsgIHave) | ||
| return err, ctrlMsgType | ||
| if totalInvalidTopicIdErrs > c.config.IHave.InvalidTopicIdThreshold { | ||
| return err, ctrlMsgType |
yhassanzadeh13
changed the title
Co-authored-by: Yahya Hassanzadeh, Ph.D. <yhassanzadeh@ieee.org>
Co-authored-by: Yahya Hassanzadeh, Ph.D. <yhassanzadeh@ieee.org>
Co-authored-by: Yahya Hassanzadeh, Ph.D. <yhassanzadeh@ieee.org>
Co-authored-by: Yahya Hassanzadeh, Ph.D. <yhassanzadeh@ieee.org>
…flow/flow-go into khalil/6934-invalid-topicid-threshold
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #5391 +/- ##
==========================================
- Coverage 55.99% 55.98% -0.01%
==========================================
Files 1026 1026
Lines 99815 99902 +87
==========================================
+ Hits 55894 55933 +39
- Misses 39627 39674 +47
- Partials 4294 4295 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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 pull request mitigates the potential for false positives arising from edge cases in Gossipsub, specifically addressing scenarios where a node receives control messages containing apparently invalid topics (e.g., the node is not subscribed to the topic, subscription dissemination glitches, etc.). The enhancement introduces a configurable
invalid-topic-id-thresholdfor graft, prune, and ihave control message topic validation. Now, an error is triggered only when the number of encountered invalid topic ids surpasses this configured threshold. Additionally, the PR includes XX_AboveThreshold and XX_BelowThreshold tests, ensuring that the dissemination of an invalid control message notification aligns with expectations based on whether the count is above or below the configured threshold.