Metadata-Version: 2.4
Name: jefferson
Version: 0.4.8
Summary: JFFS2 filesystem extraction tool.
Author: ONEKEY, Stefan Viehböck
Author-email: ONEKEY <support@onekey.com>, Stefan Viehböck <support@onekey.com>
License-Expression: MIT
License-File: LICENSE
Requires-Dist: click>=8.1.3,<9
Requires-Dist: dissect-cstruct>=4.4,<5
Requires-Dist: lzallright>=0.3,<0.4
Requires-Python: >=3.10
Description-Content-Type: text/markdown

## Jefferson

JFFS2 filesystem extraction tool.

### Installation

You can install Jefferson from PyPi with the following command:

```
pip install --user jefferson
```

### Usage

```sh
jefferson filesystem.img -d outdir
```

### Features

- big-endian and little-endian support with auto-detection
- zlib, rtime, LZMA, and LZO compression support
- CRC checks - for now only enforced on `hdr_crc`
- extraction of symlinks, directories, files, and device nodes
- detection/handling of duplicate inode numbers. Occurs if multiple JFFS2 filesystems are found in one file and causes `jefferson` to treat segments as separate filesystems

### Development

The package is maintained with [uv](https://docs.astral.sh/uv/). If you want to contribute, we recommend you follow these steps:

```sh
git clone https://github.com/onekey-sec/jefferson.git
cd jefferson
uv sync
uv run jefferson
uv run pre-commit install
```

Nix users get the environment from `nix develop` or direnv.
