Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcocesarato/php-antimalware-scanner
AMWScan (PHP Antimalware Scanner) is a free tool to scan php files and analyze your project to find any malicious code inside it.
https://github.com/marcocesarato/php-antimalware-scanner
amwscan antimalware antivirus backdoor cleaner eval exploit free malware php scan scanner scanning shell tool virus wordpress
Last synced: about 9 hours ago
JSON representation
AMWScan (PHP Antimalware Scanner) is a free tool to scan php files and analyze your project to find any malicious code inside it.
- Host: GitHub
- URL: https://github.com/marcocesarato/php-antimalware-scanner
- Owner: marcocesarato
- License: gpl-3.0
- Created: 2018-03-21T15:09:38.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-19T14:23:37.000Z (7 months ago)
- Last Synced: 2024-05-19T15:03:02.377Z (7 months ago)
- Topics: amwscan, antimalware, antivirus, backdoor, cleaner, eval, exploit, free, malware, php, scan, scanner, scanning, shell, tool, virus, wordpress
- Language: PHP
- Homepage: https://marcocesarato.github.io/PHP-Antimalware-Scanner/
- Size: 6.42 MB
- Stars: 571
- Watchers: 29
- Forks: 98
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
![Version](images/logo.png)
PHP Antimalware Scanner
![Version](https://img.shields.io/badge/version-0.14.0-brightgreen?style=for-the-badge)
![Requirements](https://img.shields.io/badge/php-%3E%3D%205.5-4F5D95?style=for-the-badge)
![Code Style](https://img.shields.io/badge/code%20style-PSR-blue?style=for-the-badge)
![License](https://img.shields.io/github/license/marcocesarato/PHP-Antimalware-Scanner?style=for-the-badge)
[![GitHub](https://img.shields.io/badge/GitHub-Repo-6f42c1?style=for-the-badge)](https://github.com/marcocesarato/PHP-Antimalware-Scanner)#### If this project helped you out, please support us with a star :star:
[Documentation](https://marcocesarato.github.io/PHP-Antimalware-Scanner/)
## Description
PHP Antimalware Scanner is a free tool to scan PHP files and analyze your project to find any malicious code inside it.
It provides an interactive text terminal console interface to scan a file, or all files in a given directory (file paths
can also be managed using `--filter-paths` or `--ignore-paths`), and find PHP code files that seem to contain malicious
code. When a probable malware is detected, will be asked what action to take (like add to the whitelist, delete files, try
clean infected code, etc).The package can also scan the PHP files in a report mode (`--report|-r`), so without interacting and outputting anything to
the terminal console. In that case, the results will be stored in a report file in HTML (default) or text
format (`--report-format `).This scanner can work on your own php projects and on a lot of other platforms using the right combination of
configurations (ex. using `--lite|-l` flag can help to find less false positivity).:warning: *Remember that you will be solely responsible for any damage to your computer system or loss of data that
results from such activities. You are solely responsible for adequate protection and backup of the data before executing
the scanner.*### How to contribute
Have an idea? Found a bug? Please raise to [ISSUES](https://github.com/marcocesarato/PHP-Antimalware-Scanner/issues)
or [PULL REQUEST](https://github.com/marcocesarato/PHP-Antimalware-Scanner/pulls). Contributions are welcome and are
greatly appreciated! Every little bit helps.## :blue_book: Requirements
- php 5.5+
- php-xml
- php-zip
- php-mbstring
- php-json
- php-common
- php-curl
- php-gd## :book: Install
### Release
You can use one of these methods to install the scanner by downloading it from GitHub or directly from the console.
#### Download
Go to the GitHub page and press on the Releases tab or download the raw file from:
[![Download](https://img.shields.io/badge/Download-Latest%20Build-important?style=for-the-badge)](https://raw.githubusercontent.com/marcocesarato/PHP-Antimalware-Scanner/master/dist/scanner)
#### Console
1. Run this command from the console (the scanner will be downloaded to your current directory):
`wget https://raw.githubusercontent.com/marcocesarato/PHP-Antimalware-Scanner/master/dist/scanner`
2. Run the scanner:
`php scanner ./dir-to-scan -l ...`
3. *(Optional)* Install as bin command (Unix Bash)
Run this command:
```sh
wget https://raw.githubusercontent.com/marcocesarato/PHP-Antimalware-Scanner/master/dist/scanner -O /usr/bin/awscan.phar && \
printf "#!/bin/bash\nphp /usr/bin/awscan.phar \$@" > /usr/bin/awscan && \
chmod u+x,g+x /usr/bin/awscan.phar && \
chmod u+x,g+x /usr/bin/awscan && \
export PATH=$PATH":/usr/bin"
```Now you can run the scanner simply with this command: `awscan ./dir-to-scan -l...`
### Source
##### Download
Click the GitHub page "Clone or download" or download from:
[![Download](https://img.shields.io/badge/Download-Source-important?style=for-the-badge)](https://codeload.github.com/marcocesarato/PHP-Antimalware-Scanner/zip/master)
##### Git
1. Install git
2. Copy the command and link from below in your terminal:
`git clone https://github.com/marcocesarato/PHP-Antimalware-Scanner`
3. Change directories to the new `~/PHP-Antimalware-Scanner` directory:
`cd ~/PHP-Antimalware-Scanner/`
4. To ensure that your master branch is up-to-date, use the pull command:
`git pull https://github.com/marcocesarato/PHP-Antimalware-Scanner`
5. Enjoy## :whale: Docker
1. Download the source
2. Build command
`docker build --tag amwscan-docker .`
3. Run command
`docker run -it --rm amwscan-docker bash`## :mag_right: Scanning mode
The first think you need to decide is the strength, you need to calibrate your scan to find less false positive as possible during scanning without miss for real malware.
For this you can choose the aggression level.The scanner permit to have some predefined modes:
| Mode | Alias | 🚀 | Description |
| --------------------------- | ----- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| None *(default)* | | 🔴 | Search for all functions, exploits and malware signs without any restrictions |
| Only exploits | `-e` | 🟠| Search only for exploits definitions
Use flag: `--only-exploits` |
| Lite mode | `-l` | 🟡 | Search for exploits with some restrictions and malware signs *(on Wordpress and others platform could detect less false positivity)*
Use flag: `--lite` |
| Only functions | `-f`| 🟡 | Search only for functions *(on some obfuscated code functions couldn't be detected)*
Use flag: `--only-functions` |
| Only signatures | `-s` | 🟢 | Search only for malware signatures *(could be a good solution for Wordpress and others platform to detect less false positivity)*
Use flag: `--only-signatures` |## :computer: Usage
### Command line
```
php amwscan ./mywebsite/http/ -l -s --only-exploits
php amwscan -s --max-filesize="5MB"
php amwscan -s -logs="/user/marco/scanner.log"
php amwscan --lite --only-exploits
php amwscan --exploits="double_var2" --functions="eval, str_replace"
php amwscan --ignore-paths="/my/path/*.log,/my/path/*/cache/*"
```#### Doesn't work?
In case above command doesn't work, you can use script responsible for malware scan manually by executing:
`php dist/scanner `To check all options check the [Documentation](https://marcocesarato.github.io/PHP-Antimalware-Scanner/options)
### Suggestions
If you are running the scanner on a Wordpress project or other popular platform use `--only-signatures` or `--lite` flag
to have check with less false positive but this could miss some dangerous exploits like `nano`.### Programmatically
On programmatically silent mode and auto skip are automatically enabled.
```php
use AMWScan\Scanner;$app = new Scanner();
$report = $app->setPathScan("my/path/to/scan")
->enableBackups()
->setPathBackups("/my/path/backups")
->enableLiteMode()
->setAutoClean()
->run();
```##### Report Object
```php
object(stdClass) (7) {
["scanned"] => int(0)
["detected"] => int(0)
["removed"] => array(0) {}
["ignored"] => array(0) {}
["edited"] => array(0) {}
["quarantine"] => array(0) {}
["whitelist"] => array(0) {}
}
```## :art: Screenshots
### Report
> HTML report format (`default`)
![Screen Report](images/screenshot_report.png)
### Interactive CLI
![Screen Full](images/screenshot_full.png)