We release patches for security vulnerabilities for the following versions:
| Version | Supported |
|---|---|
| 1.x.x | ✅ |
We take the security of BranChat seriously. If you discover a security vulnerability, please follow these steps:
Please do not report security vulnerabilities through public GitHub issues.
Instead, please report them via one of the following methods:
-
GitHub Security Advisories (Preferred)
- Navigate to the Security tab
- Click "Report a vulnerability"
- Fill out the form with details
-
Email
- Send an email to the maintainers through GitHub
- Include "SECURITY" in the subject line
Please include the following information in your report:
- Type of vulnerability
- Full paths of source file(s) related to the vulnerability
- Location of the affected source code (tag/branch/commit or direct URL)
- Step-by-step instructions to reproduce the issue
- Proof-of-concept or exploit code (if possible)
- Impact of the vulnerability, including how an attacker might exploit it
- Initial Response: Within 48 hours, we will acknowledge receipt of your vulnerability report
- Status Updates: We will send updates on our progress every 5-7 days
- Resolution: We aim to resolve critical vulnerabilities within 30 days
- We request that you do not publicly disclose the vulnerability until we have addressed it
- Once a fix is available, we will coordinate with you on the disclosure timeline
- We will credit you in the security advisory (unless you prefer to remain anonymous)
BranChat stores API keys locally on your device:
- macOS Electron App: API keys are stored in the system Keychain
- Web Version: API keys are stored in browser localStorage
Important: Never commit your .env file or share your API keys publicly.
BranChat is designed for local use only. Do not host BranChat publicly on the internet without:
- Implementing proper authentication
- Adding rate limiting
- Securing API endpoints
- Reviewing the codebase for security vulnerabilities
Public hosting without proper security measures could expose your API keys and user data.
- All conversations are stored locally on your device
- No data is sent to BranChat servers (we don't have any)
- API calls are made directly from your device to AI provider APIs
- Review each AI provider's privacy policy for how they handle your data
The Electron app includes the following security measures:
- Context isolation enabled
- Node integration disabled in renderer
- Content Security Policy (CSP) configured
- IPC communication restricted to specific channels
When contributing to BranChat, please:
- Never commit secrets: Use
.env.examplefor templates only - Validate user input: Sanitize all user-provided data
- Keep dependencies updated: Regularly update npm packages
- Follow OWASP guidelines: Be aware of common vulnerabilities (XSS, injection, etc.)
- Review security implications: Consider security impact of code changes
Past security vulnerabilities will be listed here once they have been resolved and disclosed:
- No vulnerabilities have been reported yet
Thank you for helping keep BranChat and its users safe!