fastlane-plugin-sous 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4106c4a2457aa6d1e78a2e35a064ff34a199e6d0a335cec2f5d5254a720d5c8
+  data.tar.gz: 72db785a94ea3068d9edf1a1530c03c001a1cc48fceba149b170ea949662bb14
+SHA512:
+  metadata.gz: b14bba76e1f8b10c6340c005eb881fe7ccbd2e1c06f947a1d8eb241f8386b5e55a6f7392b7571db84f35be44b45fb0692ec75bd6914f8b9e4b71688338f69f11
+  data.tar.gz: 579cd49a419e3841ff703db51c71931cf2943506a190447143a226a4c4fad02c6d5c61c1dc50bcda5acddfd1a946a4ff60565e3e21eca5b9f42ec3dfa81f422a

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jonathan Nogueira <jontnog@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# sous plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-sous)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-sous`, add it to your project by running:
+
+```bash
+fastlane add_plugin sous
+```
+
+## About sous
+
+A tool to help create and sync keystores, as well as sign apks and aabs for the play store
+
+## How to use
+
+Use `prep` to create a keystore and send it to a git repository for `pass` to use.
+
+Use `pass` to pull and decrypt existing keystores from a repository.
+
+Use `plate` to sign an APK, can also align the apk.
+
+## 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`. (Warning- this is a work in progress and the fastfile will not execute yet)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/sous.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/sous/version'
+
+module Fastlane
+  module Sous
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Sous.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/sous/actions/pass_action.rb

@@ -0,0 +1,241 @@
+## Based strongly on the work done at https://github.com/christopherney/fastlane-plugin-match_keystore/blob/master/lib/fastlane/plugin/match_keystore/actions/match_keystore_action.rb
+
+require 'digest'
+require 'openssl'
+require 'git'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      KEYSTORE_PATH = :KEYSTORE_PATH
+    end
+
+    class PassAction < Action
+      def self.run(params)
+        # input params:
+        git_url = params[:git_url]
+        git_branch = params[:git_branch]
+        package_name = params[:package_name]
+        existing_keystore = params[:existing_keystore]
+        match_secret = params[:match_secret]
+        keystore_data = params[:keystore_data]
+
+        # constants:
+        keystore_name = package_name + ".jks"
+        keystore_encrypt_name = package_name + ".jks.enc"
+
+        # Check Android Home Env:
+        android_home = Helper::SousHelper.get_android_home
+        if android_home.to_s.strip.empty?
+          raise "The Android SDK is not installed or the environment variable ANDROID_HOME is not defined "
+        else
+          UI.message("Android SDK: #{android_home}")
+        end
+
+        # Check OpenSSL:
+        self.check_openssl_version
+
+        # Init working local directory:
+        dir_name = File.join(File.absolute_path(ENV['HOME']), '.sous')
+        unless File.directory?(dir_name)
+          UI.message("Creating '.sous' working directory...")
+          FileUtils.mkdir_p(dir_name)
+        end
+
+        # Init 'security password' for AES encryption:
+        key_name = "#{self.to_md5(git_url)}.hex"
+        key_path = File.join(dir_name, key_name)
+        unless File.file?(key_path)
+          security_password = self.prompt(text: "Security password: ", secure_text: true, ci_input: match_secret)
+          if security_password.to_s.strip.empty?
+            raise "Security password is not defined! Please use 'match_secret' parameter"
+          end
+          UI.message "Generating security key '#{key_name}'..."
+          self.gen_key(key_path, security_password)
+        end
+
+        # check if password is well initialized
+        tmpkey = self.get_file_content(key_path).strip
+        if tmpkey.length == 128
+          UI.message "Security key '#{key_name}' initialized"
+        else
+          raise "The security key '#{key_name}' is malformed, or not initialized!"
+        end
+
+        # create repo directory to sync remote keystores
+        repo_dir = File.join(dir_name, self.to_md5(git_url))
+        unless File.directory?(repo_dir)
+          UI.message("Creating Keystore directory...")
+          UI.message("Directory: #{repo_dir}")
+          FileUtils.mkdir_p(repo_dir)
+        end
+
+        # cloning/pulling git remote repo
+        gitDir = File.join(repo_dir, '/.git')
+        if !File.directory?(gitDir)
+          UI.message("Cloning remote Keystores repository...")
+          self.git_clone(git_url, git_branch, self.to_md5(git_url), dir_name)
+        else
+          UI.message("Pulling remote Keystores repository...#{git_branch}")
+          self.git_pull(repo_dir, git_branch)
+        end
+
+        # create sub-directory for android app
+        if package_name.to_s.strip.empty?
+          raise "Package name is not defined!"
+        end
+        keystoreAppDir = File.join(repo_dir, "android")
+        keystore_path = File.join(keystoreAppDir, keystore_name)
+        keystore_encrypt_path = File.join(keystoreAppDir, keystore_encrypt_name)
+
+        unless File.file?(keystore_encrypt_path)
+          raise "Cannot find encrypted keystore at path: #{keystore_encrypt_path}. Please make sure you have run `prep` at least once and that the keystore is uploaded to your store."
+        else
+          self.decrypt_file(keystore_encrypt_path, keystore_path, key_path)
+        end
+
+        Actions.lane_context[SharedValues::KEYSTORE_PATH] = keystore_path
+
+        keystore_path        
+        
+      end
+
+      def self.git_clone(git_url, git_branch, repo_name, repo_dir)
+        Git.clone(git_url, repo_name, :path => repo_dir, :branch => git_branch)
+      end
+
+      def self.git_pull(repo_dir, git_branch)
+        g = Git.open(repo_dir)
+        g.fetch
+        g.checkout("origin/" + git_branch, :force => true)
+        g.pull("origin", git_branch)
+      end 
+
+      def self.to_md5(value)
+        hash_value = Digest::MD5.hexdigest value
+        hash_value
+      end
+
+      def self.check_openssl_version
+        output = `openssl version`
+        if !output.start_with?("OpenSSL")
+          raise "Please install OpenSSL at least version 1.1.1 https://www.openssl.org/"
+        end
+        UI.message("OpenSSL v
+          ersion: " + output.strip)
+      end
+
+      def self.prompt(params)
+        if params[:value].to_s.empty?
+          return_value = other_action.prompt(text: params[:text], secure_text: params[:secure_text], ci_input: params[:ci_input])
+        else
+          return_value = params[:value]
+        end
+        return_value
+      end
+
+      def self.get_file_content(file_path)
+        data = File.read(file_path)
+        data
+      end
+
+      def self.decrypt_file(encrypt_file, clear_file, key_path)
+        if File.exist?(clear_file)
+          File.delete(clear_file)
+        end
+        # TODO: Change this to use the actual openssl library instead of a shell command
+        sh("openssl enc -d -aes-256-cbc -pbkdf2 -in \"#{encrypt_file}\" -out \"#{clear_file}\" -pass file:\"#{key_path}\"")
+      end
+
+      def self.gen_key(key_path, password)
+        if File.exist?(key_path)
+          File.delete(key_path)
+        end
+        digest = Digest::SHA512.hexdigest(password)
+        File.open(key_path, "w") do |f|
+          f << digest
+        end
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :git_url,
+                                       env_name: "SOUS_GIT_URL",
+                                       description: "URL to the git repo containing the android secrets",
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                          UI.user_error!("No Android Secrets Git Url given, pass using `git_url: 'url_location'`") unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :git_branch,
+                                       env_name: "SOUS_GIT_BRANCH",
+                                       description: "Specific git branch to use",
+                                       is_string: true,
+                                       default_value: "master"),
+          FastlaneCore::ConfigItem.new(key: :match_secret,
+                                       env_name: "SOUS_MATCH_PASSWORD",
+                                       description: "Passphrase used to encrypt secrets",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :package_name,
+                                       env_name: "SOUS_PACKAGE_NAME",
+                                       description: "The package name of the App",
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                          UI.user_error!("No Android Package Name given, pass using `package_name: 'package_name'`") unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :existing_keystore,
+                                       env_name: "SOUS_KEYSTORE",
+                                       description: "Path of an existing Keystore",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :keystore_data,
+                                       env_name: "SOUS_JSON_PATH",
+                                       description: "Required data to import an existing keystore, or create a new one",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :key_password,
+                                       env_name: "SOUS_KEY_PASSWORD",
+                                       description: "Keystore Password",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :alias_name,
+                                       env_name: "SOUS_ALIAS_NAME",
+                                       description: "Keystore Alias name",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :alias_password,
+                                       env_name: "SOUS_ALIAS_PASSWORD",
+                                       description: "Keystore Alias password",
+                                       is_string: true,
+                                       optional: true)
+        ]
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "This action retrieves existing keystores for the android build system"
+      end
+
+      def self.details
+        "You can use this action to pull the upload and signing keystores for android."
+      end
+
+      def self.output
+        [
+          ['KEYSTORE_PATH', 'The path to the synced keystore file']
+        ]
+      end
+
+      def self.authors
+        ["Jonathan Nogueira"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/sous/actions/plate_action.rb

@@ -0,0 +1,144 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      SIGNED_APK_PATH = :SIGNED_APK_PATH
+    end
+
+    class PlateAction < Action
+      def self.run(params)
+        apk_path = params[:apk_path]
+        keystore_path = params[:keystore_path]
+        key_password = params[:key_password]
+        alias_name = params[:alias_name]
+        alias_password = params[:alias_password]
+        zip_align = params[:zip_align]
+
+        UI.message "Signing APK #{apk_path}..."
+        apk_path = self.sign_apk(
+          apk_path: apk_path,
+          keystore_path: keystore_path,
+          key_password: key_password,
+          alias_name: alias_name,
+          alias_password: alias_password,
+          zip_align: zip_align)
+
+        Actions.lane_context[SharedValues::KEYSTORE_PATH] = apk_path
+
+        apk_path
+      end
+
+      def self.sign_apk(apk_path:, keystore_path:, key_password:, alias_name:, alias_password:, zip_align:)
+
+        build_tools_path = self.get_build_tools()
+
+        # https://developer.android.com/studio/command-line/zipalign
+        if zip_align == true
+          apk_path_aligned = apk_path.gsub(".apk", "-aligned.apk")
+          if File.exist?(apk_path_aligned)
+            File.delete(apk_path_aligned)
+          end
+          sh("#{build_tools_path}zipalign 4 \"#{apk_path}\" \"#{apk_path_aligned}\"")
+        else
+          apk_path_aligned = apk_path
+        end
+        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
+        if File.exist?(apk_path_signed)
+          File.delete(apk_path_signed)
+        end
+        sh("#{build_tools_path}apksigner sign --ks \"#{keystore_path}\" --ks-pass pass:\"#{key_password}\" --v1-signing-enabled true --v2-signing-enabled true --out \"#{apk_path_signed}\" \"#{apk_path_aligned}\"")
+        
+        sh("#{build_tools_path}apksigner verify \"#{apk_path_signed}\"")
+        if File.exist?(apk_path_aligned)
+          File.delete(apk_path_aligned)
+        end
+
+        apk_path_signed
+      end
+
+      def self.get_build_tools
+        android_home = Helper::SousHelper.get_android_home
+        build_tools_root = File.join(android_home, '/build-tools')
+
+        sub_dirs = Dir.glob(File.join(build_tools_root, '*', ''))
+        build_tools_last_version = ''
+        for sub_dir in sub_dirs
+          build_tools_last_version = sub_dir
+        end
+
+        build_tools_last_version
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :apk_path,
+                                       env_name: "SOUS_APK_PATH",
+                                       description: "Path to the APK File",
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                          UI.user_error!("No APK Path given, pass using `apk_path: 'path to apk'`") unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :keystore_path,
+                                       env_name: "SOUS_KEYSTORE_PATH",
+                                       description: "Path to the Keystore file to sign APKs",
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                          UI.user_error!("Keystore path is not present, pass using `keystore_path: 'path to keystore'`") unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :key_password,
+                                       env_name: "SOUS_KEY_PASSWORD",
+                                       description: "Signing Keystore password",
+                                       is_string: true,
+                                       verify_block: proc do |value|
+                                          UI.user_error!("No Keystore password given, pass using `key_password: 'password'`") unless (value and not value.empty?)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :alias_name,
+                                       env_name: "SOUS_ALIAS_NAME",
+                                       description: "Keystore Alias name",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :alias_password,
+                                       env_name: "SOUS_ALIAS_PASSWORD",
+                                       description: "URL to the git repo containing the android secrets",
+                                       is_string: true,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :zip_align,
+                                       env_name: "SOUS_ZIP_ALIGN",
+                                       description: "Whether to specifically zip align the apk before signing",
+                                       is_string: false,
+                                       optional: true,
+                                       default_value: false)
+        ]
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "This action signs apks using an existing keystore"
+      end
+
+      def self.details
+        "You can use this action to sign APKs"
+      end
+
+      def self.output
+        [
+          ['SIGNED_APK_PATH', 'The path to the signed apk file']
+        ]
+      end
+
+      def self.authors
+        ["Jonathan Nogueira"]
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/sous/helper/sous_helper.rb

@@ -0,0 +1,15 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class SousHelper
+      
+      def self.get_android_home
+        android_home = File.absolute_path(ENV["ANDROID_HOME"])
+        android_home
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Sous
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-sous
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Nogueira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.156.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.156.1
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/sous.rb
+- lib/fastlane/plugin/sous/actions/pass_action.rb
+- lib/fastlane/plugin/sous/actions/plate_action.rb
+- lib/fastlane/plugin/sous/helper/sous_helper.rb
+- lib/fastlane/plugin/sous/version.rb
+homepage: https://github.com/LuminousPath/fastlane-plugin-sous
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A tool to help create and sync keystores, as well as sign apks and aabs for
+  the play store
+test_files: []