[RCA] Validate and quarantine a bundle for offline maintainer use

Abierto
#14,236 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
cli, go
Área
cli, security, testing

Línea de trabajo

Start by reviewing the prerequisite issue #14234 and the existing CLI entry points under bydbctl/internal/cmd; the proposed bydbctl rca inspect command is not an existing API. Define the archive validation, quarantine, and intake report behavior, then add independently sourced fixtures and focused TestRCA coverage. Done means only a valid archive is accepted, unsafe archives are refused without escaping quarantine, and offline inspection reports incomplete or unknown data explicitly.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

database enhancement

Umbrella: #14222

Blocked by: #14234

Summary

Validate and quarantine a bundle for offline maintainer use. Deliver one usable operation, not a framework-only foundation.

Boundary

Proposed activation caller: bydbctl rca inspect --archive … --output …. Command names are proposed, not existing APIs.
Reporter collection runs with read-only source access; offline steps use local files only.
No source storage/wire-format changes are requested. The incident format is separately versioned.

Requirements

R1. Validate archive bounds, member paths, duplicates, declared types, hashes and supported format before accepting evidence. Reject traversal, symlink escapes and decompression bombs.
R2. Extract only into an isolated quarantine directory; never execute bundled code, commands, hooks or configuration. Treat every evidence string as untrusted data.
R3. Produce a read-only intake report of versions, coverage, missing sources and policy/review provenance. Integrity and reporter approval do not prove the data is harmless or factually correct.
R4. Run without database credentials or outbound connections; unsupported versions and partial bundles produce explicit outcomes rather than improvised interpretation.

Acceptance criteria

  • Independent fixtures cover a valid archive, bad hash, traversal, duplicate member and oversized expansion. Only the valid archive is accepted and no file escapes quarantine.
  • With networking denied, inspect the archive end to end and preserve mixed/unknown versions and incomplete-coverage warnings.
  • Use hand-authored or independently captured fixtures with documented provenance; do not generate expected values using the code under test.
  • Add focused behavioral tests before implementation and record the actual RED command/failure, then GREEN results.
  • Keep existing CLI/API behavior compatible. Never overwrite unrelated user files; output conflicts must be refused.

Scope and readiness audit

  • Boundary and behavior: the single operation above; independently observable output and refusal behavior.
  • Production activation: the named CLI or skill entry point above, included in the same PR.
  • Packages/callers: public archive reader and schema validator; local quarantine directory.
  • Dependencies: #14234
  • Classification: planned blocked leaf; revalidate prerequisite seams after merge.
  • RED evidence: not executed during this planning task; no claim of passing or failing implementation tests.
  • End-to-end proof: the real command/skill scenarios above, not source-text assertions.
  • Formats/lifecycle/fixtures: private workspace or public archive only; artifact-specific fixture family above.
  • Focused tests: CLI leaves should add TestRCA… coverage under bydbctl/internal/cmd and/or the introduced collector package;
    run go test ./bydbctl/internal/cmd -run TestRCA -count=1 plus the new package tests. Skill leaves must add a replayable evaluation harness
    with an exact command documented in the PR. Final test names/paths are fixed when the prerequisite seam merges.
  • Resource/concurrency checks: cancellation, bounded reads/output and cleanup on failure; use repository panic-aware goroutine wrappers if concurrency is introduced.
  • Decision: one proposed PR. If the named behavior requires an unimplemented server API or another lifecycle change, stop and split that prerequisite.

Required-only scope audit

Untrusted public bundles require safe validation before analysis; a general archive tool is not needed.

Removed/deferred: Multiple archive formats, automatic repair, signature infrastructure and execution of bundle-supplied content.

Out of scope

Re-running database queries, automatic code execution, sandbox provisioning, claiming privacy from checksums.

Lenguaje dominante
Java
Estrellas
25k
Forks
6.6k
Merge medio
12 h 1 min
PR fusionados (30 d)
43

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de apache/skywalking

Todos los issues de apache/skywalking

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.