Skip to content

Security: cardano-foundation/antithesis

SECURITY.md

Security Vulnerability Disclosure Policy

Introduction

The Antithesis project's purpose is to offer a shared platform to experiment with the security of the Cardano network through models, simulations and testing of nodes and applications. As such, it's entirely possible and actually expected those experiments will lead to exposing new security issues in the underlying Software Under Test (SUT), or even the protocol implementation. This Security Vulnerability Disclosure Policy outlines how security vulnerabilities should be reported and how we will respond to and remediate such reports.

Security Vulnerability Handling Process

Reporting a Vulnerability

Due to the peculiar nature of this project, we need to distinguish three different types of security vulnerability reports:

  1. Reports about vulnerabilities in the Antithesis code and infrastructure,
  2. Reports about vulnerabilities in one or more SUTs exposed through the use of Antithesis code and infrastructure,
  3. Reports about vulnerabilities in one or more SUTs related to Cardano but exposed independently of the use Antithesis.

Vulnerabilities in Antithesis code and infrastructure

If you discover a security vulnerability in the code or infrastructure of Antithesis, we encourage you to responsibly disclose it to us. To report a vulnerability, please use the private reporting form on GitHub to draft a new Security advisory.

Please include as much details as needed to clearly qualify the issue:

  • A description of the vulnerability and its potential impact.
  • Steps to reproduce the vulnerability.
  • The commit SHA of antithesis code where the vulnerability exists.
  • Any relevant proof-of-concept or exploit code (if applicable).

Processing Vulnerability

  1. Acknowledgment: The team acknowledges the receipt of your report within 3 business days by commenting on the issue reporting it or replying to email.

  2. Validation: The team investigates the issue and either reject or validate the reported vulnerability.

    a. Rejection: If the team rejects the report, detailed explanations will be provided by email or commenting on the relevant issue and the latter will be made public and closed as Won't fix.

    b. Acceptance: If the team accepts the report, a CVE identifier will be requested through GitHub and a private fork opened to work on a fix to the issue

  3. Resolution: The team works to resolve the vulnerability in a timely manner. The timeline for resolution will depend on the complexity and severity of the vulnerability, but we will strive to address critical vulnerabilities as quickly as possible.

  4. Collaboration: While working on a fix, the team maintains open and transparent communication with the reporter throughout the process, providing updates on the status of the vulnerability and any steps taken to remediate it. In particular this means that the reporter will be asked to review any proposed fix and to advise on the timing for public disclosure.

  5. Fixing Issue: The team agrees on the fix, the announcement, and the release schedule with the reporter. If the reporter is not responsive in a reasonable time frame this should not block the team from moving to the next steps particularly in the face of a high impact or high severity issue.

    a. Mitigation: Depending on the severity and criticity of the issue, the team can decide to disclose the issue publicly in the absence of a fix if and only if a clear, simple, and effective mitigation plan is defined. This must include instructions for users and operators of the software, and a time horizon at which the issue will be properly fixed (eg. version number).

    b. Fix: When a fix is available and approved, it should be merged and made available as quickly as possible:

    • All commits to the private repository are squashed into a single commit whose description should not make any reference it relates to a security vulnerability
    • A new Pull Request is created with this single commit
    • This PR's review and merging is expedited as all the work as already been done
  6. Release: The team creates and publish a release that includes the fix

  7. Announcement: Concommitant to the release annoucement, the team announces the security vulnerability by making the GitHub issue public. This is the first point that any information regarding the vulnerability is made public.

    a. Credit: The team publicly acknowledges the contributions of the reporter once the vulnerability is resolved, subject to the reporter's preferences for attribution.

  8. Disagreements: In case of disagreements with the reporter on the fix, mitigation, timing, or announcement, the team has the final say.

Vulnerabilities in SUTs exposed through Antithesis

If you discover a security vulnerability in a component or protocol through the use of Antithesis code and infrastructure, we encourage you to responsibly disclose it to us. To report a vulnerability, please use the private reporting form on GitHub to draft a new Security advisory.

Please include as much details as needed to clearly qualify the issue:

  • A description of the vulnerability and its potential impact.
  • Steps to reproduce the vulnerability.
  • The commit SHA of antithesis code where the vulnerability exists.
  • Any relevant proof-of-concept or exploit code (if applicable).

Processing Vulnerability

  1. Acknowledgment: The team acknowledges the receipt of your report within 3 business days by commenting on the issue reporting it or replying to email.

  2. Validation: The team investigates the issue and either reject or validate the reported vulnerability.

    a. Rejection: If the team rejects the report, detailed explanations will be provided by email or commenting on the relevant issue and the latter will be made public and closed as Won't fix.

    b. Acceptance: If the team accepts the report, suspecting there's a vulnerability in one of the tested components, it will assist the reporter in engaging with the relevant team(s). From that point on, each team's security policy will apply.

Vulnerabilities in SUTs exposed outside of Antithesis

If you discover a security vulnerability in a Cardano component or protocol through independent analysis, eg. outside of Antithesis, please checkout the component's security policy for instructions on how to proceed. Vulnerability reports that are not tied to code and infrastructure offered by Antithesis will be rejected.

Responsible Disclosure

We kindly request that reporters adhere to responsible disclosure practices, which include:

  • Do not disclose the vulnerability publicly: Please refrain from posting details of the vulnerability on public forums or social media until it has been resolved.
  • Do not exploit the vulnerability: Do not attempt to exploit the vulnerability to cause harm or gain unauthorized access to systems.
  • Work with us: Allow us a reasonable amount of time to investigate and address the vulnerability before publicly disclosing any details.

Legal Protections

We will not pursue legal action against individuals who report security vulnerabilities to us.

Contact Information

To report a security vulnerability, please use GitHub form.

Revision of Policy

This Security Vulnerability Disclosure Policy may be updated or revised as necessary. Please check the latest version of this policy on the Antithesis repository.

There aren’t any published security advisories