app_permission_statistics 0.1.1

data/lib/app_permission_statistics/extracter.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require_relative "mobile_provision"
+require_relative "info_plist"
+require_relative "entitlements"
+require_relative "helper"
+
+require 'fileutils'
+require 'forwardable'
+
+module AppPermissionStatistics
+
+    class Extracter 
+        include Helper::Archive
+        include Helper::Sigflat
+        include Helper::Utils
+        extend Forwardable
+        attr_reader :file
+        attr_reader :store_path
+
+        def initialize(file, store_path = nil)
+            @file = file
+            @store_path = store_path
+        end
+
+        def extract_update            
+            capabilities_summary = Hash.new
+            capabilities = extract_capabilities_info
+            capabilities.each do |key,value|
+                capabilities_summary[key] = createsig(value)
+            end
+    
+            usage_desc_summary = Hash.new
+            usage_desc = plistInfo.permis_usagedescription
+            usage_desc.each do |key,value|
+                usage_desc_summary[key] = createsig(value)
+            end
+    
+            yaml_content = {
+                'Capabilities_Summary' => capabilities_summary,
+                'Capabilities' => capabilities,
+                'PermissionsUsageDescription_Summary' => usage_desc_summary,
+                'PermissionsUsageDescription' => usage_desc
+            }
+            yaml_name = entitlements_yaml_name(plistInfo.version, plistInfo.identifier, path: @store_path)
+        
+            File.open(yaml_name, "w") { |file| file.write(yaml_content.to_yaml) }
+            update_versions
+            yaml_content
+        end
+    
+    
+        def update_versions
+            yaml_name = versions_yaml_name(plistInfo.identifier, path: @store_path)
+            yaml_content = [ ]
+            if File.exist?(yaml_name) 
+                yaml_content = YAML.load_file(yaml_name)
+            end
+            version = plistInfo.version
+            if !yaml_content.include?(version)
+                yaml_content.unshift(version)
+                File.open(yaml_name, "w") { |file| file.write(yaml_content.to_yaml) }  
+            end
+        end
+    
+        def extract_capabilities_info 
+            capabilities_info = {}
+            capabilities_info["In-App Purchase"] = true
+            capabilities_info = capabilities_info.merge(entitlementsInfo.enabled_capabilities)
+            capabilities_info = capabilities_info.merge(plistInfo.backgroundModes)
+            capabilities_info = capabilities_info.merge(plistInfo.enabled_capabilities)
+            capabilities_info
+        end
+    
+        def mobileprovision
+            return unless mobileprovision?
+            return @mobileprovision if @mobileprovision
+            @mobileprovision = MobileProvision.new(mobileprovision_path)
+        end
+    
+        def plistInfo
+            @plistInfo ||= InfoPlist.new(info_path)
+        end
+    
+        def entitlementsInfo
+            @entitlementsInfo ||= EntitlementsPlist.new(entitlements_path)
+        end
+    
+    
+        def mobileprovision?
+            File.exist?(mobileprovision_path)
+        end
+    
+        def mobileprovision_path
+            filename = 'embedded.mobileprovision'
+            @mobileprovision_path ||= File.join(@file, filename)
+            unless File.exist?(@mobileprovision_path)
+                @mobileprovision_path = File.join(app_path, filename)
+            end
+        
+            @mobileprovision_path
+        end
+    
+    
+        def contents
+            @contents ||= unarchive(@file, path: 'ios')
+        end
+    
+        def info_path
+            @info_path ||= File.join(app_path, 'Info.plist')
+        end
+
+        def entitlements_path
+            @entitlements_path ||= File.join(app_path, 'Runner.entitlements')
+        end
+
+        def app_path
+            @app_path ||= Dir.glob(File.join(contents, 'Payload', '*.app')).first
+        end
+
+        def clear!
+            return unless @contents
+        
+            FileUtils.rm_rf(@contents)
+        
+            @contents = nil
+            @app_path = nil
+            @info_path = nil
+            @info = nil
+            @pre_version = nil
+        end      
+
+    end
+
+end

data/lib/app_permission_statistics/helper.rb

@@ -0,0 +1,90 @@
+require 'tmpdir'
+require 'crimp'
+
+module AppPermissionStatistics
+
+    module Helper
+
+        module Sigflat
+            def createsig(body)
+                return Crimp.signature(body)
+            end
+        end
+
+        module Utils
+
+            def defalut_store_path(app_identifier)
+                root_path = "#{Dir.home}/appInfo-#{app_identifier}"
+                FileUtils.mkdir_p(root_path) unless File.exists?(root_path)
+                root_path
+            end
+
+            def entitlements_yaml_name(v,app_identifier,path: nil)
+                dir_path = path ? "#{path}-#{app_identifier}" : defalut_store_path(app_identifier)
+                yaml_name = "#{dir_path}/entitlements_#{v}.yml";
+                yaml_name
+            end
+
+            def versions_yaml_name(app_identifier,path: nil)
+                dir_path = path ? "#{path}-#{app_identifier}"  : defalut_store_path(app_identifier)
+                yaml_name = "#{dir_path}/entitlements_versions.yml";
+                yaml_name
+            end
+
+            def report_file_name(path: nil)
+                path = path ? "#{path}/entitlements" : nil
+                if !path.nil?
+                    FileUtils.mkdir_p(path) unless File.exists?(path)
+                end
+                file_name = path ? "#{path}/analyze_report" : "analyze_report";
+                file_name
+            end
+
+        end
+
+        module Archive
+            require 'fileutils'
+            require 'securerandom'
+            require 'zip'
+
+            # Unarchive zip file
+            #
+            # source: https://github.com/soffes/lagunitas/blob/master/lib/lagunitas/ipa.rb
+            def unarchive(file, path: nil)
+                path = path ? "#{path}-" : ''
+                root_path = "#{Dir.mktmpdir}/AppInfo-#{path}#{SecureRandom.hex}"
+                # puts root_path
+                Zip::File.open(file) do |zip_file|
+                    if block_given?
+                        yield root_path, zip_file
+                    else
+                        zip_file.each do |f|
+                            f_path = File.join(root_path, f.name)
+                            FileUtils.mkdir_p(File.dirname(f_path))
+                            zip_file.extract(f, f_path) unless File.exist?(f_path)
+                        end
+                    end
+                end
+    
+                root_path
+            end
+
+    
+            def tempdir(file, prefix:, system: false)
+                dest_path = if system
+                                Dir.mktmpdir("appinfo-#{prefix}-#{File.basename(file, '.*')}-", '/tmp')
+                            else
+                                File.join(File.dirname(file), prefix)
+                            end
+    
+                dest_file = File.join(dest_path, File.basename(file))
+                FileUtils.mkdir_p(dest_path, mode: 0_700) unless system
+                dest_file
+            end
+            
+        end
+    
+    
+    end
+
+end

data/lib/app_permission_statistics/info_plist.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'cfpropertylist'
+
+module AppPermissionStatistics
+    
+    # Apple Device Type
+    module Device
+        MACOS = 'macOS'
+        IPHONE = 'iPhone'
+        IPAD = 'iPad'
+        UNIVERSAL = 'Universal'
+    end
+
+    # iOS Info.plist parser
+    class InfoPlist
+        extend Forwardable
+
+        def initialize(file)
+            @file = file
+        end
+
+        #
+        # Extract the permissions UsageDescription from the Info.plist
+        # https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html
+        #
+        def permis_usagedescription
+            desc = Hash.new
+            info.each do |key, value|
+                if key.include?("UsageDescription")
+                    desc[key] = value
+                end 
+            end
+            desc
+        end
+
+        def backgroundModes
+            value = info.try(:[], 'UIBackgroundModes')
+            if !value.nil? 
+                return   {
+                    "BackgroundModes" => {
+                        "UIBackgroundModes" => value
+                    }
+                }                
+            end
+        end
+
+        # 
+        # Extract the capabilities from the Info.plist
+        # https://mercury.tencent.com/introduction/show?item=ios
+        # 
+        def enabled_capabilities 
+            capabilities = Hash.new
+            info.each do |key, value|
+                case key
+                when 'UIRequiredDeviceCapabilities' 
+                    capabilities['RequiredDeviceCapabilities']  = {
+                        key => value
+                    }
+                when 'UIFileSharingEnabled' 
+                    capabilities['FileSharingEnabled' ] = {
+                        key => value
+                    }
+                when 'CADisableMinimumFrameDurationOnPhone' 
+                    capabilities['DisableMinimumFrameDurationOnPhone'] = {
+                        key => value
+                    }
+                when 'GCSupportedGameControllers' 
+                    capabilities['GameControllers'] = {
+                        key => value
+                    }
+                when 'GCSupportsControllerUserInteraction' 
+                    capabilities['SupportsControllerUserInteraction' ] = {
+                        key => value
+                    }
+                when 'MKDirectionsApplicationSupportedModes' 
+                    capabilities['Maps'] = {
+                        key => value
+                    }
+                when 'NSAppTransportSecurity' 
+                    capabilities['AppTransportSecurity'] = {
+                        key => value
+                    }
+                when 'CFBundleDocumentTypes' 
+                    capabilities['BundleDocumentTypes'] = {
+                        key => value
+                    }
+                end 
+            end   
+            capabilities         
+        end
+
+
+        def device_type
+            device_family = info.try(:[], 'UIDeviceFamily')
+            if device_family == [1]
+                Device::IPHONE
+            elsif device_family == [2]
+                Device::IPAD
+            elsif device_family == [1, 2]
+                Device::UNIVERSAL
+            elsif !info.try(:[], 'DTSDKName').nil? || !info.try(:[], 'DTPlatformName').nil?
+                Device::MACOS
+            end
+        end
+
+        def version
+            release_version || build_version
+        end
+
+        def build_version
+            info.try(:[], 'CFBundleVersion')
+        end
+
+        def release_version
+            info.try(:[], 'CFBundleShortVersionString')
+        end
+
+        def identifier
+            info.try(:[], 'CFBundleIdentifier')
+        end
+        alias bundle_id identifier
+
+        def name
+            display_name || bundle_name
+        end
+
+        def display_name
+            info.try(:[], 'CFBundleDisplayName')
+        end
+
+        def bundle_name
+            info.try(:[], 'CFBundleName')
+        end
+
+        def min_os_version
+            min_sdk_version || min_system_version
+        end
+
+        #
+        # Extract the Minimum OS Version from the Info.plist (iOS Only)
+        #
+        def min_sdk_version
+            info.try(:[], 'MinimumOSVersion')
+        end
+
+        #
+        # Extract the Minimum OS Version from the Info.plist (macOS Only)
+        #
+        def min_system_version
+            info.try(:[], 'LSMinimumSystemVersion')
+        end
+
+        def iphone?
+            device_type == Device::IPHONE
+        end
+
+        def ipad?
+            device_type == Device::IPAD
+        end
+
+        def universal?
+            device_type == Device::UNIVERSAL
+        end
+
+        def macos?
+            device_type == Device::MACOS
+        end
+
+        def device_family
+            info.try(:[], 'UIDeviceFamily') || []
+        end
+
+        def [](key)
+            info.try(:[], key.to_s)
+        end
+
+        def_delegators :info, :to_h
+
+        def method_missing(method_name, *args, &block)
+            info.try(:[], method_name.to_s.ai_camelcase) ||
+                info.send(method_name) ||
+                super
+        end
+
+        def respond_to_missing?(method_name, *args)
+            info.key?(method_name.to_s.ai_camelcase) ||
+                info.respond_to?(method_name) ||
+                super
+        end
+
+        private
+
+        def info
+            return unless File.file?(@file)
+
+            @info ||= CFPropertyList.native_types(CFPropertyList::List.new(file: @file).value)
+        end
+
+    end
+end