|
| 1 | +# Copyright (c) Meta Platforms, Inc. and affiliates. |
| 2 | +# |
| 3 | +# This source code is licensed under the MIT license found in the |
| 4 | +# LICENSE file in the root directory of this source tree. |
| 5 | + |
| 6 | +module PrivacyManifestUtils |
| 7 | + def self.add_aggregated_privacy_manifest(installer) |
| 8 | + user_project = get_user_project_from(installer) |
| 9 | + targets = get_application_targets(user_project) |
| 10 | + file_path = get_privacyinfo_file_path(user_project) |
| 11 | + |
| 12 | + privacy_info = read_privacyinfo_file(file_path) || { |
| 13 | + "NSPrivacyCollectedDataTypes" => [], |
| 14 | + "NSPrivacyTracking" => false |
| 15 | + } |
| 16 | + |
| 17 | + # Get all required reason APIs defined in current pods |
| 18 | + required_reason_apis = get_used_required_reason_apis(installer) |
| 19 | + |
| 20 | + # Add the Required Reason APIs from React Native core |
| 21 | + get_core_accessed_apis.each do |accessed_api| |
| 22 | + api_type = accessed_api["NSPrivacyAccessedAPIType"] |
| 23 | + reasons = accessed_api["NSPrivacyAccessedAPITypeReasons"] |
| 24 | + required_reason_apis[api_type] ||= [] |
| 25 | + required_reason_apis[api_type] += reasons |
| 26 | + end |
| 27 | + |
| 28 | + # Merge the Required Reason APIs from pods with the ones from the existing PrivacyInfo file |
| 29 | + (privacy_info["NSPrivacyAccessedAPITypes"] || []).each do |accessed_api| |
| 30 | + api_type = accessed_api["NSPrivacyAccessedAPIType"] |
| 31 | + reasons = accessed_api["NSPrivacyAccessedAPITypeReasons"] |
| 32 | + # Add reasons from existing PrivacyInfo file to the ones from pods |
| 33 | + required_reason_apis[api_type] ||= [] |
| 34 | + required_reason_apis[api_type] += reasons |
| 35 | + end |
| 36 | + |
| 37 | + # Update the existing PrivacyInfo file with the new aggregated data |
| 38 | + privacy_info["NSPrivacyAccessedAPITypes"] = required_reason_apis.map { |api_type, reasons| |
| 39 | + { |
| 40 | + "NSPrivacyAccessedAPIType" => api_type, |
| 41 | + "NSPrivacyAccessedAPITypeReasons" => reasons.uniq |
| 42 | + } |
| 43 | + } |
| 44 | + |
| 45 | + Xcodeproj::Plist.write_to_path(privacy_info, file_path) |
| 46 | + |
| 47 | + targets.each do |target| |
| 48 | + ensure_reference(file_path, user_project, target) |
| 49 | + end |
| 50 | + end |
| 51 | + |
| 52 | + def self.get_application_targets(user_project) |
| 53 | + return user_project.targets.filter { |t| t.symbol_type == :application } |
| 54 | + end |
| 55 | + |
| 56 | + def self.read_privacyinfo_file(file_path) |
| 57 | + # Maybe add missing default NSPrivacyTracking, NSPrivacyTrackingDomains, NSPrivacyCollectedDataTypes, but this works without those keys |
| 58 | + source_data = nil |
| 59 | + # Try to read an existing PrivacyInfo.xcprivacy file |
| 60 | + begin |
| 61 | + source_data = Xcodeproj::Plist.read_from_path(file_path) |
| 62 | + Pod::UI.puts "[Privacy Manifest Aggregation] Appending aggregated reasons to existing PrivacyInfo.xcprivacy file." |
| 63 | + rescue => e |
| 64 | + Pod::UI.puts "[Privacy Manifest Aggregation] No existing PrivacyInfo.xcprivacy file found, creating a new one." |
| 65 | + end |
| 66 | + return source_data |
| 67 | + end |
| 68 | + |
| 69 | + def self.ensure_reference(file_path, user_project, target) |
| 70 | + reference_exists = target.resources_build_phase.files_references.any? { |file_ref| file_ref.path.end_with? "PrivacyInfo.xcprivacy" } |
| 71 | + unless reference_exists |
| 72 | + # We try to find the main group, but if it doesn't exist, we default to adding the file to the project root – both work |
| 73 | + file_root = user_project.root_object.main_group.children.first { |group| group.name == target.name } || user_project |
| 74 | + file_ref = file_root.new_file(file_path) |
| 75 | + build_file = target.resources_build_phase.add_file_reference(file_ref, true) |
| 76 | + end |
| 77 | + end |
| 78 | + |
| 79 | + def self.get_privacyinfo_file_path(user_project) |
| 80 | + # We try to find a file we know exists in the project to get the path to the main group directory |
| 81 | + info_plist_path = user_project.files.find { |file_ref| file_ref.name == "Info.plist" } |
| 82 | + if info_plist_path.nil? |
| 83 | + # return path that is sibling to .xcodeproj |
| 84 | + path = user_project.path |
| 85 | + return File.join(File.dirname(path), "PrivacyInfo.xcprivacy") |
| 86 | + end |
| 87 | + return File.join(File.dirname(info_plist_path.real_path),"PrivacyInfo.xcprivacy") |
| 88 | + end |
| 89 | + |
| 90 | + def self.get_used_required_reason_apis(installer) |
| 91 | + # A dictionary with keys of type string (NSPrivacyAccessedAPIType) and values of type string[] (NSPrivacyAccessedAPITypeReasons[]) |
| 92 | + used_apis = {} |
| 93 | + Pod::UI.puts "[Privacy Manifest Aggregation] Reading .xcprivacy files to aggregate all used Required Reason APIs." |
| 94 | + installer.pod_targets.each do |pod_target| |
| 95 | + # puts pod_target |
| 96 | + pod_target.file_accessors.each do |file_accessor| |
| 97 | + file_accessor.resource_bundles.each do |bundle_name, bundle_files| |
| 98 | + bundle_files.each do |file_path| |
| 99 | + # This needs to be named like that due to apple requirements |
| 100 | + if File.basename(file_path) == 'PrivacyInfo.xcprivacy' |
| 101 | + content = Xcodeproj::Plist.read_from_path(file_path) |
| 102 | + accessed_api_types = content["NSPrivacyAccessedAPITypes"] |
| 103 | + accessed_api_types.each do |accessed_api| |
| 104 | + api_type = accessed_api["NSPrivacyAccessedAPIType"] |
| 105 | + reasons = accessed_api["NSPrivacyAccessedAPITypeReasons"] |
| 106 | + used_apis[api_type] ||= [] |
| 107 | + used_apis[api_type] += reasons |
| 108 | + end |
| 109 | + end |
| 110 | + end |
| 111 | + end |
| 112 | + end |
| 113 | + end |
| 114 | + return used_apis |
| 115 | + end |
| 116 | + |
| 117 | + def self.get_privacy_manifest_paths_from(user_project) |
| 118 | + privacy_manifests = user_project |
| 119 | + .files |
| 120 | + .select { |p| |
| 121 | + p.path&.end_with?('PrivacyInfo.xcprivacy') |
| 122 | + } |
| 123 | + return privacy_manifests |
| 124 | + end |
| 125 | + |
| 126 | + def self.get_core_accessed_apis() |
| 127 | + file_timestamp_accessed_api = { |
| 128 | + "NSPrivacyAccessedAPIType" => "NSPrivacyAccessedAPICategoryFileTimestamp", |
| 129 | + "NSPrivacyAccessedAPITypeReasons" => ["C617.1"], |
| 130 | + } |
| 131 | + user_defaults_accessed_api = { |
| 132 | + "NSPrivacyAccessedAPIType" => "NSPrivacyAccessedAPICategoryUserDefaults", |
| 133 | + "NSPrivacyAccessedAPITypeReasons" => ["CA92.1"], |
| 134 | + } |
| 135 | + boot_time_accessed_api = { |
| 136 | + "NSPrivacyAccessedAPIType" => "NSPrivacyAccessedAPICategorySystemBootTime", |
| 137 | + "NSPrivacyAccessedAPITypeReasons" => ["35F9.1"], |
| 138 | + } |
| 139 | + return [file_timestamp_accessed_api, user_defaults_accessed_api, boot_time_accessed_api] |
| 140 | + end |
| 141 | + |
| 142 | + |
| 143 | + def self.get_user_project_from(installer) |
| 144 | + user_project = installer.aggregate_targets |
| 145 | + .map{ |t| t.user_project } |
| 146 | + .first |
| 147 | + return user_project |
| 148 | + end |
| 149 | + |
| 150 | + def self.add_privacy_manifest_if_needed(installer) |
| 151 | + user_project = get_user_project_from(installer) |
| 152 | + privacy_manifest = self.get_privacy_manifest_paths_from(user_project).first |
| 153 | + if privacy_manifest.nil? |
| 154 | + privacy_manifest = { |
| 155 | + "NSPrivacyCollectedDataTypes" => [], |
| 156 | + "NSPrivacyTracking" => false, |
| 157 | + "NSPrivacyAccessedAPITypes" => get_core_accessed_apis |
| 158 | + } |
| 159 | + path = File.join(user_project.path.parent, "PrivacyInfo.xcprivacy") |
| 160 | + Xcodeproj::Plist.write_to_path(privacy_manifest, path) |
| 161 | + Pod::UI.puts "Your app does not have a privacy manifest! A template has been generated containing Required Reasons API usage in the core React Native library. Please add the PrivacyInfo.xcprivacy file to your project and complete data use, tracking and any additional required reasons your app is using according to Apple's guidance: https://developer.apple.com/documentation/bundleresources/privacy_manifest_files. Then, you will need to manually add this file to your project in Xcode.".red |
| 162 | + end |
| 163 | + end |
| 164 | +end |
0 commit comments