cocoapods-privacy 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94168860cf706b12ecc89c41a75635f23e11f5afcf0b775ebf5f927a16ab6cef
-  data.tar.gz: 8bf3705783a5023c2a6b9066029d9c8e1ec40c596101c0dcf832f5fda70b34de
+  metadata.gz: ba881a65811e8640597663d499127914a78678976913fcb8352e873a1760dbda
+  data.tar.gz: 4fb771e904d423d13f4a188451ace0b4adca4f0683d3d0ce2230c56aa2948fda
 SHA512:
-  metadata.gz: 1bfc8743f267c99b07afb734ef2584cd9c4ffe07960118fe2a4d2f8d82e2783dd86dd88dd716299f63ed3c373f1148d48900a9aeff24d8fef4a24257e99eecfc
-  data.tar.gz: 2b42d00dcb94b13b9bbb35df5979762e65c6ba781d1f3bc16fdf7c80988c5213b96cf7df31c05b3219170f0c16953b9c0f33f8cb7f7e490f765afbf7d6779804
+  metadata.gz: b714abed735826938d267bb5c8a16e28a01ae9a470cebb4725627adc6aeb8ad3b0b078b858cff7c16e3e33c0545e7d2303bb8a6855614bc7c6aacfcfc7cc457d
+  data.tar.gz: d1fc4f2e8ea3846969a6854cab16bf5eaf7468bbb085ab7e2ddcb566b6ac1eb4f320fbc42de60aad392804a9131b6183f5075ad1f35ec6f4acdbf47557a46060

data/README.md

@@ -103,7 +103,13 @@ $ pod privacy install
 ```
 <img width="298" alt="截屏2024-02-02 10 59 59" src="https://github.com/ymoyao/cocoapods-privacy/assets/13619221/c6f10e36-0f62-497a-93d4-f8b336dc8df4">
 
-After command, a PrivacyInfo.xcprivacy will create to you project Resources if empty. and it will search component that configuration files allow and do not have their own privacy manifest file.
+After command, a PrivacyInfo.xcprivacy will create to you project Resources if empty. 
+
+Components that meet all of the following items will be processed.
+* do not have their own privacy manifest file components
+* in white list and not in black list components
+* source code components（binary components please deal with command `pod privacy spec` ）
+
 
 ## Notice
 The plugin is focus on NSPrivacyAccessedAPITypes and automatically search and create workflow.

data/lib/cocoapods-privacy/command/confuse/spec.rb

@@ -0,0 +1,34 @@
+module Pod
+    class Command
+      class Confuse < Command
+        class Spec < Confuse
+            self.summary = '根据 podspec 创建对应混淆文件'
+
+            self.description = <<-DESC
+                根据podspec 创建对应混淆文件，并自动修改podspec文件。
+            DESC
+    
+            self.arguments = [
+                CLAide::Argument.new('podspec_file', false, true),
+            ]
+    
+            def initialize(argv)
+                @podspec_file = argv.arguments!.first
+                super
+            end
+
+            def validate!
+                @podspec_file =  @podspec_file ?  @podspec_file : PrivacyUtils.podspec_file_path
+                unless @podspec_file && !@podspec_file.empty?
+                  raise Informative, 'no podspec file were found, please run pod confuse podspec_file_path'   
+                end
+            end
+    
+            def run
+                ConfuseModule.load_module(@podspec_file)
+            end
+        end
+      end
+    end
+  end
+  

data/lib/cocoapods-privacy/command/install.rb

@@ -1,5 +1,5 @@
 require 'cocoapods-privacy/command'
-
+#### 以下是隐私协议部分 #### 
 module Pod
     class Config
         attr_accessor :privacy_folds
@@ -18,8 +18,8 @@ module Pod
             [
             ['--privacy', '使用该参数，会自动生成并更新PrivacyInfo.xcprivacy'],
             ['--privacy-folds=folds', '指定文件夹检索，多个文件夹使用逗号","分割'],
-            ['--query', '仅查询隐私api，不做写入'],
-            ['--all', '忽略黑名单和白名单限制，查询工程所有组件'],
+            ['--privacy-query', '仅查询隐私api，不做写入'],
+            ['--privacy-all', '忽略黑名单和白名单限制，查询工程所有组件'],
             ].concat(origin_options)
           end
         end
@@ -27,9 +27,9 @@ module Pod
         alias_method :privacy_origin_initialize, :initialize
         def initialize(argv)
           privacy_folds = argv.option('privacy-folds', '').split(',')
+          is_query = argv.flag?('privacy-query',false)
+          is_all = argv.flag?('privacy-all',false)
           is_privacy = argv.flag?('privacy',false)
-          is_query = argv.flag?('query',false)
-          is_all = argv.flag?('all',false)
           privacy_origin_initialize(argv)
           instance = Pod::Config.instance
           instance.privacy_folds = privacy_folds
@@ -39,4 +39,37 @@ module Pod
         end
       end
     end
+end
+
+#### 以下是混淆部分 #### 
+module Pod
+  class Config
+      attr_accessor :confuse_pattern
+  end
+end
+
+module Pod
+  class Command
+    class Install < Command
+      class << self
+        alias_method :confuse_origin_options, :options
+        def options
+          [
+          ['--confuse=enable', '使用该参数，开启工程混淆'],
+          ['--confuse=disable', '使用该参数，移除工程混淆配置'],
+          # ['--confuse-folds=folds', '指定额外文件夹检索，多个文件夹使用逗号","分割'],
+          # ['--confuse-all', '忽略黑名单和白名单限制，查询工程所有组件'],
+          ].concat(origin_options)
+        end
+      end
+
+      alias_method :confuse_origin_initialize, :initialize
+      def initialize(argv)
+        confuse_pattern = argv.option('confuse', '') #混淆模式
+        confuse_origin_initialize(argv)
+        instance = Pod::Config.instance
+        instance.confuse_pattern = confuse_pattern
+      end
+    end
+  end
 end

data/lib/cocoapods-privacy/command/privacy/config.rb

@@ -36,7 +36,7 @@ module Pod
             
             def download_remote_config
               # 配置文件目录
-              cache_config_file = PrivacyUtils.cache_config_file
+              cache_config_file = Common::Config.instance.cache_config_file
 
               # 开始下载
               system("curl -o #{cache_config_file} #{@config}")
@@ -50,7 +50,7 @@ module Pod
             
             def copy_local_config
               # 配置文件目录
-              cache_config_file = PrivacyUtils.cache_config_file
+              cache_config_file = Common::Config.instance.cache_config_file
             
               # 复制本地文件
               FileUtils.cp(@config, cache_config_file)

data/lib/cocoapods-privacy/command.rb

@@ -1,15 +1,30 @@
+### common
+require 'cocoapods-privacy/common/config'
+require 'cocoapods-privacy/common/BBSpec'
+require 'cocoapods-privacy/common/BBSpecManager'
+
+
+### privacy
 require 'cocoapods-privacy/command/privacy'
 require 'cocoapods-privacy/command/privacy/config'
 require 'cocoapods-privacy/command/privacy/install'
 require 'cocoapods-privacy/command/privacy/spec'
 require 'cocoapods-privacy/command/install'
-
 require 'cocoapods-privacy/privacy/privacy_specification_hook'
 require 'cocoapods-privacy/privacy/privacy_installer_hook'
 require 'cocoapods-privacy/privacy/PrivacyUtils'
 require 'cocoapods-privacy/privacy/PrivacyModule'
 require 'cocoapods-privacy/privacy/PrivacyHunter'
-require 'cocoapods-privacy/privacy/PrivacyConfig'
 require 'cocoapods-privacy/privacy/PrivacyLog'
 
+## mix
+require 'cocoapods-privacy/command/confuse/spec'
+require 'cocoapods-privacy/confuse/confuse_installer_hook'
+require 'cocoapods-privacy/confuse/confuse_specification_hook'
+require 'cocoapods-privacy/confuse/ConfuseUtils'
+require 'cocoapods-privacy/confuse/ConfuseModule'
+require 'cocoapods-privacy/confuse/ConfuseHunter'
+require 'cocoapods-privacy/confuse/ObjCMethodAPIConverter'
+require 'cocoapods-privacy/confuse/SwiftCallAssembly'
+
 

data/lib/cocoapods-privacy/common/BBSpec.rb

@@ -0,0 +1,234 @@
+require 'cocoapods-privacy/command'
+
+KSpecTypePrivacy = 'bb_privacy'
+KSpecTypeConfuse = 'bb_confuse' 
+
+
+KSource_Files_Key = 'source_files' #不存在单数 source_file
+KExclude_Files_Key = 'exclude_files' #不存在单数 exclude_file
+KResource_Bundle_Key = 'resource_bundle' #resource_bundle 和 resource_bundles 这两个参数本质上是一样的，resource_bundle 也能指向多个参数
+
+class BBRow
+  attr_accessor  :content, :is_comment, :is_spec_start, :is_spec_end, :key, :value
+
+  def initialize(content, is_comment=false, is_spec_start=false, is_spec_end=false)
+    @content = content
+    @is_comment = is_comment
+    @is_spec_start = is_spec_start
+    @is_spec_end = is_spec_end
+
+    parse_key_value
+  end
+
+  def parse_key_value
+    # 在这里添加提取 key 和 value 的逻辑
+    if @content.include?('=')
+      key_value_split = @content.split('=')
+      @key = key_value_split[0]
+      @value = key_value_split[1..-1].join('=')
+    else
+      @key = nil
+      @value = nil
+    end
+  end
+end
+
+class BBSpec
+  attr_accessor :name, :alias_name, :full_name, :parent, :rows, :sources_files, :exclude_files, :type, :privacy_file, :confuse_file
+
+  def initialize(name,alias_name,full_name,type)
+    @rows = []
+    @name = name
+    @alias_name = alias_name
+    @full_name = full_name
+    @type = type
+    @privacy_file = "Pod/Privacy/#{full_name}/PrivacyInfo.xcprivacy"
+    confuse_file_name = @full_name.tr('.','_')
+    @confuse_file = "Pod/Confuse/#{full_name}/#{confuse_file_name}_Confuse"
+  end
+
+
+  def uniq_full_name_in_parent(name)
+    names = []
+    @rows.each_with_index do |line, index|
+      if line && line.is_a?(BBSpec)  
+        names << line.name
+      end
+    end
+
+    #判断names 中是否包含 name，如果包含，那么给name 添加一个 “.diff” 后缀，一直到names 中没有包含name为止
+    while names.include?(name)
+      name = "#{name}.diff"
+    end
+
+    "#{@full_name}.#{name}"
+  end
+
+  # 单独属性转成spec字符串，方便解析
+  def assemble_single_property_to_complex(property_name)
+    property_name += "s" if property_name == KResource_Bundle_Key #检测到单数resource_bundle,直接转成复数，功能一致
+    property_name
+  end
+
+  def privacy_handle(podspec_file_path)
+    @rows.each_with_index do |line, index|
+      if !line || line.is_a?(BBSpec) || !line.key || line.key.empty? 
+        next
+      end
+       
+      if !line.is_comment && line.key.include?("." + KResource_Bundle_Key)
+        @has_resource_bundle = true
+      elsif !line.is_comment && line.key.include?("." + KSource_Files_Key)
+        @source_files_index = index
+      end
+    end
+    create_file_if_need(podspec_file_path)
+    modify_resource_bundle_if_need(podspec_file_path)
+  end
+
+  # 对应Spec新增隐私文件
+  def create_file_if_need(podspec_file_path)
+    if @source_files_index
+      if is_handle_privacy
+        PrivacyUtils.create_privacy_if_empty(File.join(File.dirname(podspec_file_path), @privacy_file))
+      elsif is_handle_confuse
+        ConfuseUtils.create_confuse_if_empty(File.join(File.dirname(podspec_file_path), "#{@confuse_file}.h"))
+        ConfuseUtils.create_confuse_if_empty(File.join(File.dirname(podspec_file_path), "#{@confuse_file}.swift"))
+      end
+    end
+  end
+
+  def is_handle_privacy
+    @type.include?(KSpecTypePrivacy)
+  end
+
+  def is_handle_confuse
+    @type.include?(KSpecTypeConfuse)
+  end
+
+  # 这里处理所有多行参数的解析，目前处理 source_files\exclude_files\resource_bundle 这三种
+  # 输入格式 ['.source_files':false,'.exclude_files':true......] => true 代表会根据获取的重置属性，需要把多行多余的进行删除
+  # 返回格式 {'.source_files':BBRow,......}
+  def fetch_mul_line_property(propertys_mul_line_hash)
+    property_hash = {}
+    line_processing = nil
+    property_config_processing = nil
+    @rows.each_with_index do |line, index|
+      if !line || line.is_a?(BBSpec) || line.is_comment
+        next
+      end
+
+      property_find = propertys_mul_line_hash.find { |key, _| line.key && line.key.include?(key) } #查找不到返回nil 查到返回数组，key， value 分别在第一和第二个参数
+      if property_find
+        property_config_processing = property_find 
+      end
+
+      if property_config_processing
+        begin
+          property_name = property_config_processing.first
+          is_replace_line = property_config_processing.second
+          if line_processing
+            code = "#{line_processing.value}#{line.content}"
+          else
+            code = "#{line.value}"
+          end
+
+          # 清除 content 和 value, 后面会把所有的content 组装起来，多余的内容要清除，避免重复
+          if is_replace_line
+            line.content = ''
+            line.value = nil
+          end
+
+          property_name_complex = assemble_single_property_to_complex(property_name)
+          spec_str = "Pod::Spec.new do |s|; s.#{property_name_complex} = #{code}; end;"
+          RubyVM::InstructionSequence.compile(spec_str)
+          spec = eval(spec_str)
+          property_value = spec.attributes_hash[property_name_complex]
+        rescue SyntaxError, StandardError => e
+          unless line_processing
+            line_processing = line
+          end
+          line_processing.value = code if line_processing #存储当前残缺的value,和后面完整的进行拼接
+          next
+        end
+
+        final_line = (line_processing ? line_processing : line)
+        final_line.value = property_value
+        property_hash[property_name] = final_line
+        line_processing = nil
+        property_config_processing = nil
+      end
+    end
+
+    property_hash
+  end
+
+  # 处理字符串或者数组，使其全都转为数组，并转成实际文件夹地址
+  def handle_string_or_array_files(podspec_file_path,line)
+    value = line.value
+    array = fetch_string_or_array_files(podspec_file_path,line)
+  
+    files = array.map do |file_path|
+      File.join(File.dirname(podspec_file_path), file_path.strip)
+    end
+    files
+  end
+
+  def fetch_string_or_array_files(podspec_file_path,line)
+    value = line.value
+    if value.is_a?(String) && !value.empty?
+      array = [value]
+    elsif value.is_a?(Array)
+      array = value
+    else
+      array = []
+    end
+    array
+  end
+
+  # 把新增的隐私文件 映射给 podspec  && 解析 sources_files && 解析 exclude_files
+  def modify_resource_bundle_if_need(podspec_file_path)
+    if @source_files_index
+
+      # 这里处理所有多行参数的解析，目前处理 source_files\exclude_files\resource_bundle 这三种
+      propertys_mul_line_hash = {}
+      propertys_mul_line_hash[KSource_Files_Key] = false
+      propertys_mul_line_hash[KExclude_Files_Key] = false
+      propertys_mul_line_hash[KResource_Bundle_Key] = false 
+
+      property_value_hash = fetch_mul_line_property(propertys_mul_line_hash)
+      property_value_hash.each do |property, line|
+        if property == KSource_Files_Key                 #处理 source_files
+          @sources_files = handle_string_or_array_files(podspec_file_path,line)
+          # puts "originSource = #{sources_files}"
+          if is_handle_confuse
+            source_array = fetch_string_or_array_files(podspec_file_path,line)
+            source_array.push("#{@confuse_file}.{h,swift}")
+            line.value = source_array.uniq
+            line.content = "#{line.key}= #{line.value}"
+          end
+        elsif property == KExclude_Files_Key             #处理 exclude_files
+          @exclude_files = handle_string_or_array_files(podspec_file_path,line)
+        elsif property == KResource_Bundle_Key           #处理 原有resource_bundle 合并隐私清单文件映射
+          # 仅在隐私清单时才去解析 resource_bundle
+          privacy_resource_bundle = { "#{full_name}.privacy" => @privacy_file }
+          if is_handle_privacy
+            if @has_resource_bundle
+              merged_resource_bundle = line.value.merge(privacy_resource_bundle)
+              @resource_bundle = merged_resource_bundle
+              line.value = merged_resource_bundle
+              line.content = "#{line.key}= #{line.value}"
+            else # 如果原先没有resource_bundle，需要单独加一行resource_bundle
+              space = PrivacyUtils.count_spaces_before_first_character(rows[@source_files_index].content)
+              line = "#{alias_name}.resource_bundle = #{privacy_resource_bundle}"
+              line = PrivacyUtils.add_spaces_to_string(line,space)
+              row = BBRow.new(line)
+              @rows.insert(@source_files_index+1, row)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/cocoapods-privacy/common/BBSpecManager.rb

@@ -0,0 +1,166 @@
+require 'cocoapods-privacy/command'
+
+module BB
+    class BBSpecManager
+        def initialize(type)
+            @type = type
+        end
+
+
+        def check(podspec_file_path)
+            # Step 1: 读取podspec
+            lines = read_podspec(podspec_file_path)
+            
+            # Step 2: 逐行解析并转位BBRow 模型
+            rows = parse_row(lines)
+
+            # Step 3.1:如果Row 是属于Spec 内，那么聚拢成BBSpec，
+            # Step 3.2:BBSpec 内使用数组存储其Spec 内的行
+            # Step 3.3 在合适位置给每个有效的spec都创建一个 隐私模版，并修改其podspec 引用
+            combin_sepcs_and_rows = combin_sepc_if_need(rows,podspec_file_path)
+
+            # Step 4: 展开修改后的Spec,重新转换成 BBRow
+            rows = unfold_sepc_if_need(combin_sepcs_and_rows)
+
+            # Step 5: 打开隐私模版，并修改其podspec文件，并逐行写入
+            File.open(podspec_file_path, 'w') do |file|
+            # 逐行写入 rows
+            rows.each do |row|
+                file.puts(row.content)
+            end
+            end
+
+        
+            # Step 6: 获取privacy 相关信息，传递给后续处理
+            hash = fetch_hash(combin_sepcs_and_rows,podspec_file_path).compact
+            filtered_hash = hash.reject { |_, value| value.empty? }
+            filtered_hash
+        end
+
+
+        def read_podspec(file_path)
+            # puts "read_podspec = #{file_path}"
+            File.readlines(file_path)
+        end
+        
+        def parse_row(lines)
+            rows = []  
+            code_stack = [] #栈，用来排除if end 等对spec 的干扰
+        
+            lines.each do |line|
+            content = line.strip
+            is_comment = content.start_with?('#')
+            is_spec_start = !is_comment && (content.include?('Pod::Spec.new') || content.include?('.subspec'))
+            is_if = !is_comment && content.start_with?('if')  
+            is_end = !is_comment && content.start_with?('end')
+        
+            # 排除if end 对spec_end 的干扰
+            code_stack.push('spec') if is_spec_start 
+            code_stack.push('if') if is_if 
+            stack_last = code_stack.last 
+            is_spec_end = is_end && stack_last && stack_last == 'spec'
+            is_if_end = is_end && stack_last && stack_last == 'if'
+            code_stack.pop if is_spec_end || is_if_end
+        
+            row = BBRow.new(line, is_comment, is_spec_start, is_spec_end)
+            rows << row
+            end
+            rows
+        end
+        
+        # 数据格式：
+        # [
+        #   BBRow
+        #   BBRow
+        #   BBSpec
+        #     rows
+        #         [
+        #            BBRow
+        #            BBSpec 
+        #            BBRow
+        #            BBRow
+        #         ] 
+        #   BBRow
+        #   ......  
+        # ]
+        # 合并Row -> Spec（会存在部分行不在Spec中：Spec new 之前的注释）
+        def combin_sepc_if_need(rows,podspec_file_path) 
+            spec_stack = []
+            result_rows = []
+            default_name = File.basename(podspec_file_path, File.extname(podspec_file_path))
+        
+            rows.each do |row|
+            if row.is_spec_start 
+                # 获取父spec
+                parent_spec = spec_stack.last 
+        
+                # 创建 spec
+                name = row.content.split("'")[1]&.strip || default_name
+                alias_name = row.content.split("|")[1]&.strip
+                full_name = parent_spec ? parent_spec.uniq_full_name_in_parent(name) : name
+        
+                spec = BBSpec.new(name,alias_name,full_name,@type)
+                spec.rows << row
+                spec.parent = parent_spec
+        
+                # 当存在 spec 时，存储在 spec.rows 中；不存在时，直接存储在外层
+                (parent_spec ? parent_spec.rows : result_rows ) << spec
+        
+                # spec 入栈
+                spec_stack.push(spec)
+            elsif row.is_spec_end
+                # 当前 spec 的 rows 加入当前行
+                spec_stack.last&.rows << row
+        
+                #执行隐私协议修改
+                spec_stack.last.privacy_handle(podspec_file_path)
+        
+                # spec 出栈
+                spec_stack.pop
+            else
+                # 当存在 spec 时，存储在 spec.rows 中；不存在时，直接存储在外层
+                (spec_stack.empty? ? result_rows : spec_stack.last.rows) << row
+            end
+            end
+        
+            result_rows
+        end
+        
+        # 把所有的spec中的rows 全部展开，拼接成一级数组【BBRow】
+        def unfold_sepc_if_need(rows)
+            result_rows = []
+            rows.each do |row|
+            if row.is_a?(BBSpec) 
+                result_rows += unfold_sepc_if_need(row.rows)
+            else
+                result_rows << row
+            end
+            end
+            result_rows
+        end
+        
+        
+        def fetch_hash(rows,podspec_file_path)
+            hash = {}
+            specs = rows.select { |row| row.is_a?(BBSpec) }
+            specs.each do |spec|
+                value = spec.sources_files ? {KSource_Files_Key => spec.sources_files,KExclude_Files_Key => spec.exclude_files || []} : {}
+                if is_handle_privacy
+                    hash[File.join(File.dirname(podspec_file_path),spec.privacy_file)] = value
+                elsif is_handle_confuse
+                    hash[File.join(File.dirname(podspec_file_path),spec.confuse_file)] = value
+                end
+                hash.merge!(fetch_hash(spec.rows,podspec_file_path))
+            end
+            hash
+        end
+
+        def is_handle_privacy
+            @type.include?(KSpecTypePrivacy)
+          end
+        
+        def is_handle_confuse
+            @type.include?(KSpecTypeConfuse)
+        end
+    end
+end

data/lib/cocoapods-privacy/common/config.rb

@@ -0,0 +1,69 @@
+require 'cocoapods-privacy/command'
+require 'digest'
+
+module Common
+    class Config        
+        def initialize()
+            load_config_content_if_exist()
+        end
+        
+        def api_template_url
+            load_config_content_if_exist()
+            return @json['api.template.url'] || ""
+        end
+
+        def source_black_list
+            load_config_content_if_exist()
+            return @json['source.black.list'] || []
+        end
+
+        def source_white_list
+            load_config_content_if_exist()
+            return @json['source.white.list'] || []
+        end
+
+        def self.instance
+            @instance ||= new
+        end
+
+        def cache_privacy_fold
+            # 本地缓存目录
+            cache_directory = File.expand_path('~/.cache')
+            
+            # 目标文件夹路径
+            target_directory = File.join(cache_directory, 'cocoapods-privacy', 'privacy')
+        
+            # 如果文件夹不存在，则创建
+            FileUtils.mkdir_p(target_directory) unless Dir.exist?(target_directory)
+        
+            target_directory
+        end
+    
+        # etag 文件夹
+        def cache_privacy_etag_fold
+            File.join(cache_privacy_fold,'etag')
+        end
+        
+        # config.json 文件
+        def cache_config_file
+            File.join(cache_privacy_fold, 'config.json')
+        end
+    
+        # config.json 文件
+        def cache_log_file
+             File.join(cache_privacy_fold, 'privacy.log')
+        end
+
+        private
+        def load_config_content_if_exist
+            unless @json 
+                if File.exist?(cache_config_file)
+                    config_content = File.read(cache_config_file)
+                    @json = JSON.parse(config_content)
+                end
+            end
+        end
+              
+      
+    end
+end