commit | 9a771bef4ef0faf4a89e5a98e7839bd0f8e3de08 | [log] [tgz] |
---|---|---|
author | Michael Groover <mpgroover@google.com> | Thu Apr 02 19:41:36 2020 -0700 |
committer | Michael Groover <mpgroover@google.com> | Thu Apr 02 19:57:57 2020 -0700 |
tree | 853794390aefe5c91174c327075caee7ec02e488 | |
parent | a45b23e2096e9d4633d601852b9ba813a43753c6 [diff] |
Change apksig API to allow disabling V4 error reporting During cleanup of testV4State_disableV3EnableV4_fails in ApkSignerTest I noticed the setV4SigningRequested may be confusing to clients of apksig since the majority will consider setV4SigningEnabled as requesting V4 signing. This commit modifies the apksig API to treat setV4SigningEnabled as the caller requesting V4 signing and modifies setV4SigningRequested to setV4ErrorReportingEnabled to indicate the behavior of this method on the signing process. Bug: 153123157 Test: gradlew test Change-Id: I4b1679eea413312249a078a6c8edd39a01d7f273
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 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 offers two operations:
apksigner sign
for usage information.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.