iOS问题记录 - App Store审核新政策：隐私清单 & SDK签名（持续更新）

迷南。 2024-05-28 10:24 121阅读 0赞

#### 文章目录 ####

*  前言
 *  开发环境
 *  问题描述
 *  问题分析
 *   *  1. 隐私清单 & SDK签名
     *   *  1.1. 隐私清单 - 数据使用声明
         *  1.2. 隐私清单 - 所用API原因描述
         *  1.3. SDK签名
     *  2. 即将发布的第三方SDK要求
 *  解决方案
 *  最后

--------------------

## 前言 ##

前段时间用Flutter开发的iOS App提交了新版本，结果刚过两分钟就收到了一封问题邮件，我还以为审核被拒了，结果并没有。

粗略看了看，只是出了审核新政策，`2024/05/01`开始才会被拒。那还早，当时我就不慌了，继续忙其他事情，直到现在才有空研究一番这个问题。

**注意：文中有很多描述没有官方中文，所以可能存在翻译不够准确的情况。**

## 开发环境 ##

*  Xcode: 15.3
 *  Flutter: 3.19.4
 *  macOS: 14.4

## 问题描述 ##

审核问题邮件内容：

Although submission for App Store review was successful, you may want to correct the following issues in your next submission for App Store review. Once you've corrected the issues, upload a new binary to App Store Connect.
    
    ITMS-91053: Missing API declaration - Your app’s code in the “Runner” file references one or more APIs that require reasons, including the following API categories: NSPrivacyAccessedAPICategoryDiskSpace. While no action is required at this time, starting May 1, 2024, when you upload a new app or app update, you must include a NSPrivacyAccessedAPITypes array in your app’s privacy manifest to provide approved reasons for these APIs used by your app’s code. For more details about this policy, including a list of required reason APIs and approved reasons for usage, visit: https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api.
    
    ITMS-91053: Missing API declaration - Your app’s code in the “Runner” file references one or more APIs that require reasons, including the following API categories: NSPrivacyAccessedAPICategoryFileTimestamp. While no action is required at this time, starting May 1, 2024, when you upload a new app or app update, you must include a NSPrivacyAccessedAPITypes array in your app’s privacy manifest to provide approved reasons for these APIs used by your app’s code. For more details about this policy, including a list of required reason APIs and approved reasons for usage, visit: https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api.
    
    ITMS-91053: Missing API declaration - Your app’s code in the “Runner” file references one or more APIs that require reasons, including the following API categories: NSPrivacyAccessedAPICategorySystemBootTime. While no action is required at this time, starting May 1, 2024, when you upload a new app or app update, you must include a NSPrivacyAccessedAPITypes array in your app’s privacy manifest to provide approved reasons for these APIs used by your app’s code. For more details about this policy, including a list of required reason APIs and approved reasons for usage, visit: https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api.
    
    ITMS-91053: Missing API declaration - Your app’s code in the “Runner” file references one or more APIs that require reasons, including the following API categories: NSPrivacyAccessedAPICategoryUserDefaults. While no action is required at this time, starting May 1, 2024, when you upload a new app or app update, you must include a NSPrivacyAccessedAPITypes array in your app’s privacy manifest to provide approved reasons for these APIs used by your app’s code. For more details about this policy, including a list of required reason APIs and approved reasons for usage, visit: https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api.

## 问题分析 ##

### 1. 隐私清单 & SDK签名 ###

从邮件内容看，问题很明确，缺少`API`声明，看了看[链接][Link 1]指向的文档，原来是新政策要求提供隐私清单，并声明所用API的原因。

> If you upload an app to App Store Connect that uses required reason API without describing the reason in its privacy manifest file, Apple sends you an email reminding you to add the reason to the app’s privacy manifest. Starting May 1, 2024, apps that don’t describe their use of required reason API in their privacy manifest file aren’t accepted by App Store Connect.

更多详情请看这个视频介绍：[WWDC2023 - Get started with privacy manifests][]，右下角字幕可以切换为**简体中文**。

![screenshot1][]

视频可以简单概括两点：

1.  App的大部分隐私情况往往取决于第三方SDK，这就可能导致App的隐私标签不够准确，所以要求第三方SDK也提供隐私清单用于生成隐私报告，帮助App开发者更准确地创建隐私标签
2.  第三方SDK以二进制文件的形式依赖时要求签名，更多详情请看视频[WWDC2023 - Verify app dependencies with digital signatures][]

补充：隐私标签的创建位于`App Store Connect`的`App 隐私`页面。

找了找隐私清单相关的官方文档：

*  [Describing data use in privacy manifests][]
 *  [Describing use of required reason API][Link 1]

结合前面的视频，可知隐私清单主要包含**数据使用声明**和**所用API原因描述**，先逐个看看都是些什么。

#### 1.1. 隐私清单 - 数据使用声明 ####

官方文档中的概述：

> Record the categories of data that your app or third-party SDK collects about the person using the app, and the reasons it collects the data. App developers can use Xcode to create a privacy report, summarizing the information about collected data in their app and the third-party SDKs the app links to.  
> 记录您的应用或第三方SDK收集的有关应用使用者的数据类别，以及收集数据的原因。应用程序开发人员可以使用Xcode创建隐私报告，总结有关应用程序中收集的数据以及应用程序链接到的第三方SDK的信息。

需要填写的内容：

<table> 
 <thead> 
  <tr> 
   <th>Key</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>NSPrivacyCollectedDataType</td> 
   <td>用于标识您的应用或第三方SDK收集的数据类型</td> 
  </tr> 
  <tr> 
   <td>NSPrivacyCollectedDataTypeLinked</td> 
   <td>指示您的应用程序或第三方SDK是否将此数据类型关联到用户的身份</td> 
  </tr> 
  <tr> 
   <td>NSPrivacyCollectedDataTypeTracking</td> 
   <td>指示您的应用程序或第三方SDK是否使用此数据类型进行跟踪</td> 
  </tr> 
  <tr> 
   <td>NSPrivacyCollectedDataTypePurposes</td> 
   <td>列出您的应用或第三方SDK收集数据的原因</td> 
  </tr> 
 </tbody> 
</table>

`NSPrivacyCollectedDataType`列举的部分数据类型：

![screenshot2][]

`NSPrivacyCollectedDataTypePurposes`的可选项：

![screenshot3][]

不知道你有没有感觉很熟悉，如果你上架过应用，那应该不会陌生，创建隐私标签时的选项不就是这些。打开`App Store Connect`的`App 隐私`页面，找到`数据类型`并编辑：

![screenshot4][]

上图中的选项对应着`NSPrivacyCollectedDataType`列举的数据类型。再看看下面这些，分别对应着`NSPrivacyCollectedDataTypeLinked`、`NSPrivacyCollectedDataTypeTracking`、`NSPrivacyCollectedDataTypePurposes`：

![screenshot5][]

![screenshot6][]

![screenshot7][]

所以给App创建隐私清单后，关于数据使用声明的填写，可以参考以前创建的隐私标签，毕竟以前创建的隐私标签基本没包含第三方SDK（如果以前有包含，填写时不需要涵盖）。下面举个简单例子，更多填写细节可以参考前面的[视频介绍][WWDC2023 - Verify app dependencies with digital signatures]：

![screenshot8][]

项目打包后生成的隐私报告（截取部分）：

![screenshot9][]

如图，如果第三方SDK有填写，也会整合在隐私报告中，以后隐私标签的创建可以直接参考隐私报告。**那如果不想填数据使用声明可以吗？目前可以。**

一是官方文档中没有明确声明会拒绝未填写数据使用声明的应用；二是提交审核暂时也没有收到这方面的问题邮件。隐私清单中的数据使用声明更多是为了帮助App开发者更准确的创建隐私标签。

#### 1.2. 隐私清单 - 所用API原因描述 ####

官方文档中的概述：

> Some APIs that your app uses to deliver its core functionality — in code you write or included in a third-party SDK — have the potential of being misused to access device signals to try to identify the device or user, also known as fingerprinting. Regardless of whether a user gives your app permission to track, fingerprinting is not allowed. Describe the reasons your app or third-party SDK on iOS, iPadOS, tvOS, visionOS, or watchOS uses these APIs, and check that your app or third-party SDK only uses the APIs for the expected reasons.  
> 您的应用程序用来提供其核心功能的某些API（在您编写的或包含在第三方SDK中的代码中）有可能被滥用来访问设备信号以尝试识别设备或用户，也称为指纹识别。无论用户是否授予您的应用跟踪权限，都不允许进行指纹识别。描述您的iOS、iPadOS、tvOS、visionOS或watchOS上的应用或第三方SDK使用这些API的原因，并检查您的应用或第三方SDK是否仅出于预期原因使用这些API。

需要填写的内容：

<table> 
 <thead> 
  <tr> 
   <th>Key</th> 
   <th>Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>NSPrivacyAccessedAPIType</td> 
   <td>用于标识您的应用程序使用的所需原因API的类别</td> 
  </tr> 
  <tr> 
   <td>NSPrivacyAccessedAPITypeReasons</td> 
   <td>用于标识您的应用程序使用API的原因</td> 
  </tr> 
 </tbody> 
</table>

可选API类别及原因列表：

**最后更新日期：2024/03/31**

<table> 
 <tbody> 
  <tr> 
   <th>NSPrivacyAccessedAPIType</th> 
   <th colspan="2">NSPrivacyAccessedAPITypeReasons</th> 
  </tr> 
  <tr> 
   <td>NSPrivacyAccessedAPICategoryFileTimestamp</td> 
   <td>DDA9.1</td> 
   <td>声明此原因以向使用该设备的人员显示文件时间戳。<br><br>出于此原因访问的信息或任何派生信息可能不会发送到设备外。</td> 
  </tr> 
  <tr> 
   <td>C617.1</td> 
   <td>声明此原因以访问应用程序容器、应用程序组容器或应用程序的CloudKit容器内文件的时间戳、大小或其他元数据。</td> 
  </tr> 
  <tr> 
   <td>3B52.1</td> 
   <td>声明此原因以访问用户明确授予访问权限的文件或目录的时间戳、大小或其他元数据，例如使用文档选择器视图控制器。</td> 
  </tr> 
  <tr> 
   <td>0A2A.1</td> 
   <td>如果您的第三方SDK提供文件时间戳API的包装函数供应用程序使用，并且您仅在应用程序调用您的包装函数时才访问文件时间戳API，请声明此原因。此原因只能由第三方SDK声明。如果您的第三方SDK主要是为了包装所需的原因 API 而创建的，则可能不会声明此原因。<br><br>出于此原因访问的信息或任何派生信息不得用于您的第三方SDK自身的目的，也不得由您的第三方SDK发送至设备外。</td> 
  </tr> 
  <tr> 
   <td>NSPrivacyAccessedAPICategorySystemBootTime</td> 
   <td>35F9.1</td> 
   <td>声明此原因以访问系统启动时间，以便测量应用程序内发生的事件之间经过的时间量或执行计算以启用计时器。<br><br>出于此原因访问的信息或任何派生信息可能不会发送到设备外。有关应用程序内发生的事件之间经过的时间量的信息有一个例外，该信息可能会发送到设备外。</td> 
  </tr> 
  <tr> 
   <td>8FFB.1</td> 
   <td>声明此原因以访问系统启动时间，以计算应用程序内发生的事件的绝对时间戳，例如与UIKit或AVFAudio框架相关的事件。<br><br>您的应用内发生的事件的绝对时间戳可能会发送到设备外。出于此原因访问的系统启动时间或从系统启动时间派生的任何其他信息可能不会发送到设备外。</td> 
  </tr> 
  <tr> 
   <td>3D61.1</td> 
   <td>声明此原因以在使用设备的人选择提交的可选错误报告中包含系统启动时间信息。系统启动时间信息必须作为报告的一部分显着地向人员显示。<br><br>仅在用户肯定选择提交包括系统启动时间信息的特定错误报告之后，并且仅出于调查或响应错误报告的目的，才可以将出于此原因访问的信息或任何派生信息发送到设备外。</td> 
  </tr> 
  <tr> 
   <td>NSPrivacyAccessedAPICategoryDiskSpace</td> 
   <td>85F4.1</td> 
   <td>声明此原因以向使用该设备的人员显示磁盘空间信息。磁盘空间可以以信息单位（例如字节）或与媒体类型结合的时间单位（例如高清视频的分钟）来显示。<br><br>出于此原因访问的信息或任何派生信息可能不会发送到设备外。有一个例外，允许应用程序通过本地网络将磁盘空间信息发送到同一个人操作的另一台设备，仅用于显示该设备上的磁盘空间信息；此例外仅适用于用户明确允许发送磁盘空间信息的情况，并且该信息不得通过Internet发送。</td> 
  </tr> 
  <tr> 
   <td>E174.1</td> 
   <td>声明此原因是为了检查是否有足够的磁盘空间来写入文件，或者检查磁盘空间是否不足，以便应用程序可以在磁盘空间不足时删除文件。应用程序必须根据磁盘空间以用户可观察到的方式表现不同。<br><br>出于此原因访问的信息或任何派生信息可能不会发送到设备外。有一个例外，允许应用程序在磁盘空间不足时避免从服务器下载文件。</td> 
  </tr> 
  <tr> 
   <td>7D9E.1</td> 
   <td>声明此原因以在使用设备的人员选择提交的可选错误报告中包含磁盘空间信息。磁盘空间信息必须作为报告的一部分突出地显示给相关人员。<br><br>仅在用户明确选择提交包括磁盘空间信息的特定错误报告之后，并且仅出于调查或响应错误报告的目的，因此访问的信息或任何派生信息才可以发送到设备外。</td> 
  </tr> 
  <tr> 
   <td>B728.1</td> 
   <td>如果您的应用程序是健康研究应用程序，并且您访问此API类别来检测并通知研究参与者磁盘空间不足影响研究数据收集，请声明此原因。<br><br>您的应用程序必须符合<a href="https://developer.apple.com/app-store/review/guidelines/#health-and-health-research" rel="nofollow">应用程序商店审核指南§5.1.3</a>。除了提供有关健康研究的信息并允许人们参与健康研究之外，您的应用程序不得提供任何其他功能。</td> 
  </tr> 
  <tr> 
   <td>NSPrivacyAccessedAPICategoryActiveKeyboards</td> 
   <td>3EC4.1</td> 
   <td>如果您的应用程序是自定义键盘应用程序，并且您访问此 API 类别以确定设备上处于活动状态的键盘，请声明此原因。<br><br>为用户提供系统范围的自定义键盘必须是应用程序的主要功能。<br>出于此原因访问的信息或任何派生信息可能不会发送到设备外。</td> 
  </tr> 
  <tr> 
   <td>54BD.1</td> 
   <td>声明此原因以访问活动键盘信息，以便向使用该设备的人员呈现正确的自定义用户界面。应用程序必须具有用于输入或编辑文本的文本字段，并且必须以用户可观察到的方式根据活动键盘采取不同的行为。<br><br>出于此原因访问的信息或任何派生信息可能不会发送到设备外。</td> 
  </tr> 
  <tr> 
   <td>NSPrivacyAccessedAPICategoryUserDefaults</td> 
   <td>CA92.1</td> 
   <td>声明此原因以访问用户默认读取和写入只能由应用程序本身访问的信息。<br><br>此原因不允许读取其他应用程序或系统写入的信息，或写入可由其他应用程序访问的信息。</td> 
  </tr> 
  <tr> 
   <td>1C8F.1</td> 
   <td>声明此原因以访问用户默认值以读取和写入仅可由与应用程序本身属于同一应用程序组的成员的应用程序、应用程序扩展和应用程序剪辑访问的信息。<br><br>此原因不允许读取由同一应用程序组外部的应用程序、应用程序扩展或应用程序剪辑或系统写入的信息。如果系统提供来自全局域的信息，则您的应用程序不承担责任，因为当您的应用程序尝试读取应用程序的应用程序组中的应用程序、应用程序扩展或应用程序剪辑写入的信息时，您请求的域中不存在密钥。<br><br>此原因也不允许写入可由同一应用程序组外部的应用程序、应用程序扩展或应用程序剪辑访问的信息。</td> 
  </tr> 
  <tr> 
   <td>C56D.1</td> 
   <td>如果您的第三方SDK围绕用户默认API提供包装函数供应用程序使用，并且您仅在应用程序调用您的包装函数时才访问用户默认API，请声明此原因。此原因只能由第三方SDK声明。如果您的第三方SDK主要是为了包装所需的原因API而创建的，则可能不会声明此原因。<br><br>出于此原因访问的信息或任何派生信息不得用于您的第三方SDK自身的目的，也不得由您的第三方SDK发送至设备外。</td> 
  </tr> 
  <tr> 
   <td>AC6B.1</td> 
   <td>声明此原因以访问用户默认读取com.apple.configuration.managed键以检索MDM设置的托管应用程序配置，或设置com.apple.feedback.managed键来存储要通过MDM查询的反馈信息，如Apple移动设备管理协议参考文档中所述。</td> 
  </tr> 
 </tbody> 
</table>

可以看到，问题邮件中提到的API在这都有列出来。按道理说照着官方文档填写就能解决当前问题了，可问题是我这是Flutter项目，业务逻辑代码编译后是放在了`App.framework`，Flutter项目默认的主程序文件`Runner`被检查出用了这些API没声明，我咋知道它用来干啥了？

首先要确定`Runner`可执行文件中的这些API调用怎么来的，本身Flutter项目中的iOS工程就没写几行代码，所以严重怀疑是来自静态库（`.a`）或静态框架（设置了`s.static_framework = true`的`framework`）。

使用[Shell脚本][Shell]扫描项目，果然一堆静态框架使用了这些API。大致根据实际用途，在App的隐私清单中选择填写：

![screenshot10][]

第三方SDK没有隐私清单暂时先不管，重新提交审核，不再收到问题邮件！由此，暂时可以得出以下两个结论：

1.  目前审核主要针对主程序文件，督促App开发者增加隐私清单
2.  由于静态库和静态框架在项目构建时会被静态链接到主程序可执行二进制文件，所以这些库的所用API原因描述需要在App的隐私清单中填写

#### 1.3. SDK签名 ####

根据[视频介绍][WWDC2023 - Verify app dependencies with digital signatures]，个人理解这个第三方SDK要求签名的检查应该是由Xcode完成，并不是在提交审核阶段。理由如下：

1.  第三方SDK签名校验允许SDK提供者自签名，App开发者完全可以自行对第三方SDK进行签名
2.  Xcode打包时会用本机的证书对这些第三方SDK进行签名，所以提交审核的包不会存在没有签名的情况
3.  第三方SDK如果已有签名，实测Xcode打包时也会用本机的证书重签名覆盖，所以提交审核的包不会存在原有签名的情况

可以通过以下命令查看框架的签名信息：

codesign -d --verbose=4 <framework-path>

当然，以上只是当前的个人理解，以后也许会有变化。

### 2. 即将发布的第三方SDK要求 ###

从WWDC2023到2024年5月，苹果给了将近一年的时间给开发者适配。时间虽然足够，可是第三方SDK众多，甚至有很多已经停止更新，那该怎么办？

从前面的问题邮件可以看出，暂时还只是督促App开发者填写隐私清单，并没有指出第三方SDK的问题。更重要的是有这个[即将发布的第三方SDK要求][SDK]：

![screenshot11][]

注意：以上只截取了部分名单，诸多Flutter的库在列（Flutter库一般是下划线命名，iOS原生库一般是大驼峰命名）。

个人理解，对于第三方SDK，目前还是以抓典型为主，不在名单内的不符合要求不一定抓。如果你用了名单内的，别担心，大部分已经适配，更新版本即可；如果不在名单内，已经适配的也尽量更新版本；如果已经停止更新，那没办法只能自己手动适配。

## 解决方案 ##

新建隐私清单文件：

![screenshot12][]

不要忘了勾选`Targets`，不然不会打包进应用程序：

![screenshot13][]

参考前面的问题分析填写缺失的**所用API原因描述**。如果你不清楚这些API是在哪里调用的，可以使用[Shell脚本][Shell]扫描项目。关于脚本的一些使用请看：[iOS - 超好用的隐私清单分析脚本（持续更新）][iOS -]。

## 最后 ##

如果这篇文章对你有所帮助，点赞?收藏?支持一下吧，谢谢～

--------------------

本篇文章由[@crasowas][crasowas]发布于CSDN。

[Link 1]: https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api
[WWDC2023 - Get started with privacy manifests]: https://developer.apple.com/videos/play/wwdc2023/10060/
[screenshot1]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/22798fd023f84031ad979944916f4343.png
[WWDC2023 - Verify app dependencies with digital signatures]: https://developer.apple.com/videos/play/wwdc2023/10061/
[Describing data use in privacy manifests]: https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_data_use_in_privacy_manifests
[screenshot2]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/8843f4de4a8b4380b82f77d1fba682e4.png
[screenshot3]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/661bc158ac07487996caaf81cfca49ac.png
[screenshot4]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/0fe9b8cb364d49afa01ef98273556113.png
[screenshot5]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/7783bb79bd1f4ec683a8fbb39389072d.png
[screenshot6]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/16c0ae89748743078fec084d5aaf46d9.png
[screenshot7]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/82a1eb78603e42089ede0c44245d6052.png
[screenshot8]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/7017a32d41644903b51319ad3838fd5f.png
[screenshot9]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/9530988446774721b3ae5162402e8d30.png
[Shell]: https://github.com/crasowas/app_store_required_privacy_manifest_analyser
[screenshot10]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/7c6cb3e4b0c248d7930f2cf112cb45f7.png
[SDK]: https://developer.apple.com/cn/support/third-party-SDK-requirements/
[screenshot11]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/d7b14c1deeaf4e4fa6697b69db6f1907.png
[screenshot12]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/80e9fd5412c94a40ae5c42a32aaa3a9c.png
[screenshot13]: https://image.dandelioncloud.cn/pgy_files/images/2024/05/28/78bea77340194525921f89bff706f8fe.jpeg
[iOS -]: https://blog.csdn.net/crasowas/article/details/137659281
[crasowas]: https://blog.csdn.net/crasowas