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

  1. One-Command Install (Recommended)

    • For macOS/Linux:

      curl -s https://raw.githubusercontent.com/Jordan231111/MalwareMinimizer/main/scripts/install.sh | bash
    • For Windows (PowerShell as Administrator):

      Invoke-WebRequest -Uri "https://raw.githubusercontent.com/Jordan231111/MalwareMinimizer/main/scripts/install.ps1" -OutFile "$env:TEMP\install.ps1"; powershell -ExecutionPolicy Bypass -File "$env:TEMP\install.ps1"
  2. Download from Releases

    • Go to the Releases page and download the binary for your platform.
    • Verify checksums when available.

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

See the Development Guide for full setup steps.

Quick summary:

  • Rust (stable toolchain)
  • Python 3.11 (for helper scripts/tests)
  • Optional OpenSSL dependencies if native TLS is used
  • Run ./scripts/setup.sh on macOS/Linux for a guided setup

Security & Privacy

  • Scanning happens locally on your machine.
  • Database updates are pulled from trusted sources; verify checksums when provided.
  • Do not use real malware samples in tests—use the EICAR test string.

FAQs

  • Q: My Python interpreter is 3.13.x. How do I switch to 3.11?
    A: In VS Code, click the Python version in the bottom-right status bar and select 3.11 from the interpreter list.

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.
  4. See Contributing Guidelines for details.

Feedback

Please submit feedback, suggestions, or bug reports via:


License

This project is licensed under the GNU GPL v3.0. See 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 7