Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / tools / apksig / 6442eefea4481ce11442af30127141cb934f0a1a
commit6442eefea4481ce11442af30127141cb934f0a1a[log] [tgz]
authorKhaled Abdelmohsen <khelmy@google.com>Fri Sep 25 21:23:27 2020 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Fri Sep 25 21:23:27 2020 +0000
tree9e7a90c19dcae6ec474ebfbe8183cdac3d5e798c
parent744c13d5f79642a88109a8a23d8f38322a0c44b2 [diff]
parent9f0e49e0a57bd1c12a86b6dca47b6ee9378d6cbe [diff]
Stamp refactorings am: 9f0e49e0a5

Original change: https://googleplex-android-review.googlesource.com/c/platform/tools/apksig/+/12684951

Change-Id: I23100457cba104f893c415b795477192091f6995
tree: 9e7a90c19dcae6ec474ebfbe8183cdac3d5e798c
  1. etc/
  2. src/
  3. Android.bp
  4. android_plugin_for_gradle.gradle
  5. build.gradle
  6. LICENSE
  7. OWNERS
  8. README.md
README.md

apksig

apksig is a project which aims to simplify APK signing and checking whether APK signatures are expected to verify on Android. apksig supports JAR signing (used by Android since day one) and APK Signature Scheme v2 (supported since Android Nougat, API Level 24). apksig is meant to be used outside of Android devices.

The key feature of apksig is that it knows about differences in APK signature verification logic between different versions of the Android platform. apksig thus thoroughly checks whether an APK's signature is expected to verify on all Android platform versions supported by the APK. When signing an APK, apksig chooses the most appropriate cryptographic algorithms based on the Android platform versions supported by the APK being signed.

The project consists of two subprojects:

  • apksig -- a pure Java library, and
  • apksigner -- a pure Java command-line tool based on the apksig library.

apksig library

apksig library offers three primitives:

  • ApkSigner which signs the provided APK so that it verifies on all Android platform versions supported by the APK. The range of platform versions can be customized.
  • ApkVerifier which checks whether the provided APK is expected to verify on all Android platform versions supported by the APK. The range of platform versions can be customized.
  • (Default)ApkSignerEngine which abstracts away signing APKs from parsing and building APKs. This is useful in optimized APK building pipelines, such as in Android Plugin for Gradle, which need to perform signing while building an APK, instead of after. For simpler use cases where the APK to be signed is available upfront, the ApkSigner above is easier to use.

NOTE: Some public classes of the library are in packages having the word "internal" in their name. These are not public API of the library. Do not use *.internal.* classes directly because these classes may change any time without regard to existing clients outside of apksig and apksigner.

apksigner command-line tool

apksigner command-line tool offers two operations:

  • sign the provided APK so that it verifies on all Android platforms supported by the APK. Run apksigner sign for usage information.
  • check whether the provided APK's signatures are expected to verify on all Android platforms supported by the APK. Run apksigner verify for usage information.

The tool determines the range of Android platform versions (API Levels) supported by the APK by inspecting the APK's AndroidManifest.xml. This behavior can be overridden by specifying the range of platform versions on the command-line.