dissect.jffs

A Dissect module implementing a parser for the JFFS2 file system, commonly used by router operating systems. For more information, please see the documentation.

Requirements

This project is part of the Dissect framework and requires Python.

Information on the supported Python versions can be found in the Getting Started section of the documentation.

Installation

dissect.jffs is available on PyPI.

pip install dissect.jffs

This module is also automatically installed if you install the dissect package.

Build and test instructions

This project uses tox to build source and wheel distributions. Run the following command from the root folder to build these:

tox -e build

The build artifacts can be found in the dist/ directory.

tox is also used to run linting and unit tests in a self-contained environment. To run both linting and unit tests using the default installed Python version, run:

tox

For a more elaborate explanation on how to build and test the project, please see the documentation.

Contributing

The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please refer to the development guide.

Copyright and license

dissect.jffs is developed and released as open source by the Joint Sigint Cyber Unit (https://github.com/JSCU-NL) in collaboration with Fox-IT (https://www.fox-it.com) part of NCC Group Plc (https://www.nccgroup.com).

License terms: AGPL3 (https://www.gnu.org/licenses/agpl-3.0.html). For more information, see the LICENSE file.