Skip to content

danielscos/CyberSafe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

106 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

CyberSafe - Your Cyber Security Swiss Knife

hackatime stats

CyberSafe is a versatile, all-in-one desktop platform for cybersecurity professionals, malware analysts, and security enthusiasts. Built with modern technologies, it provides essential tools for file analysis, malware detection, and security research in an intuitive interface.

FastAPI Python React Electron License

πŸ“‹ Table of Contents

Features

File Hashing & Integrity

Calculate and verify file integrity using multiple cryptographic algorithms including MD5, SHA-1, SHA-256, SHA-512, and BLAKE3. Perfect for malware analysis and forensic investigations.

Encoding/Decoding Tools

Comprehensive support for various encoding formats:

  • Base64
  • URL encoding/decoding
  • HTML entity encoding
  • Hexadecimal conversion
  • Binary conversion

YARA Rule Scanner

Integrated YARA rule engine for:

  • Malware detection and classification
  • Custom rule creation and testing
  • File and process scanning
  • Suspicious pattern identification

Entropy Analysis

Advanced entropy calculation for:

  • Identifying packed or encrypted content
  • Detecting obfuscated malware
  • Analyzing file randomness
  • Cryptographic analysis

String Extraction

Extract human-readable strings from binary files:

  • ASCII and Unicode string detection
  • Configurable minimum string length
  • Export results to various formats
  • Metadata extraction

Live Hash Monitoring

Real-time file integrity monitoring:

  • Directory monitoring for changes
  • Automated hash verification
  • Alert system for modifications
  • Forensic timeline generation

Coming Soon

  • Network traffic analysis
  • Memory dump analysis
  • Cryptographic key analysis
  • Automated report generation

πŸš€ Installation

Option 1: Download Release (Recommended)

Download the latest release for your platform from the GitHub Releases page.

Supported Platforms:

  • Linux (Ubuntu 20.04+, Debian 11+)

Option 2: Build from Source

Prerequisites:

  • Python 3.13+
  • Rust (latest stable)
  • npm or yarn
  • Git

Build Steps:

# Clone the repository
git clone https://github.com/danielscos/CyberSafe.git
cd CyberSafe

# Install Rust (if not already installed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

# Install frontend dependencies
cd frontend
npm install

# Build the backend executable (includes Rust compilation)
cd ../backend
pip install -r requirements.txt
python build.py

# Build the frontend and create distributable
cd ../frontend
npm run build
npm run dist

The executable will be created in frontend/dist/ directory.

Development Setup

Prerequisites

  • Node.js 18+
  • Python 3.13+
  • Rust (latest stable)
  • Git

Setup Instructions

  1. Clone and Setup:

    git clone https://github.com/danielscos/CyberSafe.git
    cd CyberSafe
  2. Install Rust:

    # Install Rust if not already installed
    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    source ~/.cargo/env
  3. Backend Setup:

    cd backend
    pip install -r requirements.txt
    
    # Build the Rust library for development
    cd ../rustlib
    pip install maturin
    maturin develop --release
    cd ../backend
  4. Frontend Setup:

    cd frontend
    npm install

Development Commands

Run everything (recommended):

cd frontend
npm run dev:all

Run components separately:

# Terminal 1 - Backend
cd frontend
npm run backend

# Terminal 2 - Frontend dev server
npm run dev

# Terminal 3 - Electron app
npm run dev:electron

Build for production:

cd frontend
npm run build        # Build frontend + backend
npm run dist         # Create distributable package

πŸ“– Usage

Getting Started

  1. Launch CyberSafe
  2. Select the tool you need from the main interface
  3. Follow the on-screen instructions for each tool

File Hashing Example

  1. Navigate to "File Hashing" tool
  2. Select or drag-and-drop your file
  3. Choose hash algorithms (MD5, SHA-256, etc.)
  4. View results and export if needed

YARA Scanning Example

  1. Open "YARA Scanner" tool
  2. Load your YARA rules or use built-in ones
  3. Select target files or directories
  4. Review scan results and threat classifications

Project Status

Current Version: v0.1.0-alpha Status: Active Development

Roadmap

Phase 1 (In Progress)

  • Project setup and architecture
  • Basic Electron + React frontend
  • FastAPI backend foundation
  • File hashing implementation
  • Basic encoding/decoding tools

Phase 2 (Planned)

  • YARA rule integration
  • Entropy calculator
  • String extractor
  • Live hash monitoring

Phase 3 (Future)

  • Advanced malware analysis
  • Network traffic analysis
  • Automated reporting
  • Plugin system

🀝 Contributing

We welcome contributions from the cybersecurity community!

πŸ“– For detailed contribution guidelines, please read our CONTRIBUTING.md file.

How to Contribute

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

Development Guidelines

  • Follow existing code style and patterns
  • Add tests for new features
  • Update documentation as needed
  • Ensure cross-platform compatibility

Bug Reports

Please use the GitHub Issues page to report bugs or request features.

Security

Reporting Security Issues

If you discover a security vulnerability, please send an email to [security@cybersafe.dev] instead of using the public issue tracker.

Security Best Practices

  • Always verify file hashes from trusted sources
  • Keep CyberSafe updated to the latest version
  • Review YARA rules before execution
  • Use in isolated environments for malware analysis

Tech Stack

Frontend

  • Electron - Cross-platform desktop framework
  • React 19 - UI framework
  • Vite - Build tool and dev server
  • Material-UI - Component library
  • Framer Motion - Animations

Backend

  • Python 3.13 - Core backend language
  • FastAPI - High-performance API framework
  • Uvicorn - ASGI server
  • PyInstaller - Python executable packaging

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

Support the Project

If you find CyberSafe useful, please consider supporting its development:

  • ⭐ Star this repository to show your support
  • 🍴 Fork and contribute with new features or bug fixes
  • πŸ“’ Share with your cybersecurity colleagues and friends
  • πŸ’¬ Provide feedback through issues and discussions
  • πŸ“ Write blog posts or tutorials about CyberSafe

Owner

This project is developed and maintained by danielscos.

Gravatar


CyberSafe - Empowering cybersecurity professionals with modern tools πŸ›‘οΈ

Built with ❀️ for the cybersecurity community

About

swiss-knife style safety platform for cybersec folks

Resources

License

MIT, GPL-2.0 licenses found

Licenses found

MIT
LICENSE
GPL-2.0
COPYING

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors