Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: whitelist some commands #190

Merged
merged 1 commit into from
Oct 23, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions gptme/tools/shell.py
Original file line number Diff line number Diff line change
Expand Up @@ -243,15 +243,27 @@ def execute_shell(
"""Executes a shell command and returns the output."""
shell = get_shell()
assert not args
whitelist_commands = ["ls", "stat", "cd", "cat", "pwd", "echo"]
whitelisted = True

cmd = code.strip()
if cmd.startswith("$ "):
cmd = cmd[len("$ ") :]

print_preview(cmd, "bash")
if not confirm("Run command?"):
yield Message("system", "Command not run")
return
#NOTE: This does not handle control flow words like if, for, while.
regex = r"(?:^|[|&;]|\|\||&&|\n)\s*([^\s|&;]+)"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested the regex extensively but I guess it's the most unpredictable bit here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


for match in re.finditer(regex, cmd):
Comment on lines +253 to +256
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should compile this regex

for group in match.groups():
if group and group not in whitelist_commands:
whitelisted = False
break

if not whitelisted:
print_preview(cmd, "bash")
if not confirm("Run command?"):
yield Message("system", "Command not run")
return

try:
returncode, stdout, stderr = shell.run(cmd)
Expand All @@ -261,7 +273,7 @@ def execute_shell(
stdout = _shorten_stdout(stdout.strip(), pre_tokens=2000, post_tokens=8000)
stderr = _shorten_stdout(stderr.strip(), pre_tokens=2000, post_tokens=2000)

msg = _format_block_smart("Ran command", cmd, lang="bash") + "\n\n"
msg = _format_block_smart(f"Ran {'whitelisted ' if whitelisted else ''}command", cmd, lang="bash") + "\n\n"
if stdout:
msg += _format_block_smart("", stdout, "stdout") + "\n\n"
if stderr:
Expand Down
Loading