malus/variants/
spam_statement_requests.rs

1// Copyright (C) Parity Technologies (UK) Ltd.
2// This file is part of Polkadot.
3
4// Polkadot is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8
9// Polkadot is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12// GNU General Public License for more details.
13
14// You should have received a copy of the GNU General Public License
15// along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
16
17//! A malicious node variant that attempts spam statement requests.
18//!
19//! This malus variant behaves honestly in everything except when propagating statement distribution
20//! requests through the network bridge subsystem. Instead of sending a single request when it needs
21//! something it attempts to spam the peer with multiple requests.
22//!
23//! Attention: For usage with `zombienet` only!
24
25#![allow(missing_docs)]
26
27use polkadot_cli::{
28	service::{
29		AuxStore, Error, ExtendedOverseerGenArgs, Overseer, OverseerConnector, OverseerGen,
30		OverseerGenArgs, OverseerHandle,
31	},
32	validator_overseer_builder, Cli,
33};
34use polkadot_node_network_protocol::request_response::{outgoing::Requests, OutgoingRequest};
35use polkadot_node_subsystem::{messages::NetworkBridgeTxMessage, SpawnGlue};
36use polkadot_node_subsystem_types::{ChainApiBackend, RuntimeApiSubsystemClient};
37use sp_core::traits::SpawnNamed;
38
39// Filter wrapping related types.
40use crate::{interceptor::*, shared::MALUS};
41
42use std::sync::Arc;
43
44/// Wraps around network bridge and replaces it.
45#[derive(Clone)]
46struct RequestSpammer {
47	spam_factor: u32, // How many statement distribution requests to send.
48}
49
50impl<Sender> MessageInterceptor<Sender> for RequestSpammer
51where
52	Sender: overseer::NetworkBridgeTxSenderTrait + Clone + Send + 'static,
53{
54	type Message = NetworkBridgeTxMessage;
55
56	/// Intercept NetworkBridgeTxMessage::SendRequests with Requests::AttestedCandidateV2 inside and
57	/// duplicate that request
58	fn intercept_incoming(
59		&self,
60		_subsystem_sender: &mut Sender,
61		msg: FromOrchestra<Self::Message>,
62	) -> Option<FromOrchestra<Self::Message>> {
63		match msg {
64			FromOrchestra::Communication {
65				msg: NetworkBridgeTxMessage::SendRequests(requests, if_disconnected),
66			} => {
67				let mut new_requests = Vec::new();
68
69				for request in requests {
70					match request {
71						Requests::AttestedCandidateV2(ref req) => {
72							// Temporarily store peer and payload for duplication
73							let peer_to_duplicate = req.peer.clone();
74							let payload_to_duplicate = req.payload.clone();
75							// Push the original request
76							new_requests.push(request);
77
78							// Duplicate for spam purposes
79							gum::info!(
80								target: MALUS,
81								"😈 Duplicating AttestedCandidateV2 request extra {:?} times to peer: {:?}.", self.spam_factor, peer_to_duplicate,
82							);
83							new_requests.extend((0..self.spam_factor - 1).map(|_| {
84								let (new_outgoing_request, _) = OutgoingRequest::new(
85									peer_to_duplicate.clone(),
86									payload_to_duplicate.clone(),
87								);
88								Requests::AttestedCandidateV2(new_outgoing_request)
89							}));
90						},
91						_ => {
92							new_requests.push(request);
93						},
94					}
95				}
96
97				// Passthrough the message with a potentially modified number of requests
98				Some(FromOrchestra::Communication {
99					msg: NetworkBridgeTxMessage::SendRequests(new_requests, if_disconnected),
100				})
101			},
102			FromOrchestra::Communication { msg } => Some(FromOrchestra::Communication { msg }),
103			FromOrchestra::Signal(signal) => Some(FromOrchestra::Signal(signal)),
104		}
105	}
106}
107
108//----------------------------------------------------------------------------------
109
110#[derive(Debug, clap::Parser)]
111#[clap(rename_all = "kebab-case")]
112#[allow(missing_docs)]
113pub struct SpamStatementRequestsOptions {
114	/// How many statement distribution requests to send.
115	#[clap(long, ignore_case = true, default_value_t = 1000, value_parser = clap::value_parser!(u32).range(0..=10000000))]
116	pub spam_factor: u32,
117
118	#[clap(flatten)]
119	pub cli: Cli,
120}
121
122/// SpamStatementRequests implementation wrapper which implements `OverseerGen` glue.
123pub(crate) struct SpamStatementRequests {
124	/// How many statement distribution requests to send.
125	pub spam_factor: u32,
126}
127
128impl OverseerGen for SpamStatementRequests {
129	fn generate<Spawner, RuntimeClient>(
130		&self,
131		connector: OverseerConnector,
132		args: OverseerGenArgs<'_, Spawner, RuntimeClient>,
133		ext_args: Option<ExtendedOverseerGenArgs>,
134	) -> Result<(Overseer<SpawnGlue<Spawner>, Arc<RuntimeClient>>, OverseerHandle), Error>
135	where
136		RuntimeClient: RuntimeApiSubsystemClient + ChainApiBackend + AuxStore + 'static,
137		Spawner: 'static + SpawnNamed + Clone + Unpin,
138	{
139		gum::info!(
140			target: MALUS,
141			"😈 Started Malus node that duplicates each statement distribution request spam_factor = {:?} times.",
142			&self.spam_factor,
143		);
144
145		let request_spammer = RequestSpammer { spam_factor: self.spam_factor };
146
147		validator_overseer_builder(
148			args,
149			ext_args.expect("Extended arguments required to build validator overseer are provided"),
150		)?
151		.replace_network_bridge_tx(move |cb| InterceptedSubsystem::new(cb, request_spammer))
152		.build_with_connector(connector)
153		.map_err(|e| e.into())
154	}
155}
malus/variants/spam_statement_requests.rs

malus/variants/
spam_statement_requests.rs
