Skip to content

Repo hardening: fix install instructions, dead imports, hygiene#1

Open
cognis-digital wants to merge 3 commits into
mainfrom
cognis-audit/repo-hardening
Open

Repo hardening: fix install instructions, dead imports, hygiene#1
cognis-digital wants to merge 3 commits into
mainfrom
cognis-audit/repo-hardening

Conversation

@cognis-digital

@cognis-digital cognis-digital commented Jun 12, 2026

Copy link
Copy Markdown
Owner

This PR applies a few small, mechanically-verified hardening fixes found by an automated audit of the Cognis suite:

  • 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)

Each change is deterministic; all touched Python files were confirmed to still compile (py_compile) before this PR was opened.

- 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)

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your first PR! 🚀 A maintainer will review under the collaboration-pull model (see CONTRIBUTING.md).

@cognis-digital cognis-digital force-pushed the cognis-audit/repo-hardening branch from b1b7ad7 to 05e7178 Compare June 12, 2026 21:55
Cognis Digital 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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant