Repo hardening: fix install instructions, dead imports, hygiene#1
Open
cognis-digital wants to merge 3 commits into
Open
Repo hardening: fix install instructions, dead imports, hygiene#1cognis-digital wants to merge 3 commits into
cognis-digital wants to merge 3 commits into
Conversation
- fix 2 broken `pip install` line(s) in README (package is not on PyPI; use the working git+https install) - remove 5 unused import(s) (ruff F401/F811)
b1b7ad7 to
05e7178
Compare
added 2 commits
June 13, 2026 04:14
…anguage overview and install instructions - keyhunt/core.py: extend hardcoded-password regex to also match admin_password and root_password field names (underscore-separated compound names were blocked by the lookbehind exclusion class) - demos/01-basic/firmware_dump.txt: update telnet line from "telnetd -l /bin/sh" (shell path, not a credential) to "busybox telnetd -l admin" so the telnet-default-cred detector fires as the demo scenario intends - README.md: add "What is this?" plain-language section and comprehensive Install section - install.sh / install.ps1: cross-platform install scripts (pipx/uv/pip) - layman.md: non-technical description of the tool
- core.py: add TOOL_NAME/TOOL_VERSION constants so the module is self-contained; add scan() and to_json() public aliases used by mcp_server and external callers; scan_path now raises FileNotFoundError on a missing root instead of silently returning []. - cli.py: remove the triple-redundant fmt resolution; wrap parse_args so a SystemExit propagates the correct code; route the no-subcommand help to stderr; narrow the except clause to OSError/FileNotFoundError with a last-resort catch-all. - mcp_server.py: fix broken imports (scan/to_json now exist in core); guard keyhunt_scan against FileNotFoundError; fix E501 docstring. - integrations/webhook.py: split multi-import line (ruff E401). - tests/test_hardening.py: 18 new tests covering empty bytes, empty dir, missing root, unreadable file, entropy edge cases, to_dict redact flag, to_json, and CLI error paths.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR applies a few small, mechanically-verified hardening fixes found by an automated audit of the Cognis suite:
pip installline(s) in README (package is not on PyPI; use the working git+https install)Each change is deterministic; all touched Python files were confirmed to still compile (
py_compile) before this PR was opened.