A Dissect module implementing a parser for the SquashFS file system, commonly used in appliance or device firmware. For more information, please see the documentation.
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.
dissect.squashfs is available on PyPI.
pip install dissect.squashfsThis project decompresses lzo and lz4 compressed file systems and can use the faster, native (C-based) lz4 and lzo
implementations when installed, instead of the slower pure Python implementation provided by dissect.util. To use
these faster implementations, install the package with the lzo and lz4 extras:
pip install "dissect.squashfs[lz4,lzo]"Unfortunately there is no binary python-lzo wheel for PyPy installations on Windows, so it won't be installed there
This module including the lz4 and lzo extras is also automatically installed if you install the dissect package.
This project uses tox to build source and wheel distributions. Run the following command from the root folder to build
these:
tox -e buildThe 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:
toxFor a more elaborate explanation on how to build and test the project, please see the documentation.
The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please refer to the development guide.
Dissect is released as open source by Fox-IT (https://www.fox-it.com) part of NCC Group Plc (https://www.nccgroup.com).
Developed by the Dissect Team ([email protected]) and made available at https://github.com/fox-it/dissect.
License terms: AGPL3 (https://www.gnu.org/licenses/agpl-3.0.html). For more information, see the LICENSE file.