saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

salt.utils.verify.clean_path: make filesystem link resolution optinally

Browse source
This commit is contained in:
hurzhurz 2024-04-23 10:33:29 +02:00 • committed by Daniel Wozniak
parent 6052a1ede2
commit d2e2bf7db8
2 changed files with 20 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
salt/utils/verify.py
View file

@ -513,25 +513,28 @@ def _realpath(path):
return os.path.realpath(path)
def clean_path(root, path, subdir=False):
def clean_path(root, path, subdir=False, realpath=True):
"""
Accepts the root the path needs to be under and verifies that the path is
under said root. Pass in subdir=True if the path can result in a
subdirectory of the root instead of having to reside directly in the root
subdirectory of the root instead of having to reside directly in the root.
Pass realpath=False if filesystem links should not be resolved.
"""
real_root = _realpath(root)
if not os.path.isabs(real_root):
if not os.path.isabs(root):
return ""
root = os.path.normpath(root)
if not os.path.isabs(path):
path = os.path.join(root, path)
path = os.path.normpath(path)
real_path = _realpath(path)
if realpath:
root = _realpath(root)
path = _realpath(path)
if subdir:
if real_path.startswith(real_root):
return real_path
if os.path.commonpath([path, root]) == root:
return path
else:
if os.path.dirname(real_path) == os.path.normpath(real_root):
return real_path
if os.path.dirname(path) == root:
return path
return ""

8
tests/pytests/unit/utils/verify/test_clean_path_link.py
View file

@ -65,3 +65,11 @@ def test_clean_path_symlinked_tgt(setup_links):
expect_path = str(to_path / "test")
ret = salt.utils.verify.clean_path(str(from_path), str(test_path))
assert ret == expect_path, f"{ret} is not {expect_path}"
def test_clean_path_symlinked_src_unresolved(setup_links):
to_path, from_path = setup_links
test_path = from_path / "test"
expect_path = str(from_path / "test")
ret = salt.utils.verify.clean_path(str(from_path), str(test_path), realpath=False)
assert ret == expect_path, f"{ret} is not {expect_path}"