[Networking] GossipSub Spam Mitigation- Dynamic Decay Speed

cmd/access/node_builder/access_node_builder.go

@@ -1544,15 +1544,17 @@ func (builder *FlowAccessNodeBuilder) initPublicLibp2pNode(networkKey crypto.Pri
 	}
 	meshTracer := tracer.NewGossipSubMeshTracer(meshTracerCfg)
 
-	libp2pNode, err := p2pbuilder.NewNodeBuilder(builder.Logger, &p2pconfig.MetricsConfig{
-		HeroCacheFactory: builder.HeroCacheMetricsFactory(),
-		Metrics:          networkMetrics,
-	},
+	libp2pNode, err := p2pbuilder.NewNodeBuilder(builder.Logger,
+		&p2pconfig.MetricsConfig{
+			HeroCacheFactory: builder.HeroCacheMetricsFactory(),
+			Metrics:          networkMetrics,
+		},
 		network.PublicNetwork,
 		bindAddress,
 		networkKey,
 		builder.SporkID,
 		builder.IdentityProvider,
+		builder.FlowConfig.NetworkConfig.GossipSubConfig.GossipSubScoringRegistryConfig,
 		&builder.FlowConfig.NetworkConfig.ResourceManagerConfig,
 		&builder.FlowConfig.NetworkConfig.GossipSubConfig.GossipSubRPCInspectorsConfig,
 		&p2pconfig.PeerManagerConfig{

cmd/observer/node_builder/observer_builder.go

@@ -708,8 +708,7 @@ func (builder *ObserverServiceBuilder) initPublicLibp2pNode(networkKey crypto.Pr
 	}
 	meshTracer := tracer.NewGossipSubMeshTracer(meshTracerCfg)
 
-	node, err := p2pbuilder.NewNodeBuilder(
-		builder.Logger,
+	node, err := p2pbuilder.NewNodeBuilder(builder.Logger,
 		&p2pconfig.MetricsConfig{
 			HeroCacheFactory: builder.HeroCacheMetricsFactory(),
 			Metrics:          builder.Metrics.Network,
@@ -719,10 +718,10 @@ func (builder *ObserverServiceBuilder) initPublicLibp2pNode(networkKey crypto.Pr
 		networkKey,
 		builder.SporkID,
 		builder.IdentityProvider,
+		builder.FlowConfig.NetworkConfig.GossipSubConfig.GossipSubScoringRegistryConfig,
 		&builder.FlowConfig.NetworkConfig.ResourceManagerConfig,
 		&builder.FlowConfig.NetworkConfig.GossipSubConfig.GossipSubRPCInspectorsConfig,
-		p2pconfig.PeerManagerDisableConfig(), // disable peer manager for observer node.
-		&p2p.DisallowListCacheConfig{
+		p2pconfig.PeerManagerDisableConfig(), &p2p.DisallowListCacheConfig{
 			MaxSize: builder.FlowConfig.NetworkConfig.DisallowListNotificationCacheSize,
 			Metrics: metrics.DisallowListCacheMetricsFactory(builder.HeroCacheMetricsFactory(), network.PublicNetwork),
 		},

config/default-config.yml

@@ -140,6 +140,17 @@ network-config:
   gossipsub-rpc-metrics-inspector-workers: 1
   # The size of the queue used by worker pool for the control message metrics inspector
   gossipsub-rpc-metrics-inspector-cache-size: 100
+  #  The lower bound on the decay value for a spam record when initialized.
+  #  A random value in a range of InitDecayLowerBound and InitDecayUpperBound is used when initializing the decay
+  #  of a spam record.
+  gossipsub-scoring-registry-init-decay-lowerbound: .5
+  #  The upper bound on the decay value for a spam record when initialized.
+  gossipsub-scoring-registry-init-decay-upperbound: .7
+  #  The threshold for which when the negative penalty is below this value the decay threshold will be increased by some amount. This will
+  #  lead to malicious nodes having longer decays while honest nodes will have faster decays.
+  gossipsub-scoring-registry-increase-decay-threshold: -99
+  #  The amount the decay will be increased when the negative penalty score falls below the IncreaseDecayThreshold.
+  gossipsub-scoring-registry-decay-threshold-incrementer: .01
   # Application layer spam prevention
   alsp-spam-record-cache-size: 10e3
   alsp-spam-report-queue-size: 10e4

follower/follower_builder.go

@@ -586,20 +586,19 @@ func (builder *FollowerServiceBuilder) initPublicLibp2pNode(networkKey crypto.Pr
 	}
 	meshTracer := tracer.NewGossipSubMeshTracer(meshTracerCfg)
 
-	node, err := p2pbuilder.NewNodeBuilder(
-		builder.Logger,
+	node, err := p2pbuilder.NewNodeBuilder(builder.Logger,
 		&p2pconfig.MetricsConfig{
 			HeroCacheFactory: builder.HeroCacheMetricsFactory(),
 			Metrics:          builder.Metrics.Network,
 		},
 		network.PublicNetwork,
 		builder.BaseConfig.BindAddr,
-		networkKey,
-		builder.SporkID,
+		networkKey, builder.SporkID,
 		builder.IdentityProvider,
+		builder.FlowConfig.NetworkConfig.GossipSubConfig.GossipSubScoringRegistryConfig,
 		&builder.FlowConfig.NetworkConfig.ResourceManagerConfig,
 		&builder.FlowConfig.NetworkConfig.GossipSubConfig.GossipSubRPCInspectorsConfig,
-		p2pconfig.PeerManagerDisableConfig(), // disable peer manager for follower
+		p2pconfig.PeerManagerDisableConfig(),
 		&p2p.DisallowListCacheConfig{
 			MaxSize: builder.FlowConfig.NetworkConfig.DisallowListNotificationCacheSize,
 			Metrics: metrics.DisallowListCacheMetricsFactory(builder.HeroCacheMetricsFactory(), network.PublicNetwork),

network/internal/p2pfixtures/fixtures.go

@@ -125,6 +125,7 @@ func CreateNode(t *testing.T, networkKey crypto.PrivateKey, sporkID flow.Identif
 		networkKey,
 		sporkID,
 		idProvider,
+		defaultFlowConfig.NetworkConfig.GossipSubConfig.GossipSubScoringRegistryConfig,
 		&defaultFlowConfig.NetworkConfig.ResourceManagerConfig,
 		&defaultFlowConfig.NetworkConfig.GossipSubRPCInspectorsConfig,
 		p2pconfig.PeerManagerDisableConfig(),

network/netconf/flags.go

@@ -70,6 +70,12 @@ const (
 	metricsInspectorNumberOfWorkers = "gossipsub-rpc-metrics-inspector-workers"
 	metricsInspectorCacheSize       = "gossipsub-rpc-metrics-inspector-cache-size"
 
+	// gossipsub scoring registry
+	scoringRegistryInitDecayLowerbound       = "gossipsub-scoring-registry-init-decay-lowerbound"
+	scoringRegistryInitDecayUpperbound       = "gossipsub-scoring-registry-init-decay-upperbound"
+	scoringRegistryIncreaseDecayThreshold    = "gossipsub-scoring-registry-increase-decay-threshold"
+	scoringRegistryDecayThresholdIncrementer = "gossipsub-scoring-registry-decay-threshold-incrementer"
+
 	alspDisabled            = "alsp-disable-penalty"
 	alspSpamRecordCacheSize = "alsp-spam-record-cache-size"
 	alspSpamRecordQueueSize = "alsp-spam-report-queue-size"
@@ -138,6 +144,10 @@ func AllFlagNames() []string {
 		controlMessageMaxSampleSize,
 		iwantDuplicateMsgIDThreshold,
 		iwantCacheMissCheckSize,
+		scoringRegistryInitDecayLowerbound,
+		scoringRegistryInitDecayUpperbound,
+		scoringRegistryIncreaseDecayThreshold,
+		scoringRegistryDecayThresholdIncrementer,
 	}
 }
 
@@ -216,6 +226,11 @@ func InitializeNetworkFlags(flags *pflag.FlagSet, config *Config) {
 	flags.Float64(iwantCacheMissThreshold, config.GossipSubConfig.GossipSubRPCInspectorsConfig.GossipSubRPCValidationInspectorConfigs.IWantRPCInspectionConfig.CacheMissThreshold, "max number of iwants to sample when performing validation")
 	flags.Int(iwantCacheMissCheckSize, config.GossipSubConfig.GossipSubRPCInspectorsConfig.GossipSubRPCValidationInspectorConfigs.IWantRPCInspectionConfig.CacheMissCheckSize, "the iWants size at which message id cache misses will be checked")
 	flags.Float64(iwantDuplicateMsgIDThreshold, config.GossipSubConfig.GossipSubRPCInspectorsConfig.GossipSubRPCValidationInspectorConfigs.IWantRPCInspectionConfig.DuplicateMsgIDThreshold, "max allowed duplicate message IDs in a single iWant control message")
+
+	flags.Float64(scoringRegistryInitDecayLowerbound, config.GossipSubConfig.GossipSubScoringRegistryConfig.InitDecayLowerBound, "the lower bound on the decay value for a spam record when initialized")
+	flags.Float64(scoringRegistryInitDecayUpperbound, config.GossipSubConfig.GossipSubScoringRegistryConfig.InitDecayUpperBound, "the upper bound on the decay value for a spam record when initialized")
+	flags.Float64(scoringRegistryIncreaseDecayThreshold, config.GossipSubConfig.GossipSubScoringRegistryConfig.IncreaseDecayThreshold, "the threshold for which when the negative penalty is below this value the decay threshold will be increased by some amount")
+	flags.Float64(scoringRegistryDecayThresholdIncrementer, config.GossipSubConfig.GossipSubScoringRegistryConfig.DecayThresholdIncrementer, "the amount the decay will be increased when the negative penalty score falls below the IncreaseDecayThreshold")
 }
 
 // SetAliases this func sets an aliases for each CLI flag defined for network config overrides to it's corresponding

network/p2p/p2pbuilder/gossipsub/gossipSubBuilder.go

@@ -40,7 +40,8 @@ type Builder struct {
 	subscriptionFilter           pubsub.SubscriptionFilter
 	gossipSubFactory             p2p.GossipSubFactoryFunc
 	gossipSubConfigFunc          p2p.GossipSubAdapterConfigFunc
-	gossipSubPeerScoring         bool          // whether to enable gossipsub peer scoring
+	gossipSubPeerScoring         bool // whether to enable gossipsub peer scoring
+	scoringRegistryConfig        p2pconf.GossipSubScoringRegistryConfig
 	gossipSubScoreTracerInterval time.Duration // the interval at which the gossipsub score tracer logs the peer scores.
 	// gossipSubTracer is a callback interface that is called by the gossipsub implementation upon
 	// certain events. Currently, we use it to log and observe the local mesh of the node.
@@ -177,15 +178,7 @@ func (g *Builder) OverrideDefaultRpcInspectorSuiteFactory(factory p2p.GossipSubR
 // Returns:
 // - a new gossipsub builder.
 // Note: the builder is not thread-safe. It should only be used in the main thread.
-func NewGossipSubBuilder(
-	logger zerolog.Logger,
-	metricsCfg *p2pconfig.MetricsConfig,
-	networkType network.NetworkingType,
-	sporkId flow.Identifier,
-	idProvider module.IdentityProvider,
-	rpcInspectorConfig *p2pconf.GossipSubRPCInspectorsConfig,
-	rpcTracker p2p.RpcControlTracking,
-) *Builder {
+func NewGossipSubBuilder(logger zerolog.Logger, metricsCfg *p2pconfig.MetricsConfig, networkType network.NetworkingType, sporkId flow.Identifier, idProvider module.IdentityProvider, scoringRegistryConfig p2pconf.GossipSubScoringRegistryConfig, rpcInspectorConfig *p2pconf.GossipSubRPCInspectorsConfig, rpcTracker p2p.RpcControlTracking) *Builder {
 	lg := logger.With().
 		Str("component", "gossipsub").
 		Str("network-type", networkType.String()).
@@ -199,6 +192,7 @@ func NewGossipSubBuilder(
 		idProvider:               idProvider,
 		gossipSubFactory:         defaultGossipSubFactory(),
 		gossipSubConfigFunc:      defaultGossipSubAdapterConfig(),
+		scoringRegistryConfig:    scoringRegistryConfig,
 		scoreOptionConfig:        scoring.NewScoreOptionConfig(lg, idProvider),
 		rpcInspectorConfig:       rpcInspectorConfig,
 		rpcInspectorSuiteFactory: defaultInspectorSuite(rpcTracker),
@@ -327,7 +321,7 @@ func (g *Builder) Build(ctx irrecoverable.SignalerContext) (p2p.PubSubAdapter, e
 	var scoreTracer p2p.PeerScoreTracer
 	if g.gossipSubPeerScoring {
 		g.scoreOptionConfig.SetRegisterNotificationConsumerFunc(inspectorSuite.AddInvalidControlMessageConsumer)
-		scoreOpt = scoring.NewScoreOption(g.scoreOptionConfig)
+		scoreOpt = scoring.NewScoreOption(g.scoringRegistryConfig, g.scoreOptionConfig)
 		gossipSubConfigs.WithScoreOption(scoreOpt)
 
 		if g.gossipSubScoreTracerInterval > 0 {

network/p2p/p2pbuilder/libp2pNodeBuilder.go

@@ -75,21 +75,7 @@ type LibP2PNodeBuilder struct {
 	networkingType       flownet.NetworkingType // whether the node is running in private (staked) or public (unstaked) network
 }
 
-func NewNodeBuilder(
-	logger zerolog.Logger,
-	metricsConfig *p2pconfig.MetricsConfig,
-	networkingType flownet.NetworkingType,
-	address string,
-	networkKey fcrypto.PrivateKey,
-	sporkId flow.Identifier,
-	idProvider module.IdentityProvider,
-	rCfg *p2pconf.ResourceManagerConfig,
-	rpcInspectorCfg *p2pconf.GossipSubRPCInspectorsConfig,
-	peerManagerConfig *p2pconfig.PeerManagerConfig,
-	disallowListCacheCfg *p2p.DisallowListCacheConfig,
-	rpcTracker p2p.RpcControlTracking,
-	unicastConfig *p2pconfig.UnicastConfig,
-) *LibP2PNodeBuilder {
+func NewNodeBuilder(logger zerolog.Logger, metricsConfig *p2pconfig.MetricsConfig, networkingType flownet.NetworkingType, address string, networkKey fcrypto.PrivateKey, sporkId flow.Identifier, idProvider module.IdentityProvider, scoringRegistryConfig p2pconf.GossipSubScoringRegistryConfig, rCfg *p2pconf.ResourceManagerConfig, rpcInspectorCfg *p2pconf.GossipSubRPCInspectorsConfig, peerManagerConfig *p2pconfig.PeerManagerConfig, disallowListCacheCfg *p2p.DisallowListCacheConfig, rpcTracker p2p.RpcControlTracking, unicastConfig *p2pconfig.UnicastConfig) *LibP2PNodeBuilder {
 	return &LibP2PNodeBuilder{
 		logger:               logger,
 		sporkId:              sporkId,
@@ -105,6 +91,7 @@ func NewNodeBuilder(
 			networkingType,
 			sporkId,
 			idProvider,
+			scoringRegistryConfig,
 			rpcInspectorCfg,
 			rpcTracker),
 		peerManagerConfig: peerManagerConfig,
@@ -477,19 +464,7 @@ func DefaultNodeBuilder(
 	}
 	meshTracer := tracer.NewGossipSubMeshTracer(meshTracerCfg)
 
-	builder := NewNodeBuilder(logger,
-		metricsCfg,
-		networkingType,
-		address,
-		flowKey,
-		sporkId,
-		idProvider,
-		rCfg,
-		rpcInspectorCfg,
-		peerManagerCfg,
-		disallowListCacheCfg,
-		meshTracer,
-		uniCfg).
+	builder := NewNodeBuilder(logger, metricsCfg, networkingType, address, flowKey, sporkId, idProvider, gossipCfg.GossipSubScoringRegistryConfig, rCfg, rpcInspectorCfg, peerManagerCfg, disallowListCacheCfg, meshTracer, uniCfg).
 		SetBasicResolver(resolver).
 		SetConnectionManager(connManager).
 		SetConnectionGater(connGater).

network/p2p/p2pconf/gossipsub.go

@@ -21,10 +21,28 @@ type GossipSubConfig struct {
 	// GossipSubTracerConfig is the configuration for the gossipsub tracer. GossipSub tracer is used to trace the local mesh events and peer scores.
 	GossipSubTracerConfig `mapstructure:",squash"`
 
+	// GossipSubScoringRegistryConfig is the configuration for the GossipSub score registry.
+	GossipSubScoringRegistryConfig `mapstructure:",squash"`
+
 	// PeerScoring is whether to enable GossipSub peer scoring.
 	PeerScoring bool `mapstructure:"gossipsub-peer-scoring-enabled"`
 }
 
+// GossipSubScoringRegistryConfig is the configuration for the GossipSub score registry.
+type GossipSubScoringRegistryConfig struct {
+	// InitDecayLowerBound is the lower bound on the decay value for a spam record when initialized.
+	// A random value in a range of InitDecayLowerBound and InitDecayUpperBound is used when initializing the decay
+	// of a spam record.
+	InitDecayLowerBound float64 `validate:"gt=0" mapstructure:"gossipsub-scoring-registry-init-decay-lowerbound"`
+	// InitDecayUpperBound is the upper bound on the decay value for a spam record when initialized.
+	InitDecayUpperBound float64 `validate:"lt=1" mapstructure:"gossipsub-scoring-registry-init-decay-upperbound"`
+	// IncreaseDecayThreshold is the threshold for which when the negative penalty is below this value the decay threshold will be increased by some amount. This will
+	// lead to malicious nodes having longer decays while honest nodes will have faster decays.
+	IncreaseDecayThreshold float64 `validate:"gt=0" mapstructure:"gossipsub-scoring-registry-increase-decay-threshold"`
+	// DecayThresholdIncrementer is the amount the decay will be increased when the negative penalty score falls below the IncreaseDecayThreshold.
+	DecayThresholdIncrementer float64 `validate:"gt=-100,lt=0" mapstructure:"gossipsub-scoring-registry-decay-threshold-incrementer"`
+}
+
 // GossipSubTracerConfig is the config for the gossipsub tracer. GossipSub tracer is used to trace the local mesh events and peer scores.
 type GossipSubTracerConfig struct {
 	// LocalMeshLogInterval is the interval at which the local mesh is logged.