SwiftShield 使用教程

1. 项目介绍

SwiftShield 是一个用于保护 iOS 应用程序免受逆向工程攻击的 Swift 混淆工具。它通过生成随机且不可逆的加密名称来重命名项目中的类型和方法（包括第三方库），从而增加逆向工程的难度。SwiftShield 使用 Apple 的 SourceKit 来模拟 Xcode 的索引行为，生成项目完整的地图，并安全地重命名项目中的部分内容。

2. 项目快速启动

2.1 下载 SwiftShield

你可以从 SwiftShield 的 GitHub 发布页面 下载 SwiftShield 的二进制文件。

2.2 配置项目

确保你的项目满足以下要求：

• 项目应完全使用代码视图（View Code）编写。
• 项目不应使用 Xcode 的 Legacy Build System 设置。
• 项目不应有基于硬编码名称的逻辑。

2.3 运行 SwiftShield

在终端中执行以下命令来运行 SwiftShield：

swiftshield obfuscate --project-file <project-file> --scheme <scheme>

其中：

• <project-file> 是你的项目 .xcodeproj 或 .xcworkspace 文件的路径。
• <scheme> 是你的项目的主 scheme。

2.4 示例代码

以下是一个简单的示例，展示如何在你的项目中使用 SwiftShield：

swiftshield obfuscate --project-file MyApp.xcodeproj --scheme MyAppScheme

3. 应用案例和最佳实践

3.1 应用案例

SwiftShield 适用于需要保护其代码免受逆向工程攻击的 iOS 应用程序。例如，金融应用、医疗应用和游戏应用等，这些应用通常包含敏感的业务逻辑和用户数据，需要额外的安全保护。

3.2 最佳实践

• 定期运行 SwiftShield：建议在每次发布新版本之前运行 SwiftShield，以确保代码始终处于混淆状态。
• 备份转换映射文件：每次运行 SwiftShield 后，生成的 conversionMap.txt 文件应妥善保存，以便在需要时用于解混淆崩溃日志。
• 避免硬编码名称：确保项目中没有基于硬编码名称的逻辑，以避免混淆后代码无法正常运行。

4. 典型生态项目

4.1 CocoaPods

如果你的项目使用 CocoaPods 作为依赖管理工具，确保在运行 SwiftShield 之前解锁项目源代码：

chmod -R 774 PATHTOPROJECTFOLDER

4.2 SwiftGen

如果你的项目使用 SwiftGen 来生成代码，确保在运行 SwiftShield 时禁用 SwiftGen，以避免文件冲突：

if [ "$SWIFTSHIELDED" = "true" ]; then
  $PODS_ROOT/SwiftGen/bin/swiftgen images --output $SRCROOT/Asset.swift $SRCROOT/Assets.xcassets
fi

通过以上步骤，你可以有效地使用 SwiftShield 来保护你的 iOS 应用程序免受逆向工程攻击。