Please do not report security vulnerabilities through public GitHub issues.
If you discover a security vulnerability in Sprout, please report it by emailing security@sprout-relay.org. Include as much detail as possible:
- A description of the vulnerability and its potential impact
- Steps to reproduce or a proof-of-concept (if available)
- The affected version(s) or commit range
- Any suggested mitigations you've identified
You will receive an acknowledgment within 48 hours. We aim to provide a full response — including a timeline for a fix — within 7 days of initial contact. We'll keep you informed as we work toward a resolution.
We ask that you:
- Give us reasonable time to address the issue before any public disclosure
- Avoid accessing or modifying data that does not belong to you
- Not perform denial-of-service attacks or disrupt production systems
We will credit reporters in release notes unless you prefer to remain anonymous.
| Version | Supported |
|---|---|
main (latest) |
✅ Active |
| Previous releases |
Sprout is pre-1.0. We do not maintain long-term support branches at this stage.
All security fixes land on main first.
Every connection to the relay must authenticate via
NIP-42
challenge/response before writing events. The relay sends a random challenge;
the client signs a kind:22242 event containing the challenge and the relay
URL, proving possession of the private key.
API tokens (bearer tokens minted by sprout-admin) are presented inside the
NIP-42 signed event as an auth_token tag. The relay validates the token
against the database before granting elevated scopes. Tokens are stored as
SHA-256 hashes — the plaintext is shown once at mint time and never stored.
Channel membership is the only access control mechanism. There are no separate ACL lists or capability taxonomies. If a principal (human or agent) is a member of a channel, they can read and write to it. If they are not a member, the relay rejects their requests — even if they are authenticated.
Private channels are invisible to non-members: they do not appear in channel listings, and subscription filters for private channel events return nothing unless the subscriber is a member.
API tokens carry a set of scopes (e.g., messages:read, channels:write).
The relay enforces scopes on every REST endpoint and WebSocket write. A token
without channels:write cannot create channels, regardless of channel
membership.
All events are written to a tamper-evident audit log (sprout-audit). Each
log entry is chained to the previous one via an HMAC, making retroactive
modification detectable. The audit log is designed for SOX-grade compliance
and eDiscovery.
- All UUIDs (channel IDs, workflow IDs) are validated at API boundaries before use in database queries.
- Workflow
call_webhookactions are SSRF-protected: the target URL is resolved and checked against a blocklist of private/loopback address ranges before the request is made. - Workflow response bodies are size-limited to prevent memory exhaustion.
evalexprcondition evaluation is sandboxed and timeout-bounded.- Query parameters passed to external URLs are percent-encoded to prevent injection.
All production deployments should terminate TLS at the relay or a reverse proxy in front of it. The relay itself does not enforce TLS — this is intentional to allow flexible deployment behind load balancers and ingress controllers.
We use cargo audit in CI to scan for known vulnerabilities in dependencies.
#![deny(unsafe_code)] is enforced across all crates — no unsafe Rust.
We follow coordinated disclosure. Once a fix is ready and released, we will publish a security advisory on GitHub describing the vulnerability, its impact, and the fix. Reporters will be credited unless they request anonymity.