Skip to content

Security: mbayue/gitSdm

SECURITY.md

Security Policy

We take the security of gitSdm seriously. This document outlines our supported versions, vulnerability reporting process, disclosure policy, response timeline, safe harbor guidelines, scope, and security best practices.


Supported Versions

Security updates are actively applied to the latest major release branch.

Version Supported
v1.x
< v1.0

Scope

In Scope

The following components are in scope for security vulnerability reports:

  • Core parsing logic under server/parser/ and server/github/.
  • API endpoints defined in server/prod-server.ts and server routers.
  • Token and secret leakage via environment variables or logs.
  • Client-side Cross-Site Scripting (XSS) in markdown or graph visualizers.

Out of Scope

  • Attacks requiring physical access to the user's host machine.
  • Issues related to third-party dependencies (unless a wrapper vulnerability exists in gitSdm itself). Please report dependency bugs to their respective maintainers.
  • Rate-limiting issues on the mock API endpoints.

Reporting a Vulnerability

Do not open a public GitHub issue for security vulnerabilities.

If you discover a vulnerability, please report it privately:

  1. GitHub Security Advisory: Submit a report via the "Security" tab on GitHub (preferred).
  2. Email: Send a detailed report to rich.bayue@gmail.com.

Please include the following details in your report:

  • A description of the vulnerability and its potential impact.
  • Step-by-step instructions to reproduce the behavior.
  • A minimal Proof of Concept (PoC) if applicable.
  • Any proposed mitigations or fixes.

Response Timeline

We aim to handle all security reports with high priority:

  • Acknowledgment: Within 72 hours.
  • Initial Assessment: Within 7 days, confirming the vulnerability and its severity.
  • Remediation & Patching: Within 30 days. We will keep you updated throughout this process.

Disclosure Policy

We follow coordinated vulnerability disclosure. Please allow us reasonable time to investigate, address, and release a patch for the reported issue before making any details public. Once a patched version is published, we will coordinate public disclosure and credit you for the discovery.


Safe Harbor

We want to encourage security research. Any activities conducted in good faith, in compliance with this policy, and aimed at identifying vulnerabilities will be treated as authorized:

  • We will not pursue legal action against you.
  • We will not report your activity to law enforcement.
  • If a third party pursues legal action against you, we will make it known that your research was conducted in compliance with this policy.

Security Best Practices for Users

  • Environment Variables: Never check in your GITHUB_TOKEN, GEMINI_API_KEY, ANTHROPIC_API_KEY, or OPENAI_API_KEY into git repositories. Use the local .env file (which is gitignored).
  • Private Repositories: Ensure access tokens passed to gitSdm use the minimum necessary scopes (ideally read-only permissions for repository metadata/trees).
  • Docker Deployments: When running via Docker, bind the server to 127.0.0.1 unless external access is explicitly required, and configure a reverse proxy with TLS.

There aren't any published security advisories