Ignore environment_path in loaded project files (#2110)

A .jedi/project.json can be part of a checked out repository, so honouring its environment_path let an untrusted file point Jedi at a binary to execute. Rather than trying to gate that binary (the ownership heuristic in _is_unix_safe_simple is meaningless on Windows, where st_uid is always 0), drop environment_path from loaded project files entirely, the same way load_unsafe_extensions is already ignored. It stays available when a Project is constructed directly by the user.
This commit is contained in:
Dhanu-dynamic
2026-09-29 13:58:51 +00:00
committed by GitHub
parent ed47f89162
commit f37a9f9feb
2 changed files with 13 additions and 25 deletions
+9 -11
View File
@@ -63,9 +63,6 @@ class Project:
Additionally there are functions to search a whole project. Additionally there are functions to search a whole project.
""" """
_environment = None _environment = None
# Set for projects loaded from a ``.jedi/project.json``. That file can be
# part of a checked out repository, so it is not trusted to run binaries.
_loaded_from_file = False
@staticmethod @staticmethod
def _get_config_folder_path(base_path): def _get_config_folder_path(base_path):
@@ -90,12 +87,14 @@ class Project:
if version == 1: if version == 1:
# A code base must not be able to enable the loading of its own # A code base must not be able to enable the loading of its own
# extensions, see the docs about security. # extensions or point Jedi at a binary to execute, see the docs
# about security. The project file can be part of a checked out
# repository, so these settings are ignored for loaded projects.
if data.pop('load_unsafe_extensions', False): if data.pop('load_unsafe_extensions', False):
debug.warning('load_unsafe_extensions is ignored for loaded projects') debug.warning('load_unsafe_extensions is ignored for loaded projects')
project = cls(**data) if data.pop('environment_path', None) is not None:
project._loaded_from_file = True debug.warning('environment_path is ignored for loaded projects')
return project return cls(**data)
else: else:
raise WrongVersion( raise WrongVersion(
"The Jedi version of this project seems newer than what we can handle." "The Jedi version of this project seems newer than what we can handle."
@@ -107,7 +106,6 @@ class Project:
""" """
data = dict(self.__dict__) data = dict(self.__dict__)
data.pop('_environment', None) data.pop('_environment', None)
data.pop('_loaded_from_file', None)
data.pop('_django', None) # TODO make django setting public? data.pop('_django', None) # TODO make django setting public?
data = {k.lstrip('_'): v for k, v in data.items()} data = {k.lstrip('_'): v for k, v in data.items()}
data['path'] = str(data['path']) data['path'] = str(data['path'])
@@ -252,10 +250,10 @@ class Project:
def get_environment(self): def get_environment(self):
if self._environment is None: if self._environment is None:
if self._environment_path is not None: if self._environment_path is not None:
# An environment path from a loaded project file is checked # environment_path can only be set by the user directly, it is
# like a scanned virtualenv, see find_virtualenvs. # never loaded from a project file, so it is trusted.
self._environment = create_environment( self._environment = create_environment(
self._environment_path, safe=self._loaded_from_file) self._environment_path, safe=False)
else: else:
self._environment = get_cached_default_environment() self._environment = get_cached_default_environment()
return self._environment return self._environment
+4 -14
View File
@@ -7,7 +7,6 @@ import pytest
from ..helpers import get_example_dir, set_cwd, root_dir, test_dir from ..helpers import get_example_dir, set_cwd, root_dir, test_dir
from jedi import Interpreter from jedi import Interpreter
from jedi.api import Project, get_default_project from jedi.api import Project, get_default_project
from jedi.api.environment import InvalidPythonEnvironment
from jedi.api.project import _is_potential_project, _CONTAINS_POTENTIAL_PROJECT from jedi.api.project import _is_potential_project, _CONTAINS_POTENTIAL_PROJECT
@@ -56,11 +55,9 @@ def test_load_save_project(tmpdir):
assert loaded.added_sys_path == ['/foo'] assert loaded.added_sys_path == ['/foo']
def test_load_project_checks_environment_path(tmpdir, monkeypatch): def test_load_project_ignores_environment_path(tmpdir, monkeypatch):
# The project file can be part of a checked out repository, so the binary # The project file can be part of a checked out repository, so it must not
# it points to has to pass the same check as in find_virtualenvs. # be able to point Jedi at a binary to execute.
monkeypatch.setattr('jedi.api.environment._is_safe', lambda executable_path: False)
def _get_subprocess(self): def _get_subprocess(self):
raise RuntimeError('Should not get called!') raise RuntimeError('Should not get called!')
@@ -68,14 +65,7 @@ def test_load_project_checks_environment_path(tmpdir, monkeypatch):
_get_subprocess) _get_subprocess)
Project(tmpdir.strpath, environment_path=sys.executable).save() Project(tmpdir.strpath, environment_path=sys.executable).save()
with pytest.raises(InvalidPythonEnvironment): assert Project.load(tmpdir.strpath)._environment_path is None
Project.load(tmpdir.strpath).get_environment()
def test_load_project_safe_environment_path(tmpdir):
Project(tmpdir.strpath, environment_path=sys.executable).save()
environment = Project.load(tmpdir.strpath).get_environment()
assert environment.executable == sys.executable
def test_load_project_ignores_unsafe_extensions(tmpdir): def test_load_project_ignores_unsafe_extensions(tmpdir):