Skip to content
Explanation

Annex B Worked Example: Multi-Party CVD

The whole specification on one page

The specification is also published as a single page that holds every section and annex in order, for printing or for searching the whole text at once.

This page holds informative Annex B of the Vultron Protocol Specification: a Coordinated Vulnerability Disclosure (CVD) case with a coordinator and a second vendor. Its two-letter message codes, such as RS for Report Submission, are protocol shorthands, listed with their wire activities in §4.13 Formal Message Set.

Annex B — Worked Example: Multi-Party CVD [I]

This annex extends Annex A to a case with a coordinator and a second vendor. It shows the coordinator acting as proxy for the reporter, a participant joining a case that already has an active embargo, and the teardown-publish-close sequence across three parties.

Coordination With a Coordinator

The next two diagrams show how a Reporter engages a Coordinator, and how the Coordinator then engages a Vendor. In the first diagram, the Reporter sends a report together with an embargo proposal to the Coordinator (\(RS,EP\)). The Coordinator acknowledges receipt with an \(RK,EK\) response. After it evaluates the proposed embargo, the Coordinator accepts it with an EA message. Then the Coordinator validates and prioritizes the report, and sends an RV and an RA as it does so.

---
title: Reporter Engages Coordinator
---
sequenceDiagram
    actor Reporter
    actor Coordinator

    Reporter ->> Coordinator: RS,EP
    note right of Coordinator: Report Received
    note right of Coordinator: Embargo Proposed
    Coordinator -->> Reporter: RK,EK
    Coordinator ->> Reporter: EA
    activate Coordinator
    activate Reporter
    note right of Coordinator: Embargo Active
    Reporter -->> Coordinator: EK
    Coordinator ->> Reporter: RV
    note right of Coordinator: Report Valid
    Reporter -->> Coordinator: RK
    Coordinator ->> Reporter: RA
    note right of Coordinator: Report/Case Accepted
    Reporter -->> Coordinator: RK
    deactivate Coordinator
    deactivate Reporter

Coordinator-as-proxy can be sub-optimal

In this scenario, we show the Coordinator as a proxy between the Reporter and the Vendor. This is how people practiced CVD in the past, but it is not necessarily the most efficient way to operate. CVD Platforms like VINCE show that the process can be more efficient when CVD case participants share one space.

In the next diagram, the Coordinator acts as a proxy for the Reporter. The Coordinator notifies the Vendor and sends the embargo information in an \(RS,EP\) message of its own. The Vendor agrees to the existing embargo, and then validates (RV) and prioritizes (RA) the report. The case's embargo is already active, so the Vendor's agreement is its own consent to the embargo, an Accept of the Invite, and not an EA: EA is the decision that moves the case's embargo from proposed to active. The Coordinator passes the relevant responses from the Vendor to the Reporter.

The Vendor accepted the report for further work, so the Vendor then creates a fix for the reported vulnerability. When the fix is complete, the Vendor tells the Coordinator that it is ready. The Coordinator then sends this information to the Reporter in the CF message.

---
title: Coordinator Notifies Vendor
---
sequenceDiagram
    actor Reporter
    actor Coordinator
    actor Vendor

    Coordinator ->> Vendor: RS,EP
    Vendor -->> Coordinator: RK,EK,CV
    Coordinator ->> Reporter: CV
    Vendor --> Vendor: Evaluate Embargo
    Reporter -->> Coordinator: CK
    activate Vendor
    note right of Vendor: Embargo Active
    Vendor ->> Coordinator: Accept(Invite)
    activate Coordinator
    Coordinator ->> Reporter: Accept(Invite)
    activate Reporter
    Vendor --> Vendor: Validate Report
    Coordinator -->> Vendor: EK
    Reporter -->> Coordinator: EK

    note right of Vendor: Report Valid
    Vendor ->> Coordinator: RV
    Vendor --> Vendor: Prioritize Report
    Coordinator -->> Vendor: RK

    note right of Vendor: Report/Case Accepted
    Vendor ->> Coordinator: RA
    Vendor --> Vendor: Create Fix
    Coordinator -->> Vendor: RK

    note right of Vendor: Fix Ready
    Vendor ->> Coordinator: CF
    Coordinator ->> Reporter: CF

    Coordinator -->> Vendor: CK
    Reporter -->> Coordinator: CK
    deactivate Vendor
    deactivate Coordinator
    deactivate Reporter

Embargo Teardown, Publish, and Close

Any Participant can initiate an embargo teardown. In the following diagram, we show the case where the Coordinator initiates it. The Coordinator sends an embargo termination message (ET) to all parties in the case. In this scenario, these parties are the Reporter and the Vendor. Recipients of the ET message acknowledge receipt and update their EM state to match.

Embargo Teardown, Publication, and Closure Can Start with Any Participant

For all three scenarios in this section, Participants do not have to act in a specific order. We could also show the Reporter as it initiates an embargo teardown because of a leaked media report. Or we could show the Vendor as it exits an embargo early because their fix was ready sooner than expected.

---
title: Coordinator Initiates Embargo Teardown
---
sequenceDiagram
    actor Reporter
    actor Coordinator
    actor Vendor

    Coordinator ->> Reporter: ET
    Coordinator ->> Vendor: ET
    note right of Vendor: Embargo Terminated
    Reporter -->> Coordinator: EK
    Vendor -->> Coordinator: EK

Embargo Termination is not Publication

Our protocol only sets a discrete end to the embargo. It intentionally does not address a publication schedule. After the embargo has been exited, any Participant may publish at any time.

Participants can choose to coordinate their publication schedules more closely, but the protocol does not require it. Some situations might need more concise publication scheduling. We examine this concern again in Process Implementation Notes.

Publishing After Embargo Teardown

After the embargo has been exited, any Participant may now publish. In the following figure, we show the Vendor as it publishes first. The Vendor tells the Coordinator that it has published. It uses a CP message, which says that information about the vulnerability is now public.

The Coordinator relays this information to the Reporter. Both the Reporter and the Coordinator publish their own reports shortly thereafter.

---
title: Publishing After Embargo Teardown
---
sequenceDiagram
    actor Reporter
    actor Coordinator
    actor Vendor

    Vendor --> Vendor: Publish
    note right of Vendor: Public Aware
    Vendor ->> Coordinator: CP
    Coordinator ->> Reporter: CP
    Reporter -->> Coordinator: CK
    Reporter --> Reporter: Publish
    Reporter ->> Coordinator: CP
    Coordinator ->> Vendor: CP
    Coordinator -->> Reporter: CK
    Vendor -->> Coordinator: CK
    Coordinator --> Coordinator: Publish
    Coordinator ->> Reporter: CP
    Coordinator ->> Vendor: CP
    Reporter -->> Coordinator: CK
    Vendor -->> Coordinator: CK

Report Closure is a Per-Participant Choice

Report closure is a per-Participant choice. We chose to show a simple case where all Participants agreed at approximately the same time that no more work was necessary. Participants will not always agree at the same time, and they do not have to.

Closing the Case

In the next diagram, the Reporter has no more work to do on the case. So the Reporter closes their report and tells the Coordinator with an RC message. This prompts the Coordinator to review their open tasks and decide to close their own report. Then the Coordinator relays this to the Vendor, who also closes their report.

---
title: Participants Close Their Reports
---
sequenceDiagram
    actor Reporter
    actor Coordinator
    actor Vendor

    Reporter --> Reporter: Close
    Reporter ->> Coordinator: RC
    Coordinator -->> Reporter: RK
    Coordinator --> Coordinator: Close
    Coordinator ->> Vendor: RC
    Vendor -->> Coordinator: RK
    Vendor --> Vendor: Close
    note right of Vendor: Case Closed
    Vendor ->> Coordinator: RC
    Coordinator -->> Vendor: RK

Runnable scenarios

The reference implementation ships these flows as executable scenarios, which are the most current statement of what it supports: