-
Notifications
You must be signed in to change notification settings - Fork 19
fix(iscsi): block device allowlist confinement #432
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
Open
ambient-code
wants to merge
3
commits into
main
Choose a base branch
from
fix/352-iscsi-block-device-confinement
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+174
−2
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
python/packages/jumpstarter-driver-iscsi/jumpstarter_driver_iscsi/driver_test.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| """Tests for iSCSI driver block device allowlist and path confinement.""" | ||
|
|
||
| import os | ||
| import sys | ||
|
|
||
| import pytest | ||
|
|
||
| if sys.platform != "linux": | ||
| pytest.skip("iSCSI driver requires Linux (libudev)", allow_module_level=True) | ||
|
|
||
| from jumpstarter_driver_iscsi.driver import ISCSI, ISCSIError | ||
|
|
||
|
|
||
| @pytest.fixture | ||
| def tmp_root(tmp_path): | ||
| return str(tmp_path) | ||
|
|
||
|
|
||
| def _make_driver(tmp_root, block_device_allowlist=None): | ||
| """Create an ISCSI driver instance without initializing rtslib.""" | ||
| driver = object.__new__(ISCSI) | ||
| driver.root_dir = tmp_root | ||
| driver.block_device_allowlist = block_device_allowlist or [] | ||
| return driver | ||
|
|
||
|
|
||
| class TestGetFullPathBlock: | ||
| """Tests for _get_full_path with is_block=True.""" | ||
|
|
||
| def test_block_empty_allowlist_rejects(self, tmp_root): | ||
| driver = _make_driver(tmp_root, block_device_allowlist=[]) | ||
| with pytest.raises(ISCSIError, match="block_device_allowlist is empty"): | ||
| driver._get_full_path("/dev/sda", is_block=True) | ||
|
|
||
| def test_block_not_in_allowlist_rejects(self, tmp_root): | ||
| driver = _make_driver(tmp_root, block_device_allowlist=["/dev/sdb"]) | ||
| with pytest.raises(ISCSIError, match="not in the configured allowlist"): | ||
| driver._get_full_path("/dev/sda", is_block=True) | ||
|
|
||
| def test_block_in_allowlist_accepted(self, tmp_root): | ||
| driver = _make_driver(tmp_root, block_device_allowlist=["/dev/sda"]) | ||
| result = driver._get_full_path("/dev/sda", is_block=True) | ||
| assert result == "/dev/sda" | ||
|
|
||
| def test_block_relative_path_rejected(self, tmp_root): | ||
| driver = _make_driver(tmp_root, block_device_allowlist=["/dev/sda"]) | ||
| with pytest.raises(ISCSIError, match="must be an absolute path"): | ||
| driver._get_full_path("dev/sda", is_block=True) | ||
|
|
||
| def test_block_symlink_resolved(self, tmp_root): | ||
| """Symlinks are resolved before checking the allowlist.""" | ||
| real_dev = os.path.join(tmp_root, "real_device") | ||
| link_path = os.path.join(tmp_root, "link_device") | ||
| # Create a real file and symlink | ||
| with open(real_dev, "w") as f: | ||
| f.write("") | ||
| os.symlink(real_dev, link_path) | ||
|
|
||
| driver = _make_driver(tmp_root, block_device_allowlist=[real_dev]) | ||
| result = driver._get_full_path(link_path, is_block=True) | ||
| assert result == real_dev | ||
|
|
||
| def test_block_symlink_not_in_allowlist(self, tmp_root): | ||
| """Symlink target not in allowlist should be rejected.""" | ||
| real_dev = os.path.join(tmp_root, "real_device") | ||
| link_path = os.path.join(tmp_root, "link_device") | ||
| with open(real_dev, "w") as f: | ||
| f.write("") | ||
| os.symlink(real_dev, link_path) | ||
|
|
||
| driver = _make_driver(tmp_root, block_device_allowlist=[link_path]) | ||
| with pytest.raises(ISCSIError, match="not in the configured allowlist"): | ||
| driver._get_full_path(link_path, is_block=True) | ||
|
|
||
|
|
||
| class TestGetFullPathFile: | ||
| """Tests for _get_full_path with is_block=False (unchanged behavior).""" | ||
|
|
||
| def test_file_relative_path_confined(self, tmp_root): | ||
| driver = _make_driver(tmp_root) | ||
| result = driver._get_full_path("subdir/test.img", is_block=False) | ||
| assert result.startswith(tmp_root) | ||
|
|
||
| def test_file_absolute_path_rejected(self, tmp_root): | ||
| driver = _make_driver(tmp_root) | ||
| with pytest.raises(ISCSIError, match="Invalid file path"): | ||
| driver._get_full_path("/etc/passwd", is_block=False) | ||
|
|
||
| def test_file_traversal_rejected(self, tmp_root): | ||
| driver = _make_driver(tmp_root) | ||
| with pytest.raises(ISCSIError, match="Invalid file path"): | ||
| driver._get_full_path("../../etc/passwd", is_block=False) |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess this parameter would need to be documented in the README.md of the driver.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch! I've added
block_device_allowlistto both the config parameters table and the YAML example in the driver README (commit 9232932).