Skip to content
Reference

rv-csaf Scenario: Reporter + Vendor, a Case from a CSAF Report

Overview

The rv-csaf scenario shows a case that starts from a Common Security Advisory Framework (CSAF) 2.1 vulnerability report. The Reporter sends the Vendor a report with a CSAF document attached, and states no report name, no summary and no embargo end. The case takes all three from the document: its name is the document's title, its summary is the document's summary note, and its embargo ends at the document's disclosure date. After the case starts, the scenario goes on as the rv scenario does.

Participants:

  • Reporter — discovers the vulnerability and submits the report; in the case it holds the Reporter role; the protocol has no separate Finder role (ADR-0078).
  • Vendor — publishes a default embargo, receives the report, validates it, and owns the case.
  • Case Actor — the actor that holds the CASE_MANAGER role for this case; it writes every canonical ledger entry and fans it out to the participants. In the demo it runs on the dedicated case-actor container, but its authority comes from the role, not from where it runs.

Protocol narrative

1. Vendor publishes a default embargo

Before the report arrives, the Vendor publishes a 30-day default embargo on its own actor profile. This default is what the Reporter's terms compete with when the case is created. The policy is not a case-ledger entry, because the case does not exist yet.

2. Reporter sends a CSAF vulnerability report

The Reporter writes a CSAF 2.1 document of category csaf_vulnerability_report. The document has a title, a summary note, and one vulnerability whose disclosure date is 10 days away. The Reporter calls its submit-report trigger with the document attached and with no report name, summary or embargo end. The report's content says that the CSAF document is attached, because a CSAF document does not fill a report's content. The trigger checks the document against the CSAF 2.1 schema and refuses a document that is not schema-valid. The trigger then fills the report's name and summary from the document, and proposes an embargo that ends at the document's disclosure date. The Vendor receives an Offer that carries the report, the document and the proposed embargo.

Antecedent: the Reporter has a CSAF document that this project wrote, schema-valid against the pinned CSAF 2.1 revision.

3. Vendor validates the report and engages the case

The Vendor validates the report and engages the case, as in rv. The Case Actor creates the case from the document on the Offer that the Vendor's case proposal carries. The case's name is the document's title, and the case's summary is the document's summary note. The two embargo terms compete by shortest-wins. The document's 10-day term is shorter than the Vendor's 30-day default, so it becomes the active embargo. The Vendor's default is registered as a pending revision, and the case starts in the Embargo Management (EM) state REVISE. The Case Actor relays the revision to the Reporter, whose terms won, and the Reporter accepts it.

Antecedent: the Offer reached the Vendor (step 2).

4. The scenario checks the case against the document

The scenario first checks that the report on the Offer is named with the document's title, and that the Offer proposes an embargo that ends at the document's disclosure date. It then reads the canonical case on the Case Actor's container. It checks that the case's name is the document's title and its summary is the document's summary note. It checks that the active embargo ends at the document's disclosure date, and that the pending revision runs the Vendor's 30-day default.

5. The case continues as in rv

The Reporter asks the Vendor about a workaround, and the Vendor answers. The Vendor reports its fix ready. The Vendor publishes, which ends the embargo, and then the Reporter publishes. The Reporter closes the case, and then the Vendor, the Case Owner, closes it last.

Antecedent: engage_case is present in the ledger.

Unobservable edges

Unobservable step Why not in ledger
Vendor publishes its default embargo A policy on the Vendor's own profile; no case exists yet.
Reporter submits the CSAF report to the Vendor Report submission is an out-of-band API call; the case does not yet exist when the report is submitted.

The story as the code tells it

This is the plot of the scenario as the demo code composes it, generated from that code. It is here so a reader can check the narrative above against what the demo actually runs; where the two disagree, the narrative is the one written independently, so read it as the claim and this as the evidence.

  1. Reporter decides: Send the Vendor a CSAF vulnerability report
  2. The Vendor sets its default embargo; the Reporter sends a CSAF report.
  3. The case takes its name, summary and embargo end from the CSAF report.
  4. The Reporter asks whether a workaround exists; the Vendor answers.
  5. The Vendor reports fix ready and stops at VFd (CSB-15-002).
  6. The Vendor, the Case Owner, publishes first; then the Reporter.
  7. The Reporter leaves; the Vendor, the Case Owner, leaves last.