fastlane-plugin-match_keystore 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc39c27ae6c902a6fcd405d5eef892687e663bb85cccb0fbbeb10dfb69b00751
-  data.tar.gz: b6aebe60f441bfc603aac48563763fc18ec57f8079276780ae871795d833a67f
+  metadata.gz: 0af6b5ad125ace188811247b482ba84e38bd73cad908e32cb2ddd2193059fd9b
+  data.tar.gz: 01dc72217dd581f967e5c9639459af9557fea5921c9dd6fce4580c75b41ada2c
 SHA512:
-  metadata.gz: 7582d8c4cc25d65d84b9b77db1bd18eacb4e434733456e1307f9cff59bb55cea15112045f8d6664968a2ec704da32c1c132c563713baf06946b45f07dd7a33a9
-  data.tar.gz: 6f978721abbfb8110c1ed311dcd366602baba4fac92ada9d1406682201d99a40909cd4400b48c621e32f680b43be73a02f42b0c5770432d522f6019e01558585
+  metadata.gz: 61861369ca1cddf195c96ee6402802b01b686a9864974e68563daef6bb0cd79329289a989b16a22e2dacee7348987e1ebaf0e11610625f634e8d7c17aba055d7
+  data.tar.gz: 1842d84d9bee7a59192a17c3105d1e202d3addcc86f2ea29a582a64847d862d43bee7326fc51c7705de063a1c6ec4483a857d27101919fdd824fb204cefc3879

data/README.md

@@ -12,9 +12,13 @@ fastlane add_plugin match_keystore
 
 ## About match_keystore
 
-Easily sync your Android keystores across your team
+Easily sync your Android keystores across your team.
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+This plugin was design based on the 'match' plugin and code signing concept: https://codesigning.guide/
+
+With **match_keystore** you can store all your Android Keystores in secured private repository and share it to your team and your CI system.
+
+The keystore properties are encrypted with AES in order to secure sensitive data in the Git repository itself.
 
 ## How to use
 
@@ -24,11 +28,14 @@ Easily sync your Android keystores across your team
   	gradle(task: "clean")
     gradle(task: 'assemble', build_type: 'Release')
 
-    match_keystore(
-      git_url: "https://github.com/<GITHUB_USERNAME>/keystores.git",
+    signed_apk_path = match_keystore(
+      git_url: "https://github.com/<GITHUB_USERNAME>/keystores.git", # Please use a private Git repository !
       package_name: "com.your.package.name",
-      apk_path: "/app/build/outputs/apk/app-release.apk"
+      apk_path: "/app/build/outputs/apk/app-release.apk" # Or path without APK: /app/build/outputs/apk/
     )
+
+    # Return the path of signed APK (useful for other lanes such as `publish_to_firebase`, `upload_to_play_store`)
+    puts signed_apk_path
   end
 ```
 

data/lib/fastlane/plugin/match_keystore/actions/match_keystore_action.rb

@@ -84,7 +84,7 @@ module Fastlane
         # https://developer.android.com/studio/command-line/apksigner
         apk_path_signed = apk_path.gsub(".apk", "-signed.apk")
         puts `rm -f #{apk_path_signed}`
-        puts `#{build_tools_path}apksigner sign --ks #{keystore_path} --ks-key-alias #{alias_name} --ks-pass pass:#{alias_password} --key-pass pass:#{key_password} --v1-signing-enabled true --v2-signing-enabled true --out #{apk_path_signed} #{apk_path_aligned}`
+        puts `#{build_tools_path}apksigner sign --ks #{keystore_path} --ks-key-alias '#{alias_name}' --ks-pass pass:'#{alias_password}' --key-pass pass:'#{key_password}' --v1-signing-enabled true --v2-signing-enabled true --out #{apk_path_signed} #{apk_path_aligned}`
     
         puts `#{build_tools_path}apksigner verify #{apk_path_signed}`
         puts `rm -f #{apk_path_aligned}`
@@ -93,7 +93,7 @@ module Fastlane
       end
 
       def self.resolve_apk_path(apk_path)
-        
+
         if !apk_path.to_s.end_with?(".apk") 
 
           if !File.directory?(apk_path)
@@ -126,6 +126,7 @@ module Fastlane
         git_url = params[:git_url]
         package_name = params[:package_name]
         apk_path = params[:apk_path]
+        existing_keystore = params[:existing_keystore]
         override_keystore = params[:override_keystore]
 
         keystore_name = 'keystore.jks'
@@ -173,8 +174,9 @@ module Fastlane
         properties_path = keystoreAppDir + '/' + properties_name
         properties_encrypt_path = keystoreAppDir + '/' + properties_encrypt_name
 
-         # Create keystore with command
-        if !File.file?(keystore_path) || override_keystore
+        # Create keystore with command
+        override_keystore = File.file?(existing_keystore)
+        if !File.file?(keystore_path) || override_keystore 
 
           if File.file?(keystore_path)
             FileUtils.remove_dir(keystore_path)
@@ -184,25 +186,31 @@ module Fastlane
           alias_name = other_action.prompt(text: "Keystore Alias name: ")
           alias_password = other_action.prompt(text: "Keystore Alias password: ")
 
-          full_name = other_action.prompt(text: "Certificate First and Last Name: ")
-          org_unit = other_action.prompt(text: "Certificate Organisation Unit: ")
-          org = other_action.prompt(text: "Certificate Organisation: ")
-          city_locality = other_action.prompt(text: "Certificate City or Locality: ")
-          state_province = other_action.prompt(text: "Certificate State or Province: ")
-          country = other_action.prompt(text: "Certificate Country Code (XX): ")
-
           # https://developer.android.com/studio/publish/app-signing
-          UI.message("Generating Android Keystore...")
-          keytool_parts = [
-            "keytool -genkey -v",
-            "-keystore #{keystore_path}",
-            "-alias #{alias_name}",
-            "-keyalg RSA -keysize 2048 -validity 10000",
-            "-storepass #{alias_password} ",
-            "-keypass #{key_password}",
-            "-dname \"CN=#{full_name}, OU=#{org_unit}, O=#{org}, L=#{city_locality}, S=#{state_province}, C=#{country}\"",
-          ]
-          sh keytool_parts.join(" ")
+          if !File.file?(existing_keystore)
+            UI.message("Generating Android Keystore...")
+            
+            full_name = other_action.prompt(text: "Certificate First and Last Name: ")
+            org_unit = other_action.prompt(text: "Certificate Organisation Unit: ")
+            org = other_action.prompt(text: "Certificate Organisation: ")
+            city_locality = other_action.prompt(text: "Certificate City or Locality: ")
+            state_province = other_action.prompt(text: "Certificate State or Province: ")
+            country = other_action.prompt(text: "Certificate Country Code (XX): ")
+            
+            keytool_parts = [
+              "keytool -genkey -v",
+              "-keystore #{keystore_path}",
+              "-alias #{alias_name}",
+              "-keyalg RSA -keysize 2048 -validity 10000",
+              "-storepass #{alias_password} ",
+              "-keypass #{key_password}",
+              "-dname \"CN=#{full_name}, OU=#{org_unit}, O=#{org}, L=#{city_locality}, S=#{state_province}, C=#{country}\"",
+            ]
+            sh keytool_parts.join(" ")
+          else
+            UI.message("Copy existing keystore to match_keystore repository...") 
+            puts `cp #{existing_keystore} #{keystore_path}`
+          end
 
           UI.message("Generating Keystore properties...")
          
@@ -249,19 +257,25 @@ module Fastlane
 
         output_signed_apk = ''
         apk_path = self.resolve_apk_path(apk_path)
-        UI.message("APK to sign: " + apk_path)
-
-        if File.file?(keystore_path)
-          UI.message("Signing the APK...")
-          output_signed_apk = self.sign_apk(
-            apk_path, 
-            keystore_path, 
-            key_password, 
-            alias_name, 
-            alias_password, 
-            true
-          )
-        end 
+
+        if File.file?(apk_path)
+          UI.message("APK to sign: " + apk_path)
+
+          if File.file?(keystore_path)
+
+            UI.message("Signing the APK...")
+            output_signed_apk = self.sign_apk(
+              apk_path, 
+              keystore_path, 
+              key_password, 
+              alias_name, 
+              alias_password, 
+              true
+            )
+          end 
+        else
+          UI.message("No APK file found to sign!")
+        end
 
         output_signed_apk
 
@@ -295,12 +309,12 @@ module Fastlane
 
       def self.available_options
         [
-           FastlaneCore::ConfigItem.new(key: :git_url,
+          FastlaneCore::ConfigItem.new(key: :git_url,
                                    env_name: "MATCH_KEYSTORE_GIT_URL",
                                 description: "The URL of the Git repository (Github, BitBucket...)",
                                    optional: false,
                                        type: String),
-           FastlaneCore::ConfigItem.new(key: :package_name,
+          FastlaneCore::ConfigItem.new(key: :package_name,
                                    env_name: "MATCH_KEYSTORE_PACKAGE_NAME",
                                 description: "The package name of the App",
                                    optional: false,
@@ -310,7 +324,12 @@ module Fastlane
                                 description: "Path of the APK file to sign",
                                    optional: false,
                                        type: String),
-           FastlaneCore::ConfigItem.new(key: :override_keystore,
+          FastlaneCore::ConfigItem.new(key: :existing_keystore,
+                                   env_name: "MATCH_KEYSTORE_EXISTING",
+                                description: "Path of an existing Keystore",
+                                   optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :override_keystore,
                                    env_name: "MATCH_KEYSTORE_OVERRIDE",
                                 description: "Override an existing Keystore (false by default)",
                                    optional: true,

data/lib/fastlane/plugin/match_keystore/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module MatchKeystore
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-match_keystore
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Christopher NEY