OWASP MASTG 最佳实践 MASTG-BEST-0024:在 iOS 应用沙盒中选择正确的数据存储目录并加密敏感数据
OWASP MASTG 最佳实践 MASTG-BEST-0024:在 iOS 应用沙盒中选择正确的数据存储目录并加密敏感数据
本文是 OWASP MASTG(Mobile Application Security Testing Guide)最佳实践 MASTG-BEST-0024 的完整技术解读。它聚焦于 iOS 应用沙盒(App Sandbox)内数据落盘位置的选择原则:用户生成内容放入 Documents 目录,应用内部数据放入 Library 目录,并深入剖析 Documents 目录因文件共享能力(UIFileSharingEnabled / LSSupportsOpeningDocumentsInPlace)而带来的被篡改、被复制、被其他应用读取三类现实风险。读完本文,你将掌握沙盒各目录的语义边界、可被用户访问的暴露面判定方法、正确的目录解析与写入代码姿势,以及面向 L2(高合规)应用的"加密落盘 + 密钥入 Keychain"纵深防御方案。
一、最佳实践的核心主张
该最佳实践给出的核心规则只有一条,但极具工程指导价值:
在应用沙盒内为应用数据与用户数据选择正确的存储位置:
Documents目录用于存放用户生成的内容(user-generated content),Library目录用于存放应用自身的内部数据。
其背后的安全动机是:iOS 允许应用通过两个 Info.plist 键将 Documents 目录对用户(以及通过文件共享链路对其他人)开放——UIFileSharingEnabled("Application supports iTunes file sharing")和 LSSupportsOpeningDocumentsInPlace("Supports opening documents in place")。一旦开启,把数据库、配置文件、购买状态等应用内部数据放进 Documents 目录就变得高度危险。
二、iOS 应用沙盒目录结构全景
要理解"放哪里"的安全含义,先要看清沙盒内部的地形。根据 MASTG-KNOW-0108(App Sandbox Directories),每个 iOS 应用都拥有两个主位置:
- Bundle 目录(如
/private/var/containers/Bundle/Application/3ADAF47D-A734-49FA-B274-FBCA66589E67/):存放AppName.app,即 IPA 中的应用程序包,包含可执行二进制与资源。该目录运行期不可写、默认不对用户可见、不参与备份,其内容用于代码签名校验。 - Data 目录(如
/private/var/mobile/Containers/Data/Application/8C8E7EB0-BC9B-435B-8EF8-8F5560EB0693/):应用的数据沙盒,本最佳实践讨论的正是其中的子目录。
沙盒数据目录的标准结构(目录结构图):
各目录的安全与语义属性可归纳如下:
| 目录 | 典型用途 | 用户可见/可写 | 是否备份 | 系统清理 |
|---|---|---|---|---|
Documents/ |
用户创建或用户可见的持久内容 | 取决于应用配置,开启文件共享后可在"文件"App 中可见、可写 | 默认备份 | 否 |
Library/ |
应用专用支持文件(配置、偏好、Cookie、缓存) | 不可见、用户不可直接写入 | 默认备份 | 否 |
Library/Caches/ |
可再生成的半持久缓存 | 不可见 | 不备份 | 存储空间不足时 OS 可能自动删除 |
Library/Application Support/ |
应用运行所需的持久文件(如数据库) | 不可见 | 默认备份 | 否 |
Library/Preferences/ |
UserDefaults/NSUserDefaults 的键值对(以 [BUNDLE_ID].plist 明文保存) |
不可见 | 默认备份 | 否 |
tmp/ |
无需跨启动保留的临时/暂存文件 | 不可见 | 不备份 | OS 可随时清除,尤其空间不足时 |
从该结构可以推断出本最佳实践的精确意图:Documents 是唯一"默认可能向用户开放"的常规存储区,因此它只应承载用户主动生成、用户理应能够看到和导出的内容;而应用的内部状态(数据库、配置、购买记录等)必须落到 Library 体系(尤其是 Library/Application Support 或 Library/Preferences),才能保持对用户的不可见性。
三、为什么把内部数据放进 Documents 是危险的
MASTG-BEST-0024 明确指出三大风险来源:
- 用户可篡改内部文件:文件共享开启后,用户能在"文件"App 或通过 iTunes/Finder 直接编辑
Documents中的内容,例如改写数据库、篡改购买状态或修改配置。 - 物理接触设备的攻击者可复制
Documents内容:即使设备处于正常(非越狱)状态,攻击者只要短暂接触设备,就能通过文件共享链路把敏感数据完整拷出。 - 其他应用可通过文档选择器读取:借助文档选择器界面(
UIDocumentPickerViewController),其他应用可以在用户的授权流程下访问其他应用的Documents内容。
需要强调:documentDirectory 本身并非天然不安全(MASTG-TEST-0303 中亦有此说明);风险取决于"敏感数据 + 共享暴露"的组合——当应用既把明文敏感数据写入 Documents,又在 Info.plist 中开启了上述两个键时,问题才真正成立。相比之下,位于 Library/Application Support 且经过加密的数据,或直接存放在 Keychain 中的数据,即使文件共享开启也无法被访问。
验证方式:测试用例 MASTG-TEST-0303(References to APIs for Storing Unencrypted Data in Shared Storage)专门核查此类暴露面——静态审查所有向共享/可能共享位置(如 .documentDirectory、URL.documentsDirectory)写入的 API,同时用 MASTG-TECH-0153 提取 Info.plist、用 MASTG-TECH-0154 检查 UIFileSharingEnabled 与 LSSupportsOpeningDocumentsInPlace 两个标志位的状态。
四、落地实现:如何正确解析与写入沙盒目录
在代码层面,目录解析的标准做法是使用 FileManager 的目录查询 API,明确指定目标目录枚举值,而不是硬编码路径。根据 MASTG-KNOW-0091(File System APIs),核心 API 是 FileManager.default.urls(for:in:),其中 for 参数决定落盘位置:
.documentDirectory—— 用户生成内容;.libraryDirectory—— 应用内部数据;.cachesDirectory—— 可清除的缓存文件;.applicationSupportDirectory—— 应用运行必需的持久文件(配置、模板、数据库等);temporaryDirectory/FileManager.default.temporaryDirectory—— 临时文件,系统可能在应用未运行时清除。
基础写入示例(来自 MASTG-KNOW-0091):
let url = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask)[0]
.appendingPathComponent("filename.txt")
FileManager.default.createFile(
atPath: url.path,
contents: "secret text".data(using: .utf8),
attributes: [FileAttributeKey.protectionKey: FileProtectionType.complete]
)
除 FileManager.createFile(atPath:contents:attributes:) 外,写入沙盒还可经由以下 API(同样需要纳入安全审计视野):
Data.write(to:options:)与String.write(to:atomically:encoding:);FileHandle.write(contentsOf:),用于增量写入;- 底层 POSIX/BSD 调用:
open、write、pwrite、close等; - 文档型应用可借助
UIDocument/NSDocument,它们底层仍落在沙盒或 iCloud 容器内的普通文件上,文件保护属性同样生效。
代码审查提示:静态测试 MASTG-TEST-0300 会扫描上述全部 API(包括 UserDefaults、Core Data、SQLite 封装等高层持久化设施)以及 Keychain 相关 API,定位"向私有存储写入明文敏感数据"的代码位置;动态测试 MASTG-TEST-0301 则通过运行时方法挂钩(MASTG-TECH-0095)监控真实的文件系统与 Keychain 调用。注意:部分目标 API 的 I/O 会经由系统守护进程转发,不会直接产生 open/write 系统调用,因此挂钩目标应选择相关 Objective-C/Swift API 而非仅跟踪系统调用。
五、纵深防御:目录正确 ≠ 数据安全
这是本最佳实践最重要的一条补充告诫:
把数据放在正确的目录,并不意味着它就安全了。 对于 L2(高级合规)档位的应用,建议在写入前对文件进行加密,并把加密密钥放入 Keychain。
其含义是:目录选择解决的是"暴露面"问题(谁能够看到、谁能够触碰),而数据保护解决的是"内容安全"问题(即使文件被拿到,明文也不可得)。两者是互补的两道防线,缺一不可。
5.1 第一道防线:数据保护等级(Data Protection)
iOS 的原生文件保护(Data Protection)机制会对文件内容进行加密,密钥链与设备解锁状态绑定。开发者可在创建文件时通过 attributes 指定保护等级,或对既有文件使用 setAttributes 调整(示例来自 MASTG-KNOW-0091):
FileManager.default.setAttributes(
[FileAttributeKey.protectionKey: FileProtectionType.complete],
ofItemAtPath: path
)
关键事实:
- 系统默认保护等级为
NSFileProtectionCompleteUntilFirstUserAuthentication(首次用户解锁后文件可访问); - 使用其他 API 创建的文件默认继承该等级,除非显式用
setAttributes升级; - 也可在 Info.plist 中通过
NSFileProtectionKey为整个应用设置默认保护等级。
动态测试 MASTG-TEST-0299 专门核查该维度:在典型使用流程(认证、资料加载、消息、缓存、离线、加解密操作)后,检索沙盒目录树(/var/mobile/Containers/Data/Application/<UUID>/)与 App Group 共享容器(/private/var/mobile/Containers/Shared/AppGroup/<UUID>/,详见 MASTG-KNOW-0082)中所有文件的数据保护类;若含敏感数据的文件保护等级为 NSFileProtectionNone,则测试失败。
5.2 第二道防线:加密落盘 + 密钥入 Keychain
对于 L2 场景,推荐的做法是"先加密、后落盘、密钥入钥匙串":
- 使用 Keychain 中的对称密钥对敏感数据加密(如生成随机会话密钥或使用 Keychain 管理的密钥),再把密文写入
Library/Application Support等不可见目录; - 加密密钥本身存放在 Keychain 中,并为其设置合适的访问控制与可访问性属性(如
kSecAttrAccessibleWhenUnlockedThisDeviceOnly); - 绝不把密钥与密文放在同一位置,更不要把密钥硬编码进代码或写进 plist。
动态差分测试 MASTG-TEST-0302 是对该防线是否成立的直接验证:先取沙盒文件清单基线(MASTG-TECH-0059)与 Keychain 快照(MASTG-TECH-0061),在充分操作应用后再次快照,通过差分找出新增/修改的文件与 Keychain 条目;若敏感数据以明文或"可平凡解码"形式(base64、十六进制、URL 编码、转义序列、二进制 plist、zip/tar 压缩包、宽字符、异或混淆等)出现在新增或修改的文件中,测试即失败——这些编码/压缩手段只是"掩盖"而非"保护"。
与之配套的静态审查见 MASTG-TEST-0300:确认敏感数据在写入私有存储前是否被加密、或是否直接经 Keychain API 存储,并记录 Keychain 调用的访问控制与可访问性属性。
六、信息共享配置检查清单
最后,将本文所有要点收敛为可执行的核查清单:
- 目录映射:用户生成内容 →
Documents;内部数据(数据库、配置、购买状态、Cookie、偏好)→Library(首选Application Support/Preferences);缓存 →Library/Caches;临时文件 →tmp。 - Info.plist 审计:确认
UIFileSharingEnabled与LSSupportsOpeningDocumentsInPlace是否被误设为YES。若应用无需在"文件"App 中共享文档,两个键应保持未设置或为NO。 - 写入 API 审计:用 MASTG-TEST-0300 静态扫描
FileManager、Data.write、String.write、FileHandle、POSIX/BSD 与UserDefaults/Core Data/SQLite 等所有落盘路径。 - 运行时验证:用 MASTG-TEST-0301 挂钩相关 API,确认运行期写入行为与静态分析一致。
- 差分取证:用 MASTG-TEST-0302 对比操作前后沙盒与 Keychain 快照,识别明文或可平凡解码的敏感数据。
- 数据保护等级:用 MASTG-TEST-0299 确认含敏感数据文件未使用
NSFileProtectionNone。 - L2 加固:对敏感数据先加密再落盘,密钥存放于 Keychain 并配置适当的访问控制与可访问性属性。
遵循以上步骤,即可在"正确的目录 + 原生的数据保护 + 应用层加密与 Keychain 密钥管理"三层结构下,系统性地消除 iOS 应用沙盒存储的安全盲区。
