Extractor

Extractor is a utility for working with Lineage install packages. These packages contain all the proprietary files used for device support. Since we don't have access to all the devices, this gives us a way to extract the same files for analysis.

All of the files we want are in a zip file. So extractor starts by unzipping the file to get to the binary files. Then the binary files are unpacked using either otadump or sdat2img-brotli to extract the filesystem images. These images can then be mounted to access the files.

The Lineage extract-files.py utility doesn't use the mounted file-systems, it handles that itself. So if you have mounted the file-systems, you want to unmount them before running extract-files.py.

Options

By default, extractor does nothing unless an action is supplied. All the options take a directory, and the program fiogures out the rest from there.

-h, --help            show this help message and exit
-v, --verbose         verbose output
-i, --indir DIR       The top level device directory
-z, --unzip DIR       Decompress the zip file
-e, --extract DIR     Extract all unzipped files
-m, --mount DIR       Mount all filesystems
-u, --unmount DIR     Unmount all filesystems
-r, --remove DIR      Clean all generated file
-a, --all             Do all operations
-o, --outdir DIR      The output directory
-c, --clone DIR       Copy the proprietary files for analysis

--indir

This is the top level directory containing all of the downloaded Lineage packages, and defaults to the current directory.

--unzip

This decompresses the Lineage install package into the payload files.

--mount

This mounts all the filesystem images that have been extracted from the payload files.

--unmount

This unmounts all the filesystem images that have been extracted from the payload files.

--extract

This uses the Lineage extract-files.py script to try to extract all the proprietary files. Since each device extracts files differently, this may not work for all devices.

--clone

This uses the same configuration files Lineage does and extracts all the listed files into an output directory for further analysis. If the proprietary-files.txt files are missing in Lineage because you haven't downloaded them, this creates a version of this file by scanning all the files. Sometimes there is a file listed in the proprietary-files.txt that doesn't exist ihn the actual device, this is flagged as a warning since it will keep Lineage for building.

--outdir

This is the output directory used when cloning the proprietary files, and defaults to ./blobs if not specified.

--remove

This removes all generated files leaving only the Lineage zip package.