-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the Router Flood Wiki - your comprehensive guide to educational network stress testing in controlled environments.
β οΈ 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
- Installation Guide - Step-by-step setup instructions
- Quick Start Tutorial - Your first simulation in 5 minutes
- Command Reference - Complete CLI documentation
- Configuration Guide - YAML configuration deep dive
- Protocol Deep Dive - UDP, TCP, ICMP, IPv6, ARP explained
- Burst Patterns - Sustained, Burst, and Ramp configurations
- Performance Tuning - Optimization for different environments
- Troubleshooting - Common issues and solutions
- Safety Mechanisms - Built-in protections and validations
- Ethical Usage Guidelines - Responsible testing practices
- Network Safety - Private ranges and authorized testing
- Audit Logging - Session tracking and accountability
- Architecture Overview - Module structure and design
- Contributing Guidelines - How to contribute safely
- Testing Framework - 140+ comprehensive tests
- CI/CD Pipeline - GitHub Actions workflow
- Basic Simulation Examples - Simple getting started scenarios
- Protocol-Specific Testing - Per-protocol testing guides
- Statistics and Export - JSON/CSV export and analysis
- Real-world Scenarios - Educational use cases
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
π 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
- 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
- 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
- π¬ 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
git clone https://github.com/PaulShpilsher/router-flood.git
cd router-flood
cargo build --release./target/release/router-flood --target 192.168.1.1 --ports 80 --dry-runsudo ./target/release/router-flood --target 192.168.1.1 --ports 80,443 --threads 4 --rate 100 --duration 30./target/release/router-flood --list-interfaces- π 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
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.
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:
- Fork the repository
- Create a new wiki page or improve existing content
- Test all examples in safe environments
- Submit via pull request with detailed description
Last Updated: August 12, 2025
Version: 0.0.1
License: MIT