feat(handler): add EROFS filesystem handler

EROFS is a high-performance read-only filesystem originally developed by
Huawei and now used extensively in AOSP. It offers features like
compression (LZ4, LZ4HC, LZMA, ZLIB, ZSTD), inline data, and reduced storage overhead,
making it ideal for read-only system images.

Create erofs file : > mkfs.erofs -z[compressor, level (optional)]
foo.erofs.img foo/

Extract erofs file: > fsck.erofs --extract=foo_extracted/ foo.erofs.img

Key notes:
- First 1024 bytes are reserved for the boot loader
- Header starts at 0x400 with E0F5E1E2
- Header can be more than 128 bytes if extra slots provided
- File format in little endian
- There is no standarized file extension. The official documentation
  uses ".erofs.img"
- Checksum changes from version to version

HEADER / SUPERBLOCK:
>  4 bytes : Magic
>  4 bytes : Checksum
>  4 bytes : Feature
>  1 byte  : Block size in bit shift
>  1 byte  : Superblock extension
>  2 bytes : Root NID
>  8 bytes : Total valid i-node
>  8 bytes : Built time in timestamp
>  4 bytes : Nanoseconds (ns) component of timestamp
>  4 bytes : Total block count
>  4 bytes : Start block addr of metadata area
>  4 bytes : Start block of shared xattr area
> 16 bytes : UUID for volume
> 16 bytes : Filesystem label
>  4 bytes : Incompatible feature flag for kernel
>  2 bytes : Available compression algorithm
>  2 bytes : LZ4 max distance
>  2 bytes : Extra devices
>  2 bytes : Start address of external device table
>  1 byte  : Directory block size 2^blkszbits+dirblkbits
>  1 byte  : Total number of long xattr name prefixes
>  4 bytes : Start address of long xattr prefixes
>  8 bytes : NID of the special packed inode.
>  1 byte  : xattr filter reserved
> 23 bytes : Reserved

Unblob structs the header until feature_incompact. The rest is labeled
as "reserved". Unblob parses the end offset by multiplying the block
size in bit shift with the block count.

Since the checksum is not consistent troughout versions, unblob matched
on block count (min 1), printable volume name, build time, build
time in ns and bit shift (min 9).

[Sources]
https://elixir.bootlin.com/linux/v6.14-rc6/source/fs/erofs/erofs_fs.h
https://web.git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/fs/erofs/erofs_fs.h?h=v6.6
https://erofs.docs.kernel.org/en/latest/core_ondisk.html
https://www.kernel.org/doc/html/latest/filesystems/erofs.html

Author: qkaiser

docs/formats.md

@@ -97,6 +97,7 @@ For compression formats, metadata cannot be preserved, as this information in mo
 | ---------------------- | ---------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
 | Android sparse image   | ❌                                 | [filesystem/android/sparse.py][android-handler] | [`simg2img`][android-extractor]                 |
 | CRAMFS                 | ✅                                 | [filesystem/cramfs.py][cramfs-handler]          | [`7z`][cramfs-extractor]                        |
+| EROFS                  | ✅                                 | [filesystem/android/erofs.py][erofs-handler]    | [`fsck.erfos`][erofs-extractor]                 | 
 | ExtFS                  | ✅                                 | [filesystem/extfs.py][extfs-handler]            | [`debugfs`][extfs-extractor]                    |
 | FAT                    | ✅                                 | [filesystem/fat.py][fat-handler]                | [`7z`][fat-extractor]                           |
 | ISO9660                | ✅                                 | [filesystem/iso9660.py][iso9660-handler]        | [`7z`][iso9660-extractor]                       |
@@ -107,12 +108,14 @@ For compression formats, metadata cannot be preserved, as this information in mo
 | SquashFS v4 Big Endian | ✅                                 | [filesystem/squashfs.py][squashfs-handler]      | [`sasquatch-v4-be`][squashfs-v4-be-extractor]   |
 | UBI                    | ✅                                 | [filesystem/ubi.py][ubi-handler]                | [`ubireader_extract_images`][ubi-extractor]     |
 | UBIFS                  | ✅                                 | [filesystem/ubi.py][ubi-handler]                | [`ubireader_extract_files`][ubifs-extractor]    |
-| YAFFS (1, 2)           | ✅                                 | [filesystem/yaffs.py][yaffs-handler]            | [`YAFFSExtractor` custom code][yaffs-extractor]                   |
+| YAFFS (1, 2)           | ✅                                 | [filesystem/yaffs.py][yaffs-handler]            | [`YAFFSExtractor` custom code][yaffs-extractor] |
 
 [android-handler]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/filesystem/android/sparse.py
 [android-extractor]: https://github.com/onekey-sec/unblob/blob/3008039881a0434deb75962e7999b7e35aca8271/unblob/handlers/filesystem/android/sparse.py#L61
 [cramfs-handler]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/filesystem/cramfs.py
 [cramfs-extractor]: https://github.com/onekey-sec/unblob/blob/3008039881a0434deb75962e7999b7e35aca8271/unblob/handlers/filesystem/cramfs.py#L45
+[erofs-handler]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/filesystem/android/erfos.py
+[erofs-extractor]: https://github.com/onekey-sec/unblob/blob/...
 [extfs-handler]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/filesystem/extfs.py
 [extfs-extractor]: https://github.com/onekey-sec/unblob/blob/3008039881a0434deb75962e7999b7e35aca8271/unblob/handlers/filesystem/extfs.py#L68
 [fat-handler]: https://github.com/onekey-sec/unblob/blob/main/unblob/handlers/filesystem/fat.py

install-deps.sh

@@ -5,6 +5,7 @@ apt-get update
 apt-get install --no-install-recommends -y \
     android-sdk-libsparse-utils \
     curl \
+    erofs-utils \
     lz4 \
     lziprecover \
     lzop \

package.nix

@@ -4,6 +4,7 @@
   fetchFromGitHub,
   makeWrapper,
   e2fsprogs-nofortify,
+  erofs-utils,
   jefferson,
   lz4,
   lziprecover,
@@ -24,6 +25,7 @@ let
   # These dependencies are only added to PATH
   runtimeDeps = [
     e2fsprogs-nofortify
+    erofs-utils
     jefferson
     lziprecover
     lzop

python/unblob/handlers/__init__.py

@@ -49,7 +49,7 @@
     ubi,
     yaffs,
 )
-from .filesystem.android import sparse
+from .filesystem.android import erofs, sparse
 
 BUILTIN_HANDLERS: Handlers = (
     cramfs.CramFSHandler,
@@ -118,6 +118,7 @@
     engenius.EngeniusHandler,
     ecc.AutelECCHandler,
     uzip.UZIPHandler,
+    erofs.EROFSHandler,
 )
 
 BUILTIN_DIR_HANDLERS: DirectoryHandlers = (

python/unblob/handlers/filesystem/android/erofs.py

@@ -0,0 +1,72 @@
+import io
+from typing import Optional
+
+from unblob.extractors import Command
+from unblob.file_utils import (
+    Endian,
+    InvalidInputFormat,
+)
+from unblob.models import (
+    File,
+    HexString,
+    StructHandler,
+    ValidChunk,
+)
+
+C_DEFINITIONS = r"""
+    typedef struct erofs_handler{
+        uint32_t magic;
+        uint32_t crc32c;
+        uint32_t feature_compact;
+        uint8_t block_size_bs;
+        uint8_t sb_extslots;
+        uint16_t root_nid;
+        uint64_t inos;
+        uint64_t build_time;
+        uint32_t build_time_nsec;
+        uint32_t block_count;
+        uint32_t meta_blkaddr;
+        uint32_t xattr_blkaddr;
+        uint8_t uuid[16];
+        char volume_name[16];
+        uint32_t feature_incompact;
+        char reserved[44];
+    } erofs_handler_t;
+"""
+
+SUPERBLOCK_OFFSET = 0x400
+
+
+class EROFSHandler(StructHandler):
+    NAME = "erofs"
+    PATTERNS = [HexString("e2 e1 f5 e0")]  # Magic in little endian
+    HEADER_STRUCT = "erofs_handler_t"
+    C_DEFINITIONS = C_DEFINITIONS
+    EXTRACTOR = Command(
+        "fsck.erofs",
+        "--no-preserve",
+        "--extract={outdir}",
+        "{inpath}",
+    )
+    PATTERN_MATCH_OFFSET = -SUPERBLOCK_OFFSET
+
+    def is_valid_header(self, header) -> bool:
+        return (
+            header.block_count >= 1
+            and header.build_time > 0
+            and header.build_time_nsec > 0
+            and header.block_size_bs >= 9
+            and str(header.volume_name).rstrip("\x00").isprintable()
+        )
+
+    def calculate_chunk(self, file: File, start_offset: int) -> Optional[ValidChunk]:
+        file.seek(start_offset + SUPERBLOCK_OFFSET, io.SEEK_SET)
+        header = self.parse_header(file, Endian.LITTLE)
+        if not self.is_valid_header(header):
+            raise InvalidInputFormat("Invalid erofs header.")
+
+        end_offset = (1 << header.block_size_bs) * header.block_count
+        return ValidChunk(
+            start_offset=start_offset,
+            end_offset=end_offset,
+        )

tests/integration/filesystem/android/erofs/__input__/foo.erofs.img

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7f400d3497501c6e68324868d88207aa9398888902414045f4ea498ff26bcdcd
+size 4096

tests/integration/filesystem/android/erofs/__input__/foo_padding.erofs.img

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7520d3fe98e5f5d25ccc4027321a561a125fbb413ecd83e935a8bc6b425b2aaf
+size 6144

tests/integration/filesystem/android/erofs/__output__/foo.erofs.img_extract/bar.txt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0bfc3200f0152ab9e91e662afd75add3306131f670a1d71539f680c7acdb0a9f
+size 13

tests/integration/filesystem/android/erofs/__output__/foo.erofs.img_extract/notes/apple.pdf

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5f70bf18a086007016e948b04aed3b82103a36bea41755b6cddfaf10ace3c6ef
+size 1024

tests/integration/filesystem/android/erofs/__output__/foo_padding.erofs.img_extract/0-1024.padding

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a5dc7382e2247702f0e29e2e71fedfb464d2b930a439957fa7458882f7f7116d
+size 3072

tests/integration/filesystem/android/erofs/__output__/foo_padding.erofs.img_extract/1024-4096.erofs

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0bfc3200f0152ab9e91e662afd75add3306131f670a1d71539f680c7acdb0a9f
+size 13

tests/integration/filesystem/android/erofs/__output__/foo_padding.erofs.img_extract/1024-4096.erofs_extract/bar.txt

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e5a00aa9991ac8a5ee3109844d84a55583bd20572ad3ffcd42792f3c36b183ad
+size 2048