NoPASARAN is an advanced network tool designed to detect, fingerprint, and locate network middleboxes in a unified framework.
Project description
NoPASARAN
NoPASARAN is an advanced network tool designed to detect, fingerprint, and locate network middleboxes in a unified framework. Written in Python, NoPASARAN uses finite state machines to describe test cases and leverages Ansible for distributing and orchestrating these tests across a network of nodes.
Table of Contents
Features
- Detection, fingerprinting, and location of network middleboxes.
- Utilization of finite state machines for test case description.
- Network orchestration with Ansible.
- Flexible roles for network nodes and proxies.
- Support for JSON-based test files for state machine configurations.
Requirements
- Python 3.8 or later
- Scapy
- Twisted
Installation
You can install and use NoPASARAN either by cloning the source code from GitHub or by installing it as a Python package.
Installing from Source Code
-
Clone the NoPASARAN repository:
git clone https://github.com/BenIlies/NoPASARAN.git
-
Navigate into the NoPASARAN directory:
cd NoPASARAN
-
Install the necessary Python packages:
pip install -r requirements.txt
Installing as a Python Package
-
Alternatively, you can install NoPASARAN as a Python package using pip:
pip install nopasaran
Usage
To run NoPASARAN, you need to specify a JSON file for the state machine indicating the test the application has to run.
-
From the source code:
python main.py --test=<path-to-json-test-file>
-
As a package:
nopasaran --test=<path-to-json-test-file>
Additional Options
You can further customize the behavior of NoPASARAN with the following options:
--verbose
or-v
: Enable verbose output.--log=<path-to-log-file>
or-l=<path-to-log-file>
: Specify the path to the log file (default is "conf.log").--log-level=<log-level>
or-ll=<log-level>
: Specify the log level for output. Valid choices are "debug", "info", "warning", and "error".
Replace <path-to-json-test-file>
with the path to your actual JSON test file.
For any further assistance, use the --help
argument with any command for additional information.
Docker
You can also use Docker to download and run a NoPASARAN node.
-
Pull the latest node image:
docker pull benilies/nopasaran:latest
-
Run the node container:
docker run -it benilies/nopasaran:latest
The node container is now ready for use.
Documentation
For more detailed guides and information about NoPASARAN, please visit our documentation.
Gitter
Join the discussion on Gitter.
Acknowledgements
This software is based on the research paper titled "NoPASARAN: a Novel Platform to Analyse Semi Active elements in Routes Across the Network" by Ilies Benhabbour and Marc Dacier, published in 2022.
@article{benhabbour2022nopasaran,
title={NoPASARAN: a Novel Platform to Analyse Semi Active elements in Routes Across the Network},
author={Benhabbour, Ilies and Dacier, Marc},
year={2022},
publisher={Index Copernicus}
}
License
NoPASARAN is released under the GNU General Public License v3.0.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file nopasaran-0.2.40.tar.gz
.
File metadata
- Download URL: nopasaran-0.2.40.tar.gz
- Upload date:
- Size: 48.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d288d94ce8df16cee6b949c75bf54c7c76273caa768856878304f359dfcf2c3 |
|
MD5 | 0e466905e545b202164d245542ea6bd0 |
|
BLAKE2b-256 | 1bdd5929d4e608606fd3035b1530c05ea96afec08f152da743db0deacba06a48 |
File details
Details for the file nopasaran-0.2.40-py3-none-any.whl
.
File metadata
- Download URL: nopasaran-0.2.40-py3-none-any.whl
- Upload date:
- Size: 68.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8d9f2621de26a7093a439bc41f6bedbd8f305353f71387bc049e713da1d486a |
|
MD5 | 71d9f5899890903a5e4005dae9f06f16 |
|
BLAKE2b-256 | 2a2dc01afbb0042dc98ed995414d2c264878e317003fd08249257f777c68a5a0 |