Skip to content

Commit 9ed15ba

Browse files
authored
Merge pull request #107 from FSoft-AI4Code/chore/security-policy-and-license
Add SECURITY.md and LICENSE
2 parents 2531801 + 59e38c3 commit 9ed15ba

2 files changed

Lines changed: 89 additions & 0 deletions

File tree

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 FSoft-AI4Code
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎SECURITY.md‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
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

Comments
 (0)