Skip to content

docs: cara pública de cierre del proyecto (arXiv v25) - #137

Merged
alonsoir merged 1 commit into
mainfrom
docs/readme-cierre
Aug 7, 2026
Merged

docs: cara pública de cierre del proyecto (arXiv v25)#137
alonsoir merged 1 commit into
mainfrom
docs/readme-cierre

Conversation

@alonsoir

@alonsoir alonsoir commented Aug 7, 2026

Copy link
Copy Markdown
Owner

Cara pública de cierre (arXiv:2604.04952 v25)

Cuarto y (probablemente) último PR antes de repo read-only. Cierra la cara
pública del entregable (1) del criterio de cierre: un README para quien llega
del paper + reproducibilidad como propiedad del repo.

Qué entra

  • README reescrito (poda Vía Appia): estado actual anclado a medido,
    make reproduce-paper en portada, enlaces a Pages y a la guía de drivers,
    puntero a paper-artifacts/. F1=0.9985 anclado al subconjunto conductual de 646.
  • Makefile: up/halt -> 5 VMs (alias de 2 conservados); reproduce-paper
    (composición de 7 targets ya validados) + reproduce-paper-deps (construye
    correlation-engine + adapters suri/zeek para que el from-scratch sea honesto
    por construcción); mitre-dataset, custom-start, validate-driver.
  • Andamio de drivers (scripts/custom_start.sh.template +
    docs/WRITING-A-DRIVER.md): salda DEBT-DATASET-DRIVER-CONTRACT-001 nivel 3 —
    el investigador rellena solo el SEAM; el harness invariante hace el resto.
  • paper-artifacts/: salidas exactas del run 20260804-080140 para revisar
    sin correr nada.
  • docs/HITOS.md: diario DAY 111-252 archivado fuera del README.

Honesto / diferido

  • El test de aceptación real (destroy -f && up -> bootstrap ->
    reproduce-paper, ~2h) queda diferido a la promoción a EMECAS+++. Los targets
    están verificados por make -n (composición) y sus piezas ya corrieron en días
    previos; falta la corrida limpia end-to-end desde clon, que es ese test.
  • El overhaul de pipeline-start/status (DEBT-PIPELINE-START-*) va en su
    propio PR, no aquí.
  • reproduce-paper reconstruye deps en cada corrida (cierre de dependencias
    completo); afinar la velocidad es future-work.

Summary by CodeRabbit

  • New Features

    • Added workflows to reproduce paper results, generate MITRE datasets, run custom traffic drivers, and validate generated artifacts.
    • Added a customizable traffic-driver template with sensor setup, data processing, correlation, and verification steps.
    • Updated environment controls to start and stop all required analysis services together.
  • Documentation

    • Reworked the README with architecture, installation, reproducibility, limitations, and research context.
    • Added guides for creating traffic drivers and understanding historical project milestones.
    • Documented paper artifacts, provenance, replay variance, and bias-analysis results.

- README.md: reescrito para quien llega del paper (arXiv:2604.04952 v25).
  reproduce-paper en portada; enlaces a la doc generada (Pages) y a la guía
  de drivers; puntero a paper-artifacts/; F1=0.9985 anclado al subconjunto
  conductual de 646; artefacto de investigación, no producción.
- Makefile: up/halt -> 5 VMs (up-argus/halt-argus siguen como alias de 2);
  reproduce-paper (composición de 7 targets ya validados) + reproduce-paper-deps
  (construye correlation-engine + adapters suri/zeek -> from-scratch honesto por
  construcción); mitre-dataset; custom-start DRIVER=...; validate-driver.
- scripts/custom_start.sh.template + docs/WRITING-A-DRIVER.md: andamio
  "escribe tu ataque, recibe tu dataset" (DEBT-DATASET-DRIVER-CONTRACT-001
  nivel 3: el investigador rellena solo el SEAM).
- paper-artifacts/: salidas exactas del run anclado 20260804-080140
  (bias-report, bias-denominator-true, dataset modo A) para revisar sin correr.
- docs/HITOS.md: diario DAY 111-252 archivado (poda Vía Appia del README).
@alonsoir
alonsoir merged commit c94c18f into main Aug 7, 2026
8 of 10 checks passed
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 346b9357-4bdc-4083-891d-2703c8fe9313

📥 Commits

Reviewing files that changed from the base of the PR and between d6bba19 and e772470.

⛔ Files ignored due to path filters (1)
  • paper-artifacts/dataset-modeA-20260804-080140.csv is excluded by !**/*.csv
📒 Files selected for processing (8)
  • Makefile
  • README.md
  • docs/HITOS.md
  • docs/WRITING-A-DRIVER.md
  • paper-artifacts/README.md
  • paper-artifacts/bias-denominator-true-20260804-080140.txt
  • paper-artifacts/bias-report-20260804-080140.txt
  • scripts/custom_start.sh.template

📝 Walkthrough

Walkthrough

The PR adds VM and dataset reproduction commands, a validated custom traffic-driver workflow, paper-supporting reports, and a rewritten research-artifact README with historical and driver documentation.

Changes

Reproducibility and research artifact workflow

Layer / File(s) Summary
Reproduction entrypoints and environment setup
Makefile, README.md
The Makefile now controls all five VMs and adds paper reproduction, MITRE dataset, adapter preparation, custom-driver, and artifact-validation targets. The README documents setup and reproduction commands.
Custom driver lifecycle
scripts/custom_start.sh.template, docs/WRITING-A-DRIVER.md
The driver template runs traffic through the sensor pipeline, converts and seals artifacts, loads Kuzu data, creates correlations, and verifies results. The guide documents the driver contract and lifecycle.
Paper artifact evidence
paper-artifacts/README.md, paper-artifacts/bias-denominator-true-20260804-080140.txt, paper-artifacts/bias-report-20260804-080140.txt
The artifacts document replay provenance, denominator calculations, blind flows, sensor coverage, detection behavior, and consistency checks.
Project context and history
README.md, docs/HITOS.md
The README now presents the current architecture, thesis, results, installation, limitations, and references. The historical diary records earlier milestones and metrics.

Estimated code review effort: 4 (Complex) | ~45 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Researcher
  participant Makefile
  participant custom_start.sh.template
  participant Sensors
  participant Kuzu
  Researcher->>Makefile: Run reproduce-paper or custom-start
  Makefile->>custom_start.sh.template: Execute validated driver
  custom_start.sh.template->>Sensors: Start, drain, and collect sensor data
  Sensors->>custom_start.sh.template: Return sensor artifacts
  custom_start.sh.template->>Kuzu: Load datasets and create correlations
  Kuzu->>custom_start.sh.template: Return graph and verdict results
  custom_start.sh.template->>Researcher: Print validation output
Loading

Possibly related PRs

  • alonsoir/argus#87: Covers the multisensor architecture that this reproduction workflow orchestrates.
  • alonsoir/argus#128: Provides the Suricata adapter and Kuzu correlation pipeline used by the driver workflow.
  • alonsoir/argus#135: Covers CTU/NERIS replay and bias-analysis workflows integrated by the new Makefile targets.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/readme-cierre

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@graphify-labs graphify-labs Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Graphify reviewed this change.

Looks safe to merge — no coupling regressions and no blocking issues, checked against the code graph (not a self-assessment).


Graphify review — findings

This pull request appears to reframe the project's public-facing documentation and add reproducibility tooling. In the Makefile, it changes up/halt to bring up/down a broader set of VMs (defender, client, suricata, zeek, wazuh) instead of just the argus targets, and adds new targets under a "DAY 254" section: reproduce-paper (which composes existing fetch/export/report targets), mitre-dataset, custom-start (runs a user-supplied driver script), reproduce-paper-deps, and validate-driver (checks for expected parquet/Kuzu artifacts). The README.md is substantially rewritten, replacing a large collection of status badges and milestone/hito sections with a shorter description positioning the project as a research artifact rather than a production system. The touched symbols also indicate corresponding rewrites/additions across docs (milestone history, "writing a driver" guide, paper-artifacts readme). The surface area spans build/orchestration configuration and documentation; I have not assessed whether the new Makefile targets or documented reproduction steps behave as intended.

No blocking issues surfaced. 2 lower-confidence candidates did not survive cross-model review.

Analysis details — impact, health, verification

Impact & health

Graphify review

Impact — 48 functions depend on the 48 functions this change touches.

Health — grade A; no new coupling hotspots.

Verification — 48 functions in the blast radius were not formally verified this run (proofs are advisory here).

Gate & verification

graphify gate

PASS — objectively clean (no health regressions, tests not run — proofs not run this pass (advisory)). Grounded, not self-assessed.

Advisory (not blocking):

  • verification_scope: 48 function(s) in the blast radius were not formally verified this run

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant