|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +## Supported Versions |
| 4 | + |
| 5 | +We prioritize the security of our users and ensure that our library is as secure as possible. Currently, we provide security updates primarily for the latest major version of Piscina. |
| 6 | + |
| 7 | +Older versions might receive security updates depending on the severity of the vulnerability and the maintainers' bandwidth, but this is not guaranteed. |
| 8 | + |
| 9 | +| Version | Supported | |
| 10 | +| ------- | ------------------ | |
| 11 | +| 6.x-rc | ⚠️ | |
| 12 | +| 5.x | :white_check_mark: | |
| 13 | +| 4.x | :white_check_mark: | |
| 14 | +| 3.x | :x: | |
| 15 | + |
| 16 | + |
| 17 | +## Scope & Threat Model |
| 18 | + |
| 19 | +Piscina is a fast, efficient Node.js Worker Thread Pool implementation. Due to the nature of offloading tasks to separate threads, we are particularly interested in vulnerabilities related to: |
| 20 | + |
| 21 | +* **Thread Isolation Bypass:** Cross-thread data leakage or unexpected state sharing between separate worker threads. |
| 22 | +* **Arbitrary Code Execution (ACE):** Ability for an attacker to manipulate the `filename` or task execution parameters to run unauthorized code. |
| 23 | +* **Denial of Service (DoS):** Exploits capable of locking up the main thread, bypassing `maxQueue` constraints, or exhausting memory resources in ways the library intends to prevent. |
| 24 | + |
| 25 | +## Reporting a Vulnerability |
| 26 | + |
| 27 | +👮 **Responsible Disclosure** |
| 28 | + |
| 29 | +**Do not open public issues that might have security implications.** It is critical that security-related issues are reported privately so we have time to address them before they become public knowledge. |
| 30 | + |
| 31 | +Individuals who find potential vulnerabilities in Piscina are invited to report them privately using the following channels: |
| 32 | + |
| 33 | +1. **GitHub Security Advisories:** You can privately report a vulnerability directly via the [GitHub Security Advisory feature](https://github.com/piscinajs/piscina/security/advisories/new) on the Piscina repository. |
| 34 | + |
| 35 | +### What to Include in the Report |
| 36 | + |
| 37 | +To help us properly address the issue, please include the following in your report: |
| 38 | + |
| 39 | +- A detailed description of the vulnerability and its potential impact. |
| 40 | +- Steps to reproduce the issue (a minimal reproduction repository or code snippet is highly appreciated). |
| 41 | +- The version(s) of `piscina` and `Node.js` affected. |
| 42 | +- Any potential mitigation or workarounds you might have found. |
| 43 | + |
| 44 | +## Disclosure Policy |
| 45 | + |
| 46 | +When you report a vulnerability, we will strive to follow this process: |
| 47 | + |
| 48 | +1. **Acknowledgement:** We will acknowledge receipt of your vulnerability report within 3 working days. |
| 49 | +2. **Triage:** We will triage the issue, confirm the vulnerability, and determine its severity. |
| 50 | +3. **Patching:** We will work on a patch to address the vulnerability in a private fork. |
| 51 | +4. **Release:** A new version of the package will be released with the patch. |
| 52 | +5. **Public Disclosure:** Once the fix is released, we will publish a public security advisory on GitHub, giving you proper credit for the discovery (unless you prefer to remain anonymous). |
| 53 | + |
| 54 | +We ask that you operate in good faith and refrain from sharing the vulnerability publicly until a fix has been released and the official advisory is published. |
0 commit comments