
适用于iOS和macOS的官方VPN客户端,提供加密隧道、安全的凭据存储、自动化服务器配置,并支持主流VPN协议。
Copyright (c) 2025 Proton Technologies AG
本项目所有依赖项均使用 Swift Package Manager 管理。在运行任何 target 之前,请先让 Xcode 解析依赖包。
已解析的版本记录在 ProtonVPN.xcworkspace/xcshareddata/swiftpm/Package.resolved 中。Proton 自有的共享代码以 git 子模块的形式存放在 external/ 目录下,必须先初始化这些子模块,工作区才能完成解析。
最快捷的方式是在仓库根目录运行 ./Integration/Scripts/bootstrap.sh,该脚本会安装 Homebrew 依赖、克隆并链接凭据仓库、初始化子模块,并安装 pre-commit 钩子。以下步骤说明了该脚本所做的事情,以及它无法替你完成的部分。
git submodule init + git submodule update)brew bundle 安装 Homebrew 依赖Cmd+Shift+K)构建项目需要一组密钥。
这些密钥包括 URL 和密钥,保存在名为 ObfuscatedConstants.swift 的文件中。
这些文件保存在一个单独的仓库中,需要一些额外的设置才能保持同步。
首先,使用 setup 命令调用位于 Integration/Scripts/credentials.sh 的脚本。
使用 -p 参数提供你希望将密钥仓库克隆到本地的路径,使用 -r 参数提供该仓库的 URL。
./Integration/Scripts/credentials.sh setup -p <path to credentials repo> -r <credentials remote>
然后,验证设置是否成功:
./Integration/Scripts/credentials.sh checkout
如果配置正确,混淆常量将在每个应用的 Generate Obfuscated Constants 构建阶段自动同步。
项目按层打包,以避免模块依赖地狱:
应尽可能避免向 LegacyCommon 和 NEHelper 添加新代码/功能。 应逐步削减这些包,以便将其组件放入上述三个类别中的新包或现有包中。
在开发过程中,swiftlint 以非严格模式运行,因此开发时更容易,无需担心代码格式问题。在 CI 上,lint 是严格的,任何警告都会导致失败。在向此仓库提交代码之前,运行以下脚本添加一个 pre-commit 钩子,该钩子将以严格模式检查所有新增/修改的文件,并阻止你提交无法通过 CI 的代码。
./Integration/Scripts/pre_commit_lint.sh setup
应用使用 SwiftGen 为 Strings 包中的字符串生成类型安全的访问器。仅将新字符串添加到英文 Localizable.strings 中,然后从 libraries/Foundations/Strings 运行 swiftgen 并提交重新生成的 Strings.swift。所有其他语言来自 Crowdin,不得手动编辑。
请注意,未发布功能的名称以占位符形式检入,例如 $HERMES,构建步骤会在构建时使用 libraries/Foundations/Strings/Codewords.strings.env 中的映射替换它们。添加此类字符串时,请使用占位符而不是真实名称。
此发行版中的代码和数据文件根据自由软件基金会发布的 GPLv3 条款许可。请参阅 https://www.gnu.org/licenses/ 获取此许可证的副本。
Copyright (c) 2025 Proton Technologies AG