42Crunch Scan Skill

Runs a single phase: Scan (live conformance + authorization testing and SQG-blocking fix loop). Requires explicit user permission before execution. Does not run a static audit — use the 42crunch-audit skill for that.

Assumes the OAS file is already audit-clean (or the user is explicitly running scan only). If the user mentions audit issues before scanning, suggest running 42crunch-audit first.

Entry Point

1. Pre-flight checks. Read ../../references/pre-flight.md and complete all steps (setup, OAS resolution, tag detection). When prompting for OAS file selection, use the context "scan" (e.g. "Which one should I scan?"). Do not proceed if any step fails or the user cancels.

2. Resolve the scan target URL.

   Read servers[0].url from the OAS file.

   • If SCAN42C_HOST environment variable is set → announce silently:

     "Using scan target from SCAN42C_HOST: <url>" Store as SCAN_TARGET_URL and proceed.

   • If not set → call AskUserQuestion:
     • question: "The OAS points to <servers[0].url> as the API target. Is this the right URL to scan against?" — options: ["Yes — use this URL", "No — I'll provide a different URL"]
     • If No → ask the user to provide the URL and store it as SCAN_TARGET_URL.
     • If Yes → store servers[0].url as SCAN_TARGET_URL.

   Reachability check — run immediately after SCAN_TARGET_URL is confirmed. Uses a two-stage probe to distinguish "server is down" from "wrong base URL".

   Stage 1 — probe the base URL:

   curl -s -o /dev/null -w "%{http_code}" --max-time 5 <SCAN_TARGET_URL>/
   

   • 2xx, 3xx, 401, 403, or 405 → API is reachable. Proceed silently.
   • Connection refused or timeout → call AskUserQuestion:
     • question: "I couldn't reach <SCAN_TARGET_URL> — the connection timed out or was refused. How would you like to proceed?"
     • options: ["Try a different URL", "Continue anyway — the API may be temporarily down", "Cancel"]
     • If Try a different URL → ask for new URL, store as SCAN_TARGET_URL, re-run from Stage 1.
     • If Continue anyway → proceed with warning noted.
     • If Cancel → stop.
   • 404 → ambiguous (server may be up but nothing is mounted at root). Proceed to Stage 2.

   Stage 2 — probe the first simple OAS path (only reached when Stage 1 returns 404): Find the first GET path in the OAS that has no required path parameters. Strip any {param}-style segments and probe:

   curl -s -o /dev/null -w "%{http_code}" --max-time 5 <SCAN_TARGET_URL><first_simple_path>
   

   • Any HTTP response → server is up; root just has no handler. Proceed silently.
   • Connection refused or timeout → same AskUserQuestion as Stage 1.
   • 404 again → call AskUserQuestion:
     • question: "The server responded but both / and <path> returned 404 — the base URL may be incorrect (the API may be mounted at a different prefix). How would you like to proceed?"
     • options: ["Try a different URL", "Continue anyway", "Cancel"]
     • If Try a different URL → ask for new URL, store as SCAN_TARGET_URL, re-run from Stage 1.
     • If Continue anyway → proceed with warning noted.
     • If Cancel → stop.

3. OAS analysis for scan preview — run silently before asking permission.

   Read the OAS file and collect:

   • Total operation count
   • Auth scheme types from securitySchemes (Bearer/JWT, API Key, Basic, OAuth2)
   • BOLA candidate count: operations where the path has {…Id}, {…Key}, {…Ref}, or similar resource-ID placeholders AND the method is GET, PUT, PATCH, or DELETE
   • Whether the OAS contains sample data: any operation with example, examples, or default values on its request body or parameter schemas

4. Ask for permission to configure the scan. Call AskUserQuestion:

   • question: (show the scan preview first, then ask)

     Ready to configure the scan?
       Target:   <SCAN_TARGET_URL>  ✓ reachable  /  ⚠ reachability unknown
       OAS:      <filename>  (<N> operations)
       Auth:     <scheme types>  [+  second user needed — <N> BOLA candidate(s)]
       Samples:  OAS has sample data  /  No samples — you'll need to provide test data
       Tag:      <category>:<tagname>           ← platform mode only, when a tag is assigned; omit if no tag
       Mode:     Platform / Freemium
     

     "I'm ready to start configuring the scan. I'll ask for credentials, classify your operations, and set up test scenarios — then run a happy path validation before the full scan. Shall I proceed?"
   • options: ["Yes, let's configure", "No, cancel"]

5. Execute the Scan. Mode is already resolved from pre-flight — do not re-derive it. Read ../../references/scan-workflow.md and apply only the commands for the identified mode throughout. The workflow sets up the scan config, collects credentials, gathers test data, classifies operations, validates happy paths, then asks for permission again before running the full scan. It presents a risk-classified findings report (Authorization failures / SQG-blocking conformance / informational conformance) and pauses for consent before applying any OAS changes.

Mandatory checkpoint: after any direct edit to CONF_FILE (including environments.default.variables.*, auth wiring, or scenario chains), run scan conf validate and resolve all validation errors before continuing to happy-path or full scan runs.

Freemium mode: no SQG is enforced for scan. Present all findings for information. The user decides which (if any) to fix.

6. Present the final scan summary (see Output Format below).

Only continue after explicit user confirmation at each permission prompt.

Output Format

After the scan completes, produce a summary in this shape:

Scan Complete
  Mode:           Platform / Freemium
  SQG:            PASSED  (<sqg-name> — your org's security quality gate is met)    ← platform mode, passed
  SQG:            FAILED  (<sqg-name> — the quality gate is not met; fixes above are required)    ← platform mode, failed
  SQG:            N/A  (Freemium — scan findings are informational; no gate enforced)    ← freemium mode
  Tag:            <category>:<tagname>             ← platform mode only, when a tag is assigned; omit this row if no tag
  Authorization:  BOLA confirmed on 1 operation — OAS updated · server-side fix applied
  Conformance:    1 SQG-blocking issue fixed (OAS + code) · 3 informational findings surfaced
  OAS updated:    <path/to/openapi.json>

Show only the one SQG line that matches the current mode and result.

If the user declined to apply fixes or no issues were found, note that instead.

Environment Variables

All other variables (API_KEY, PLATFORM_HOST, FREEMIUM_TOKEN) and general constraints are defined in ../../references/pre-flight.md.