webshell-analyzer 1.0.0__tar.gz → 1.0.1__tar.gz

{webshell_analyzer-1.0.0/webshell_analyzer.egg-info → webshell_analyzer-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webshell-analyzer
-Version: 1.0.0
+Version: 1.0.1
 Summary: Webshell Detection Tool integrating Machine Learning based on Static Feature Extraction
 Author-email: Adelia Saputri <adelias.dev@gmail.com>
 License: MIT License
@@ -41,24 +41,26 @@ Requires-Dist: pyfiglet
 Requires-Dist: joblib
 Dynamic: license-file
 
-# Webshell-Analyzer
-![Webshell Analyzer Home Screen](/assets/images/home-screen.png "Home Screen")
+# Webshell Analyzer
 webshell analyzer is command line based webshell detection tool that utillizes static feature extraction and using Random Forest classification to detect malicious PHP webshell.
 
-# Table of Contens
-- About
-- Features
-- Requirements
-- Instalation
-- Usage
-- Commands
+![Webshell Analyzer Home Screen](/assets/images/home_screen.png "Home Screen")
 
-# About
+## Table of Contens
+- [About](#about)
+- [Features](#features)
+- [Requirements](#requirements)
+- [Instalation](#installation)
+- [Usage](#usage)
+- [Commands](#commands)
+- [Example Output](#example-output)
+
+## About
 webshell analyzer was developed to assist security analysts, researchers, and system administrators in identifying potentially malicious PHP files before they are executed on a web server. the tool helps to mitigate the risk of unauthorised access, web defacement attacks, and persistent backdoor attacks, which are commonly associated with webshells.
 
 this system combines three static code analysis methods: lexical analysis, statistical analysis, and Abstract Syntax Tree (AST) analysis. this approach enables the detection process to identify suspicious functions, code structure patterns, and statistical characteristics that may indicate malicious behavior.
 
-# Features
+## Features
 - Scan individual PHP files for webshell indicators
 - Recursively scan entire directories
 - Static feature extraction (no code execution required)
@@ -66,40 +68,53 @@ this system combines three static code analysis methods: lexical analysis, stati
 - Export results to only JSON file
 - Interactive CLI environment
 
-# Requirements
+## Requirements
 before installing and running webshell analyzer, ensure that your system meets the following requirements :
 
 - Python 3.10 or later
-- Pip (oython package manager)
+- Pip (python package manager)
 - Git
 
-**Python Dependencies**
-The required python packages are listed in the ```requirements.txt``` file and can be installed automatically using :
+## Installation
+
+### Option 1 — Via pip (Recommended)
+
+The easiest way to install Webshell Analyzer is via pip:
+
+```bash
+pip install webshell-analyzer
+```
+All required dependencies will be installed automatically.
 
-```pip install -r requirements.txt```
+### Option 2 — Via GitHub Clone
 
-# Installation
-to install webshell analyzer, clone this repository to your local machine using the following command :
+```bash
+# Clone the repository
+git clone https://github.com/Adeliasaputriiii/webshell-analyzer
 
-```git clone https://github.com```
+# Navigate to the project directory
+cd webshell-analyzer
 
-After the installation process is complete, the system is ready to use.
+# Install dependencies
+pip install -r requirements.txt
 
-# Usage
-To get started with Webshell Analyzer:
+# Install the package
+pip install .
+```
 
-Start ```bash wsanalyzer```:  this is the main command to enter the Webshell Analyzer interactive environment.
-You will be greeted with the Webshell Analyzer prompt:
+## Usage
+Use the following command to launch the webshell analyzer interactive environment :
 
-From here, you can run all available commands such as `scan`, `detect`, `--output`, `help`, `exit`.
+```wsanalyzer```
 
-# Command
+once started, you will be presented with the webshell analyzer command prompt. From this environment, you can run all available commands such as `scan`, `detect`, `--output`, `help`, `exit`.
+
+## Commands
 1. ```scan <directory_path> [--output <output_file.json>]``` -> scan all PHP files in a directory for webshell detection
 2. ```detect <file_path> [--output <output_file.json>]``` -> detect a specific file for webshell activity
 3. ```help``` -> for show this help message
 4. ```exit``` -> For Exit the Webshell Analyzer
 5. ```--output <output_file.json>``` -> Save the detection results to a JSON file
 
-
-
-
+## Example Output
+![Process Detecting Single file PHP](/assets/images/detectFile.png "detecting File")

{webshell_analyzer-1.0.0 → webshell_analyzer-1.0.1}/README.md

@@ -1,21 +1,23 @@
-# Webshell-Analyzer
-![Webshell Analyzer Home Screen](/assets/images/home-screen.png "Home Screen")
+# Webshell Analyzer
 webshell analyzer is command line based webshell detection tool that utillizes static feature extraction and using Random Forest classification to detect malicious PHP webshell.
 
-# Table of Contens
-- About
-- Features
-- Requirements
-- Instalation
-- Usage
-- Commands
+![Webshell Analyzer Home Screen](/assets/images/home_screen.png "Home Screen")
 
-# About
+## Table of Contens
+- [About](#about)
+- [Features](#features)
+- [Requirements](#requirements)
+- [Instalation](#installation)
+- [Usage](#usage)
+- [Commands](#commands)
+- [Example Output](#example-output)
+
+## About
 webshell analyzer was developed to assist security analysts, researchers, and system administrators in identifying potentially malicious PHP files before they are executed on a web server. the tool helps to mitigate the risk of unauthorised access, web defacement attacks, and persistent backdoor attacks, which are commonly associated with webshells.
 
 this system combines three static code analysis methods: lexical analysis, statistical analysis, and Abstract Syntax Tree (AST) analysis. this approach enables the detection process to identify suspicious functions, code structure patterns, and statistical characteristics that may indicate malicious behavior.
 
-# Features
+## Features
 - Scan individual PHP files for webshell indicators
 - Recursively scan entire directories
 - Static feature extraction (no code execution required)
@@ -23,40 +25,53 @@ this system combines three static code analysis methods: lexical analysis, stati
 - Export results to only JSON file
 - Interactive CLI environment
 
-# Requirements
+## Requirements
 before installing and running webshell analyzer, ensure that your system meets the following requirements :
 
 - Python 3.10 or later
-- Pip (oython package manager)
+- Pip (python package manager)
 - Git
 
-**Python Dependencies**
-The required python packages are listed in the ```requirements.txt``` file and can be installed automatically using :
+## Installation
+
+### Option 1 — Via pip (Recommended)
+
+The easiest way to install Webshell Analyzer is via pip:
+
+```bash
+pip install webshell-analyzer
+```
+All required dependencies will be installed automatically.
 
-```pip install -r requirements.txt```
+### Option 2 — Via GitHub Clone
 
-# Installation
-to install webshell analyzer, clone this repository to your local machine using the following command :
+```bash
+# Clone the repository
+git clone https://github.com/Adeliasaputriiii/webshell-analyzer
 
-```git clone https://github.com```
+# Navigate to the project directory
+cd webshell-analyzer
 
-After the installation process is complete, the system is ready to use.
+# Install dependencies
+pip install -r requirements.txt
 
-# Usage
-To get started with Webshell Analyzer:
+# Install the package
+pip install .
+```
 
-Start ```bash wsanalyzer```:  this is the main command to enter the Webshell Analyzer interactive environment.
-You will be greeted with the Webshell Analyzer prompt:
+## Usage
+Use the following command to launch the webshell analyzer interactive environment :
 
-From here, you can run all available commands such as `scan`, `detect`, `--output`, `help`, `exit`.
+```wsanalyzer```
 
-# Command
+once started, you will be presented with the webshell analyzer command prompt. From this environment, you can run all available commands such as `scan`, `detect`, `--output`, `help`, `exit`.
+
+## Commands
 1. ```scan <directory_path> [--output <output_file.json>]``` -> scan all PHP files in a directory for webshell detection
 2. ```detect <file_path> [--output <output_file.json>]``` -> detect a specific file for webshell activity
 3. ```help``` -> for show this help message
 4. ```exit``` -> For Exit the Webshell Analyzer
 5. ```--output <output_file.json>``` -> Save the detection results to a JSON file
 
-
-
-
+## Example Output
+![Process Detecting Single file PHP](/assets/images/detectFile.png "detecting File")

{webshell_analyzer-1.0.0 → webshell_analyzer-1.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "webshell-analyzer"
-version = "1.0.0"
+version = "1.0.1"
 authors = [
     {name = "Adelia Saputri", email = "adelias.dev@gmail.com"}
 ]

{webshell_analyzer-1.0.0 → webshell_analyzer-1.0.1/webshell_analyzer.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webshell-analyzer
-Version: 1.0.0
+Version: 1.0.1
 Summary: Webshell Detection Tool integrating Machine Learning based on Static Feature Extraction
 Author-email: Adelia Saputri <adelias.dev@gmail.com>
 License: MIT License
@@ -41,24 +41,26 @@ Requires-Dist: pyfiglet
 Requires-Dist: joblib
 Dynamic: license-file
 
-# Webshell-Analyzer
-![Webshell Analyzer Home Screen](/assets/images/home-screen.png "Home Screen")
+# Webshell Analyzer
 webshell analyzer is command line based webshell detection tool that utillizes static feature extraction and using Random Forest classification to detect malicious PHP webshell.
 
-# Table of Contens
-- About
-- Features
-- Requirements
-- Instalation
-- Usage
-- Commands
+![Webshell Analyzer Home Screen](/assets/images/home_screen.png "Home Screen")
 
-# About
+## Table of Contens
+- [About](#about)
+- [Features](#features)
+- [Requirements](#requirements)
+- [Instalation](#installation)
+- [Usage](#usage)
+- [Commands](#commands)
+- [Example Output](#example-output)
+
+## About
 webshell analyzer was developed to assist security analysts, researchers, and system administrators in identifying potentially malicious PHP files before they are executed on a web server. the tool helps to mitigate the risk of unauthorised access, web defacement attacks, and persistent backdoor attacks, which are commonly associated with webshells.
 
 this system combines three static code analysis methods: lexical analysis, statistical analysis, and Abstract Syntax Tree (AST) analysis. this approach enables the detection process to identify suspicious functions, code structure patterns, and statistical characteristics that may indicate malicious behavior.
 
-# Features
+## Features
 - Scan individual PHP files for webshell indicators
 - Recursively scan entire directories
 - Static feature extraction (no code execution required)
@@ -66,40 +68,53 @@ this system combines three static code analysis methods: lexical analysis, stati
 - Export results to only JSON file
 - Interactive CLI environment
 
-# Requirements
+## Requirements
 before installing and running webshell analyzer, ensure that your system meets the following requirements :
 
 - Python 3.10 or later
-- Pip (oython package manager)
+- Pip (python package manager)
 - Git
 
-**Python Dependencies**
-The required python packages are listed in the ```requirements.txt``` file and can be installed automatically using :
+## Installation
+
+### Option 1 — Via pip (Recommended)
+
+The easiest way to install Webshell Analyzer is via pip:
+
+```bash
+pip install webshell-analyzer
+```
+All required dependencies will be installed automatically.
 
-```pip install -r requirements.txt```
+### Option 2 — Via GitHub Clone
 
-# Installation
-to install webshell analyzer, clone this repository to your local machine using the following command :
+```bash
+# Clone the repository
+git clone https://github.com/Adeliasaputriiii/webshell-analyzer
 
-```git clone https://github.com```
+# Navigate to the project directory
+cd webshell-analyzer
 
-After the installation process is complete, the system is ready to use.
+# Install dependencies
+pip install -r requirements.txt
 
-# Usage
-To get started with Webshell Analyzer:
+# Install the package
+pip install .
+```
 
-Start ```bash wsanalyzer```:  this is the main command to enter the Webshell Analyzer interactive environment.
-You will be greeted with the Webshell Analyzer prompt:
+## Usage
+Use the following command to launch the webshell analyzer interactive environment :
 
-From here, you can run all available commands such as `scan`, `detect`, `--output`, `help`, `exit`.
+```wsanalyzer```
 
-# Command
+once started, you will be presented with the webshell analyzer command prompt. From this environment, you can run all available commands such as `scan`, `detect`, `--output`, `help`, `exit`.
+
+## Commands
 1. ```scan <directory_path> [--output <output_file.json>]``` -> scan all PHP files in a directory for webshell detection
 2. ```detect <file_path> [--output <output_file.json>]``` -> detect a specific file for webshell activity
 3. ```help``` -> for show this help message
 4. ```exit``` -> For Exit the Webshell Analyzer
 5. ```--output <output_file.json>``` -> Save the detection results to a JSON file
 
-
-
-
+## Example Output
+![Process Detecting Single file PHP](/assets/images/detectFile.png "detecting File")