Skip to content

Expand the security policy now that private reporting is enabled - #150

Merged
jmanico merged 2 commits into
mainfrom
docs/security-policy
Sep 24, 2026
Merged

jmanico merged 2 commits into
mainfrom
docs/security-policy

Conversation

@jmanico

@jmanico jmanico commented Sep 24, 2026 •

Copy link
Copy Markdown
Member

Closes #107.

Problem

SECURITY.md sent reporters to the private advisory form, but private vulnerability reporting was disabled, so only admins could use it. The file also had no fallback contact, scope, or response expectations, and its version table didn't name the artifacts.

Change

Private vulnerability reporting is now enabled in the repository settings. gh api repos/OWASP/owasp-java-encoder/private-vulnerability-reporting returns {"enabled":true}, and the public Security tab shows Report a vulnerability.

  • SECURITY.md
    • Supported versions for all four Maven coordinates. Only the latest 1.x release gets fixes.
    • Upgrading the core encoder artifact needs no code changes: a javap -public diff of encoder-1.2.3.jar against encoder-1.4.0.jar shows no public members removed. The note also says 1.4.0 needs Java 8 (1.2.3 targeted Java 5).
    • Reporting through the Security Advisories page, with a note that the form needs a GitHub account and an email fallback to the project leaders (jeremy.long@owasp.org, from pom.xml, and jim@owasp.org, from the OWASP project leaders page).
    • What to include in a report, in-scope and out-of-scope issues (mirroring esapi/README.md for ESAPI), and response goals: acknowledgement in about a week and a 90-day disclosure window.
  • README.md
    • A short Security section that links the policy.
    • The release notes now say to update SECURITY.md when publishing a release.

Not included

The release-verification section (signatures and the signing-key fingerprint) waits until the key is published. That work is tracked in #110 and #95, and this PR adds no placeholder for it.

🤖 Generated with Claude Code

jmanico and others added 2 commits September 24, 2026 16:02
Private vulnerability reporting is now enabled for the repository, so
the advisory form SECURITY.md points to works for any GitHub user.

Rewrite SECURITY.md to cover:
- supported versions for all four Maven coordinates, with a note that
  upgrading the core artifact is drop-in (no public API removed
  between 1.2.3 and 1.4.0)
- the Security Advisories page, the GitHub-account requirement, and
  an email fallback to the project leaders
- what to include in a report, what is in and out of scope, and
  best-effort response goals

Link the policy from README.md, and add updating SECURITY.md to the
release notes.

Closes #107

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
encoder 1.2.3 targets Java 5 (class file major 49) and 1.4.0 targets
Java 8 (major 52). The public API is a superset, but the upgrade is not
drop-in for applications still on Java 5 through 7.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@jmanico
jmanico merged commit b52a954 into main Sep 24, 2026
11 checks passed
@jmanico
jmanico deleted the docs/security-policy branch September 24, 2026 23:13
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.

Enable private vulnerability reporting and expand SECURITY.md

1 participant