| commit | 039f815895f62c9f8af23df66622b66246f3f61e | [log] [tgz] |
|---|---|---|
| author | Michael Groover <mpgroover@google.com> | Tue Jun 20 11:51:03 2023 -0500 |
| committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu Aug 10 17:13:12 2023 +0000 |
| tree | 0d7fda7068d650b5230a4abcbb8f3874fb0cd8f9 | |
| parent | 6b787ef9f09f0ad09453b91e4830a32b61576127 [diff] |
Add errors from signature verify result to returned result During APK signature verification, the apksig library will maintain an internal Result instance for the current signature version being verified; any errors / warnings from the specific version signer(s) verification will then be copied to a Result instance that is returned to the caller containing details for each of the signature versions that the library attempted to verify. The internal Result instance can also contain more general errors / warnings abut the verification; these are currently not merged with the Result to be returned to the caller, so some APKs may fail to verify without a valid error returned. This commit resolves this by merging all general errors / warnings with the Result to be returned to the caller. Bug: 266580022 Test: gradlew test (cherry picked from https://googleplex-android-review.googlesource.com/q/commit:0b086bdc130e1e6216fcbc5436fe8e3cdc9ec011) Merged-In: Id0f4ee47a964a3bb5d30916808a3108858e6a0cf Change-Id: Id0f4ee47a964a3bb5d30916808a3108858e6a0cf
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.