Skip to content

docs(security): refresh policy and link published advisories - #375

Merged
cyfyifanchen merged 1 commit into
mainfrom
docs/security-policy-refresh
Jul 30, 2026
Merged

docs(security): refresh policy and link published advisories#375
cyfyifanchen merged 1 commit into
mainfrom
docs/security-policy-refresh

Conversation

@dani1005

Copy link
Copy Markdown
Collaborator

Summary

SECURITY.md had drifted: the supported-versions section still read "EverOS is
released and at v1.0.0 (stable)" and listed all of 1.x as supported, two minor
releases behind. This refreshes it and fills two gaps that
GHSA-grm3-hcqf-hm28
made visible.

  • Supported versions are now expressed as a line (1.2.x (current))
    rather than a pinned patch number, so the section does not go stale on the
    next release — which is how the old text ended up two minors behind.
  • New "Published Advisories" section pointing at /security/advisories,
    with a note to read the affected range on the advisory rather than comparing
    version numbers. Ranges are not always a simple "everything below X".
  • New threat-model bullet: ingested documents are untrusted input. The
    existing first bullet covers who can call the API (loopback-only by
    default). It does not cover the case where the caller is trusted but the
    filenames, metadata, and content it forwards are not — which is the shape of
    the traversal fixed in 1.2.1.
  • Reporters are credited in the advisory as well as the release notes, matching
    what we actually do.

Reporting stays email-only. GitHub private vulnerability reporting is
deliberately left disabled: the documented 5-business-day acknowledgement is
easier to honour through one monitored inbox than through GitHub notifications
on this repo.

Area

  • Architecture method
  • Benchmark
  • Use case
  • Documentation
  • Developer experience
  • CI, build, or release

Verification

python3 scripts/check_commit_messages.py HEAD^..HEAD   -> pass
No line in the diff exceeds 80 columns (matches surrounding style).
Advisory URL resolves; no relative links added.
Documentation-only change; no code or tests affected.

Checklist

  • I kept the change scoped to the relevant area.
  • I am opening this from a separate branch, not pushing directly to main.
  • I updated docs, examples, or setup notes when behavior changed.
  • I added or updated tests when the change affects behavior. (N/A — docs only)
  • I did not commit secrets, .env files, dependency folders, or generated output.
  • Active relative links in Markdown files resolve.

Notes for Reviewers

The supported-versions table is a policy statement, so it is worth an
explicit look: it now says 1.1.x and older receive no backports. That matches
the previous wording ("applied to the latest release line only") and the current
reality that this repository has no maintenance branches — only main. If the
intent is to keep patching a 1.1.x line, this table needs to say so instead.

By submitting this pull request, I agree that my contribution is licensed under
the Apache License 2.0.

The supported-versions section still said "released and at v1.0.0" and
listed all of `1.x` as supported, which had drifted two minor releases.
It is now stated as a line ("1.2.x (current)") rather than a pinned
patch number, so it does not go stale on the next release.

Also:

- Point readers at /security/advisories, and tell them to read the
  affected range on the advisory rather than comparing version numbers.
- Add a threat-model bullet for ingested documents. The loopback-only
  default covers who can call the API, but filenames, metadata, and
  content arriving from elsewhere are untrusted regardless of how the
  API is reached.
- Note that reporters are credited in the advisory as well as the
  release notes, which is what we do in practice.

Reporting stays email-only; GitHub private vulnerability reporting is
deliberately left disabled so the documented 5-business-day response
runs through one monitored inbox.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@dani1005 dani1005 changed the title docs(security): refresh supported versions and link published advisories docs(security): refresh policy and link published advisories Jul 30, 2026
@dani1005
dani1005 requested a review from cyfyifanchen July 30, 2026 05:53
@cyfyifanchen
cyfyifanchen merged commit 4c2ae84 into main Jul 30, 2026
14 of 15 checks passed
@cyfyifanchen
cyfyifanchen deleted the docs/security-policy-refresh branch July 30, 2026 05:55
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.

2 participants