Cyber Hack is a multi-disciplinary open-source project focused on STEM, DIY Hardware, Cybersecurity, and Embedded Systems. It combines comprehensive documentation with practical scripts and configurations.
📖 Documentation Site (hack.cgabc.xyz)
- Embedded & Robotics: Control STM32, ESP32, and integrate with ROS2.
- Network & Security: SocketCAN (CAN Bus), Serial tools, and security scripts.
- Violent Python: Forensics, network scanning, and automation scripts based on the classic cookbook.
- Home Automation: OpenWRT, Home Assistant, and Docker setups.
- STEM: Resources for science and engineering education.
Ensure you have Python 3.x and Pip installed. Some scripts may require additional system-level libraries (e.g., can-utils for SocketCAN).
# Install core Python dependencies
pip install -r requirements.txtThe project documentation is built with MkDocs Material.
# Serve locally for development
mkdocs serve
# Build static site
mkdocs buildNavigate to the specific directory and follow the instructions in its README.md. For example, in the embedded section:
# Control STM32 Drive Board with Joystick
python3 embedded/Joystick/ps3_pygame.py/docs: Documentation source files (Markdown)./embedded: Firmware, samples, and control scripts for Arduino/ESP32/STM32./home_automation: Configs for smart home and network infrastructure./network: Low-level communication utilities (CAN, USB, Serial)./ViolentPython: Security research and penetration testing tools.
Contributions are welcome! Whether it's a documentation fix, a new hardware script, or an automation flow:
- Fork the project.
- Create your feature branch (
git checkout -b feature/AmazingFeature). - Commit your changes (
git commit -m 'Add some AmazingFeature'). - Push to the branch (
git push origin feature/AmazingFeature). - Open a Pull Request.
This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.
Maintained by Gavin Gao