Skip to content

Add security policy naming the Security Maintainer - #1797

Merged
tleonhardt merged 1 commit into
mainfrom
security-policy
Oct 31, 2026
Merged

tleonhardt merged 1 commit into
mainfrom
security-policy

Conversation

@tleonhardt

Copy link
Copy Markdown
Member

Summary

Adds .github/SECURITY.md so the project has a published security policy with a named Security Maintainer.

  • Security Maintainer: names Todd Leonhardt (tleonhardt) as the sole Security Maintainer, who also holds the GitHub Security manager organization role in python-cmd2.
  • Supported versions: only the latest 4.x release gets security fixes, since all releases are published from main and there are no maintenance branches.
  • Reporting: directs reporters to GitHub private vulnerability reporting (now enabled for this repo) rather than public issues, PRs, or discussions, and lists what details to include.
  • Response and disclosure: good-faith targets for acknowledgement (7 days) and initial assessment (14 days); fixes ship in a patched release alongside a GitHub Security Advisory, with a CVE when appropriate and credit for the reporter.
  • Scope: clarifies that intended behavior of builtin features that reach the OS or a Python interpreter (shell/!, edit, run_script/@, run_pyscript, py, ipy, redirection and pipes) is not a vulnerability, links to the docs for removing or disabling them, and states that bypassing those safeguards is in scope.

Notes

  • .github/* is already owned by @tleonhardt in CODEOWNERS, so no CODEOWNERS change is needed.
  • No CHANGELOG entry, since this does not change the library.
  • Once merged to main, GitHub will show the policy on the repository's Security tab and community profile.

Test plan

  • make check passes (prettier and typos also run directly on the new file)
  • make test passes
  • make docs-test passes
  • All links in the policy resolve, including the #remove-builtin-commands and #disabling-redirection anchors

Add .github/SECURITY.md, which names @tleonhardt as the project's sole
Security Maintainer, directs reporters to GitHub private vulnerability
reporting, states the supported versions and disclosure process, and
clarifies that intended behavior of builtin features such as shell,
edit, run_pyscript, and redirection is out of scope.
@codecov

codecov Bot commented Oct 31, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.75%. Comparing base (599cd1d) to head (7506d0a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1797   +/-   ##
=======================================
  Coverage   99.75%   99.75%           
=======================================
  Files          23       23           
  Lines        6574     6574           
=======================================
  Hits         6558     6558           
  Misses         16       16           
Flag Coverage Δ
unittests 99.75% <ø> (ø)

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

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

@tleonhardt tleonhardt self-assigned this Oct 31, 2026
@tleonhardt
tleonhardt merged commit c6c664b into main Oct 31, 2026
32 checks passed
@tleonhardt
tleonhardt deleted the security-policy branch October 31, 2026 16:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant