mirror of
https://github.com/yogeshojha/rengine.git
synced 2026-10-20 23:31:31 +02:00
reNgine 2 had a Tools section; 3.0 lost it, so a hunter left the product for a whois or a dns lookup even though every capability was already here inside a scan. `toolbox/` is a top-level package mounted into api and worker, and a tool is one file under `toolbox/tools/` — auto-discovered exactly like stages, report sections and MCP tools, with a pydantic `Input` whose flattened schema IS the form the UI renders. Six ship: WHOIS, DNS records, subdomain finder, HTTP probe, IP address and CVE. Where a tool runs is a declaration the registry enforces. The api image carries no tool binaries, so `INLINE` answers from RDAP, the offline range tables or the threat feeds on the request's AsyncSession, and `QUEUED` shells out on the worker; `_validate` rejects a class whose `run` is async or sync the wrong way round, so the two cannot drift. A run is a question rather than inventory, so it lives in Redis with a seven-day TTL and no migration, keyed by user id. A queued run nobody collects fails after two minutes instead of spinning for ever. A tool answers in blocks — facts, table, tags, code, note — so one frontend renderer serves every tool and a new one costs no frontend work. An empty block with nothing to say about being empty is dropped. `require_public` refuses loopback, private and link-local before the HTTP probe sends anything, because an authenticated user typing 169.254.169.254 is an SSRF. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CtRcxFCPSYxW5sXam3SUWB
252 lines
7.8 KiB
Python
252 lines
7.8 KiB
Python
from celery import Celery
|
|
|
|
from shared.config import BaseAppSettings
|
|
from shared.definitions.constants import SCANS_QUEUE
|
|
from shared.logging import get_logger
|
|
|
|
logger = get_logger(__name__)
|
|
|
|
_celery_client: Celery | None = None
|
|
|
|
|
|
def get_celery_client() -> Celery:
|
|
global _celery_client # noqa: PLW0603
|
|
if _celery_client is None:
|
|
_settings = BaseAppSettings()
|
|
# never set_as_current: this client carries no result backend, and adopting it as
|
|
# the ambient app leaves every later chord in the process unable to start
|
|
_celery_client = Celery(
|
|
broker=_settings.celery_broker_url, set_as_current=False
|
|
)
|
|
_celery_client.conf.update(
|
|
task_serializer="json",
|
|
accept_content=["json"],
|
|
)
|
|
return _celery_client
|
|
|
|
|
|
def dispatch_whois_lookups(target_ids: list[str]) -> None:
|
|
if not target_ids:
|
|
return
|
|
logger.info("Dispatching WHOIS lookups for %d targets", len(target_ids))
|
|
get_celery_client().send_task(
|
|
"app.tasks.whois.perform_whois_lookups",
|
|
kwargs={"target_ids": target_ids},
|
|
queue="default",
|
|
)
|
|
|
|
|
|
def dispatch_ripestat_enrichment(target_ids: list[str]) -> None:
|
|
if not target_ids:
|
|
return
|
|
|
|
logger.info("Dispatching RIPEstat enrichment for %d targets", len(target_ids))
|
|
get_celery_client().send_task(
|
|
"app.tasks.ripestat.enrich_targets_bgp",
|
|
kwargs={"target_ids": target_ids},
|
|
queue="default",
|
|
)
|
|
|
|
|
|
def dispatch_dns_lookups(target_ids: list[str]) -> None:
|
|
if not target_ids:
|
|
return
|
|
|
|
logger.info(f"Dispatching DNS lookup for {len(target_ids)} target(s)")
|
|
get_celery_client().send_task(
|
|
"app.tasks.dns.perform_dns_lookups",
|
|
kwargs={"target_ids": target_ids},
|
|
queue="default",
|
|
)
|
|
|
|
|
|
def dispatch_scan_run(scan_id: str) -> None:
|
|
logger.info("Dispatching scan run %s", scan_id)
|
|
get_celery_client().send_task(
|
|
"app.tasks.scan.run_scan",
|
|
kwargs={"scan_id": scan_id},
|
|
queue=SCANS_QUEUE,
|
|
)
|
|
|
|
|
|
def revoke_scan_tasks(task_ids: list[str]) -> None:
|
|
"""SIGKILL-revoke a scan's celery tasks so an in-flight scan stops promptly."""
|
|
if not task_ids:
|
|
return
|
|
logger.info("Revoking %d scan task(s)", len(task_ids))
|
|
try:
|
|
get_celery_client().control.revoke(
|
|
list(task_ids), terminate=True, signal="SIGKILL"
|
|
)
|
|
except Exception:
|
|
logger.warning("scan task revoke failed", exc_info=True)
|
|
|
|
|
|
def dispatch_template_sync() -> bool:
|
|
"""Kick off a library refresh. Returns whether the queue accepted it."""
|
|
try:
|
|
get_celery_client().send_task("app.tasks.vuln_templates.sync", queue="default")
|
|
except Exception:
|
|
logger.warning("template sync dispatch failed", exc_info=True)
|
|
return False
|
|
return True
|
|
|
|
|
|
def dispatch_endpoint_verify(
|
|
scan_id: str, host: str, dir_path: str | None, limit: int
|
|
) -> bool:
|
|
"""Verify one branch of a scan's endpoints on demand. Returns whether the queue took it."""
|
|
try:
|
|
get_celery_client().send_task(
|
|
"app.tasks.endpoints.verify_branch",
|
|
kwargs={
|
|
"scan_id": scan_id,
|
|
"host": host,
|
|
"dir_path": dir_path,
|
|
"limit": limit,
|
|
},
|
|
queue="default",
|
|
)
|
|
except Exception:
|
|
logger.warning("endpoint verify dispatch failed", exc_info=True)
|
|
return False
|
|
return True
|
|
|
|
|
|
def dispatch_report(report_id: str) -> bool:
|
|
"""Queue a report render. Returns whether the queue took it."""
|
|
try:
|
|
get_celery_client().send_task(
|
|
"app.tasks.reports.generate", args=[report_id], queue="default"
|
|
)
|
|
except Exception:
|
|
logger.warning("report dispatch failed", exc_info=True)
|
|
return False
|
|
return True
|
|
|
|
|
|
def dispatch_interest_evaluation(
|
|
scan_id: str, *, include_ai: bool = True, notify: bool = True
|
|
) -> None:
|
|
logger.info("Dispatching interest evaluation for scan %s", scan_id)
|
|
get_celery_client().send_task(
|
|
"app.tasks.interest.evaluate_scan",
|
|
kwargs={"scan_id": scan_id, "include_ai": include_ai, "notify": notify},
|
|
queue="default",
|
|
)
|
|
|
|
|
|
def dispatch_interest_live(scan_id: str) -> None:
|
|
"""Re-judge a running scan from its rules alone. Cheap, deterministic, no model."""
|
|
try:
|
|
get_celery_client().send_task(
|
|
"app.tasks.interest.evaluate_live",
|
|
kwargs={"scan_id": scan_id},
|
|
queue="default",
|
|
)
|
|
except Exception:
|
|
logger.warning("live interest dispatch failed", exc_info=True)
|
|
|
|
|
|
def dispatch_interest_refresh(project_id: str) -> None:
|
|
logger.info("Dispatching interest refresh for project %s", project_id)
|
|
get_celery_client().send_task(
|
|
"app.tasks.interest.refresh_project",
|
|
kwargs={"project_id": project_id},
|
|
queue="default",
|
|
)
|
|
|
|
|
|
def dispatch_threat_intel(scan_id: str, *, enrich: bool = True) -> None:
|
|
"""Score a finished scan from the feeds, then fill the provider cache behind it."""
|
|
try:
|
|
client = get_celery_client()
|
|
client.send_task(
|
|
"app.tasks.threat_intel.apply_scan", args=[scan_id], queue="default"
|
|
)
|
|
if enrich:
|
|
client.send_task(
|
|
"app.tasks.threat_intel.enrich", args=[scan_id], queue="default"
|
|
)
|
|
except Exception:
|
|
logger.warning("threat intel dispatch failed", exc_info=True)
|
|
|
|
|
|
def dispatch_threat_intel_refresh(*, force: bool = False) -> bool:
|
|
"""Kick off a feed refresh. Returns whether the queue accepted it."""
|
|
try:
|
|
get_celery_client().send_task(
|
|
"app.tasks.threat_intel.refresh", kwargs={"force": force}, queue="default"
|
|
)
|
|
except Exception:
|
|
logger.warning("threat intel refresh dispatch failed", exc_info=True)
|
|
return False
|
|
return True
|
|
|
|
|
|
def dispatch_bounty_sync(*, scopes: bool = True) -> bool:
|
|
"""Refresh the bug bounty program library. Returns whether the queue accepted it."""
|
|
try:
|
|
get_celery_client().send_task(
|
|
"app.tasks.bounty_programs.sync", kwargs={"scopes": scopes}, queue="default"
|
|
)
|
|
except Exception:
|
|
logger.warning("bounty program sync dispatch failed", exc_info=True)
|
|
return False
|
|
return True
|
|
|
|
|
|
def dispatch_bounty_program_sync(handle: str, platform: str = "hackerone") -> bool:
|
|
"""Refresh one program's scope."""
|
|
try:
|
|
get_celery_client().send_task(
|
|
"app.tasks.bounty_programs.sync_program",
|
|
args=[handle, platform],
|
|
queue="default",
|
|
)
|
|
except Exception:
|
|
logger.warning("bounty program scope dispatch failed", exc_info=True)
|
|
return False
|
|
return True
|
|
|
|
|
|
def dispatch_bounty_feed_sync() -> bool:
|
|
"""Refresh the public program feed. Returns whether the queue accepted it."""
|
|
try:
|
|
get_celery_client().send_task(
|
|
"app.tasks.bounty_programs.sync_feed", queue="default"
|
|
)
|
|
except Exception:
|
|
logger.warning("bounty feed sync dispatch failed", exc_info=True)
|
|
return False
|
|
return True
|
|
|
|
|
|
def dispatch_toolbox_run(
|
|
*,
|
|
run_id: str,
|
|
user_id: str,
|
|
tool: str,
|
|
payload: dict,
|
|
project_id: str | None,
|
|
) -> bool:
|
|
"""Hand a toolbox run to the worker. Returns whether the queue accepted it."""
|
|
from shared.definitions.constants import CRITICAL_QUEUE # noqa: PLC0415
|
|
|
|
try:
|
|
get_celery_client().send_task(
|
|
"app.tasks.toolbox.run",
|
|
kwargs={
|
|
"run_id": run_id,
|
|
"user_id": user_id,
|
|
"tool": tool,
|
|
"payload": payload,
|
|
"project_id": project_id,
|
|
},
|
|
queue=CRITICAL_QUEUE,
|
|
)
|
|
except Exception:
|
|
logger.warning("toolbox dispatch failed", exc_info=True)
|
|
return False
|
|
return True
|