Skip to content

Commit 942fc02

Browse files
committed
chore: update .gitignore and README for improved clarity and new features
- Added .env.local and .env.*.local to .gitignore for better environment management. - Updated README to include new features: bug bounty mode, TUI, MCP server, and export formats (Markdown, SARIF, JUnit). - Clarified output directory structure and tools available for running scans and skills.
1 parent f219d2b commit 942fc02

2 files changed

Lines changed: 20 additions & 8 deletions

File tree

.gitignore

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,17 @@ venv/
33
env/
44
.venv/
55
.env
6+
.env.local
7+
.env.*.local
68

7-
# Application results
9+
# Application results and session data
810
results/
911
.sisyphus/
1012
.secnode_temp/
13+
.api-agent/
1114
all_tests.txt
1215

13-
# Python Cache
16+
# Python cache and build
1417
__pycache__/
1518
*.pyc
1619
*.pyo
@@ -19,6 +22,9 @@ __pycache__/
1922
.coverage
2023
htmlcov/
2124
*.egg-info/
25+
dist/
26+
build/
27+
*.egg
2228

2329
# macOS
2430
.DS_Store
@@ -28,5 +34,5 @@ htmlcov/
2834
.vscode/
2935
.cursor/
3036

31-
# Debug logs
32-
debug-*.log
37+
# Logs
38+
*.log

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ SecNode API helps security engineers and backend teams run repeatable API risk a
1515
- Executes tests concurrently with optional proxy routing
1616
- Supports autonomous agent mode with request budgets and iterative replanning
1717
- Supports direct microservices mode with controller/planner/worker boundaries
18-
- Produces both human-readable and machine-readable findings
18+
- Bug bounty mode with strict scope enforcement for authorized testing
19+
- TUI (`secnodeapi-tui`) for interactive scans and skill execution
20+
- MCP server for Cursor and IDE integration
21+
- Produces both human-readable and machine-readable findings (Markdown, SARIF, JUnit)
1922

2023
## What It Is and Is Not
2124

@@ -175,11 +178,13 @@ TUI command highlights:
175178

176179
## Output
177180

178-
Each run generates an output directory containing:
181+
Each run generates an output directory under `results/` containing:
179182

180183
- `report.md` with executive summary, severity overview, and evidence sections
181184
- `findings.json` for machine processing and pipeline integration
182185

186+
Export formats include Markdown, SARIF, and JUnit for CI integration.
187+
183188
## Development
184189

185190
```bash
@@ -211,13 +216,14 @@ GitHub Actions workflow runs:
211216

212217
## Direct Microservices Runtime
213218

214-
This repository now includes a direct microservices runtime foundation:
219+
This repository includes a direct microservices runtime foundation:
215220

216221
- Controller service
217222
- Planner service
218223
- Skill engine service with ranked skill dispatch
219224
- Specialized workers (recon, discovery, fuzzing, exploit)
220225
- Tool adapters (`ffuf`, `nuclei`, `sqlmap`, `zap`, `kiterunner`)
226+
- Python skills: BOLA, JWT tamper, XSS, SSRF, GraphQL injection/auth bypass, NoSQL injection, command injection, rate limit bypass, workflow exploit
221227
- Memory subsystem (session, history, skill metrics)
222228
- Attack graph engine
223229
- FastAPI control plane
@@ -267,7 +273,7 @@ secnodeapi-mcp --transport streamable-http --port 8010
267273
### Tools
268274

269275
- `run_scan(target)` run a full API pentest against the target URL
270-
- `run_skill(target, skill_name)` run a specific skill (e.g. api_path_fuzz, template_vuln_scan)
276+
- `run_skill(target, skill_name)` run a specific skill (e.g. api_path_fuzz, bola_test, jwt_tamper, xss_scan)
271277
- `list_skills()` list available pentesting skills
272278
- `export_report(session_id, format, output_path)` export findings to Markdown or SARIF
273279

0 commit comments

Comments
 (0)