Skip to content

Introduce a mechanism to reserve OSEC identifiers - #43

Merged
hannesm merged 4 commits into
ocaml:mainfrom
edwintorok:main
Oct 28, 2026
Merged

hannesm merged 4 commits into
ocaml:mainfrom
edwintorok:main

Conversation

@edwintorok

@edwintorok edwintorok commented Sep 28, 2026 •

Copy link
Copy Markdown
Collaborator

OSEC advisory identifiers can be reserved by creating an empty advisories/<year>/OSEC-<year>-NNN.md file.

Reservations only works with completely empty advisories to avoid leaking details about upcoming vulnerabilities.
The reservation is then considered owned by the person creating the reservation PR, and can be updated with the actual contents once the fix is public. (ownership isn't enforced, but if we consider an OSEC identifier assigned once a PR with an empty file is merged to main then that'll prevent duplicate assignments)

This avoids "race conditions" when multiple security reports are in flight, and fixes are released out of order. Projects may wish to embed an OSEC identifier into their commit messages, so it'd be nice if this didn't change, once it has been assigned.

@edwintorok
edwintorok marked this pull request as ready for review September 28, 2026 13:30
@edwintorok
edwintorok marked this pull request as draft September 28, 2026 13:33
@edwintorok
edwintorok marked this pull request as ready for review September 28, 2026 13:38
@edwintorok
edwintorok requested a review from hannesm September 28, 2026 13:41
@edwintorok
edwintorok force-pushed the main branch 2 times, most recently from edaee29 to f3193f3 Compare October 28, 2026 09:17
@hannesm

hannesm commented Oct 28, 2026

Copy link
Copy Markdown
Member

thanks. all that is needed is a brief paragraph in the README

edwintorok and others added 3 commits October 28, 2026 09:31
When multiple advisories are handled concurrently it might be useful
to assign a different OSEC identifier to each (e.g. these may be included into
commit messages).
Meanwhile other PRs can get created on this repo that may reuse an
already assigned identifier (and if a duplicate identifier makes its way
into a release it'll be difficult to change later).

Make OSEC identifier reservation explicit:
* either an empty file
* or a regular advisory

Advisory reservation is implemented by skipping the file in the 2
workflows.

Signed-off-by: Edwin Török <edwin@tarides.com>
Signed-off-by: Edwin Török <edwin@tarides.com>
Signed-off-by: Edwin Török <edwin@etorok.net>
@edwintorok

Copy link
Copy Markdown
Collaborator Author

thanks. all that is needed is a brief paragraph in the README

I added another commit for that, and mentioned that this is intended for internal coordination within the security team.

Reservation is done with an empty file on purpose: to avoid leaking
details about vulnerabilities.
However this doesn't prevent accidentally mentioning something in the
commit message or PR comment. Add a reminder.

Signed-off-by: Edwin Török <edwin@etorok.net>
@hannesm

hannesm commented Oct 28, 2026

Copy link
Copy Markdown
Member

thanks

@hannesm
hannesm merged commit bbb98af into ocaml:main Oct 28, 2026
1 check passed
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