Add individual hash command to target-shell #1517

skepppy · 2026-01-26T21:54:14Z

This PR adds the commands md5sum, sha1sum and sha256sum to target-shell.

Closes #1516.

codecov · 2026-01-26T22:00:03Z

Codecov Report

❌ Patch coverage is 85.71429% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 80.78%. Comparing base (f787f5a) to head (fc2b41a).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
dissect/target/tools/shell.py	85.71%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1517      +/-   ##
==========================================
+ Coverage   80.75%   80.78%   +0.02%     
==========================================
  Files         396      396              
  Lines       34750    34771      +21     
==========================================
+ Hits        28063    28089      +26     
+ Misses       6687     6682       -5

Flag	Coverage Δ
unittests	`80.78% <85.71%> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codspeed-hq · 2026-01-26T22:02:38Z

Merging this PR will not alter performance

✅ 11 untouched benchmarks

_{Comparing skepppy:add/hash-command-target-shell (fc2b41a) with main (f787f5a)}

Schamper

The alias and docstring comments also for the other ones.

Schamper · 2026-01-27T09:10:47Z

dissect/target/tools/shell.py

        return False

+    @arg("path")
+    @alias("md5sum")


No need to add alias, they're already named the same.

Ahh, I'll remove them.

Schamper · 2026-01-27T09:11:28Z

dissect/target/tools/shell.py

+    @arg("path")
+    @alias("md5sum")
+    def cmd_md5sum(self, args: argparse.Namespace, stdout: TextIO) -> bool:
+        """Print the MD5 hash of the file"""


Suggested change

"""Print the MD5 hash of the file"""

"""print the MD5 hash of the file"""

Schamper · 2026-01-27T09:12:04Z

dissect/target/tools/shell.py

+        path = self.check_file(args.path)
+        if not path:


Suggested change

path = self.check_file(args.path)

if not path:

if not (path := self.check_file(args.path)):

Schamper · 2026-01-27T09:12:35Z

tests/tools/test_shell.py


+def test_target_cli_hashsums(tmp_path: Path, target_unix: Target, capsys: pytest.CaptureFixture) -> None:
+    target_unix.fs.map_file_fh("/test-file", BytesIO(b"Hello world!"))
+    out_file = tmp_path / "checksum.txt"


Why not read stdout?

I was piping my commands to md5sum thinking it would pipe the output to the cmd_md5sum() call, but it would invoke Linux' md5sum, resulting in capsys.readstdouterr() having no data in its stdout, which I thought was because it didn't work on my machine. That's why I piped it to a file, but I changed it now.

yunzheng

Instead of calculating the default md5, sha1 and sha256 hashes, specify the algo via hash().

yunzheng · 2026-01-27T12:05:42Z

dissect/target/tools/shell.py

+        if not path:
+            return False
+
+        _, _, sha256 = path.get().hash()


Suggested change

_, _, sha256 = path.get().hash()

sha256, *_ = path.get().hash(["sha256"])

yunzheng · 2026-01-27T12:06:03Z

dissect/target/tools/shell.py

+        if not path:
+            return False
+
+        _, sha1, _ = path.get().hash()


Suggested change

_, sha1, _ = path.get().hash()

sha1, *_ = path.get().hash(["sha1"])

yunzheng · 2026-01-27T12:06:23Z

dissect/target/tools/shell.py

+        if not path:
+            return False
+
+        md5, _, _ = path.get().hash()


Suggested change

md5, _, _ = path.get().hash()

md5, *_ = path.get().hash(["md5"])

Schamper

Same for the rest.

The docstrings in this file as specifically formatted like this to look the most "CLI-like" when used as help messages. Perhaps there should be a comment explaining that in this file.

Schamper · 2026-01-29T12:34:00Z

dissect/target/tools/shell.py

+        """print the MD5 checksum of a file provided by a path or from stdin.
+
+        Args:
+            args (argparse.Namespace): the arguments passed to md5sum.
+            stdout (TextIO): the file handle to write the md5sum output to.
+
+        Returns:
+            bool: always False, since True indicates the CLI should exit.
+        """


Suggested change

"""print the MD5 checksum of a file provided by a path or from stdin.

Args:

args (argparse.Namespace): the arguments passed to md5sum.

stdout (TextIO): the file handle to write the md5sum output to.

Returns:

bool: always False, since True indicates the CLI should exit.

"""

"""print the MD5 checksum of a file at the given path"""

skepppy force-pushed the add/hash-command-target-shell branch from 0493abb to c27b643 Compare January 26, 2026 21:55

Schamper requested changes Jan 27, 2026

View reviewed changes

yunzheng requested changes Jan 27, 2026

View reviewed changes

skepppy added 2 commits January 27, 2026 12:57

Add md5sum, sha1sum, and sha256sum to target-shell

e5f4138

Add test cases for md5sum, sha1sum, and sha256sum in target-shell

8c94292

skepppy force-pushed the add/hash-command-target-shell branch from c27b643 to 8c94292 Compare January 27, 2026 13:04

Schamper changed the title ~~Add/hash command target shell~~ Add individual hash command to target-shell Jan 27, 2026

Apply reviewer changes

dc3f7f8

skepppy force-pushed the add/hash-command-target-shell branch 3 times, most recently from 7059b97 to 93022e2 Compare January 27, 2026 22:20

Schamper requested changes Jan 29, 2026

View reviewed changes

Implement other review changes

c581405

skepppy force-pushed the add/hash-command-target-shell branch from 93022e2 to c581405 Compare January 30, 2026 13:41

Schamper approved these changes Jan 30, 2026

View reviewed changes

Merge branch 'main' into add/hash-command-target-shell

fc2b41a

Schamper merged commit 2294418 into fox-it:main Jan 30, 2026
22 of 24 checks passed

	"""Print the MD5 hash of the file"""
	"""print the MD5 hash of the file"""

	path = self.check_file(args.path)
	if not path:
	if not (path := self.check_file(args.path)):

	_, _, sha256 = path.get().hash()
	sha256, *_ = path.get().hash(["sha256"])

	_, sha1, _ = path.get().hash()
	sha1, *_ = path.get().hash(["sha1"])

	md5, _, _ = path.get().hash()
	md5, *_ = path.get().hash(["md5"])

Add individual hash command to target-shell #1517

Add individual hash command to target-shell #1517

Conversation

skepppy commented Jan 26, 2026

Uh oh!

codecov bot commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codspeed-hq bot commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merging this PR will not alter performance

Uh oh!

Schamper left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yunzheng left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Schamper left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Jan 26, 2026 •

edited

Loading

codspeed-hq bot commented Jan 26, 2026 •

edited

Loading

yunzheng left a comment •

edited

Loading