尝试以扩展 VS Code 中的代理模式!

工作区信任

Visual Studio Code 非常重视安全性,并希望帮助你安全地浏览和编辑代码,无论其来源或原始作者是谁。工作区信任功能允许你决定项目文件夹中的代码是否可以在未经你明确批准的情况下由 VS Code 和扩展执行。

Trust this folder dialog

注意:如有疑问,请将文件夹保留在受限模式。你始终可以在以后启用信任

安全的代码浏览

公共仓库和文件共享中提供了如此多的源代码,这真是太棒了。无论编码任务或问题是什么,很可能某个地方已经有了很好的解决方案。同时,有如此多强大的编码工具可帮助你理解、调试和优化代码,这也很棒。然而,使用开源代码和工具确实存在风险,你可能会面临恶意代码执行和漏洞利用的威胁。

当在“受限模式”下打开工作区时,工作区信任通过阻止工作区中任何代码的自动执行,为处理不熟悉的代码提供了一层额外的安全性。

注意:“工作区”和“文件夹”这两个术语在 VS Code UI 和文档中广泛使用。你可以将“工作区”视为一个由 VS Code 创建和使用的带有额外元数据的文件夹。

受限模式

当出现工作区信任对话框时,如果你选择不,我不信任作者,VS Code 将进入受限模式以防止代码执行。

工作台顶部会显示一个横幅,其中包含一个指向“工作区信任”编辑器中管理文件夹的链接。在状态栏中,你还会看到一个徽章,指示工作区处于受限模式。

Workspace Trust Restricted Mode banner

受限模式试图通过禁用或限制多个 VS Code 功能的操作来阻止自动代码执行:任务、调试、工作区设置和扩展。

要查看受限模式中禁用的完整功能列表,你可以通过横幅中的管理链接,或选择状态栏中的“受限模式”徽章,来打开“工作区信任”编辑器。

Workspace Trust editor

重要:工作区信任无法阻止恶意扩展执行代码并忽略受限模式。你只应安装和运行来自你信任的知名发布者的扩展。

任务

VS Code 任务可以运行脚本和工具二进制文件。由于任务定义在工作区 `“.vscode”` 文件夹中定义,它们是仓库提交源代码的一部分,并共享给该仓库的每个用户。如果有人创建恶意任务,任何克隆该仓库的人都可能在不知情的情况下运行它。

如果你在受限模式下尝试运行甚至枚举任务(任务 > 运行任务),VS Code 会显示一个提示,要求你确认信任该文件夹并可以继续执行任务。如果你取消对话框,VS Code 将保持受限模式。

Workspace Trust Restricted Mode tasks dialog

调试

与运行 VS Code 任务类似,调试扩展在启动调试会话时可以运行调试器二进制文件。因此,当文件夹在受限模式下打开时,调试也会被禁用。

如果你在受限模式下尝试启动调试会话(调试 > 启动调试),VS Code 会显示一个提示,要求你确认信任该文件夹并可以继续启动调试器。如果你取消对话框,VS Code 将保持受限模式,并且不会启动调试会话。

Workspace Trust Restricted Mode debugging dialog

工作区设置

工作区设置存储在工作区根目录的 `.vscode` 文件夹中,因此由克隆工作区仓库的任何人共享。某些设置包含可执行文件的路径(例如,linter 二进制文件),如果将其设置为指向恶意代码,可能会造成损害。因此,VS Code 在受限模式下运行时会禁用一组工作区设置。

Workspace Trust editor workspace settings link

在“工作区信任”编辑器中,选择未应用的“工作区设置”链接,以调出按 `@tag:requireTrustedWorkspace` 标签限定范围的“设置”编辑器。

Settings editor scoped by the requireTrustedWorkspace tag in a restricted workspace

扩展

VS Code 扩展生态系统极其丰富多样。人们创建了扩展,可以帮助完成几乎任何编程任务或编辑器自定义。有些扩展提供完整的编程语言支持(智能感知、调试、代码分析),而另一些则允许你播放音乐或拥有虚拟宠物

大多数扩展代表你运行代码,并可能造成损害。有些扩展的设置如果配置为运行意外的可执行文件,可能会导致它们恶意行为。因此,未明确选择工作区信任的扩展在受限模式下默认是禁用的。

Workspace Trust disabled extensions link

你可以通过选择“工作区信任”编辑器中的扩展被禁用或功能受限链接来查看已安装扩展的状态,该链接会显示使用 `@workspaceUnsupported` 筛选器限定范围的“扩展”视图。

Extensions view filtered by workspaceUnsupported showing disabled and limited extensions

未选择工作区信任的扩展可以在受限模式下被禁用或受限。

在受限模式下禁用

未明确表示支持在受限模式下运行的扩展显示在在受限模式下禁用部分。如果扩展作者确定其扩展可能被工作区中的修改(设置或文件)滥用,他们也可以指示他们永远不想在受限模式下启用。

在受限模式下受限

扩展作者还可以评估其扩展可能存在的安全漏洞,并声明在受限模式下运行时具有受限支持。此模式意味着扩展可能会禁用某些特性或功能以防止可能的漏洞利用。

扩展可以在“扩展”视图的“工作区信任”徽章中添加自定义文本,解释在不受信任的文件夹中运行时存在的限制。例如,VS Code 内置的 PHP 扩展限制了 php.validate.executablePath 设置在受信任的文件夹中使用,因为覆盖此设置可能会运行恶意程序。

PHP extension limited in Restricted Mode hover

你可以使用 extensions.supportUntrustedWorkspaces 设置覆盖扩展的“工作区信任”支持级别,详见下方启用扩展部分。

如果你在受限模式下尝试安装扩展,系统会提示你信任工作区或仅安装扩展。如果扩展不支持工作区信任,它将安装,但会被禁用或以有限功能运行。

Workspace Trust install an extension in Restricted Mode dialog

注意:扩展作者可以通过阅读工作区信任扩展指南了解如何更新其扩展以支持工作区信任。

信任工作区

如果你信任一个项目的作者和维护者,你可以信任你本地机器上该项目的文件夹。例如,通常可以安全地信任来自知名 GitHub 组织(如 github.com/microsoft 或 github.com/docker)的仓库。

当你打开一个新文件夹时,最初的“工作区信任”提示会让你信任该文件夹及其子文件夹。

Trust this folder dialog

你还可以调出“工作区编辑器”,并通过选择信任信任父级按钮来快速切换文件夹的信任状态。

Workspace Trust editor Trust buttons

有几种方法可以调出“工作区信任”编辑器对话框。

在受限模式下

  • 受限模式横幅中的管理链接
  • 受限模式状态栏项

你也可以随时使用

  • 通过命令面板(⇧⌘P (Windows, Linux Ctrl+Shift+P))运行工作区:管理工作区信任命令

选择文件夹

当你信任一个文件夹时,它会被添加到“工作区信任”编辑器中显示的受信任的文件夹和工作区列表。

Workspace Trust editor Trusted Folders and Workspaces list

你可以手动添加、编辑和从该列表中删除文件夹,以启用或禁用工作区信任。活动文件夹在此列表中以粗体突出显示。

选择父文件夹

当你通过“工作区信任”编辑器信任一个文件夹时,你可以选择也信任父文件夹。这将把信任应用到父文件夹及其所有子文件夹。

Workspace Trust editor showing the Trust Parent button

如果你在同一个文件夹下有许多包含受信任内容的文件夹,信任父文件夹会很有帮助。

当你打开一个受信任父文件夹下的子文件夹时,你将不会看到通常的不信任按钮让你返回受限模式。相反,会有文本提示你的文件夹由于另一个文件夹而被信任。

你可以从受信任的文件夹和工作区列表中添加、修改和删除父文件夹条目。

文件夹配置

当你信任一个父文件夹时,所有子文件夹都会被信任,这使你可以通过存储库在磁盘上的位置来控制工作区信任。

例如,你可以将所有受信任的仓库放在“TrustedRepos”父文件夹下,而将不熟悉的仓库放在另一个父文件夹下,例如“ForEvaluation”。你会信任“TrustedRepos”文件夹,并选择性地信任“ForEvaluation”下的文件夹。

├── TrustedRepos - Clone trusted repositories under this parent folder
└── ForEvaluation - Clone experimental or unfamiliar repositories under this parent folder

你还可以通过将仓库分组到特定组织的父文件夹下,来对它们进行分组和设置信任。

├── github/microsoft - Clone a specific organization's repositories under this parent folder
├── github/{myforks} - Place your forked repositories under this parent folder
└── local - Local un-published repositories

启用扩展

如果你想使用受限模式,但你喜欢的扩展不支持工作区信任,该怎么办?这种情况可能会发生,因为某个扩展虽然有用且功能齐全,但并未积极维护,也未声明其工作区信任支持。为了处理这种情况,你可以使用 extensions.supportUntrustedWorkspaces 设置来覆盖该扩展的信任状态。

重要:请谨慎覆盖扩展的工作区信任支持。扩展作者可能因为有充分的理由才在受限模式下禁用其扩展。如有疑问,请联系扩展作者或查看最近的变更日志以获取更多背景信息。

在“设置”编辑器中(⌘, (Windows, Linux Ctrl+,)),你可以通过扩展:支持不受信任的工作区设置(extensions.supportUntrustedWorkspaces)来覆盖单个扩展的工作区信任。

Extension support

选择在 settings.json 中编辑链接,管理扩展 ID 及其支持状态和版本列表。你可以通过智能感知建议选择任何已安装的扩展。

下面是 Prettier 扩展的 `settings.json` 条目。

  "extensions.supportUntrustedWorkspaces": {
    "esbenp.prettier-vscode": {
      "supported": true,
      "version": "6.4.0"
    },
  },

你可以使用 `supported` 属性启用或禁用工作区信任支持。 `version` 属性指定适用的确切扩展版本,如果你想为所有版本设置状态,则可以删除版本字段。

如果你想了解更多关于扩展作者如何评估和确定在受限模式下限制哪些功能的信息,你可以阅读工作区信任扩展指南

打开不受信任的文件

如果你打开一个位于不受信任文件夹之外的文件,VS Code 会检测到该文件来自文件夹根目录之外的位置,并提示你选择继续打开文件,或者在新窗口中以受限模式打开文件。以受限模式打开是最安全的选择,一旦你确定文件是可信的,你随时可以在原始 VS Code 窗口中重新打开该文件。

Untrusted files dialog

如果你不想在打开来自不受信任工作区的文件时收到提示,你可以将 security.workspace.trust.untrustedFiles 设置为 `open`。你也可以将 security.workspace.trust.untrustedFiles 设置为 `newWindow`,以始终在受限模式下创建新窗口。勾选不受信任文件对话框中的记住我对所有工作区的决定选项会将你的选择应用到 security.workspace.trust.untrustedFiles 用户设置。

打开不受信任的文件夹

在使用包含多个文件夹的多根工作区时,如果你尝试向受信任的多根工作区添加一个新文件夹,系统会提示你决定是否信任该文件夹中的文件,否则整个工作区将切换到受限模式。

Untrusted folder dialog

空窗口(未打开文件夹)

默认情况下,如果你打开一个新的 VS Code 窗口(实例)而没有打开文件夹或工作区,VS Code 会以完全信任模式运行该窗口。所有已安装的扩展都被启用,你可以无限制地使用空窗口。

当你打开一个文件时,系统会提示你是否要打开一个不受信任的文件,因为没有父文件夹。

你可以通过使用“工作区信任”编辑器(在命令面板中选择工作区:管理工作区信任),然后选择不信任,将空窗口切换到受限模式。该空窗口在当前会话中保持受限模式,但如果你重启或创建新窗口,它将恢复为受信任模式。

如果你希望所有空窗口都处于受限模式,你可以将 security.workspace.trust.emptyWindow 设置为 `false`。

设置

以下是可用的工作区信任设置

命令行开关

你可以通过在 VS Code 命令行中传递 `--disable-workspace-trust` 来禁用工作区信任。此开关仅影响当前会话。

后续步骤

了解更多信息:

常见问题

在受限模式下我还能编辑源代码吗?

是的,你仍然可以在受限模式下浏览和编辑源代码。某些语言功能可能会被禁用,但文本编辑始终受支持。

我安装的扩展去哪儿了?

在受限模式下,任何不支持工作区信任的扩展都将被禁用,并且所有 UI 元素(如活动栏图标和命令)都不会显示。

你可以使用 extensions.supportUntrustedWorkspaces 设置覆盖扩展的工作区信任支持级别,但请务必小心。启用扩展中提供了更多详细信息。

我可以禁用工作区信任功能吗?

你可以,但不建议这样做。如果你不希望 VS Code 在打开新文件夹或仓库时检查工作区信任,你可以将 security.workspace.trust.enabled 设置为 false。VS Code 将表现得与 1.57 版本发布之前一样。

如何取消信任文件夹/工作区?

调出“工作区信任”编辑器(通过命令面板运行工作区:管理工作区信任)并选择不信任按钮。你也可以从受信任的文件夹和工作区列表中移除该文件夹。

为什么我没有看到“不信任”按钮?

如果你在“工作区信任”对话框中没有看到不信任按钮,则该文件夹的信任级别可能继承自父文件夹。请查看受信任的文件夹和工作区列表,检查是否有父文件夹已启用工作区信任。

某些工作流程,例如连接到 GitHub Codespace连接到正在运行的 Docker 容器,会自动受信任,因为这些是受管理的环境,你对此应该已经有很高的信任度。

工作区信任可以防止什么?

VS Code 的许多功能允许第三方工具和扩展自动运行,例如保存时进行代码检查或格式化,或者在你执行编译代码或调试等特定操作时。不道德的人可能会制作一个看似无害的项目,它会在你不知情的情况下运行恶意代码并损害你的本地机器。工作区信任通过尝试阻止代码执行,在你评估不熟悉源代码的安全性和完整性时,提供了一层额外的安全性。