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
39 changes: 36 additions & 3 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
## Security Posture

This MCP server now ships with a stripped-down Openbridge authentication flow
focused on local deployments. Key behaviours to be aware of:
This MCP server ships with a streamlined Openbridge authentication flow
focused on local deployments. Key security behaviors:

### Token handling
- `OPENBRIDGE_REFRESH_TOKEN` is exchanged for a JWT on demand and cached in
memory only; no file persistence remains.
memory only; no file persistence.
- **CRITICAL**: Never commit `OPENBRIDGE_REFRESH_TOKEN` to version control.
Store it only in your local `.env` file (gitignored).
- Failures to convert the refresh token raise an `AuthenticationError`. The
server never falls back to sending the refresh token downstream.
- Logs redact bearer values. Debug instrumentation reports token length instead
Expand All @@ -22,5 +24,36 @@ focused on local deployments. Key behaviours to be aware of:
`OPENBRIDGE_ENABLE_LLM_VALIDATION=true`. By default the server evaluates
queries with heuristics only.

## Security Best Practices

When deploying this MCP server:

1. **Never commit secrets**: Ensure `.env` is in `.gitignore` and never committed
2. **Rotate tokens regularly**: Refresh your `OPENBRIDGE_REFRESH_TOKEN` periodically
3. **Use environment variables**: Store all sensitive configuration in environment
variables, never hardcode in source files
4. **Review logs carefully**: Verify logs don't expose sensitive data before
sharing or storing long-term
5. **Keep dependencies updated**: Regularly update Python packages to address
known vulnerabilities

## Responsible Disclosure

We take security vulnerabilities seriously. If you discover a security issue:

1. **Do NOT** open a public GitHub issue
2. Email your findings to: **[email protected]**
3. Include:
- Detailed description of the vulnerability
- Steps to reproduce the issue
- Potential impact assessment
- Suggested remediation (if available)

We will acknowledge receipt within 48 hours and provide a timeline for
remediation. We appreciate responsible disclosure and will credit researchers
(with permission) in security advisories.

## Additional Resources

Review the README for configuration details before deploying in your own
environment.