工作区信任扩展指南
什么是工作区信任？
工作区信任是解决用户在 VS Code 中打开工作区时可能面临的意外代码执行安全风险的功能。例如，考虑一个语言扩展为了提供功能，可能会执行当前加载的工作区中的代码。在这种情况下，用户应该信任工作区的内容不是恶意的。工作区信任将此决定集中在 VS Code 内部，并支持受限模式以防止自动代码执行，这样扩展作者就不必自己处理此基础结构。VS Code 提供了静态声明和 API 支持，使扩展能够快速入门，无需在不同扩展之间重复代码。
入门
静态声明
在扩展的 package.json 中，VS Code 支持以下新的 capabilities 属性 untrustedWorkspaces
capabilities:
untrustedWorkspaces:
{ supported: true } |
{ supported: false, description: string } |
{ supported: 'limited', description: string, restrictedConfigurations?: string[] }
对于 supported 属性，接受以下值
true- 扩展在受限模式下完全受支持，因为它不需要工作区信任来执行任何功能。它将像以前一样启用。false- 扩展在受限模式下不受支持，因为它在没有工作区信任的情况下无法运行。它将保持禁用状态，直到授予工作区信任。'limited'- 扩展的某些功能在受限模式下受支持。敏感信任的功能应该在授予工作区信任之前禁用。扩展可以使用 VS Code API 来隐藏或禁用这些功能。工作区设置可以使用restrictedConfigurations属性自动受信任。
对于 description 属性，必须提供对为何需要信任的描述，以帮助用户了解哪些功能将被禁用，或者在授予或拒绝工作区信任之前应该审查什么。如果 supported 设置为 true，则忽略此属性。
description 属性的值应该添加到 package.nls.json 中，然后在 package.json 文件中引用，以支持本地化。
restrictedConfigurations 属性接受一个配置设置 ID 数组。对于列出的设置，当在不受信任的工作区的受限模式下时，扩展将不会获得工作区定义的值。
如何支持受限模式？
为了帮助扩展作者了解工作区信任的范围以及哪些类型的功能在受限模式下是安全的，这里列出了需要考虑的问题。
我的扩展是否有主入口点？
如果扩展没有 main 入口点（例如主题和语言语法），则扩展不需要工作区信任。扩展作者不需要对此类扩展采取任何措施，因为它们无论工作区是否受信任都将继续运行。
我的扩展是否依赖打开的工作区中的文件来提供功能？
这可能意味着可以通过工作区设置的设置或工作区中的实际代码。如果扩展从不使用工作区的任何内容，则可能不需要信任。否则，请查看其他问题。
我的扩展是否将工作区的任何内容视为代码？
最常见的例子是使用项目的 workspace dependencies，例如存储在本地工作区中的 Node.js 模块。恶意工作区可能会检查模块的受损版本。因此，这对用户和扩展来说都是一个安全风险。此外，扩展可能依赖控制扩展或其他模块行为的 JavaScript 或其他配置文件。还有许多其他例子，例如执行一个打开的代码文件以确定其输出用于错误报告。
我的扩展是否使用可以通过工作区定义的确定代码执行的设置？
您的扩展可能会将设置值用作扩展执行的 CLI 的标志。如果这些设置被恶意工作区覆盖，它们可能会被用作攻击扩展的载体。另一方面，如果设置的值仅用于检测某些条件，那么它可能不是安全风险，也不需要工作区信任。配置（设置）部分包含有关设置的指导，可帮助您找到适合您扩展的最佳配置。
这并不是需要工作区信任的所有情况的详尽列表。当我们审查更多扩展时，我们会更新此列表。在考虑工作区信任时，请使用此列表来思考您的扩展可能正在进行的类似行为。
如果我不更改扩展怎么办？
如上所述，未在其 package.json 中贡献任何内容的扩展将被视为不支持工作区信任。当工作区处于受限模式时，它将被禁用，并且会通知用户某些扩展由于工作区信任而无法工作。此措施对用户来说是最安全的。尽管这是默认行为，但最佳实践是设置适当的值，表明作为扩展作者，您已努力保护用户和您的扩展免受恶意工作区内容的侵害。
工作区信任 API
如上所述，使用 API 的第一步是将静态声明添加到 package.json。最简单的入门方法是为 supported 属性使用 false 值。再次强调，即使您什么都不做，这也是默认行为，但它向用户发出了一个好信号，表明您做出了有意的选择。在这种情况下，您的扩展无需执行其他任何操作。它将保持未激活状态，直到获得信任，然后您的扩展将知道它是在用户同意的情况下执行的。但是，如果您的扩展仅对部分功能需要信任，这可能不是最佳选择。
对于希望根据工作区信任来限制其功能的扩展，它们应该为 supported 属性使用 'limited' 值，并且 VS Code 提供了以下 API
export namespace workspace {
/**
* When true, the user has explicitly trusted the contents of the workspace.
*/
export const isTrusted: boolean;
/**
* Event that fires when the current workspace has been trusted.
*/
export const onDidGrantWorkspaceTrust: Event<void>;
}
使用 isTrusted 属性确定当前工作区是否受信任，并使用 onDidGrantWorkspaceTrust 事件监听何时授予工作区信任。您可以使用此 API 来阻止特定的代码路径，并在工作区受信任后执行任何必要的注册。
VS Code 还公开了一个上下文键 isWorkspaceTrusted，用于如下所述的 when 子句。
贡献点
命令、视图或其他 UI
当用户未信任工作区时，他们将在受限模式下运行，功能受限，主要用于浏览代码。您在受限模式下禁用的任何功能都应该对用户隐藏。这可以通过when 子句上下文和上下文键 isWorkspaceTrusted 来完成。即使命令未呈现在 UI 中，它仍然可以被调用，因此您应该根据扩展代码中的上述 API 来阻止执行或不注册命令。
配置（设置）
首先，您应该审查您的设置，以确定它们是否需要考虑信任。如上所述，工作区可以为您的扩展使用的设置定义一个对使用恶意的价值。如果您确定易受攻击的设置，您应该为 supported 属性使用 'limited'，并在 restrictedConfigurations 数组中列出设置 ID。
当您将设置 ID 添加到 restrictedConfigurations 数组时，VS Code 在受限模式下将仅返回用户定义的设置值。然后，您的扩展无需进行任何额外的代码更改来处理设置。授予信任后，除了工作区信任事件外，还将触发配置更改事件。
调试扩展
VS Code 将阻止在受限模式下进行调试。因此，调试扩展通常不需要信任，并且应该为 supported 属性选择 true。但是，如果您的扩展提供了不属于内置调试流程的额外功能、命令或设置，您应该使用 'limited' 并遵循上述指导。
任务提供程序
与调试类似，VS Code 阻止在受限模式下运行任务。如果您的扩展提供了不属于内置任务流程的额外功能、命令或设置，您应该使用 'limited' 并遵循上述指导。否则，您可以指定 supported: true。
测试工作区信任
有关启用和配置工作区信任的详细信息，请参阅工作区信任用户指南。