Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / tools / apksig / 42e5cb6c68d1d0f3f9e6852888d737727528f19d
commit42e5cb6c68d1d0f3f9e6852888d737727528f19d[log] [tgz]
authorMichael Groover <mpgroover@google.com>Wed Jun 13 12:59:18 2018 -0700
committerMichael Groover <mpgroover@google.com>Fri Jun 22 18:11:06 2018 -0700
treef152313f5afd5883c4648e61faff611bbdf556fa
parent51d7b22b0f3b6ac3dd176449c1a1bfb28c1c8e4e [diff]
Add support to modify capabilities of signers in lineage

The apksigner tool currently supports the rotate option to create / update a
SigningCertificateLineage, but the capabilities of the previous signers are set
to default values. Both the current rotate option and the new lineage option in
apksigner have been updated to accept parameters to set the capabilities of
previous signers; the lineage is then created / updated with these new
capability values.

Fixes: 78638791
Test: Manually created and updated lineages with various capabilities for
      previous signers.

Change-Id: Ie1cf1c4713ba9dfd0bdcdc3647c2e94a5398c6b0
18 files changed
tree: f152313f5afd5883c4648e61faff611bbdf556fa
  1. etc/
  2. src/
  3. Android.bp
  4. android_plugin_for_gradle.gradle
  5. apksig.iml
  6. BUILD
  7. build.gradle
  8. LICENSE
  9. OWNERS
  10. 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.