Skip to content

Commit

Permalink
feat(terminal): restrict default allowed commands to 'ls' and 'echo'
Browse files Browse the repository at this point in the history
Change the default value of `terminal.allowCommands` from an empty array to `['ls', 'echo']`. This change prevents users from running all available commands by default in tutorials, enhancing security and focus. Lesson authors can still allow all commands by specifying `terminal.allowCommands: []` in the metadata.

BREAKING CHANGE: The default value of `terminal.allowCommands` is now restricted to `['ls', 'echo']`. To allow all commands, explicitly set `terminal.allowCommands: []` in the metadata.

Closes #302
  • Loading branch information
RonithManikonda committed Oct 13, 2024
1 parent e335d17 commit bd8c5fc
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ You can set terminal open by default by specifying the `open` value.

An interactive terminal will disable the output redirect syntax by default. For instance, you cannot create a file `world.txt` with the contents `hello` using the command `echo hello > world.txt`. The reason is that this could disrupt the lesson if a user overwrites certain files. To allow output redirection, you can change the behavior with the `allowRedirects` setting. You can define this setting either per panel or for all panels at once.

Additionally, you may not want users to run arbitrary commands. For example, if you are creating a lesson about `vitest`, you could specify that the only command the user can run is `vitest` by providing a list of `allowCommands`. Any other command executed by the user will be blocked. You can define the `allowCommands` setting either per panel or for all panels at once.
Additionally, you may not want users to run arbitrary commands. For example, if you are creating a lesson about vitest, you could specify that the only command the user can run is vitest by providing a list of allowCommands. By default, the allowed commands are ls and echo. Providing a list of allowCommands will override these defaults, and specifying an empty list will allow all commands. Any other command executed by the user will be blocked. You can define the allowCommands setting either per panel or for all panels at once.

By default, in every new lesson terminals start a new session. If you want to keep the terminal session between lessons, you can specify the `id` property for a given terminal panel and keep the same `id` across lessons.
<PropertyTable inherited type="Terminal" />
Expand Down
19 changes: 17 additions & 2 deletions packages/runtime/src/webcontainer/terminal-config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,9 @@ export class TerminalPanel implements ITerminal {
}
}

// set the default commands for the terminal
const DEFAULT_COMMANDS = ['ls', 'echo'];

/**
* Normalize the provided configuration to a configuration which is easier to parse.
*
Expand Down Expand Up @@ -232,9 +235,21 @@ function normalizeTerminalConfig(config?: TerminalSchema): NormalizedTerminalCon

const panels: TerminalPanel[] = [];

const resolveAllowCommands = (allowCommands?: string[]): string[] | undefined => {
if (allowCommands === undefined) {
return DEFAULT_COMMANDS;
}

if (Array.isArray(allowCommands) && allowCommands.length === 0) {
return undefined;
}

return allowCommands;
};

const options = {
allowRedirects: config.allowRedirects,
allowCommands: config.allowCommands,
allowCommands: resolveAllowCommands(config.allowCommands),
};

if (config.panels) {
Expand All @@ -258,7 +273,7 @@ function normalizeTerminalConfig(config?: TerminalSchema): NormalizedTerminalCon
id: panel.id,
title: panel.title,
allowRedirects: panel.allowRedirects ?? config.allowRedirects,
allowCommands: panel.allowCommands ?? config.allowCommands,
allowCommands: panel.allowCommands ?? DEFAULT_COMMANDS,
});
}

Expand Down

0 comments on commit bd8c5fc

Please sign in to comment.