|
1 | | -# Security policy |
| 1 | +# Security Policy |
2 | 2 |
|
3 | | -DeckProbe treats all input documents as untrusted. |
| 3 | +DeckProbe is designed with a security-first mindset: **all input documents are treated as untrusted**. The engine inspects PDF, Microsoft Office, and Apple iWork files without rendering them or launching desktop office suites, minimizing attack surface while extracting targeted metadata. |
4 | 4 |
|
5 | | -Please report suspected vulnerabilities privately through GitHub Security Advisories for the `deckflow/deckprobe` repository. Do not open a public issue containing exploit documents, private files, passwords, or customer data. |
| 5 | +## Supported Versions |
6 | 6 |
|
7 | | -Only the latest published beta or stable minor version receives security fixes. |
| 7 | +We actively maintain and provide security updates for the following versions: |
| 8 | + |
| 9 | +| Version | Status | |
| 10 | +| ------- | --------------- | |
| 11 | +| Latest stable minor (X.Y) | ✅ Supported | |
| 12 | +| Latest beta (X.Y-beta.Z) | ✅ Supported | |
| 13 | +| Older minor versions | ❌ Unsupported | |
| 14 | + |
| 15 | +We strongly recommend running the latest published stable or beta release to benefit from the most recent security hardening. |
| 16 | + |
| 17 | +## Reporting a Vulnerability |
| 18 | + |
| 19 | +We appreciate responsible disclosure of security issues. If you discover a vulnerability, please follow these steps: |
| 20 | + |
| 21 | +### 1. **Do Not** Create Public Issues |
| 22 | +Avoid opening public GitHub issues, discussions, or posting details on social media that could expose users to risk before a fix is available. This includes: |
| 23 | +- Malicious sample documents |
| 24 | +- Exploit code or proof-of-concept scripts |
| 25 | +- Sensitive data (passwords, customer information, internal paths) |
| 26 | + |
| 27 | +### 2. Submit a Private Report |
| 28 | +Report suspected vulnerabilities **privately** via one of these channels: |
| 29 | + |
| 30 | +- **GitHub Security Advisories**: Use the ["Report a vulnerability"](https://github.com/deckflow/deckprobe/security/advisories/new) feature in the `deckflow/deckprobe` repository. |
| 31 | +- **Email**: Send details to [security@deckprobe.dev](mailto:security@deckprobe.dev) (if you prefer email). |
| 32 | + |
| 33 | +For sensitive reports, you may encrypt your message using our PGP key (available upon request or via GitHub Security Advisories). |
| 34 | + |
| 35 | +### 3. What to Include |
| 36 | +To help us triage efficiently, please provide: |
| 37 | +- A clear description of the vulnerability and its potential impact |
| 38 | +- Steps to reproduce (including sample files, if safe to share privately) |
| 39 | +- Affected DeckProbe version(s) and platform (CLI, SDK, browser) |
| 40 | +- Any known workarounds or mitigations |
| 41 | + |
| 42 | +## Our Commitment to You |
| 43 | + |
| 44 | +- **Acknowledgment**: We will confirm receipt of your report within **48 hours**. |
| 45 | +- **Assessment**: We aim to evaluate severity and provide an initial response within **5 business days**. |
| 46 | +- **Resolution Timeline**: For confirmed vulnerabilities, we target a fix within **30 days**, depending on complexity. |
| 47 | +- **Disclosure Coordination**: We will coordinate with you on public disclosure timing. Typically, we publish advisories after patches are released and users have had time to upgrade. |
| 48 | +- **Credit**: With your permission, we will acknowledge your contribution in our security advisories and release notes. |
| 49 | + |
| 50 | +## Scope |
| 51 | + |
| 52 | +This policy covers: |
| 53 | +- All official DeckProbe crates (`deckprobe-*`) published under the `deckflow` organization |
| 54 | +- The DeckProbe CLI tool |
| 55 | +- The Browser SDK (`@deckprobe/js`) |
| 56 | +- Official Docker images and distribution packages |
| 57 | + |
| 58 | +Out of scope: |
| 59 | +- Third-party applications integrating DeckProbe |
| 60 | +- Vulnerabilities requiring physical access or already-disclosed zero-days in underlying parsers (e.g., PDF, OOXML libraries) unless exacerbated by DeckProbe's handling |
| 61 | + |
| 62 | +## Security Best Practices for Users |
| 63 | + |
| 64 | +- Always run the latest supported version |
| 65 | +- Validate document sources before processing |
| 66 | +- Use DeckProbe in sandboxed or isolated environments when handling highly sensitive or unknown files |
| 67 | +- Restrict file system permissions for the DeckProbe process |
| 68 | + |
| 69 | +--- |
| 70 | + |
| 71 | +Thank you for helping keep DeckProbe and its users safe. Your responsible disclosure makes the ecosystem more secure for everyone. |
0 commit comments