Skip to content

A comprehensive collection of bash scripts, tools, and frameworks for system administration, security, and automation

License

Notifications You must be signed in to change notification settings

Gr3ytrac3/SquareBash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SquareBash

SquareBash Mainframe

A comprehensive collection of bash scripts, tools, and frameworks for system administration, security, and automation. License Security Considerations

Categories

🟢 Basic

Perfect for those starting with bash scripting and system administration.

🟡 Medium

For users with solid bash fundamentals looking to tackle more complex scenarios.

🔴 Advanced

Sophisticated tools for security professionals and experienced system administrators.

Quick Start

# Clone the repository
git clone https://github.com/Gr3ytrac3/SquareBash.git
cd bash-projects

# Make scripts executable
find . -name "*.sh" -exec chmod +x {} \;

# Run a beginner project
cd beginner/syshealth
./syshealth.sh

# Try an intermediate tool
cd ../../intermediate/network-scanner
./netscan.sh --cidr 192.168.1.0/24

Features

  • Well-organized structure - Projects categorized by complexity level
  • Comprehensive testing - Unit and integration tests included
  • Detailed documentation - Each project includes thorough README files
  • Security-focused - Tools for security assessment and system hardening
  • Production-ready - Scripts designed for real-world usage
  • Utilities included - Common functions and error handling modules

Installation

Prerequisites

  • Bash 4.0 or higher
  • Standard Linux utilities (find, grep, awk, etc.)
  • Root access (for some security tools)

System Dependencies

Most projects will automatically check for and install required dependencies. For manual installation:

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install curl wget nmap netdiscover arp-scan

# RHEL/CentOS/Fedora
sudo yum install curl wget nmap netdiscover arp-scan

# Arch Linux
sudo pacman -S curl wget nmap netdiscover arp-tools

Usage Examples

System Health Monitoring

cd beginner/syshealth
./syshealth.sh --format json --modules cpu,memory,disk

Network Discovery

cd intermediate/network-scanner
./netscan.sh --cidr 192.168.1.0/24 --type full --output csv

Security Hardening

cd intermediate/system-hardener
sudo ./harden.sh --modules services,kernel,firewall --dry-run

Testing

Run the test suite to ensure all scripts work correctly on your system:

# Run all tests
./tests/run_all_tests.sh

# Run tests for specific project
./tests/run_tests.sh beginner/syshealth

# Run shellcheck on all scripts
find . -name "*.sh" -exec shellcheck {} \;

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines.

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-tool)
  3. Commit your changes (git commit -m 'Add amazing tool')
  4. Push to the branch (git push origin feature/amazing-tool)
  5. Open a Pull Request

Coding Standards

  • Follow bash best practices (see docs/bash-best-practices.md)
  • Include comprehensive error handling
  • Add logging where appropriate
  • Write tests for new functionality
  • Update documentation

Security Considerations

⚠️ Important Security Notice: Many tools in this repository are designed for security testing and system administration. Please note:

  • Advanced tools are for authorized testing only
  • Always get proper permission before running security tools
  • Test in isolated environments first
  • Some tools require root privileges
  • Be aware of legal implications in your jurisdiction

See docs/security-considerations.md for detailed guidelines.

Author

[RedKernel]

Support

If you find this repository helpful:

  • ⭐ Star the repository
  • 🍴 Fork it for your own use
  • 🐛 Report issues
  • 💡 Suggest improvements

⚠️ Disclaimer: These tools are for educational and authorized testing purposes only. Users are responsible for complying with applicable laws and obtaining proper authorization before using security-related tools.

About

A comprehensive collection of bash scripts, tools, and frameworks for system administration, security, and automation

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published