Skip to content

With the number of malware attacks occurring every day, we want to provide users with accessible, free-to-use software that can scan their devices for malware and allow them to take action against any existing malware.

License

Notifications You must be signed in to change notification settings

Jordan231111/MalwareMinimizer

Repository files navigation

Malware Minimizer

Overview

Malware Minimizer is an open-source, cross-platform software designed to scan devices for malware and provide actionable steps to address detected threats. The primary goal is to deliver a lightweight, user-friendly solution that works directly from the command line without requiring extensive setup or additional dependencies for end users.


Features

  1. Fast Scan:

    • Quickly scans files and compares their hashes against a malware database.
    • Includes basic malware removal and quarantine functionality.
  2. Deep Scan:

    • Detects packed or obfuscated malware using heuristic or anomaly-based techniques.
    • Optimized for runtime performance while maintaining accuracy.
  3. Cross-Platform CLI:

    • Designed for use on macOS, Linux, and Windows.
    • Simple and intuitive command-line interface.
  4. Automated Malware Database Updates:

    • Ensures access to the latest malware signatures for accurate detection.
  5. Open Source:

    • Fully hosted on GitHub with detailed documentation and community-driven development.

Quick Start

Installation

Code Editor/IDE

  • VSCode: Lightweight and customizable. Install extensions for the languages you'll use.

Recommended extensions:

  • C/C++: Microsoft C/C++ extension for IntelliSense and debugging.
  • Python: Python extension for running/debugging Python scripts.
  • Rust Analyzer: Provides IntelliSense for Rust.
  • GitLens: Enhances Git integration within VSCode.
  1. Download the Precompiled Binary

    • Go to the Releases page and download the binary for your platform.
  2. Run the Software

    • For macOS/Linux:
      curl -sSL https://github.com/Jordan231111/MalwareMinimizer/releases/latest/download/malware_minimizer -o malware_minimizer
      chmod +x malware_minimizer
      ./malware_minimizer --help
    • For Windows (PowerShell):
      iex ((New-Object System.Net.WebClient).DownloadString('https://github.com/Jordan231111/MalwareMinimizer/releases/latest/download/install.ps1'))

Running the Scanner

  • Fast Scan:

    ./malware_minimizer scan --path /path/to/scan
  • Deep Scan:

    ./malware_minimizer scan --path /path/to/scan --deep
  • Quarantine Detected Malware:

    ./malware_minimizer quarantine --id <malware_id>
  • Remove Detected Malware:

    ./malware_minimizer remove --id <malware_id>

Development Setup

Dependencies

Languages and Tools

  • Rust:
    • Install via Rustup:
      curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
      rustup update
  • Python 3.11:
    • Install via Homebrew (macOS):
      brew install python@3.11
    • Ensure pip is installed:
      python3.11 -m pip --version
  • C++:
    • Install GCC or Clang (macOS):
      brew install gcc
      # or
      brew install llvm

Libraries

  • Rust Crates (add to Cargo.toml):

    [dependencies]
    clap = "4.5.26"
    reqwest = { version = "0.12.12", features = ["json"] }
    tokio = { version = "1.43.0", features = ["full"] }
    serde = { version = "1.0.217", features = ["derive"] }
    serde_json = "1.0.135"
    sha2 = "0.10.8"
  • Python Libraries (add to requirements.txt):

    requests
    pytest
    rich
    
  • C++ Libraries:

    • OpenSSL:
      brew install openssl
    • Boost (Optional):
      brew install boost

FAQs

  • Q: My python interpreter version is 3.13.1 so how do I correct it to 3.11.11?
       Click 3.13.1 and an option to choose an intepreter would be displayed. Choose 3.11.11.
    
    

Contributing

We welcome contributions! If you'd like to contribute:

  1. Fork the repository.
  2. Create a new branch for your feature/bugfix.
  3. Submit a pull request with detailed descriptions of your changes.

Feedback

Please submit feedback, suggestions, or bug reports via:


License


About

With the number of malware attacks occurring every day, we want to provide users with accessible, free-to-use software that can scan their devices for malware and allow them to take action against any existing malware.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5