|
| 1 | +# Security Policy |
| 2 | + |
| 3 | +## Reporting a vulnerability |
| 4 | + |
| 5 | +Please do not report security issues through public GitHub issues, pull |
| 6 | +requests, or discussions. |
| 7 | + |
| 8 | +Use GitHub's private vulnerability reporting instead: |
| 9 | + |
| 10 | +**https://github.com/FSoft-AI4Code/CodeWiki/security/advisories/new** |
| 11 | + |
| 12 | +This opens a private thread that only the CodeWiki maintainers can see. You do |
| 13 | +not need to be a collaborator on the repository to use it. |
| 14 | + |
| 15 | +When reporting, please include as much of the following as you can: |
| 16 | + |
| 17 | +- The version or commit of CodeWiki you tested against |
| 18 | +- The command line or configuration you used (redact any API keys) |
| 19 | +- Steps to reproduce, or a minimal repository that triggers the issue |
| 20 | +- What an attacker can achieve, and under which conditions |
| 21 | +- Any suggested fix, if you have one |
| 22 | + |
| 23 | +## What to expect |
| 24 | + |
| 25 | +- We will acknowledge your report within **5 business days**. |
| 26 | +- We will keep you informed as we confirm the issue and work on a fix. |
| 27 | +- We aim to publish a fix and a GitHub Security Advisory within **90 days** of |
| 28 | + the initial report. If we need more time, we will tell you why and agree on |
| 29 | + a new date with you. |
| 30 | +- We will credit you in the advisory unless you ask us not to. |
| 31 | + |
| 32 | +## Supported versions |
| 33 | + |
| 34 | +Security fixes are applied to the `main` branch and to the most recent |
| 35 | +release. Older versions are not maintained. |
| 36 | + |
| 37 | +## Scope |
| 38 | + |
| 39 | +CodeWiki clones or reads repositories that you point it at. In subscription |
| 40 | +mode it routes LLM calls through the local `claude` or `codex` CLI, and in |
| 41 | +IDE-driven mode it runs as an MCP server driven by an AI IDE agent on your |
| 42 | +machine. The trust boundary we care about most is the boundary between the |
| 43 | +analyzed repository and the rest of your system. |
| 44 | + |
| 45 | +In scope: |
| 46 | + |
| 47 | +- Any way for content inside an analyzed repository (source files, READMEs, |
| 48 | + configuration, file names) to cause CodeWiki or the agent it drives to read |
| 49 | + or write files outside the intended output directory, execute commands, or |
| 50 | + exfiltrate data such as API keys |
| 51 | +- Path traversal, command injection, or unsafe deserialization in CodeWiki |
| 52 | + itself |
| 53 | +- Leakage of credentials, tokens, or environment variables into generated |
| 54 | + documentation or logs |
| 55 | +- Vulnerabilities in the Docker images or the web viewer shipped in this |
| 56 | + repository |
| 57 | + |
| 58 | +Out of scope: |
| 59 | + |
| 60 | +- Inaccurate, incomplete, or hallucinated documentation content |
| 61 | +- Vulnerabilities in the underlying LLM providers or agent CLIs (Claude Code, |
| 62 | + Codex CLI, and others). Please report those upstream. |
| 63 | +- Issues that require the attacker to already control the machine running |
| 64 | + CodeWiki |
| 65 | +- Findings from automated scanners without a demonstrated impact |
| 66 | + |
| 67 | +If you are unsure whether something is in scope, report it privately anyway |
| 68 | +and we will work it out together. |
0 commit comments