apksigcopier 1.1.1

Description:

apksigcopier 1.1.1

apksigcopier
copy/extract/patch android apk signatures & compare apks
apksigcopier is a tool for copying android APK
signatures
from a signed APK to an unsigned one (in order to verify reproducible
builds). It can also
be used to compare two APKs with different signatures. Its
command-line tool offers four operations:

copy signatures directly from a signed to an unsigned APK
extract signatures from a signed APK to a directory
patch previously extracted signatures onto an unsigned APK
compare two APKs with different signatures

Extract
$ mkdir meta
$ apksigcopier extract signed.apk meta
$ ls -1 meta
8BEA2A77.RSA
8BEA2A77.SF
APKSigningBlock
APKSigningBlockOffset
MANIFEST.MF

Patch
$ apksigcopier patch meta unsigned.apk out.apk

Copy (Extract & Patch)
$ apksigcopier copy signed.apk unsigned.apk out.apk

Compare (Copy & Verify)
Compare two APKs by copying the signature from the first to a copy of the second
and checking if the resulting APK verifies.
This command requires apksigner.
$ apksigcopier compare foo-from-fdroid.apk foo-built-locally.apk
$ apksigcopier compare --unsigned foo.apk foo-unsigned.apk

NB: copying from an APK v1-signed with signflinger to an APK signed with
apksigner works, whereas the reverse fails; see the FAQ.
Help
$ apksigcopier --help
$ apksigcopier copy --help # extract --help, patch --help, etc.

$ man apksigcopier # requires the man page to be installed

Environment Variables
The following environment variables can be set to 1, yes, or
true to override the default behaviour:

set APKSIGCOPIER_EXCLUDE_ALL_META=1 to exclude all metadata files
set APKSIGCOPIER_COPY_EXTRA_BYTES=1 to copy extra bytes after data (e.g. a v2 sig)
set APKSIGCOPIER_SKIP_REALIGNMENT=1 to skip realignment of ZIP entries

Python API
>>> from apksigcopier import do_extract, do_patch, do_copy, do_compare
>>> do_extract(signed_apk, output_dir, v1_only=NO)
>>> do_patch(metadata_dir, unsigned_apk, output_apk, v1_only=NO)
>>> do_copy(signed_apk, unsigned_apk, output_apk, v1_only=NO)
>>> do_compare(first_apk, second_apk, unsigned=False)

You can use False, None, and True instead of NO, AUTO, and
YES respectively.
The following global variables (which default to False), can be set
to override the default behaviour:

set exclude_all_meta=True to exclude all metadata files
set copy_extra_bytes=True to copy extra bytes after data (e.g. a v2 sig)
set skip_realignment=True to skip realignment of ZIP entries

FAQ
What kind of signatures does apksigcopier support?
It currently supports v1 + v2 + v3 (which is a variant of v2).
It should also support v4, since these are stored in a separate file
(and require a complementary v2/v3 signature).
When using the extract command, the v2/v3 signature is saved as
APKSigningBlock + APKSigningBlockOffset.
How does patching work?
First it copies the APK exactly like apksigner would when signing it,
including re-aligning ZIP entries and skipping existing v1 signature files.
Then it adds the extracted v1 signature files (.SF, .RSA/.DSA/.EC,
MANIFEST.MF) to the APK, using the correct ZIP metadata (either the same
metadata as apksigner would, or from differences.json).
And lastly it inserts the extracted APK Signing Block at the correct offset
(adding zero padding if needed) and updates the central directory (CD) offset in
the end of central directory (EOCD) record.
For more information about the ZIP file format, see e.g. the Wikipedia
article.
What does the "APK Signing Block offset < central directory offset" error mean?
It means that apksigcopier can't insert the APK Signing Block at the required
location, since that offset is in the middle of the ZIP data (instead of right
after the data, before the central directory).
In other words: the APK you are trying to copy the signature to is larger than
the one the signature was copied from. Thus the signature cannot be copied (and
could never have been valid for the APK you are trying to copy it to).
In the context of verifying reproducible builds,
getting this error almost certainly means the build was not reproducible.
What about APKs signed by gradle/zipflinger/signflinger instead of apksigner?
Compared to APKs signed by apksigner, APKs signed with a v1 signature by
zipflinger/signflinger (e.g. using gradle) have different ZIP metadata --
create_system, create_version, external_attr, extract_version,
flag_bits -- and compresslevel for the v1 signature files (.SF,
.RSA/.DSA/.EC, MANIFEST.MF); they also usually have a 132-byte virtual
entry at the start as well.
Recent versions of apksigcopier will detect these ZIP metadata differences and
the virtual entry (if any); extract will save them in a differences.json
file (if they exist), which patch will read (if it exists); copy and
compare simply pass the same information along internally.
CAVEAT for compare
NB: because compare copies from the first APK to the second, it will fail when
only the second APK is v1-signed with zipflinger/signflinger; e.g.
$ compare foo-signflinger.apk foo-apksigner.apk # copies virtual entry; works
$ compare foo-apksigner.apk foo-signflinger.apk # only 2nd APK has virtual entry
DOES NOT VERIFY
[...]
Error: failed to verify /tmp/.../output.apk.

What are these virtual entries?
A virtual entry is a ZIP entry with an empty filename, an extra field filled
with zero bytes, and no corresponding central directory entry (so it should be
effectively invisible to most ZIP tools).
When zipflinger deletes an entry it leaves a "hole" in the archive when there
remain non-deleted entries after it. It later fills these "holes" with virtual
entries.
There is usually a 132-byte virtual entry at the start of an APK signed with a
v1 signature by signflinger/zipflinger; almost certainly this is a default
manifest ZIP entry created at initialisation, deleted (from the central
directory but not from the file) during v1 signing, and eventually replaced by a
virtual entry.
Depending on what value of Created-By and Built-By were used for the default
manifest, this virtual entry may be a different size; apksigcopier supports
any size between 30 and 4096 bytes.

Installing
Debian
Official packages are available in
Debian and
Ubuntu.
$ apt install apksigcopier

You can also manually build a Debian package using the debian/sid
branch, or download a pre-built .deb via GitHub releases.
NixOS & Arch Linux
Official packages are also available in
nixpkgs and
Arch Linux
(and derivatives).
Using pip
$ pip install apksigcopier

NB: depending on your system you may need to use e.g. pip3 --user
instead of just pip.
From git
NB: this installs the latest development version, not the latest
release.
$ git clone https://github.com/obfusk/apksigcopier.git
$ cd apksigcopier
$ pip install -e .

NB: you may need to add e.g. ~/.local/bin to your $PATH in order
to run apksigcopier.
To update to the latest development version:
$ cd apksigcopier
$ git pull --rebase

Dependencies

Python >= 3.7 + click.
The compare command also requires apksigner.

Debian/Ubuntu
$ apt install python3-click
$ apt install apksigner # only needed for the compare command

License