在 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 扩展生态系统极其丰富多样。人们创建了各种扩展,以帮助完成几乎任何编程任务或编辑器自定义。有些扩展提供完整的编程语言支持(IntelliSense、调试、代码分析),而另一些则让您可以播放音乐或拥有虚拟宠物

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

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 列表及其支持状态和版本。您可以通过 IntelliSense 建议选择任何已安装的扩展。

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