Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Security Policy

## Reporting a Vulnerability

If you discover a security vulnerability in Electric, please report it through
[GitHub's private vulnerability reporting](https://github.com/electric-sql/electric/security/advisories/new).

**Do not open a public issue for security vulnerabilities.**

### What to include

- A description of the vulnerability and its potential impact
- Steps to reproduce or a proof of concept
- The affected version(s) or commit(s)
- Any suggested fix, if you have one

### Response timeline
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These timings seem very slow in reality. We maybe want to say we will strive to reply etc as soon as possible.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adjust in the spirit of as fast as possible


- **Acknowledgement**: within 24 hours of your report
- **Initial assessment**: normally within 48 hours, we will confirm whether the report is accepted and share our initial severity assessment
- **Resolution**: we aim to fix critical issues the same day, though timelines vary based on complexity. Resolution includes an OSS release and deploying the fix to Electric Cloud

### Disclosure policy

We follow a **coordinated disclosure** process with a **30-day embargo**:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these timings a bit enterprise? We're faster than this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no big reasons to change the upper limit. I'll adjust times on the previous section


1. You report the vulnerability privately via GitHub
2. We acknowledge and work on a fix
3. We release the fix and publish a security advisory
4. After the fix is released — or after 30 days, whichever comes first — you are free to publish details about the vulnerability

We ask that you do not disclose the vulnerability publicly until the embargo period has passed or we have published a fix, whichever comes first.

## Supported Versions

Security fixes are applied to the latest release. We do not backport fixes to older major or minor versions unless the severity warrants it.

## Scope

The following are **in scope**:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Durable Streams?
Phoenix Sync?
TanStack DB?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DS and Ts DB have their own packages, they should have their own security policy


- The Electric sync engine (`packages/sync-service`)
- Official client libraries (`packages/typescript-client`, `packages/elixir-client`, `packages/react-hooks`)
- [Electric Cloud](https://dashboard.electric-sql.cloud/)
- [Phoenix Sync](https://github.com/electric-sql/phoenix_sync)

The following are **out of scope**:

- Experimental features (e.g. the `@electric-sql/experimental` package, or features behind feature flags)
- Example applications in the `examples/` directory
- Third-party dependencies (please report these to the upstream project)
- Social engineering or phishing attacks against Electric team members

## Recognition

We appreciate the work of security researchers. With your permission, we will credit you in the security advisory for any confirmed vulnerability you report.
Loading