nopasaran 0.2.117

NoPASARAN is an advanced network tool designed to detect, fingerprint, and locate network middleboxes in a unified framework.

NoPASARAN

NoPASARAN is a distributed 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.

Table of Contents

• Framework Architecture
• Features
• Requirements
• Installation
  • Installing from Source Code
  • Installing as a Python Package
• Usage
  • Additional Options
• Docker
• Documentation
• Gitter
• Acknowledgements
• License

🚨 Important: NoPASARAN Is a Multi-Repository Framework

This repository is one component of the broader NoPASARAN distributed testing framework.

The full system is composed of multiple tightly-coupled repositories, each responsible for a critical part of test definition, orchestration, execution, and coordination. Most users and contributors will need to reference these projects together.

👉 Start here:
📁 framework-projects/ — canonical index of all NoPASARAN framework components.

Framework Components at a Glance

Component	Purpose
🧠 Tests-Trees	Decision trees defining conditional test execution logic
🧪 Tests	Reusable, reviewed test definitions executed by workers
⚙️ Endpoint	Runtime node acting as master or worker
🌐 Coordinator	Control plane, certificate authority, and user interface

➡️ If you are looking for tests, orchestration logic, or distributed execution details, you will not find them all in this repository alone.
➡️ Always refer to framework-projects/README.md for the complete picture.

Features

• Detection, fingerprinting, and location of network middleboxes.
• Utilization of finite state machines for test case description.
• 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

1. Clone the NoPASARAN repository:

   git clone https://github.com/BenIlies/NoPASARAN.git
   

2. Navigate into the NoPASARAN directory:

   cd NoPASARAN
   

3. 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.

1. Pull the latest node image:

   docker pull benilies/nopasaran:latest
   

2. 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.