Phillip Tarrant
1eb2a52f17
Core changes
- Centralize detection in the Rules Engine; browser.py now focuses on fetch/extract/persist.
- Add class-based adapters:
- FactAdapter: converts snippets → structured facts.
- FunctionRuleAdapter: wraps dict-based rule functions for engine input (str or dict).
- Register function rules (code-based) alongside YAML rules:
- form_action_missing
- form_http_on_https_page
- form_submits_to_different_host
- script_src_uses_data_or_blob
- script_src_has_dangerous_extension
- script_third_party_host
Rules & YAML
- Expand/normalize YAML rules with severities + tags; tighten patterns.
- Add new regex rules: new_function_usage, unescape_usage, string_timer_usage, long_hex_constants.
- Move iframe rule to `text` category.
- Keep existing script/form/text rules; all compile under IGNORECASE.
Browser / analysis refactor
- browser.py:
- Remove inline heuristics; rely on engine for PASS/FAIL, reason, severity, tags.
- Build page-level overview (`rule_checks`) across categories.
- Analyze forms: add `base_url` + `base_hostname` to snippet so function rules can evaluate; include per-form rule_checks.
- Analyze scripts: **per-script evaluation**:
- Inline -> run regex script rules on inline text.
- External -> run function script rules with a facts dict (src/src_hostname/base_url/base_hostname).
- Only include scripts that matched ≥1 rule; attach severity/tags to matches.
- Persist single source of truth: `/data/<uuid>/results.json`.
- Backward-compat: `fetch_page_artifacts(..., engine=...)` kwarg accepted/ignored.
UI/UX
- Suspicious Scripts table now shows only matched scripts.
- Add severity badges and tag chips; tooltips show rule description.
- Prevent table blowouts:
- Fixed layout + ellipsis + wrapping helpers (`.scripts-table`, `.breakable`, `details pre.code`).
- Shortened inline snippet preview (configurable).
- Minor template niceties (e.g., rel="noopener" on external links where applicable).
Config
- Add `ui.snippet_preview_len` to settings.yaml; default 160.
- Load into `app.config["SNIPPET_PREVIEW_LEN"]` and use in `analyze_scripts`.
Init / wiring
- Import and register function rules as `Rule(...)` objects (not dicts).
- Hook Rules Engine to Flask logger for verbose/diagnostic output.
- Log totals on startup; keep YAML path override via `SNEAKYSCOPE_RULES_FILE`.
Bug fixes
- Fix boot crash: pass `Rule` instances to `engine.add_rule()` instead of dicts.
- Fix “N/A” in scripts table by actually computing per-script matches.
- Ensure form rules fire by including `base_url`/`base_hostname` in form snippets.
Roadmap
- Update roadmap to reflect completed items:
- “Show each check and whether it triggered (pass/fail list per rule)”
- Severity levels + tags in Suspicious Scripts
- Results.json as route source of truth
- Scripts table UX (badges, tooltips, layout fix)
33 lines
1.5 KiB
Markdown
33 lines
1.5 KiB
Markdown
# SneakyScope — Roadmap (Updated 8-20-25)
|
||
|
||
## Priority 1 – Core Analysis / Stability
|
||
|
||
* Opt-in “fetch external scripts” mode (off by default): on submission, download external script content (size/time limits) and run rules on fetched content.
|
||
* Remove remaining legacy form “flagged\_reasons” plumbing once all equivalent function rules are in place.
|
||
* Unit tests: YAML compilation, function-rule adapters, and per-script/per-form rule cases.
|
||
|
||
## Priority 2 – API Layer
|
||
|
||
* API endpoints: `/screenshot`, `/source`, `/analyse`.
|
||
* OpenAPI spec: create `openapi/openapi.yaml` and serve at `/api/openapi.yaml`.
|
||
* Docs UI: Swagger UI or Redoc at `/docs`.
|
||
|
||
## Priority 3 – UI / UX
|
||
|
||
* Front page/input handling: auto-prepend `http://`/`https://`/`www.` for bare domains.
|
||
* Source code viewer: embed page source in an editor view for readability.
|
||
* Scripts table: toggle between “Only suspicious” and “All scripts”.
|
||
* Rules Lab (WYSIWYG tester): paste a rule, validate/compile, run against sample text; lightweight nav entry.
|
||
|
||
## Priority 4 – Artifact Management & Ops
|
||
|
||
* Retention/cleanup policy for old artifacts (age/size thresholds).
|
||
* Make periodic maintenance scripts for storage; cleanup options set in `settings.yaml`.
|
||
* Results caching UX: add “Re-run analysis” vs. “Load from cache” controls in the results UI.
|
||
|
||
## Priority 5 – Extras / Integrations
|
||
|
||
* Bulk URL analysis (batch/queue).
|
||
* Alerting & integrations (webhooks, Slack, email).
|
||
* Optional: analyst verdict tags and export (CSV/JSON).
|