diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6bbdfa7 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/apksign \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a8b72b0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..6de9b75 --- /dev/null +++ b/Makefile @@ -0,0 +1,35 @@ +ifndef VERBOSE +.SILENT: +endif + +GOPATH = $(shell go env GOPATH) + +dep_repo = https://github.com/morrildl + +dep_android = $(GOPATH)/src/playground/android +dep_log = $(GOPATH)/src/playground/log + +LOG_DEP = printf "\033[1;36mDEP\033[0m "; echo +LOG_GOC = printf "\033[1;36mGOC\033[0m "; echo + +## + +all: apksign + +apksign: main.go + # Test for missing dependencies + go vet 2>/dev/null || make -f $(MAKEFILE_LIST) deps + + $(LOG_GOC) $@ + go build + +deps: $(dep_android)/README.md \ + $(dep_log)/README.md + +$(dep_android)/README.md: + $(LOG_DEP) Fetching dependency 'android' + [ ! -d "$(dep_android)" ] && git clone $(dep_repo)/playground-android $(dep_android) || printf "" + +$(dep_log)/README.md: + $(LOG_DEP) Fetching dependency 'log' + [ ! -d "$(dep_log)" ] && git clone $(dep_repo)/playground-log $(dep_log) || printf "" diff --git a/main.go b/main.go new file mode 100644 index 0000000..9bd07ed --- /dev/null +++ b/main.go @@ -0,0 +1,115 @@ +// Copyright © 2020 https://github.com/Leso-KN +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package main + +import ( + "io/ioutil" + "path" + "os" + + "playground/android/apksign" + "playground/android" +) + +// + +func loadFile(name string) ([]byte, error) { + var f *os.File + var err error + var b []byte + if f, err = os.Open(name); err != nil { + return nil, err + } + defer f.Close() + if b, err = ioutil.ReadAll(f); err != nil { + return nil, err + } + return b, err +} + +func saveFile(name string, b []byte) error { + var f *os.File + var err error + if f, err = os.Create(name); err != nil { + return err + } + defer f.Close() + if _, err = f.Write(b); err != nil { + return err + } + return nil +} + +func main() { + + if len(os.Args) < 4 { + print("Usage: " + path.Base(os.Args[0]) + " \n") + return + } + + var filename = os.Args[1] + var keyfile = os.Args[2] + var crtfile = os.Args[3] + + // + + var keys []*android.SigningCert = []*android.SigningCert{ + {SigningKey: android.SigningKey{ + KeyPath: keyfile, + Type: android.RSA, + Hash: android.SHA256, + }, + CertPath: crtfile, + }, + } + + var z *apksign.Zip + var unsapk []byte + var err error + + if unsapk, err = loadFile(filename); err != nil { + print("error reading apk.\n") + return + } + + if z, err = apksign.NewZip(unsapk); err != nil { + print("error parsing apk: ", err, "\n") + return + } + + // Sign + if z, err = z.Sign(keys); err != nil { + print("error signing apk. ", err, "\n") + return + } + if err = z.VerifyV1(); err == nil { + print("v2-signature apk passed v1 verification.\n") + return + } + if err = z.VerifyV2(); err != nil { + print("v2-signature verification failed. (1) ", err, "\n") + return + } + if err = z.Verify(); err != nil { + print("v2-signature verification failed. (2) ", err, "\n") + return + } + if !z.IsAPK || !z.IsV1Signed || !z.IsV2Signed { + print("signed apk was incorrectly characterized. ", z.IsAPK, z.IsV1Signed, z.IsV2Signed, "\n") + return + } + + saveFile(filename, z.Bytes()) +} diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..69073c1 --- /dev/null +++ b/readme.md @@ -0,0 +1,36 @@ +# `apksign` + +Go based tool for signing android apks with [Apk v2 sign](https://source.android.com/security/apksigning/v2). + +Credits go to [morrildl](https://github.com/morrildl). The mechanism used in this tool was implemented in their [playground-android](https://github.com/morrildl/playground-android) repository. + +## Usage + +```sh +> apktool +``` + +## Building + +```sh +> make +``` + +or + +```sh +> make deps # Download dependencies +> go build +``` + +If you want to run the tool without compiling it you may also go for +```sh +> make deps # Download dependencies +> go run main.go +``` + +## About Certificates + +Unlike `jarsigner` this tool uses a pair of public and private key instead of a java keystore. + +You can generate a key pair [using openssl](https://www.tutorialspoint.com/how-to-use-openssl-for-generating-ssl-certificates-private-keys-and-csrs). \ No newline at end of file