src/vs/platform/sandbox/common/terminalSandboxRuntimeConfigurationPerOperation.ts
117 LOC · 91 covered · 26 uncovered · 19 ranges · 1052 concepts · 3 introducers · 489 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
/*---------------------------------------------------------------------------------------------
terminalSandboxEngine.ts ×71
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { OperatingSystem } from '../../../base/common/platform.js';
import type { ITerminalSandboxCommand } from './terminalSandboxService.js';
import { type ITerminalSandboxCommandRule, matchesTerminalSandboxCommandRule } from './terminalSandboxCommandRules.js';
export const enum TerminalSandboxRuntimeConfigurationOperation {
GnuPG = 'gnupg',
Node = 'node',
}
const terminalSandboxRuntimeConfigurationCommandRules: readonly ITerminalSandboxCommandRule<TerminalSandboxRuntimeConfigurationOperation>[] = [
{
keywords: ['node', 'npm', 'npx', 'pnpm', 'yarn', 'corepack', 'bun', 'deno', 'nvm', 'volta', 'fnm', 'asdf', 'mise'],
value: TerminalSandboxRuntimeConfigurationOperation.Node,
},
{
keywords: ['git'],
value: TerminalSandboxRuntimeConfigurationOperation.GnuPG,
condition: ({ os }) => os !== OperatingSystem.Windows,
},
];
function getTerminalSandboxRuntimeConfigurationForOperation(operation: TerminalSandboxRuntimeConfigurationOperation, os: OperatingSystem): Record<string, unknown> {
terminalSandboxReadAllowList.ts ×15
switch (operation) {
case TerminalSandboxRuntimeConfigurationOperation.GnuPG:
switch (os) {
case OperatingSystem.Windows:
return {};
case OperatingSystem.Linux:
default:
return {
network: {
allowAllUnixSockets: true
},
filesystem: {
allowRead: [
'~/.gnupg'
],
allowWrite: [
'~/.gnupg'
]
}
};
}
case TerminalSandboxRuntimeConfigurationOperation.Node:
switch (os) {
case OperatingSystem.Windows:
return {};
case OperatingSystem.Macintosh:
case OperatingSystem.Linux:
default:
return {
filesystem: {
allowWrite: [
'~/.volta/'
]
}
};
}
}
export function getTerminalSandboxRuntimeConfigurationForCommands(os: OperatingSystem, commandDetails: readonly ITerminalSandboxCommand[]): Record<string, unknown> {
const operations = new Set<TerminalSandboxRuntimeConfigurationOperation>();
terminalSandboxEngine.ts ×11
for (const command of commandDetails) {
for (const rule of terminalSandboxRuntimeConfigurationCommandRules) {
terminalSandboxReadAllowList.ts ×15
if (matchesTerminalSandboxCommandRule(command, rule, { os }) && shouldApplyRuntimeConfigurationOperation(rule.value, commandDetails)) {
operations.add(rule.value);
}
}
}
const configuration: Record<string, unknown> = {};
for (const operation of operations) {
mergeAdditionalSandboxConfigProperties(configuration, getTerminalSandboxRuntimeConfigurationForOperation(operation, os));
terminalSandboxReadAllowList.ts ×15
}
}
function shouldApplyRuntimeConfigurationOperation(operation: TerminalSandboxRuntimeConfigurationOperation, commandDetails: readonly ITerminalSandboxCommand[]): boolean {
terminalSandboxReadAllowList.ts ×15
switch (operation) {
case TerminalSandboxRuntimeConfigurationOperation.GnuPG:
// Docker socket access can grant host-level privileges, so do not allow all Unix
// sockets when a Docker-related command is part of the sandbox invocation.
return commandDetails.every(command => !command.keyword.toLowerCase().startsWith('docker'));
case TerminalSandboxRuntimeConfigurationOperation.Node:
return true;
}
function mergeAdditionalSandboxConfigProperties(target: Record<string, unknown>, additional: Record<string, unknown>): void {
terminalSandboxReadAllowList.ts ×15
for (const [key, value] of Object.entries(additional)) {
if (!Object.prototype.hasOwnProperty.call(target, key)) {
target[key] = value;
continue;
}
const existingValue = target[key];
if (Array.isArray(existingValue) && Array.isArray(value)) {
terminalSandboxReadAllowList.ts ×15
target[key] = [...new Set([...existingValue, ...value])];
continue;
}
if (isObjectForSandboxConfigMerge(existingValue) && isObjectForSandboxConfigMerge(value)) {
terminalSandboxReadAllowList.ts ×15
mergeAdditionalSandboxConfigProperties(existingValue, value);
}
}
function isObjectForSandboxConfigMerge(value: unknown): value is Record<string, unknown> {
return typeof value === 'object' && value !== null && !Array.isArray(value);
}