@luanpdd/kit-mcp 1.21.0 → 1.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (253) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +648 -648
  3. package/kit/COMANDOS.md +138 -138
  4. package/kit/README.md +76 -52
  5. package/kit/agents/advisor-researcher.md +106 -106
  6. package/kit/agents/assumptions-analyzer.md +107 -107
  7. package/kit/agents/auditor-consistencia-isolamento.md +380 -0
  8. package/kit/agents/codebase-mapper.md +768 -768
  9. package/kit/agents/crm-pipeline-implementer.md +17 -0
  10. package/kit/agents/debugger.md +772 -772
  11. package/kit/agents/detector-tenant-quente.md +337 -0
  12. package/kit/agents/example-reviewer.md +21 -21
  13. package/kit/agents/executor.md +523 -523
  14. package/kit/agents/integration-checker.md +200 -200
  15. package/kit/agents/multi-tenant-isolation-auditor.md +10 -0
  16. package/kit/agents/nyquist-auditor.md +178 -178
  17. package/kit/agents/phase-researcher.md +696 -696
  18. package/kit/agents/plan-checker.md +272 -272
  19. package/kit/agents/planner.md +891 -891
  20. package/kit/agents/project-researcher.md +652 -652
  21. package/kit/agents/research-synthesizer.md +245 -245
  22. package/kit/agents/roadmapper.md +677 -677
  23. package/kit/agents/supabase-architect.md +10 -0
  24. package/kit/agents/supabase-migration-writer.md +12 -0
  25. package/kit/agents/ui-auditor.md +437 -437
  26. package/kit/agents/ui-checker.md +302 -302
  27. package/kit/agents/ui-researcher.md +355 -355
  28. package/kit/agents/user-profiler.md +175 -175
  29. package/kit/agents/validador-evolucao-schema.md +335 -0
  30. package/kit/agents/verifier.md +728 -728
  31. package/kit/commands/adicionar-backlog.md +75 -75
  32. package/kit/commands/adicionar-fase.md +42 -42
  33. package/kit/commands/adicionar-tarefa.md +45 -45
  34. package/kit/commands/adicionar-testes.md +41 -41
  35. package/kit/commands/ajuda.md +21 -21
  36. package/kit/commands/atualizar.md +37 -37
  37. package/kit/commands/auditar-marco.md +179 -179
  38. package/kit/commands/auditar-uat.md +23 -23
  39. package/kit/commands/autonomo.md +40 -40
  40. package/kit/commands/branch-pr.md +24 -24
  41. package/kit/commands/concluir-marco.md +247 -247
  42. package/kit/commands/configuracoes.md +36 -36
  43. package/kit/commands/dados-distribuidos.md +188 -0
  44. package/kit/commands/definir-perfil.md +10 -10
  45. package/kit/commands/depurar.md +190 -190
  46. package/kit/commands/discutir-fase.md +131 -131
  47. package/kit/commands/entrar-discord.md +17 -17
  48. package/kit/commands/estatisticas.md +18 -18
  49. package/kit/commands/example-greeting.md +33 -33
  50. package/kit/commands/executar-fase.md +58 -58
  51. package/kit/commands/expresso.md +56 -56
  52. package/kit/commands/fase-ui.md +34 -34
  53. package/kit/commands/fazer.md +57 -57
  54. package/kit/commands/fio.md +125 -125
  55. package/kit/commands/fluxos-trabalho.md +64 -64
  56. package/kit/commands/forense.md +176 -176
  57. package/kit/commands/gerenciador.md +38 -38
  58. package/kit/commands/inserir-fase.md +31 -31
  59. package/kit/commands/limpeza.md +17 -17
  60. package/kit/commands/listar-hipoteses-fase.md +45 -45
  61. package/kit/commands/listar-workspaces.md +18 -18
  62. package/kit/commands/mapear-codebase.md +70 -70
  63. package/kit/commands/nota.md +33 -33
  64. package/kit/commands/novo-marco.md +43 -43
  65. package/kit/commands/novo-projeto.md +41 -41
  66. package/kit/commands/novo-workspace.md +43 -43
  67. package/kit/commands/pausar-trabalho.md +37 -37
  68. package/kit/commands/perfil-usuario.md +45 -45
  69. package/kit/commands/pesquisar-fase.md +195 -195
  70. package/kit/commands/planejar-fase.md +67 -67
  71. package/kit/commands/planejar-lacunas.md +33 -33
  72. package/kit/commands/plantar-ideia.md +25 -25
  73. package/kit/commands/progresso.md +24 -24
  74. package/kit/commands/proximo.md +30 -30
  75. package/kit/commands/publicar.md +490 -490
  76. package/kit/commands/rapido.md +35 -35
  77. package/kit/commands/reaplicar-patches.md +124 -124
  78. package/kit/commands/relatorio-sessao.md +19 -19
  79. package/kit/commands/remover-fase.md +31 -31
  80. package/kit/commands/remover-workspace.md +26 -26
  81. package/kit/commands/resumo-marco.md +50 -50
  82. package/kit/commands/retomar-trabalho.md +40 -40
  83. package/kit/commands/revisar-backlog.md +60 -60
  84. package/kit/commands/revisar-ui.md +32 -32
  85. package/kit/commands/revisar.md +37 -37
  86. package/kit/commands/saude.md +21 -21
  87. package/kit/commands/setup-notion.md +93 -93
  88. package/kit/commands/sync-main.md +68 -68
  89. package/kit/commands/validar-fase.md +35 -35
  90. package/kit/commands/verificar-tarefas.md +44 -44
  91. package/kit/commands/verificar-trabalho.md +64 -64
  92. package/kit/file-manifest.json +27 -15
  93. package/kit/framework/bin/lib/commands.cjs +959 -959
  94. package/kit/framework/bin/lib/config.cjs +442 -442
  95. package/kit/framework/bin/lib/core.cjs +1230 -1230
  96. package/kit/framework/bin/lib/frontmatter.cjs +336 -336
  97. package/kit/framework/bin/lib/init.cjs +1442 -1442
  98. package/kit/framework/bin/lib/milestone.cjs +252 -252
  99. package/kit/framework/bin/lib/model-profiles.cjs +68 -68
  100. package/kit/framework/bin/lib/phase.cjs +888 -888
  101. package/kit/framework/bin/lib/profile-output.cjs +952 -952
  102. package/kit/framework/bin/lib/profile-pipeline.cjs +539 -539
  103. package/kit/framework/bin/lib/roadmap.cjs +329 -329
  104. package/kit/framework/bin/lib/security.cjs +382 -382
  105. package/kit/framework/bin/lib/state.cjs +1031 -1031
  106. package/kit/framework/bin/lib/template.cjs +222 -222
  107. package/kit/framework/bin/lib/uat.cjs +282 -282
  108. package/kit/framework/bin/lib/verify.cjs +888 -888
  109. package/kit/framework/bin/lib/workstream.cjs +491 -491
  110. package/kit/framework/bin/tools.cjs +918 -918
  111. package/kit/framework/commands/workstreams.md +63 -63
  112. package/kit/framework/references/checkpoints.md +778 -778
  113. package/kit/framework/references/continuation-format.md +249 -249
  114. package/kit/framework/references/decimal-phase-calculation.md +64 -64
  115. package/kit/framework/references/git-integration.md +295 -295
  116. package/kit/framework/references/git-planning-commit.md +38 -38
  117. package/kit/framework/references/model-profile-resolution.md +36 -36
  118. package/kit/framework/references/model-profiles.md +139 -139
  119. package/kit/framework/references/phase-argument-parsing.md +61 -61
  120. package/kit/framework/references/planning-config.md +202 -202
  121. package/kit/framework/references/questioning.md +162 -162
  122. package/kit/framework/references/tdd.md +263 -263
  123. package/kit/framework/references/ui-brand.md +160 -160
  124. package/kit/framework/references/user-profiling.md +657 -657
  125. package/kit/framework/references/verification-patterns.md +612 -612
  126. package/kit/framework/references/workstream-flag.md +58 -58
  127. package/kit/framework/templates/DEBUG.md +164 -164
  128. package/kit/framework/templates/UAT.md +265 -265
  129. package/kit/framework/templates/UI-SPEC.md +100 -100
  130. package/kit/framework/templates/VALIDATION.md +76 -76
  131. package/kit/framework/templates/claude-md.md +122 -122
  132. package/kit/framework/templates/codebase/architecture.md +185 -185
  133. package/kit/framework/templates/codebase/concerns.md +205 -205
  134. package/kit/framework/templates/codebase/conventions.md +204 -204
  135. package/kit/framework/templates/codebase/integrations.md +192 -192
  136. package/kit/framework/templates/codebase/stack.md +158 -158
  137. package/kit/framework/templates/codebase/structure.md +199 -199
  138. package/kit/framework/templates/codebase/testing.md +301 -301
  139. package/kit/framework/templates/config.json +44 -44
  140. package/kit/framework/templates/context.md +352 -352
  141. package/kit/framework/templates/continue-here.md +78 -78
  142. package/kit/framework/templates/copilot-instructions.md +7 -7
  143. package/kit/framework/templates/debug-subagent-prompt.md +91 -91
  144. package/kit/framework/templates/dev-preferences.md +20 -20
  145. package/kit/framework/templates/discovery.md +146 -146
  146. package/kit/framework/templates/discussion-log.md +63 -63
  147. package/kit/framework/templates/milestone-archive.md +123 -123
  148. package/kit/framework/templates/milestone.md +115 -115
  149. package/kit/framework/templates/phase-prompt.md +610 -610
  150. package/kit/framework/templates/planner-subagent-prompt.md +117 -117
  151. package/kit/framework/templates/project.md +186 -186
  152. package/kit/framework/templates/requirements.md +231 -231
  153. package/kit/framework/templates/research-project/ARCHITECTURE.md +204 -204
  154. package/kit/framework/templates/research-project/FEATURES.md +147 -147
  155. package/kit/framework/templates/research-project/PITFALLS.md +200 -200
  156. package/kit/framework/templates/research-project/STACK.md +120 -120
  157. package/kit/framework/templates/research-project/SUMMARY.md +170 -170
  158. package/kit/framework/templates/research.md +419 -419
  159. package/kit/framework/templates/retrospective.md +54 -54
  160. package/kit/framework/templates/roadmap.md +202 -202
  161. package/kit/framework/templates/state.md +176 -176
  162. package/kit/framework/templates/summary-complex.md +59 -59
  163. package/kit/framework/templates/summary-minimal.md +41 -41
  164. package/kit/framework/templates/summary-standard.md +48 -48
  165. package/kit/framework/templates/summary.md +209 -209
  166. package/kit/framework/templates/user-profile.md +146 -146
  167. package/kit/framework/templates/user-setup.md +256 -256
  168. package/kit/framework/templates/verification-report.md +258 -258
  169. package/kit/framework/workflows/add-phase.md +112 -112
  170. package/kit/framework/workflows/add-tests.md +351 -351
  171. package/kit/framework/workflows/add-todo.md +158 -158
  172. package/kit/framework/workflows/audit-milestone.md +340 -340
  173. package/kit/framework/workflows/audit-uat.md +109 -109
  174. package/kit/framework/workflows/autonomous.md +891 -891
  175. package/kit/framework/workflows/check-todos.md +177 -177
  176. package/kit/framework/workflows/cleanup.md +152 -152
  177. package/kit/framework/workflows/complete-milestone.md +696 -696
  178. package/kit/framework/workflows/diagnose-issues.md +231 -231
  179. package/kit/framework/workflows/discovery-phase.md +289 -289
  180. package/kit/framework/workflows/discuss-phase-assumptions.md +653 -653
  181. package/kit/framework/workflows/discuss-phase.md +784 -784
  182. package/kit/framework/workflows/do.md +104 -104
  183. package/kit/framework/workflows/execute-phase.md +838 -838
  184. package/kit/framework/workflows/execute-plan.md +510 -510
  185. package/kit/framework/workflows/fast.md +102 -102
  186. package/kit/framework/workflows/forensics.md +265 -265
  187. package/kit/framework/workflows/health.md +181 -181
  188. package/kit/framework/workflows/help.md +619 -619
  189. package/kit/framework/workflows/insert-phase.md +130 -130
  190. package/kit/framework/workflows/list-phase-assumptions.md +178 -178
  191. package/kit/framework/workflows/list-workspaces.md +56 -56
  192. package/kit/framework/workflows/manager.md +362 -362
  193. package/kit/framework/workflows/map-codebase.md +377 -377
  194. package/kit/framework/workflows/milestone-summary.md +223 -223
  195. package/kit/framework/workflows/new-milestone.md +486 -486
  196. package/kit/framework/workflows/new-project.md +1159 -1159
  197. package/kit/framework/workflows/new-workspace.md +237 -237
  198. package/kit/framework/workflows/next.md +97 -97
  199. package/kit/framework/workflows/node-repair.md +92 -92
  200. package/kit/framework/workflows/note.md +156 -156
  201. package/kit/framework/workflows/pause-work.md +176 -176
  202. package/kit/framework/workflows/plan-milestone-gaps.md +273 -273
  203. package/kit/framework/workflows/plan-phase.md +765 -765
  204. package/kit/framework/workflows/plant-seed.md +169 -169
  205. package/kit/framework/workflows/pr-branch.md +129 -129
  206. package/kit/framework/workflows/profile-user.md +450 -450
  207. package/kit/framework/workflows/progress.md +507 -507
  208. package/kit/framework/workflows/quick.md +757 -757
  209. package/kit/framework/workflows/remove-phase.md +155 -155
  210. package/kit/framework/workflows/remove-workspace.md +90 -90
  211. package/kit/framework/workflows/research-phase.md +82 -82
  212. package/kit/framework/workflows/resume-project.md +326 -326
  213. package/kit/framework/workflows/review.md +228 -228
  214. package/kit/framework/workflows/session-report.md +146 -146
  215. package/kit/framework/workflows/settings.md +283 -283
  216. package/kit/framework/workflows/ship.md +228 -228
  217. package/kit/framework/workflows/stats.md +60 -60
  218. package/kit/framework/workflows/transition.md +671 -671
  219. package/kit/framework/workflows/ui-phase.md +302 -302
  220. package/kit/framework/workflows/ui-review.md +165 -165
  221. package/kit/framework/workflows/update.md +323 -323
  222. package/kit/framework/workflows/validate-phase.md +174 -174
  223. package/kit/framework/workflows/verify-phase.md +252 -252
  224. package/kit/framework/workflows/verify-work.md +637 -637
  225. package/kit/hooks/check-update.js +118 -118
  226. package/kit/hooks/context-monitor.js +163 -163
  227. package/kit/hooks/prompt-guard.js +103 -103
  228. package/kit/hooks/statusline.js +125 -125
  229. package/kit/hooks/workflow-guard.js +101 -101
  230. package/kit/settings.json +45 -45
  231. package/kit/skills/_shared-dados-distribuidos/glossary.md +224 -0
  232. package/kit/skills/armadilhas-sistemas-distribuidos/SKILL.md +447 -0
  233. package/kit/skills/audit-log-multi-tenant/SKILL.md +6 -0
  234. package/kit/skills/cascading-failures/SKILL.md +4 -0
  235. package/kit/skills/consistencia-leitura-replica/SKILL.md +385 -0
  236. package/kit/skills/crm-lead-pipeline-patterns/SKILL.md +17 -0
  237. package/kit/skills/escolha-modelo-consistencia/SKILL.md +495 -0
  238. package/kit/skills/evolucao-schema-compativel/SKILL.md +448 -0
  239. package/kit/skills/example-skill/SKILL.md +42 -42
  240. package/kit/skills/multi-tenant-performance-scaling/SKILL.md +4 -0
  241. package/kit/skills/multi-tenant-rls-hierarchy/SKILL.md +4 -0
  242. package/kit/skills/postgres-isolamento-concorrencia/SKILL.md +552 -0
  243. package/kit/skills/streams-eventos-cdc/SKILL.md +712 -0
  244. package/kit/skills/supabase-cron-queues/SKILL.md +9 -0
  245. package/kit/skills/supabase-migrations/SKILL.md +10 -0
  246. package/kit/skills/super-admin-platform-pattern/SKILL.md +4 -0
  247. package/kit/skills/tenant-quente-mitigacao/SKILL.md +605 -0
  248. package/package.json +63 -63
  249. package/src/core/kit.js +216 -216
  250. package/src/core/reflect.js +247 -247
  251. package/src/core/reverse-sync.js +372 -372
  252. package/src/core/sync.js +418 -418
  253. package/src/core/watch.js +121 -121
@@ -1,382 +1,382 @@
1
- /**
2
- * Security — Input validation, path traversal prevention, and prompt injection guards
3
- *
4
- * This module centralizes security checks for framework tooling. Because framework generates
5
- * markdown files that become LLM system prompts (agent instructions, workflow state,
6
- * phase plans), any user-controlled text that flows into these files is a potential
7
- * indirect prompt injection vector.
8
- *
9
- * Threat model:
10
- * 1. Path traversal: user-supplied file paths escape the project directory
11
- * 2. Prompt injection: malicious text in arguments/PRDs embeds LLM instructions
12
- * 3. Shell metacharacter injection: user text interpreted by shell
13
- * 4. JSON injection: malformed JSON crashes or corrupts state
14
- * 5. Regex DoS: crafted input causes catastrophic backtracking
15
- */
16
- 'use strict';
17
-
18
- const fs = require('fs');
19
- const path = require('path');
20
-
21
- // ─── Path Traversal Prevention ──────────────────────────────────────────────
22
-
23
- /**
24
- * Validate that a file path resolves within an allowed base directory.
25
- * Prevents path traversal attacks via ../ sequences, symlinks, or absolute paths.
26
- *
27
- * @param {string} filePath - The user-supplied file path
28
- * @param {string} baseDir - The allowed base directory (e.g., project root)
29
- * @param {object} [opts] - Options
30
- * @param {boolean} [opts.allowAbsolute=false] - Allow absolute paths (still must be within baseDir)
31
- * @returns {{ safe: boolean, resolved: string, error?: string }}
32
- */
33
- function validatePath(filePath, baseDir, opts = {}) {
34
- if (!filePath || typeof filePath !== 'string') {
35
- return { safe: false, resolved: '', error: 'Empty or invalid file path' };
36
- }
37
-
38
- if (!baseDir || typeof baseDir !== 'string') {
39
- return { safe: false, resolved: '', error: 'Empty or invalid base directory' };
40
- }
41
-
42
- // Reject null bytes (can bypass path checks in some environments)
43
- if (filePath.includes('\0')) {
44
- return { safe: false, resolved: '', error: 'Path contains null bytes' };
45
- }
46
-
47
- // Resolve symlinks in base directory to handle macOS /var -> /private/var
48
- // and similar platform-specific symlink chains
49
- let resolvedBase;
50
- try {
51
- resolvedBase = fs.realpathSync(path.resolve(baseDir));
52
- } catch {
53
- resolvedBase = path.resolve(baseDir);
54
- }
55
-
56
- let resolvedPath;
57
-
58
- if (path.isAbsolute(filePath)) {
59
- if (!opts.allowAbsolute) {
60
- return { safe: false, resolved: '', error: 'Absolute paths not allowed' };
61
- }
62
- resolvedPath = path.resolve(filePath);
63
- } else {
64
- resolvedPath = path.resolve(baseDir, filePath);
65
- }
66
-
67
- // Resolve symlinks in the target path too
68
- try {
69
- resolvedPath = fs.realpathSync(resolvedPath);
70
- } catch {
71
- // File may not exist yet (e.g., about to be created) — use logical resolution
72
- // but still resolve the parent directory if it exists
73
- const parentDir = path.dirname(resolvedPath);
74
- try {
75
- const realParent = fs.realpathSync(parentDir);
76
- resolvedPath = path.join(realParent, path.basename(resolvedPath));
77
- } catch {
78
- // Parent doesn't exist either — keep the resolved path as-is
79
- }
80
- }
81
-
82
- // Normalize both paths and check containment
83
- const normalizedBase = resolvedBase + path.sep;
84
- const normalizedPath = resolvedPath + path.sep;
85
-
86
- // The resolved path must start with the base directory
87
- // (or be exactly the base directory)
88
- if (resolvedPath !== resolvedBase && !normalizedPath.startsWith(normalizedBase)) {
89
- return {
90
- safe: false,
91
- resolved: resolvedPath,
92
- error: `Path escapes allowed directory: ${resolvedPath} is outside ${resolvedBase}`,
93
- };
94
- }
95
-
96
- return { safe: true, resolved: resolvedPath };
97
- }
98
-
99
- /**
100
- * Validate a file path and throw on traversal attempt.
101
- * Convenience wrapper around validatePath for use in CLI commands.
102
- */
103
- function requireSafePath(filePath, baseDir, label, opts = {}) {
104
- const result = validatePath(filePath, baseDir, opts);
105
- if (!result.safe) {
106
- throw new Error(`${label || 'Path'} validation failed: ${result.error}`);
107
- }
108
- return result.resolved;
109
- }
110
-
111
- // ─── Prompt Injection Detection ─────────────────────────────────────────────
112
-
113
- /**
114
- * Patterns that indicate prompt injection attempts in user-supplied text.
115
- * These patterns catch common indirect prompt injection techniques where
116
- * an attacker embeds LLM instructions in text that will be read by an agent.
117
- *
118
- * Note: This is defense-in-depth — not a complete solution. The primary defense
119
- * is proper input/output boundaries in agent prompts.
120
- */
121
- const INJECTION_PATTERNS = [
122
- // Direct instruction override attempts
123
- /ignore\s+(all\s+)?previous\s+instructions/i,
124
- /ignore\s+(all\s+)?above\s+instructions/i,
125
- /disregard\s+(all\s+)?previous/i,
126
- /forget\s+(all\s+)?(your\s+)?instructions/i,
127
- /override\s+(system|previous)\s+(prompt|instructions)/i,
128
-
129
- // Role/identity manipulation
130
- /you\s+are\s+now\s+(?:a|an|the)\s+/i,
131
- /act\s+as\s+(?:a|an|the)\s+(?!plan|phase|wave)/i, // allow "act as a plan"
132
- /pretend\s+(?:you(?:'re| are)\s+|to\s+be\s+)/i,
133
- /from\s+now\s+on,?\s+you\s+(?:are|will|should|must)/i,
134
-
135
- // System prompt extraction
136
- /(?:print|output|reveal|show|display|repeat)\s+(?:your\s+)?(?:system\s+)?(?:prompt|instructions)/i,
137
- /what\s+(?:are|is)\s+your\s+(?:system\s+)?(?:prompt|instructions)/i,
138
-
139
- // Hidden instruction markers (XML/HTML tags that mimic system messages)
140
- // Note: <instructions> is excluded — framework uses it as legitimate prompt structure
141
- // Requires > to close the tag (not just whitespace) to avoid matching generic types like Promise<User | null>
142
- /<\/?(?:system|assistant|human)>/i,
143
- /\[SYSTEM\]/i,
144
- /\[INST\]/i,
145
- /<<\s*SYS\s*>>/i,
146
-
147
- // Exfiltration attempts
148
- /(?:send|post|fetch|curl|wget)\s+(?:to|from)\s+https?:\/\//i,
149
- /(?:base64|btoa|encode)\s+(?:and\s+)?(?:send|exfiltrate|output)/i,
150
-
151
- // Tool manipulation
152
- /(?:run|execute|call|invoke)\s+(?:the\s+)?(?:bash|shell|exec|spawn)\s+(?:tool|command)/i,
153
- ];
154
-
155
- /**
156
- * Scan text for potential prompt injection patterns.
157
- * Returns an array of findings (empty = clean).
158
- *
159
- * @param {string} text - The text to scan
160
- * @param {object} [opts] - Options
161
- * @param {boolean} [opts.strict=false] - Enable stricter matching (more false positives)
162
- * @returns {{ clean: boolean, findings: string[] }}
163
- */
164
- function scanForInjection(text, opts = {}) {
165
- if (!text || typeof text !== 'string') {
166
- return { clean: true, findings: [] };
167
- }
168
-
169
- const findings = [];
170
-
171
- for (const pattern of INJECTION_PATTERNS) {
172
- if (pattern.test(text)) {
173
- findings.push(`Matched injection pattern: ${pattern.source}`);
174
- }
175
- }
176
-
177
- if (opts.strict) {
178
- // Check for suspicious Unicode that could hide instructions
179
- // (zero-width chars, RTL override, homoglyph attacks)
180
- if (/[\u200B-\u200F\u2028-\u202F\uFEFF\u00AD]/.test(text)) {
181
- findings.push('Contains suspicious zero-width or invisible Unicode characters');
182
- }
183
-
184
- // Check for extremely long strings that could be prompt stuffing
185
- if (text.length > 50000) {
186
- findings.push(`Suspicious text length: ${text.length} chars (potential prompt stuffing)`);
187
- }
188
- }
189
-
190
- return { clean: findings.length === 0, findings };
191
- }
192
-
193
- /**
194
- * Sanitize text that will be embedded in agent prompts or planning documents.
195
- * Strips known injection markers while preserving legitimate content.
196
- *
197
- * This does NOT alter user intent — it neutralizes control characters and
198
- * instruction-mimicking patterns that could hijack agent behavior.
199
- *
200
- * @param {string} text - Text to sanitize
201
- * @returns {string} Sanitized text
202
- */
203
- function sanitizeForPrompt(text) {
204
- if (!text || typeof text !== 'string') return text;
205
-
206
- let sanitized = text;
207
-
208
- // Strip zero-width characters that could hide instructions
209
- sanitized = sanitized.replace(/[\u200B-\u200F\u2028-\u202F\uFEFF\u00AD]/g, '');
210
-
211
- // Neutralize XML/HTML tags that mimic system boundaries
212
- // Replace < > with full-width equivalents to prevent tag interpretation
213
- // Note: <instructions> is excluded — framework uses it as legitimate prompt structure
214
- sanitized = sanitized.replace(/<(\/?)(?:system|assistant|human)>/gi,
215
- (_, slash) => `<${slash || ''}system-text>`);
216
-
217
- // Neutralize [SYSTEM] / [INST] markers
218
- sanitized = sanitized.replace(/\[(SYSTEM|INST)\]/gi, '[$1-TEXT]');
219
-
220
- // Neutralize <<SYS>> markers
221
- sanitized = sanitized.replace(/<<\s*SYS\s*>>/gi, '«SYS-TEXT»');
222
-
223
- return sanitized;
224
- }
225
-
226
- /**
227
- * Sanitize text that will be displayed back to the user.
228
- * Removes protocol-like leak markers that should never surface in checkpoints.
229
- *
230
- * @param {string} text - Text to sanitize
231
- * @returns {string} Sanitized text
232
- */
233
- function sanitizeForDisplay(text) {
234
- if (!text || typeof text !== 'string') return text;
235
-
236
- let sanitized = sanitizeForPrompt(text);
237
-
238
- const protocolLeakPatterns = [
239
- /^\s*(?:assistant|user|system)\s+to=[^:\s]+:[^\n]+$/i,
240
- /^\s*<\|(?:assistant|user|system)[^|]*\|>\s*$/i,
241
- ];
242
-
243
- sanitized = sanitized
244
- .split('\n')
245
- .filter(line => !protocolLeakPatterns.some(pattern => pattern.test(line)))
246
- .join('\n');
247
-
248
- return sanitized;
249
- }
250
-
251
- // ─── Shell Safety ───────────────────────────────────────────────────────────
252
-
253
- /**
254
- * Validate that a string is safe to use as a shell argument when quoted.
255
- * This is a defense-in-depth check — callers should always use array-based
256
- * exec (spawnSync) where possible.
257
- *
258
- * @param {string} value - The value to check
259
- * @param {string} label - Description for error messages
260
- * @returns {string} The validated value
261
- */
262
- function validateShellArg(value, label) {
263
- if (!value || typeof value !== 'string') {
264
- throw new Error(`${label || 'Argument'}: empty or invalid value`);
265
- }
266
-
267
- // Reject null bytes
268
- if (value.includes('\0')) {
269
- throw new Error(`${label || 'Argument'}: contains null bytes`);
270
- }
271
-
272
- // Reject command substitution attempts
273
- if (/[$`]/.test(value) && /\$\(|`/.test(value)) {
274
- throw new Error(`${label || 'Argument'}: contains potential command substitution`);
275
- }
276
-
277
- return value;
278
- }
279
-
280
- // ─── JSON Safety ────────────────────────────────────────────────────────────
281
-
282
- /**
283
- * Safely parse JSON with error handling and optional size limits.
284
- * Wraps JSON.parse to prevent uncaught exceptions from malformed input.
285
- *
286
- * @param {string} text - JSON string to parse
287
- * @param {object} [opts] - Options
288
- * @param {number} [opts.maxLength=1048576] - Maximum input length (1MB default)
289
- * @param {string} [opts.label='JSON'] - Description for error messages
290
- * @returns {{ ok: boolean, value?: any, error?: string }}
291
- */
292
- function safeJsonParse(text, opts = {}) {
293
- const maxLength = opts.maxLength || 1048576;
294
- const label = opts.label || 'JSON';
295
-
296
- if (!text || typeof text !== 'string') {
297
- return { ok: false, error: `${label}: empty or invalid input` };
298
- }
299
-
300
- if (text.length > maxLength) {
301
- return { ok: false, error: `${label}: input exceeds ${maxLength} byte limit (got ${text.length})` };
302
- }
303
-
304
- try {
305
- const value = JSON.parse(text);
306
- return { ok: true, value };
307
- } catch (err) {
308
- return { ok: false, error: `${label}: parse error — ${err.message}` };
309
- }
310
- }
311
-
312
- // ─── Phase/Argument Validation ──────────────────────────────────────────────
313
-
314
- /**
315
- * Validate a phase number argument.
316
- * Phase numbers must match: integer, decimal (2.1), or letter suffix (12A).
317
- * Rejects arbitrary strings that could be used for injection.
318
- *
319
- * @param {string} phase - The phase number to validate
320
- * @returns {{ valid: boolean, normalized?: string, error?: string }}
321
- */
322
- function validatePhaseNumber(phase) {
323
- if (!phase || typeof phase !== 'string') {
324
- return { valid: false, error: 'Phase number is required' };
325
- }
326
-
327
- const trimmed = phase.trim();
328
-
329
- // Standard numeric: 1, 01, 12A, 12.1, 12A.1.2
330
- if (/^\d{1,4}[A-Z]?(?:\.\d{1,3})*$/i.test(trimmed)) {
331
- return { valid: true, normalized: trimmed };
332
- }
333
-
334
- // Custom project IDs: PROJ-42, AUTH-101 (uppercase alphanumeric with hyphens)
335
- if (/^[A-Z][A-Z0-9]*(?:-[A-Z0-9]+){1,4}$/i.test(trimmed) && trimmed.length <= 30) {
336
- return { valid: true, normalized: trimmed };
337
- }
338
-
339
- return { valid: false, error: `Invalid phase number format: "${trimmed}"` };
340
- }
341
-
342
- /**
343
- * Validate a STATE.md field name to prevent injection into regex patterns.
344
- * Field names must be alphanumeric with spaces, hyphens, underscores, or dots.
345
- *
346
- * @param {string} field - The field name to validate
347
- * @returns {{ valid: boolean, error?: string }}
348
- */
349
- function validateFieldName(field) {
350
- if (!field || typeof field !== 'string') {
351
- return { valid: false, error: 'Field name is required' };
352
- }
353
-
354
- // Allow typical field names: "Current Phase", "active_plan", "Phase 1.2"
355
- if (/^[A-Za-z][A-Za-z0-9 _.\-/]{0,60}$/.test(field)) {
356
- return { valid: true };
357
- }
358
-
359
- return { valid: false, error: `Invalid field name: "${field}"` };
360
- }
361
-
362
- module.exports = {
363
- // Path safety
364
- validatePath,
365
- requireSafePath,
366
-
367
- // Prompt injection
368
- INJECTION_PATTERNS,
369
- scanForInjection,
370
- sanitizeForPrompt,
371
- sanitizeForDisplay,
372
-
373
- // Shell safety
374
- validateShellArg,
375
-
376
- // JSON safety
377
- safeJsonParse,
378
-
379
- // Input validation
380
- validatePhaseNumber,
381
- validateFieldName,
382
- };
1
+ /**
2
+ * Security — Input validation, path traversal prevention, and prompt injection guards
3
+ *
4
+ * This module centralizes security checks for framework tooling. Because framework generates
5
+ * markdown files that become LLM system prompts (agent instructions, workflow state,
6
+ * phase plans), any user-controlled text that flows into these files is a potential
7
+ * indirect prompt injection vector.
8
+ *
9
+ * Threat model:
10
+ * 1. Path traversal: user-supplied file paths escape the project directory
11
+ * 2. Prompt injection: malicious text in arguments/PRDs embeds LLM instructions
12
+ * 3. Shell metacharacter injection: user text interpreted by shell
13
+ * 4. JSON injection: malformed JSON crashes or corrupts state
14
+ * 5. Regex DoS: crafted input causes catastrophic backtracking
15
+ */
16
+ 'use strict';
17
+
18
+ const fs = require('fs');
19
+ const path = require('path');
20
+
21
+ // ─── Path Traversal Prevention ──────────────────────────────────────────────
22
+
23
+ /**
24
+ * Validate that a file path resolves within an allowed base directory.
25
+ * Prevents path traversal attacks via ../ sequences, symlinks, or absolute paths.
26
+ *
27
+ * @param {string} filePath - The user-supplied file path
28
+ * @param {string} baseDir - The allowed base directory (e.g., project root)
29
+ * @param {object} [opts] - Options
30
+ * @param {boolean} [opts.allowAbsolute=false] - Allow absolute paths (still must be within baseDir)
31
+ * @returns {{ safe: boolean, resolved: string, error?: string }}
32
+ */
33
+ function validatePath(filePath, baseDir, opts = {}) {
34
+ if (!filePath || typeof filePath !== 'string') {
35
+ return { safe: false, resolved: '', error: 'Empty or invalid file path' };
36
+ }
37
+
38
+ if (!baseDir || typeof baseDir !== 'string') {
39
+ return { safe: false, resolved: '', error: 'Empty or invalid base directory' };
40
+ }
41
+
42
+ // Reject null bytes (can bypass path checks in some environments)
43
+ if (filePath.includes('\0')) {
44
+ return { safe: false, resolved: '', error: 'Path contains null bytes' };
45
+ }
46
+
47
+ // Resolve symlinks in base directory to handle macOS /var -> /private/var
48
+ // and similar platform-specific symlink chains
49
+ let resolvedBase;
50
+ try {
51
+ resolvedBase = fs.realpathSync(path.resolve(baseDir));
52
+ } catch {
53
+ resolvedBase = path.resolve(baseDir);
54
+ }
55
+
56
+ let resolvedPath;
57
+
58
+ if (path.isAbsolute(filePath)) {
59
+ if (!opts.allowAbsolute) {
60
+ return { safe: false, resolved: '', error: 'Absolute paths not allowed' };
61
+ }
62
+ resolvedPath = path.resolve(filePath);
63
+ } else {
64
+ resolvedPath = path.resolve(baseDir, filePath);
65
+ }
66
+
67
+ // Resolve symlinks in the target path too
68
+ try {
69
+ resolvedPath = fs.realpathSync(resolvedPath);
70
+ } catch {
71
+ // File may not exist yet (e.g., about to be created) — use logical resolution
72
+ // but still resolve the parent directory if it exists
73
+ const parentDir = path.dirname(resolvedPath);
74
+ try {
75
+ const realParent = fs.realpathSync(parentDir);
76
+ resolvedPath = path.join(realParent, path.basename(resolvedPath));
77
+ } catch {
78
+ // Parent doesn't exist either — keep the resolved path as-is
79
+ }
80
+ }
81
+
82
+ // Normalize both paths and check containment
83
+ const normalizedBase = resolvedBase + path.sep;
84
+ const normalizedPath = resolvedPath + path.sep;
85
+
86
+ // The resolved path must start with the base directory
87
+ // (or be exactly the base directory)
88
+ if (resolvedPath !== resolvedBase && !normalizedPath.startsWith(normalizedBase)) {
89
+ return {
90
+ safe: false,
91
+ resolved: resolvedPath,
92
+ error: `Path escapes allowed directory: ${resolvedPath} is outside ${resolvedBase}`,
93
+ };
94
+ }
95
+
96
+ return { safe: true, resolved: resolvedPath };
97
+ }
98
+
99
+ /**
100
+ * Validate a file path and throw on traversal attempt.
101
+ * Convenience wrapper around validatePath for use in CLI commands.
102
+ */
103
+ function requireSafePath(filePath, baseDir, label, opts = {}) {
104
+ const result = validatePath(filePath, baseDir, opts);
105
+ if (!result.safe) {
106
+ throw new Error(`${label || 'Path'} validation failed: ${result.error}`);
107
+ }
108
+ return result.resolved;
109
+ }
110
+
111
+ // ─── Prompt Injection Detection ─────────────────────────────────────────────
112
+
113
+ /**
114
+ * Patterns that indicate prompt injection attempts in user-supplied text.
115
+ * These patterns catch common indirect prompt injection techniques where
116
+ * an attacker embeds LLM instructions in text that will be read by an agent.
117
+ *
118
+ * Note: This is defense-in-depth — not a complete solution. The primary defense
119
+ * is proper input/output boundaries in agent prompts.
120
+ */
121
+ const INJECTION_PATTERNS = [
122
+ // Direct instruction override attempts
123
+ /ignore\s+(all\s+)?previous\s+instructions/i,
124
+ /ignore\s+(all\s+)?above\s+instructions/i,
125
+ /disregard\s+(all\s+)?previous/i,
126
+ /forget\s+(all\s+)?(your\s+)?instructions/i,
127
+ /override\s+(system|previous)\s+(prompt|instructions)/i,
128
+
129
+ // Role/identity manipulation
130
+ /you\s+are\s+now\s+(?:a|an|the)\s+/i,
131
+ /act\s+as\s+(?:a|an|the)\s+(?!plan|phase|wave)/i, // allow "act as a plan"
132
+ /pretend\s+(?:you(?:'re| are)\s+|to\s+be\s+)/i,
133
+ /from\s+now\s+on,?\s+you\s+(?:are|will|should|must)/i,
134
+
135
+ // System prompt extraction
136
+ /(?:print|output|reveal|show|display|repeat)\s+(?:your\s+)?(?:system\s+)?(?:prompt|instructions)/i,
137
+ /what\s+(?:are|is)\s+your\s+(?:system\s+)?(?:prompt|instructions)/i,
138
+
139
+ // Hidden instruction markers (XML/HTML tags that mimic system messages)
140
+ // Note: <instructions> is excluded — framework uses it as legitimate prompt structure
141
+ // Requires > to close the tag (not just whitespace) to avoid matching generic types like Promise<User | null>
142
+ /<\/?(?:system|assistant|human)>/i,
143
+ /\[SYSTEM\]/i,
144
+ /\[INST\]/i,
145
+ /<<\s*SYS\s*>>/i,
146
+
147
+ // Exfiltration attempts
148
+ /(?:send|post|fetch|curl|wget)\s+(?:to|from)\s+https?:\/\//i,
149
+ /(?:base64|btoa|encode)\s+(?:and\s+)?(?:send|exfiltrate|output)/i,
150
+
151
+ // Tool manipulation
152
+ /(?:run|execute|call|invoke)\s+(?:the\s+)?(?:bash|shell|exec|spawn)\s+(?:tool|command)/i,
153
+ ];
154
+
155
+ /**
156
+ * Scan text for potential prompt injection patterns.
157
+ * Returns an array of findings (empty = clean).
158
+ *
159
+ * @param {string} text - The text to scan
160
+ * @param {object} [opts] - Options
161
+ * @param {boolean} [opts.strict=false] - Enable stricter matching (more false positives)
162
+ * @returns {{ clean: boolean, findings: string[] }}
163
+ */
164
+ function scanForInjection(text, opts = {}) {
165
+ if (!text || typeof text !== 'string') {
166
+ return { clean: true, findings: [] };
167
+ }
168
+
169
+ const findings = [];
170
+
171
+ for (const pattern of INJECTION_PATTERNS) {
172
+ if (pattern.test(text)) {
173
+ findings.push(`Matched injection pattern: ${pattern.source}`);
174
+ }
175
+ }
176
+
177
+ if (opts.strict) {
178
+ // Check for suspicious Unicode that could hide instructions
179
+ // (zero-width chars, RTL override, homoglyph attacks)
180
+ if (/[\u200B-\u200F\u2028-\u202F\uFEFF\u00AD]/.test(text)) {
181
+ findings.push('Contains suspicious zero-width or invisible Unicode characters');
182
+ }
183
+
184
+ // Check for extremely long strings that could be prompt stuffing
185
+ if (text.length > 50000) {
186
+ findings.push(`Suspicious text length: ${text.length} chars (potential prompt stuffing)`);
187
+ }
188
+ }
189
+
190
+ return { clean: findings.length === 0, findings };
191
+ }
192
+
193
+ /**
194
+ * Sanitize text that will be embedded in agent prompts or planning documents.
195
+ * Strips known injection markers while preserving legitimate content.
196
+ *
197
+ * This does NOT alter user intent — it neutralizes control characters and
198
+ * instruction-mimicking patterns that could hijack agent behavior.
199
+ *
200
+ * @param {string} text - Text to sanitize
201
+ * @returns {string} Sanitized text
202
+ */
203
+ function sanitizeForPrompt(text) {
204
+ if (!text || typeof text !== 'string') return text;
205
+
206
+ let sanitized = text;
207
+
208
+ // Strip zero-width characters that could hide instructions
209
+ sanitized = sanitized.replace(/[\u200B-\u200F\u2028-\u202F\uFEFF\u00AD]/g, '');
210
+
211
+ // Neutralize XML/HTML tags that mimic system boundaries
212
+ // Replace < > with full-width equivalents to prevent tag interpretation
213
+ // Note: <instructions> is excluded — framework uses it as legitimate prompt structure
214
+ sanitized = sanitized.replace(/<(\/?)(?:system|assistant|human)>/gi,
215
+ (_, slash) => `<${slash || ''}system-text>`);
216
+
217
+ // Neutralize [SYSTEM] / [INST] markers
218
+ sanitized = sanitized.replace(/\[(SYSTEM|INST)\]/gi, '[$1-TEXT]');
219
+
220
+ // Neutralize <<SYS>> markers
221
+ sanitized = sanitized.replace(/<<\s*SYS\s*>>/gi, '«SYS-TEXT»');
222
+
223
+ return sanitized;
224
+ }
225
+
226
+ /**
227
+ * Sanitize text that will be displayed back to the user.
228
+ * Removes protocol-like leak markers that should never surface in checkpoints.
229
+ *
230
+ * @param {string} text - Text to sanitize
231
+ * @returns {string} Sanitized text
232
+ */
233
+ function sanitizeForDisplay(text) {
234
+ if (!text || typeof text !== 'string') return text;
235
+
236
+ let sanitized = sanitizeForPrompt(text);
237
+
238
+ const protocolLeakPatterns = [
239
+ /^\s*(?:assistant|user|system)\s+to=[^:\s]+:[^\n]+$/i,
240
+ /^\s*<\|(?:assistant|user|system)[^|]*\|>\s*$/i,
241
+ ];
242
+
243
+ sanitized = sanitized
244
+ .split('\n')
245
+ .filter(line => !protocolLeakPatterns.some(pattern => pattern.test(line)))
246
+ .join('\n');
247
+
248
+ return sanitized;
249
+ }
250
+
251
+ // ─── Shell Safety ───────────────────────────────────────────────────────────
252
+
253
+ /**
254
+ * Validate that a string is safe to use as a shell argument when quoted.
255
+ * This is a defense-in-depth check — callers should always use array-based
256
+ * exec (spawnSync) where possible.
257
+ *
258
+ * @param {string} value - The value to check
259
+ * @param {string} label - Description for error messages
260
+ * @returns {string} The validated value
261
+ */
262
+ function validateShellArg(value, label) {
263
+ if (!value || typeof value !== 'string') {
264
+ throw new Error(`${label || 'Argument'}: empty or invalid value`);
265
+ }
266
+
267
+ // Reject null bytes
268
+ if (value.includes('\0')) {
269
+ throw new Error(`${label || 'Argument'}: contains null bytes`);
270
+ }
271
+
272
+ // Reject command substitution attempts
273
+ if (/[$`]/.test(value) && /\$\(|`/.test(value)) {
274
+ throw new Error(`${label || 'Argument'}: contains potential command substitution`);
275
+ }
276
+
277
+ return value;
278
+ }
279
+
280
+ // ─── JSON Safety ────────────────────────────────────────────────────────────
281
+
282
+ /**
283
+ * Safely parse JSON with error handling and optional size limits.
284
+ * Wraps JSON.parse to prevent uncaught exceptions from malformed input.
285
+ *
286
+ * @param {string} text - JSON string to parse
287
+ * @param {object} [opts] - Options
288
+ * @param {number} [opts.maxLength=1048576] - Maximum input length (1MB default)
289
+ * @param {string} [opts.label='JSON'] - Description for error messages
290
+ * @returns {{ ok: boolean, value?: any, error?: string }}
291
+ */
292
+ function safeJsonParse(text, opts = {}) {
293
+ const maxLength = opts.maxLength || 1048576;
294
+ const label = opts.label || 'JSON';
295
+
296
+ if (!text || typeof text !== 'string') {
297
+ return { ok: false, error: `${label}: empty or invalid input` };
298
+ }
299
+
300
+ if (text.length > maxLength) {
301
+ return { ok: false, error: `${label}: input exceeds ${maxLength} byte limit (got ${text.length})` };
302
+ }
303
+
304
+ try {
305
+ const value = JSON.parse(text);
306
+ return { ok: true, value };
307
+ } catch (err) {
308
+ return { ok: false, error: `${label}: parse error — ${err.message}` };
309
+ }
310
+ }
311
+
312
+ // ─── Phase/Argument Validation ──────────────────────────────────────────────
313
+
314
+ /**
315
+ * Validate a phase number argument.
316
+ * Phase numbers must match: integer, decimal (2.1), or letter suffix (12A).
317
+ * Rejects arbitrary strings that could be used for injection.
318
+ *
319
+ * @param {string} phase - The phase number to validate
320
+ * @returns {{ valid: boolean, normalized?: string, error?: string }}
321
+ */
322
+ function validatePhaseNumber(phase) {
323
+ if (!phase || typeof phase !== 'string') {
324
+ return { valid: false, error: 'Phase number is required' };
325
+ }
326
+
327
+ const trimmed = phase.trim();
328
+
329
+ // Standard numeric: 1, 01, 12A, 12.1, 12A.1.2
330
+ if (/^\d{1,4}[A-Z]?(?:\.\d{1,3})*$/i.test(trimmed)) {
331
+ return { valid: true, normalized: trimmed };
332
+ }
333
+
334
+ // Custom project IDs: PROJ-42, AUTH-101 (uppercase alphanumeric with hyphens)
335
+ if (/^[A-Z][A-Z0-9]*(?:-[A-Z0-9]+){1,4}$/i.test(trimmed) && trimmed.length <= 30) {
336
+ return { valid: true, normalized: trimmed };
337
+ }
338
+
339
+ return { valid: false, error: `Invalid phase number format: "${trimmed}"` };
340
+ }
341
+
342
+ /**
343
+ * Validate a STATE.md field name to prevent injection into regex patterns.
344
+ * Field names must be alphanumeric with spaces, hyphens, underscores, or dots.
345
+ *
346
+ * @param {string} field - The field name to validate
347
+ * @returns {{ valid: boolean, error?: string }}
348
+ */
349
+ function validateFieldName(field) {
350
+ if (!field || typeof field !== 'string') {
351
+ return { valid: false, error: 'Field name is required' };
352
+ }
353
+
354
+ // Allow typical field names: "Current Phase", "active_plan", "Phase 1.2"
355
+ if (/^[A-Za-z][A-Za-z0-9 _.\-/]{0,60}$/.test(field)) {
356
+ return { valid: true };
357
+ }
358
+
359
+ return { valid: false, error: `Invalid field name: "${field}"` };
360
+ }
361
+
362
+ module.exports = {
363
+ // Path safety
364
+ validatePath,
365
+ requireSafePath,
366
+
367
+ // Prompt injection
368
+ INJECTION_PATTERNS,
369
+ scanForInjection,
370
+ sanitizeForPrompt,
371
+ sanitizeForDisplay,
372
+
373
+ // Shell safety
374
+ validateShellArg,
375
+
376
+ // JSON safety
377
+ safeJsonParse,
378
+
379
+ // Input validation
380
+ validatePhaseNumber,
381
+ validateFieldName,
382
+ };