https://github.com/fox-it/dissect.squashfs
A Dissect module implementing a parser for the SquashFS file system.
https://github.com/fox-it/dissect.squashfs
Last synced: 2 months ago
JSON representation
A Dissect module implementing a parser for the SquashFS file system.
- Host: GitHub
- URL: https://github.com/fox-it/dissect.squashfs
- Owner: fox-it
- License: agpl-3.0
- Created: 2022-12-06T09:54:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-24T16:45:44.000Z (4 months ago)
- Last Synced: 2026-03-05T12:54:15.937Z (3 months ago)
- Language: Python
- Homepage:
- Size: 74.2 KB
- Stars: 1
- Watchers: 9
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dissect.squashfs
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](https://docs.dissect.tools/en/latest/projects/dissect.squashfs/index.html).
## 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](https://docs.dissect.tools/en/latest/index.html#getting-started).
## Installation
`dissect.squashfs` is available on [PyPI](https://pypi.org/project/dissect.squashfs/).
```bash
pip install dissect.squashfs
```
This project decompresses LZO and LZ4 compressed file systems and can use a faster, native (Rust-based) LZO or LZ4 implementation,
instead of a slower pure Python implementation. Both implementations are provided by `dissect.util`.
Pre-build wheels are available for most common platforms and the native implementation will automatically be used if available.
In the rare case that a pre-build wheel is not available, please refer to `dissect.util` for build instructions.
## 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:
```bash
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:
```bash
tox
```
For a more elaborate explanation on how to build and test the project, please see [the
documentation](https://docs.dissect.tools/en/latest/contributing/tooling.html).
## Contributing
The Dissect project encourages any contribution to the codebase. To make your contribution fit into the project, please
refer to [the development guide](https://docs.dissect.tools/en/latest/contributing/developing.html).
## Copyright and license
Dissect is released as open source by Fox-IT () part of NCC Group Plc
().
Developed by the Dissect Team () and made available at .
License terms: AGPL3 (). For more information, see the LICENSE file.