fastlane-plugin-match_keystore 0.1.16 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaedb3d25e8614b96c43af4e88ddbc46f56e71a7a97a92d2336507afc3afded8
-  data.tar.gz: 741fc33e956879046126da3fec54cb6f939b34eb8859e22d27244de8a7e6f823
+  metadata.gz: 13f57b6db57c10e142d53885360cb1416f676402fd7f234b61a549720501d9c6
+  data.tar.gz: 2809854cf748f5ba4931fd4cbe8dfc6292cfea2f4e5d556a887ed422ebfcacc2
 SHA512:
-  metadata.gz: e0d3ef8b5d0b9c5a66fcc8bece867e8d230e9f44764b963774cbdfbe110b38f7ef2446bf9592fd913716da8267471ef1cb7d2b6d30a70e494ef8ae75d78c84a9
-  data.tar.gz: 37849dd986d716d6ce16ab7fe8af4f3d18d7b8c3a1840f6f7d4ccade7121b7ced9ac2085e486c8c4442da6f7bf76435ac7581267a730bb204619f5c41d8b558a
+  metadata.gz: 97a47758d5a39ebf414ae7a232e8767cb0dfa6ac7c484f3180b8e3149d3e879fb3ce3b27d363eae444703e9f3a9bad5b4ddc5d66f2987ed5fa0ed29b04bd4c74
+  data.tar.gz: 2c27e6a39112bdef3c44c6ed8abd77a31e19c9ce52a002040562d9f4aee229b4cf0e60cbe868196493acc983ca61b39acdfadebd2914e5a9ba15d40dd1024751

data/README.md

@@ -2,6 +2,13 @@
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-match_keystore)
 
+## Machine requirements
+
+* OpenSSL 1.1.1 min OR LibreSSL 2.9 min installed
+* Git installed
+* Android SDK & Build-tools installed
+* ANDROID_HOME environment variable defined
+
 ## Getting Started
 
 This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-match_keystore`, add it to your project by running:
@@ -43,6 +50,8 @@ The keystore properties are encrypted with AES in order to secure sensitive data
   end
 ```
 
+You can build aab files as well by providing an `aab_path` instead of an `apk_path`.
+
 ## Example
 
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.

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

@@ -2,6 +2,7 @@ require 'fastlane/action'
 require 'fileutils'
 require 'os'
 require 'json'
+require 'pry'
 require 'digest'
 require_relative '../helper/match_keystore_helper'
 
@@ -11,14 +12,13 @@ module Fastlane
       MATCH_KEYSTORE_PATH = :MATCH_KEYSTORE_PATH
       MATCH_KEYSTORE_ALIAS_NAME = :MATCH_KEYSTORE_ALIAS_NAME
       MATCH_KEYSTORE_APK_SIGNED = :MATCH_KEYSTORE_APK_SIGNED
+      MATCH_KEYSTORE_AAB_SIGNED = :MATCH_KEYSTORE_AAB_SIGNED
     end
 
     class MatchKeystoreAction < Action
 
-      def self.openssl_path
-        path = "/usr/local/opt/openssl@1.1/bin"
-        path
-      end
+      KEY_VERSION = "2"
+      OPENSSL_BIN_PATH_MAC = "/usr/local/opt/openssl@1.1/bin"
 
       def self.to_md5(value)
         hash_value = Digest::MD5.hexdigest value
@@ -119,8 +119,7 @@ module Fastlane
 
       def self.openssl(forceOpenSSL)
         if forceOpenSSL
-          path = openssl_path
-          output = "#{path}/openssl"
+          output = "#{self::OPENSSL_BIN_PATH_MAC}/openssl"
         else
           output = "openssl"
         end
@@ -137,10 +136,15 @@ module Fastlane
         result
       end
 
-      def self.gen_key(key_path, password)
+      def self.gen_key(key_path, password, compat_key)
         `rm -f '#{key_path}'`
         shaValue = self.sha512(password)
-        `echo "#{shaValue}" > '#{key_path}'`
+        # Backward-compatibility
+        if compat_key == "1"
+          `echo "#{password}" | openssl dgst -sha512 | awk '{print $2}' | cut -c1-128 > '#{key_path}'`
+        else
+          `echo "#{shaValue}" > '#{key_path}'`
+        end
       end
 
       def self.encrypt_file(clear_file, encrypt_file, key_path, forceOpenSSL)
@@ -190,7 +194,7 @@ module Fastlane
 
         # Check SHA-512-File
         key_path = File.join(Dir.pwd, '/temp/key.txt')
-        self.gen_key(key_path, fakeValue)
+        self.gen_key(key_path, fakeValue, false)
         shaValue = self.get_file_content(key_path).strip!
         excepted = "cc6a7b0d89cc61c053f7018a305672bdb82bc07e5015f64bb063d9662be4ec81ec8afa819b009de266482b6bd56b7068def2524c32f5b5d4d9db49ee4578499d"
         self.assert_equals("SHA-512-File", excepted, shaValue)
@@ -250,49 +254,68 @@ module Fastlane
         build_tools_path = self.get_build_tools(version_targeted)
         UI.message("Build-tools path: #{build_tools_path}")
 
-        # https://developer.android.com/studio/command-line/zipalign
-        if zip_align == true
-          apk_path_aligned = apk_path.gsub(".apk", "-aligned.apk")
-          `rm -f '#{apk_path_aligned}'`
-          UI.message("Aligning APK (zipalign): #{apk_path}")
-          output = `#{build_tools_path}zipalign -v 4 '#{apk_path}' '#{apk_path_aligned}'`
-          puts ""
-          puts output
-
-          if !File.file?(apk_path_aligned)
-            raise "Aligned APK not exists!"
-          end
-
-        else
-          UI.message("No zip align!")
-          apk_path_aligned = apk_path
-        end
+        # https://developer.android.com/studio/command-line/apksigner
         apk_path_signed = apk_path.gsub(".apk", "-signed.apk")
         apk_path_signed = apk_path_signed.gsub("unsigned", "")
         apk_path_signed = apk_path_signed.gsub("--", "-")
-
-        # https://developer.android.com/studio/command-line/apksigner
         `rm -f '#{apk_path_signed}'`
-        UI.message("Signing APK: #{apk_path_aligned}")
+
+        UI.message("Signing APK (input): #{apk_path}")
         apksigner_opts = ""
         build_tools_version = self.get_build_tools_version(version_targeted)
         UI.message("Build-tools version: #{build_tools_version}")
         if Gem::Version.new(build_tools_version) >= Gem::Version.new('30')
           apksigner_opts = "--v4-signing-enabled false "
         end
-        output = `#{build_tools_path}apksigner sign --ks '#{keystore_path}' --ks-key-alias '#{alias_name}' --ks-pass pass:'#{key_password}' --key-pass pass:'#{alias_password}' --v1-signing-enabled true --v2-signing-enabled true #{apksigner_opts}--out '#{apk_path_signed}' '#{apk_path_aligned}'`
+        output = `#{build_tools_path}apksigner sign --ks '#{keystore_path}' --ks-key-alias '#{alias_name}' --ks-pass pass:'#{key_password}' --key-pass pass:'#{alias_password}' --v1-signing-enabled true --v2-signing-enabled true #{apksigner_opts}--out '#{apk_path_signed}' '#{apk_path}'`
         puts ""
         puts output
 
-        UI.message("Verifing APK signature: #{apk_path_signed}")
+        UI.message("Verifing APK signature (output): #{apk_path_signed}")
         output = `#{build_tools_path}apksigner verify '#{apk_path_signed}'`
         puts ""
         puts output
-        `rm -f '#{apk_path_aligned}'`
+
+
+        # https://developer.android.com/studio/command-line/zipalign
+        if zip_align != false
+          apk_path_aligned = apk_path_signed.gsub(".apk", "-aligned.apk")
+          `rm -f '#{apk_path_aligned}'`
+          UI.message("Aligning APK (zipalign): #{apk_path_signed}")
+          output = `#{build_tools_path}zipalign -v 4 '#{apk_path_signed}' '#{apk_path_aligned}'`
+          puts ""
+          puts output
+
+          if !File.file?(apk_path_aligned)
+            raise "Aligned APK not exists!"
+          end
+
+          `rm -f '#{apk_path_signed}'`
+          apk_path_signed = apk_path_aligned
+  
+        else
+          UI.message("No zip align - deactivated via parameter!")
+        end
 
         apk_path_signed
       end 
 
+      def self.sign_aab(aab_path, keystore_path, key_password, alias_name, alias_password)
+
+        aab_path_signed = aab_path.gsub('.aab', '-signed.aab')
+        aab_path_signed = aab_path_signed.gsub('unsigned', '')
+        aab_path_signed = aab_path_signed.gsub('--', '-')
+        `rm -f '#{aab_path_signed}'`
+
+        UI.message("Signing AAB (input): #{aab_path}")
+        aabsigner_opts = ""
+        output = `jarsigner -keystore '#{keystore_path}' -storepass '#{key_password}' -keypass '#{alias_password}' -signedjar '#{aab_path_signed}' '#{aab_path}' '#{alias_name}'`
+        puts ""
+        puts output
+
+        aab_path_signed
+      end
+
       def self.resolve_dir(path)
         if !File.directory?(path)
           path = File.join(Dir.pwd, path)
@@ -316,6 +339,34 @@ module Fastlane
         data
       end
 
+      def self.resolve_aab_path(aab_path)
+
+        # Set default AAB path if not set:
+        if aab_path.to_s.strip.empty?
+          aab_path = '/app/build/outputs/bundle/release/'
+        end
+
+        if !aab_path.to_s.end_with?('.aab')
+
+          aab_path = self.resolve_dir(aab_path)
+
+          pattern = File.join(aab_path, '*.aab')
+          files = Dir[pattern]
+
+          for file in files
+            if file.to_s.end_with?('.aab') && !file.to_s.end_with?("-signed.aab")
+              apk_path = file
+              break
+            end
+          end
+
+        else
+          aab_path = self.resolve_file(aab_path)
+        end
+
+        aab_path
+      end
+
       def self.resolve_apk_path(apk_path)
 
         # Set default APK path if not set:
@@ -360,6 +411,7 @@ module Fastlane
         git_url = params[:git_url]
         package_name = params[:package_name]
         apk_path = params[:apk_path]
+        aab_path = params[:aab_path]
         existing_keystore = params[:existing_keystore]
         match_secret = params[:match_secret]
         override_keystore = params[:override_keystore]
@@ -367,6 +419,8 @@ module Fastlane
         clear_keystore = params[:clear_keystore]
         unit_test = params[:unit_test]
         build_tools_version = params[:build_tools_version]
+        zip_align = params[:zip_align]
+        compat_key = params[:compat_key]
 
         # Test OpenSSL/LibreSSL
         if unit_test
@@ -390,6 +444,11 @@ module Fastlane
         # Check OpenSSL:
         self.check_ssl_version(false)
 
+        # Check is backward-compatibility is required:
+        if !compat_key.to_s.strip.empty?
+          UI.message("Compatiblity version: #{compat_key}")
+        end
+
         # Init workign local directory:
         dir_name = ENV['HOME'] + '/.match_keystore'
         unless File.directory?(dir_name)
@@ -398,7 +457,11 @@ module Fastlane
         end
 
         # Init 'security password' for AES encryption:
-        key_name = "#{self.to_md5(git_url)}.hex"
+        if compat_key == "1"
+          key_name = "#{self.to_md5(git_url)}.hex"
+        else
+          key_name = "#{self.to_md5(git_url)}-#{self::KEY_VERSION}.hex"
+        end
         key_path = File.join(dir_name, key_name)
         # UI.message(key_path)
         if !File.file?(key_path)
@@ -407,7 +470,7 @@ module Fastlane
             raise "Security password is not defined! Please use 'match_secret' parameter for CI."
           end
           UI.message "Generating security key '#{key_name}'..."
-          self.gen_key(key_path, security_password)
+          self.gen_key(key_path, security_password, compat_key)
         end
 
         # Check is 'security password' is well initialized:
@@ -446,14 +509,10 @@ module Fastlane
         gitDir = File.join(repo_dir, '/.git')
         if !File.directory?(gitDir)
           UI.message("Cloning remote Keystores repository...")
-          puts ''
           `git clone #{git_url} #{repo_dir}`
-          puts ''
         else
           UI.message("Pulling remote Keystores repository...")
-          puts ''
           `cd #{repo_dir} && git pull`
-          puts ''
         end
 
         # Load parameters from JSON for CI or Unit Tests:
@@ -554,6 +613,7 @@ module Fastlane
           self.decrypt_file(properties_encrypt_path, properties_path, key_path, false)
 
           properties = self.load_properties(properties_path)
+          # Pry::ColorPrinter.pp(properties)
           key_password = properties['keyPassword']
           alias_name = properties['aliasName']
           alias_password = properties['aliasPassword']
@@ -561,13 +621,13 @@ module Fastlane
           File.delete(properties_path)
         end
 
-        # Resolve path to the APK to sign:
-        output_signed_apk = ''
-        apk_path = self.resolve_apk_path(apk_path)
-
         # Sign APK:
-        if File.file?(apk_path)
+        if apk_path && File.file?(apk_path)
           UI.message("APK to sign: " + apk_path)
+        
+          # Resolve path to the APK to sign:
+          output_signed_apk = ''
+          apk_path = self.resolve_apk_path(apk_path)
 
           if File.file?(keystore_path)
 
@@ -579,21 +639,49 @@ module Fastlane
               key_password, 
               alias_name, 
               alias_password, 
-              true, # Zip align
+              zip_align, # Zip align
               build_tools_version # Buil-tools version
             )
             puts ''
           end 
-        else
-          UI.message("No APK file found to sign!")
-        end
 
-        # Prepare contect shared values for next lanes:
-        Actions.lane_context[SharedValues::MATCH_KEYSTORE_PATH] = keystore_path
-        Actions.lane_context[SharedValues::MATCH_KEYSTORE_ALIAS_NAME] = alias_name
-        Actions.lane_context[SharedValues::MATCH_KEYSTORE_APK_SIGNED] = output_signed_apk
+          # Prepare contect shared values for next lanes:
+          Actions.lane_context[SharedValues::MATCH_KEYSTORE_PATH] = keystore_path
+          Actions.lane_context[SharedValues::MATCH_KEYSTORE_ALIAS_NAME] = alias_name
+          Actions.lane_context[SharedValues::MATCH_KEYSTORE_APK_SIGNED] = output_signed_apk
+
+          output_signed_apk
+        # Sign AAB
+        elsif aab_path && File.file?(aab_path)
+          UI.message('AAB to sign: '+ aab_path)
+
+          # Resolve path to the AAB to sign:
+          output_signed_aab = ''
+          aab_path = self.resolve_aab_path(aab_path)
+
+          if File.file?(keystore_path)
+
+            UI.message("Signing the AAB...")
+            puts ''
+            output_signed_aab = self.sign_aab(
+              aab_path, 
+              keystore_path, 
+              key_password, 
+              alias_name, 
+              alias_password
+            )
+            puts ''
+          end 
+
+          # Prepare contect shared values for next lanes:
+          Actions.lane_context[SharedValues::MATCH_KEYSTORE_PATH] = keystore_path
+          Actions.lane_context[SharedValues::MATCH_KEYSTORE_ALIAS_NAME] = alias_name
+          Actions.lane_context[SharedValues::MATCH_KEYSTORE_AAB_SIGNED] = output_signed_aab
 
-        output_signed_apk
+          output_signed_aab
+        else
+          UI.message("No APK or AAB file found")
+        end
       end
 
       def self.description
@@ -601,7 +689,7 @@ module Fastlane
       end
 
       def self.authors
-        ["Christopher NEY"]
+        ["Christopher NEY", "Simon Scherzinger"]
       end
 
       def self.return_value
@@ -612,7 +700,8 @@ module Fastlane
         [
           ['MATCH_KEYSTORE_PATH', 'File path of the Keystore fot the App.'],
           ['MATCH_KEYSTORE_ALIAS_NAME', 'Keystore Alias Name.'],
-          ['MATCH_KEYSTORE_APK_SIGNED', 'Path of the signed APK.']
+          ['MATCH_KEYSTORE_APK_SIGNED', 'Path of the signed APK.'],
+          ['MATCH_KEYSTORE_AAB_SIGNED', 'Path of the signed AAB.']
         ]
       end
 
@@ -638,6 +727,11 @@ module Fastlane
                                 description: "Path of the APK file to sign",
                                    optional: true,
                                        type: String),
+          FastlaneCore::ConfigItem.new(key: :aab_path,
+                                   env_name: "MATCH_KEYSTORE_AAB_PATH",
+                                description: "Path of the AAB file to sign",
+                                   optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :match_secret,
                                    env_name: "MATCH_KEYSTORE_SECRET",
                                 description: "Secret to decrypt keystore.properties file (CI)",
@@ -662,17 +756,27 @@ module Fastlane
                                    env_name: "MATCH_KEYSTORE_BUILD_TOOLS_VERSION",
                                 description: "Set built-tools version (by default latest available on machine)",
                                    optional: true,
-                                       type: String),                             
+                                       type: String),      
+          FastlaneCore::ConfigItem.new(key: :zip_align,
+                                   env_name: "MATCH_KEYSTORE_ZIPALIGN",
+                                description: "Define if plugin will run zipalign on APK before sign it (true by default)",
+                                   optional: true,
+                                       type: Boolean),                    
+          FastlaneCore::ConfigItem.new(key: :compat_key,
+                                   env_name: "MATCH_KEYSTORE_COMPAT_KEY",
+                                description: "Define the compatibility key version used on local machine (nil by default)",
+                                   optional: true,
+                                       type: String),
           FastlaneCore::ConfigItem.new(key: :clear_keystore,
                                    env_name: "MATCH_KEYSTORE_CLEAR",
                                 description: "Clear the local keystore (false by default)",
                                    optional: true,
                                        type: Boolean),
           FastlaneCore::ConfigItem.new(key: :unit_test,
-                                  env_name: "MATCH_KEYSTORE_UNIT_TESTS",
+                                   env_name: "MATCH_KEYSTORE_UNIT_TESTS",
                                 description: "launch Unit Tests (false by default)",
-                                  optional: true,
-                                      type: Boolean)
+                                   optional: true,
+                                       type: Boolean)
         ]
       end
 

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

@@ -1,5 +1,5 @@
 module Fastlane
   module MatchKeystore
-    VERSION = "0.1.16"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-match_keystore
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.2.1
 platform: ruby
 authors:
 - Christopher NEY
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: Easily sync your Android keystores across your team