Skip to content

Security: firebreakrisk/firebreak-risk-api

SECURITY.md

SECURITY.md

Security Policy

Supported Versions

Use this section to tell people about which versions of your project are currently being supported with security updates.

Version Supported
1.1.x
1.0.x
< 1.0

Reporting a Vulnerability

We take the security of FireBreak Risk API seriously. If you believe you have found a security vulnerability, please report it to us as described below.

Reporting Process

Please do not report security vulnerabilities through public GitHub issues.

Instead, please report them via email to security@firebreakrisk.com. You should receive a response within 48 hours. If for some reason you do not, please follow up via email to ensure we received your original message.

Please include the following information in your report:

  • Type of issue (e.g., buffer overflow, SQL injection, cross-site scripting, etc.)
  • Full paths of source file(s) related to the manifestation of the issue
  • The location of the affected source code (tag/branch/commit or direct URL)
  • Any special configuration required to reproduce the issue
  • Step-by-step instructions to reproduce the issue
  • Proof-of-concept or exploit code (if possible)
  • Impact of the issue, including how an attacker might exploit it

Preferred Languages

We prefer all communications to be in English.

Response Process

  1. We will acknowledge your report within 48 hours
  2. We will confirm the issue and determine its severity
  3. We will develop and test a fix
  4. We will notify users who may be affected
  5. We will release a patch and document the vulnerability

Disclosure Policy

  • We follow the principle of Responsible Disclosure
  • We will coordinate the timing of the public disclosure
  • We aim to disclose vulnerabilities once a mitigation is available
  • We will credit researchers who report vulnerabilities (unless they prefer to remain anonymous)

Bug Bounty Program

We do not currently offer a bug bounty program.

Security Updates

Security updates will be clearly marked in our release notes and we encourage all users to update to the latest version promptly.

Implementation Security Guidelines

When implementing the FireBreak Risk API, please follow these security best practices:

  1. Use HTTPS for all API communications
  2. Implement proper authentication
  3. Validate all input data
  4. Monitor API usage for unusual patterns
  5. Keep all dependencies updated
  6. Follow the principle of least privilege

Security-Related Configuration

Ensure your implementation includes:

  • Rate limiting
  • Input validation
  • Output encoding
  • Error handling that doesn't expose sensitive information
  • Proper access controls
  • Audit logging

Contact

For any questions about this security policy, please contact security@firebreakrisk.com

There aren’t any published security advisories