Skip to content
Paul Shpilsher edited this page Aug 12, 2025 · 1 revision

Router Flood Wiki

Welcome to the Router Flood Wiki - your comprehensive guide to educational network stress testing in controlled environments.

Router Flood Build Tests

🚨 IMPORTANT: Educational Use Only

⚠️ This tool is exclusively for educational and authorized testing purposes.

  • Only use on networks you own or have explicit written permission to test
  • Unauthorized use is strictly prohibited and may be illegal
  • Always comply with local, national, and international laws

πŸ“š Quick Navigation

πŸš€ Getting Started

πŸ”§ Advanced Usage

πŸ›‘οΈ Safety & Security

πŸ—οΈ Development

πŸ“Š Examples & Tutorials

✨ What is Router Flood?

Router Flood is an advanced educational network stress testing tool designed for controlled local network environments. It provides comprehensive multi-protocol simulation capabilities to help:

  • Network Administrators understand router behavior under stress
  • Security Researchers identify potential vulnerabilities safely
  • Students learn about network protocols and traffic patterns
  • Educators demonstrate network concepts in controlled environments

Key Features

🌐 Multi-Protocol Support

  • UDP, TCP (SYN/ACK), ICMP packet generation
  • IPv6 (UDP/TCP/ICMP) and ARP protocol support
  • Configurable protocol ratios and traffic patterns

πŸ›‘οΈ Safety First Design

  • Automatic RFC 1918 private IP validation
  • Built-in rate limiting (max 100 threads, 10K PPS)
  • Comprehensive audit logging with UUID tracking
  • Dry-run mode for safe configuration testing

πŸ“Š Advanced Analytics

  • Real-time statistics with configurable intervals
  • JSON/CSV export with system resource monitoring
  • Per-protocol packet breakdown and analysis
  • Session management with audit trails

⚑ High Performance

  • Asynchronous Rust implementation with Tokio
  • Concurrent packet generation across multiple threads
  • Intelligent burst patterns (Sustained/Burst/Ramp)
  • Network interface auto-detection and management

🎯 Common Use Cases

Educational Scenarios

  • Network Protocol Education: Demonstrate how different protocols behave under load
  • Router Capacity Testing: Safely test router limits in lab environments
  • Traffic Pattern Analysis: Generate realistic traffic for monitoring system testing
  • Security Awareness: Show impact of network flooding in controlled settings

Research Applications

  • Performance Benchmarking: Measure network equipment capabilities
  • Monitoring System Testing: Validate network monitoring tool effectiveness
  • Protocol Behavior Studies: Research how protocols handle stress conditions
  • Educational Demonstrations: Classroom network security education

πŸ“ˆ Project Statistics

  • πŸ”¬ 140+ Comprehensive Tests across 14 modules with 100% pass rate
  • πŸ“¦ 15+ Production Dependencies including pnet, tokio, serde ecosystem
  • πŸ—οΈ 14 Well-Organized Modules for maintainability and extensibility
  • πŸ”„ GitHub Actions CI/CD with automated quality assurance
  • πŸ“ Professional Documentation with comprehensive examples

πŸš€ Quick Start

1. Installation

git clone https://github.com/PaulShpilsher/router-flood.git
cd router-flood
cargo build --release

2. Dry Run Test (Safe - No Packets Sent)

./target/release/router-flood --target 192.168.1.1 --ports 80 --dry-run

3. Basic Simulation (Requires Root)

sudo ./target/release/router-flood --target 192.168.1.1 --ports 80,443 --threads 4 --rate 100 --duration 30

4. List Network Interfaces

./target/release/router-flood --list-interfaces

πŸ”— Important Links

  • πŸ“– Main README - Complete project documentation
  • πŸ› Issues - Bug reports and feature requests
  • πŸ”„ Pull Requests - Contribute to the project
  • ⚑ Actions - CI/CD pipeline status
  • πŸ“Š Releases - Version history

βš–οΈ Legal and Ethical Notice

This tool is designed with safety and ethics as primary concerns:

βœ… Built-in Safety Mechanisms

  • Hard-coded private IP range validation (RFC 1918)
  • Rate limiting to prevent system overwhelm
  • Comprehensive audit logging for accountability
  • Dry-run mode for safe configuration testing

❌ Prohibited Uses

  • Unauthorized testing against systems you don't control
  • Bypassing or disabling safety mechanisms
  • Any malicious or harmful network activities
  • Testing without explicit written permission

πŸŽ“ Educational Mission Router Flood exists to help users learn about network behavior, protocol interactions, and security concepts in safe, controlled environments. All usage must comply with local laws and organizational policies.


πŸ“ Contributing to This Wiki

This wiki is a community resource! We welcome contributions to improve documentation, add examples, and share educational use cases.

Guidelines for Wiki Contributions:

  • Maintain focus on educational and authorized use
  • Include safety reminders in all examples
  • Provide clear, tested examples with expected outcomes
  • Follow the established format and style

How to Contribute:

  1. Fork the repository
  2. Create a new wiki page or improve existing content
  3. Test all examples in safe environments
  4. Submit via pull request with detailed description

Last Updated: August 12, 2025
Version: 0.0.1
License: MIT