-
Notifications
You must be signed in to change notification settings - Fork 1
docs: add SECURITY.md #333
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,117 @@ | ||||||
| # Security Policy | ||||||
|
|
||||||
| CipherStash takes the security of our software, infrastructure, and customers extremely seriously. | ||||||
| This document describes the security posture, reporting process, and guidelines for the Proxy repository. | ||||||
|
|
||||||
| ## Supported Software | ||||||
|
|
||||||
| This repository contains the source code for CipherStash Proxy, including: | ||||||
|
|
||||||
| - The CipherStash Proxy binary | ||||||
| - Docker containers and Docker Compose configuration | ||||||
| - Encryption migration tool | ||||||
|
|
||||||
| ### CipherStash Proxy | ||||||
|
|
||||||
| | Version | Supported | | ||||||
| | ------- | ------------------ | | ||||||
| | 2.1.x | :white_check_mark: | | ||||||
| | < 2.1 | :x: | | ||||||
|
|
||||||
|
|
||||||
| All software follows semantic versioning and undergoes internal security review, automated analysis, and reproducible builds as part of our SDLC. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Reporting a Vulnerability | ||||||
|
|
||||||
| If you believe you have found a security vulnerability in any CipherStash code, service, or dependency: | ||||||
|
|
||||||
| 📧 **Please email: `[email protected]`** | ||||||
|
|
||||||
| We request that you **do not publicly disclose** the issue before we have had a chance to investigate and provide a fix. | ||||||
|
|
||||||
| When reporting, please include (as applicable): | ||||||
|
|
||||||
| - Description of the vulnerability | ||||||
| - Steps to reproduce | ||||||
| - Impact assessment or potential misuse | ||||||
| - Any relevant logs, PoCs, or screenshots | ||||||
| - Suggested remediation (if you have one) | ||||||
|
|
||||||
| We will acknowledge receipt within **48 hours** and provide regular updates until the issue is resolved. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Disclosure & Response Policy | ||||||
|
|
||||||
| CipherStash follows a **coordinated responsible disclosure** process: | ||||||
|
|
||||||
| 1. **Submit report** privately via `[email protected]`. | ||||||
| 2. **Acknowledgement** within 48 hours. | ||||||
| 3. **Assessment** of severity using CVSS and internal risk models. | ||||||
| 4. **Fix development** and patch release in a private branch. | ||||||
| 5. **Coordinated disclosure**, including: | ||||||
| - New patch release(s) | ||||||
| - Security advisory on GitHub | ||||||
| - Credit to reporter (optional) | ||||||
|
|
||||||
| We will never take legal action against good-faith security researchers who follow this policy. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Scope | ||||||
|
|
||||||
| The following are **in scope**: | ||||||
|
|
||||||
| - The `cipherstash/proxy` GitHub repository | ||||||
| - All published Docker images published to [Docker Hub under `cipherstash/proxy`](https://hub.docker.com/r/cipherstash/proxy) | ||||||
|
||||||
| - All published Docker images published to [Docker Hub under `cipherstash/proxy`](https://hub.docker.com/r/cipherstash/proxy) | |
| - All Docker images published to [Docker Hub under `cipherstash/proxy`](https://hub.docker.com/r/cipherstash/proxy) |
Copilot
AI
Nov 26, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Spelling error: "disclosires" should be "disclosures".
| - Example [schema](./docs/sql/schema-example.sql) and [configuration](./cipherstash-proxy-example.toml) (though we are still grateful for any relevant disclosires there) | |
| - Example [schema](./docs/sql/schema-example.sql) and [configuration](./cipherstash-proxy-example.toml) (though we are still grateful for any relevant disclosures there) |
Copilot
AI
Nov 26, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Incorrect language requirement: This repository is a Rust project (as evident from Cargo.toml and the Rust packages), but the guideline states "Use TypeScript for all new code". This should be corrected to "Use Rust for all new code" or similar appropriate language.
| - Use TypeScript for all new code | |
| - Use Rust for all new code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inconsistent table formatting: Line 19 has inconsistent spacing compared to line 18. Consider adding spaces around the version for better alignment:
| < 2.1 | :x: |