From a7944913203b9eb638e4f92b2aed25b2143f8dcb Mon Sep 17 00:00:00 2001 From: hive-bumblebee Date: Thu, 19 Nov 2026 18:37:01 +0000 Subject: [PATCH 1/3] feat(reports): expose historical scan config from typed snapshots (#736) --- crates/gvm-gateway-app/src/lib_test.rs | 11 +++++--- crates/gvm-gateway-domain/src/lib_test.rs | 3 ++- crates/gvm-gateway-domain/src/reports.rs | 25 +++++++++++++++++- crates/gvm-gateway-gvmd/src/conversions.rs | 16 +++++++++++- .../gvm-gateway-gvmd/src/conversions_test.rs | 26 +++++++++++++++++++ .../src/gvmd_adapter/ports/reports.rs | 14 ++++++++++ crates/gvm-gateway-rest/src/reports.rs | 25 ++++++++++++++++-- crates/gvm-gateway-rest/src/reports_test.rs | 26 +++++++++++++++++++ crates/gvm-gateway/tests/contract.rs | 11 +++++--- docs/report-projection-adoption.md | 4 +++ spec/rest-api/reports.yaml | 15 ++++++++++- worklog.md | 2 ++ 12 files changed, 164 insertions(+), 14 deletions(-) diff --git a/crates/gvm-gateway-app/src/lib_test.rs b/crates/gvm-gateway-app/src/lib_test.rs index fc5a521d..74aa36af 100644 --- a/crates/gvm-gateway-app/src/lib_test.rs +++ b/crates/gvm-gateway-app/src/lib_test.rs @@ -1301,10 +1301,13 @@ impl ReportPort for MissingReportPort { fn test_report(id: &str) -> Report { Report { id: id.to_string(), - task: Some(ResourceRef { - id: "223e4567-e89b-12d3-a456-426614174000".to_string(), - name: Some("Task".to_string()), - }), + task: Some( + ResourceRef { + id: "223e4567-e89b-12d3-a456-426614174000".to_string(), + name: Some("Task".to_string()), + } + .into(), + ), scan_start: None, scan_end: None, severity: Some(0.0), diff --git a/crates/gvm-gateway-domain/src/lib_test.rs b/crates/gvm-gateway-domain/src/lib_test.rs index 9fbf0fb3..189b6ae8 100644 --- a/crates/gvm-gateway-domain/src/lib_test.rs +++ b/crates/gvm-gateway-domain/src/lib_test.rs @@ -308,9 +308,10 @@ fn target_serializes_exclude_hosts_only_when_nonempty() { fn report_serializes_camel_case() { let report = Report { id: "550e8400-e29b-41d4-a716-446655440000".to_string(), - task: Some(ResourceRef { + task: Some(ReportTaskRef { id: "task-1".to_string(), name: Some("Scan".to_string()), + scan_config: None, }), scan_start: Some("2026-01-01T00:00:00Z".to_string()), scan_end: None, diff --git a/crates/gvm-gateway-domain/src/reports.rs b/crates/gvm-gateway-domain/src/reports.rs index f1107509..b72c38a6 100644 --- a/crates/gvm-gateway-domain/src/reports.rs +++ b/crates/gvm-gateway-domain/src/reports.rs @@ -258,6 +258,29 @@ pub struct ReportCvePage { pub pagination: Pagination, } +/// Task snapshot reference specific to report representations. +#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)] +pub struct ReportTaskRef { + /// Report task identifier. + pub id: String, + /// Report task name. + #[serde(skip_serializing_if = "Option::is_none")] + pub name: Option, + /// Configuration recorded by the report, never the current task configuration. + #[serde(rename = "scanConfig", skip_serializing_if = "Option::is_none")] + pub scan_config: Option, +} + +impl From for ReportTaskRef { + fn from(task: ResourceRef) -> Self { + Self { + id: task.id, + name: task.name, + scan_config: None, + } + } +} + /// Domain report representation. #[derive(Clone, Debug, Deserialize, PartialEq, Serialize)] pub struct Report { @@ -265,7 +288,7 @@ pub struct Report { pub id: String, /// Associated task reference. #[serde(skip_serializing_if = "Option::is_none")] - pub task: Option, + pub task: Option, /// Scan start timestamp. #[serde(rename = "scanStart", skip_serializing_if = "Option::is_none")] pub scan_start: Option, diff --git a/crates/gvm-gateway-gvmd/src/conversions.rs b/crates/gvm-gateway-gvmd/src/conversions.rs index f74b0197..4eab561b 100644 --- a/crates/gvm-gateway-gvmd/src/conversions.rs +++ b/crates/gvm-gateway-gvmd/src/conversions.rs @@ -467,7 +467,10 @@ pub(crate) fn report_from_gmp(report: gvm_gmp::responses::Report) -> Report { Report { id: report.meta.id.to_string(), - task: report.task.map(resource_ref_from_named_entity), + task: report + .task + .map(resource_ref_from_named_entity) + .map(Into::into), scan_start: report.scan_start, scan_end: report.scan_end, severity, @@ -1278,3 +1281,14 @@ fn map_parser_server_error( #[cfg(test)] #[path = "conversions_test.rs"] mod conversions_test; + +/// Convert only the historical task embedded in the structured report. +pub(crate) fn report_task_from_snapshot( + task: gvm_gmp::responses::StructuredReportTask, +) -> Option { + task.id.map(|id| gvm_gateway_domain::ReportTaskRef { + id: id.to_string(), + name: Some(task.name), + scan_config: task.scan_config.map(resource_ref_from_named_entity), + }) +} diff --git a/crates/gvm-gateway-gvmd/src/conversions_test.rs b/crates/gvm-gateway-gvmd/src/conversions_test.rs index 32b8ec67..703702a6 100644 --- a/crates/gvm-gateway-gvmd/src/conversions_test.rs +++ b/crates/gvm-gateway-gvmd/src/conversions_test.rs @@ -1681,3 +1681,29 @@ fn typed_result_and_nested_reference_types_remain_open_and_optional() { .nvt .is_none()); } + +// Intent: historical config identity/name must come from a typed report snapshot, not current task state. +#[test] +fn snapshot_config_preserves_identity_name_and_absence() { + for (config, expected) in [ + ( + r#"Old & frozen"#, + true, + ), + ("", false), + ] { + let xml = format!( + r#"ReportTask{config}"# + ); + let parsed = gvm_gmp::responses::GetScanReportResponse::from_response(&GmpResponse::from( + xml.as_str(), + )) + .unwrap(); + let task = report_task_from_snapshot(parsed.report.task.unwrap()).unwrap(); + assert_eq!(task.scan_config.is_some(), expected); + if let Some(config) = task.scan_config { + assert_eq!(config.id, "11111111-1111-1111-1111-111111111111"); + assert_eq!(config.name.as_deref(), Some("Old & frozen")); + } + } +} diff --git a/crates/gvm-gateway-gvmd/src/gvmd_adapter/ports/reports.rs b/crates/gvm-gateway-gvmd/src/gvmd_adapter/ports/reports.rs index 0bbf32ce..9f7b8e19 100644 --- a/crates/gvm-gateway-gvmd/src/gvmd_adapter/ports/reports.rs +++ b/crates/gvm-gateway-gvmd/src/gvmd_adapter/ports/reports.rs @@ -94,6 +94,20 @@ impl ReportPort for GvmdAdapter { .map(report_from_gmp) .ok_or_else(|| GatewayError::NotFound(format!("report {id} not found")))?; + // Read the report snapshot through the typed structured source. Never fetch + // today's task/configuration to stand in for historical metadata. + let snapshot = self + .execute_with_session( + session_token, + "reports.snapshot", + gvm_gmp::commands::reports::GetScanReportRequest::new(parse_entity_id(id)?), + ) + .await?; + report.task = snapshot + .report + .task + .and_then(crate::conversions::report_task_from_snapshot); + // Fetch the explicitly requested embedded-result window for this report. let filter = paginated_filter( Some(&format!("report_id={id}")), diff --git a/crates/gvm-gateway-rest/src/reports.rs b/crates/gvm-gateway-rest/src/reports.rs index 2ef97df0..e67daf65 100644 --- a/crates/gvm-gateway-rest/src/reports.rs +++ b/crates/gvm-gateway-rest/src/reports.rs @@ -82,13 +82,34 @@ impl From for ResultCountResponse { } } +/// Task reference from a report snapshot, distinct from generic task references. +#[derive(Clone, Debug, Serialize, JsonSchema)] +#[schemars(rename = "ReportTaskRef")] +pub(crate) struct ReportTaskRefResponse { + id: Uuid, + #[serde(skip_serializing_if = "Option::is_none")] + name: Option, + #[serde(rename = "scanConfig", skip_serializing_if = "Option::is_none")] + scan_config: Option, +} + +impl From for ReportTaskRefResponse { + fn from(task: gvm_gateway_domain::ReportTaskRef) -> Self { + Self { + id: parse_uuid(&task.id), + name: task.name, + scan_config: task.scan_config.map(ResourceRefResponse::from), + } + } +} + /// JSON body returned for a single report. #[derive(Clone, Debug, Serialize, JsonSchema)] #[schemars(rename = "Report")] pub(crate) struct ReportResponse { id: Uuid, #[serde(skip_serializing_if = "Option::is_none")] - task: Option, + task: Option, #[serde(rename = "scanStart", skip_serializing_if = "Option::is_none")] #[schemars(schema_with = "datetime_schema")] scan_start: Option, @@ -108,7 +129,7 @@ impl From for ReportResponse { fn from(r: gvm_gateway_domain::Report) -> Self { Self { id: parse_uuid(&r.id), - task: r.task.map(ResourceRefResponse::from), + task: r.task.map(ReportTaskRefResponse::from), scan_start: r.scan_start, scan_end: r.scan_end, severity: r.severity, diff --git a/crates/gvm-gateway-rest/src/reports_test.rs b/crates/gvm-gateway-rest/src/reports_test.rs index 7d1589ff..5a8b47e1 100644 --- a/crates/gvm-gateway-rest/src/reports_test.rs +++ b/crates/gvm-gateway-rest/src/reports_test.rs @@ -375,3 +375,29 @@ fn application_optional_counts_json_contract() { assert!(absent.get("occurrences").is_none()); assert!(absent.get("threat").is_none()); } + +// Intent: report-only scanConfig survives REST and domain JSON exports; generic refs remain unchanged. +#[test] +fn report_task_snapshot_json_contract() { + let task = gvm_gateway_domain::ReportTaskRef { + id: "33333333-3333-3333-3333-333333333333".into(), + name: Some("Task".into()), + scan_config: Some(gvm_gateway_domain::ResourceRef { + id: "11111111-1111-1111-1111-111111111111".into(), + name: Some("Old & frozen".into()), + }), + }; + let export = serde_json::to_value(&task).unwrap(); + let rest = serde_json::to_value(super::ReportTaskRefResponse::from(task)).unwrap(); + assert_eq!(export, rest); + assert_eq!(rest["scanConfig"]["name"], "Old & frozen"); + let absent = serde_json::to_value(super::ReportTaskRefResponse::from( + gvm_gateway_domain::ReportTaskRef { + id: "33333333-3333-3333-3333-333333333333".into(), + name: None, + scan_config: None, + }, + )) + .unwrap(); + assert!(absent.get("scanConfig").is_none()); +} diff --git a/crates/gvm-gateway/tests/contract.rs b/crates/gvm-gateway/tests/contract.rs index 08dd4b27..4f0512db 100644 --- a/crates/gvm-gateway/tests/contract.rs +++ b/crates/gvm-gateway/tests/contract.rs @@ -2097,10 +2097,13 @@ impl ReportPort for MissingReportPort { fn report_response(id: &str) -> Report { Report { id: id.to_string(), - task: Some(ResourceRef { - id: "660e8400-e29b-41d4-a716-446655440000".to_string(), - name: Some("Task".to_string()), - }), + task: Some( + ResourceRef { + id: "660e8400-e29b-41d4-a716-446655440000".to_string(), + name: Some("Task".to_string()), + } + .into(), + ), scan_start: None, scan_end: None, severity: Some(5.0), diff --git a/docs/report-projection-adoption.md b/docs/report-projection-adoption.md index 56c67c89..9a2365e9 100644 --- a/docs/report-projection-adoption.md +++ b/docs/report-projection-adoption.md @@ -7,3 +7,7 @@ GET /reports/{id}/applications preserves optional hostsCount, occurrences and op ## #735 NVT type JSON type is an optional open string. Ordinary results (including report embedded results) map typed NvtRef.type_; notes/overrides map typed NvtReference.type_, retaining the legacy family alias for backward compatibility. Aggregate vulnerability and closed-CVE sources lack a typed discriminator and keep it absent. Metadata is unchanged; missing NVTs remain missing. + +## #736 report snapshot scan configuration + +Detail GET /reports/{id} and gateway JSON exports preserve optional task.scanConfig (UUID/name) using typed GetScanReportRequest / StructuredReportTask.scan_config. Generic GET /reports list task references omit scanConfig: upstream generic Report has only NamedEntity and would need an upstream extension for list coverage. No current task lookup, XML parsing or audit/delta surface is added. Existing metadata and explicit result pagination are retained. This structured helper requires upstream GMP 22.8 support; backend failures propagate, never fabricated metadata. diff --git a/spec/rest-api/reports.yaml b/spec/rest-api/reports.yaml index 28e4d1d3..23adfc69 100644 --- a/spec/rest-api/reports.yaml +++ b/spec/rest-api/reports.yaml @@ -433,7 +433,7 @@ components: type: string format: uuid task: - $ref: "./common.yaml#/components/schemas/ResourceRef" + $ref: "#/components/schemas/ReportTaskRef" scanStart: type: string format: date-time @@ -453,6 +453,19 @@ components: $ref: "./results.yaml#/components/schemas/Result" description: Embedded results from the requested page when fetching a single report. + ReportTaskRef: + type: object + required: [id] + properties: + id: + type: string + format: uuid + name: + type: string + scanConfig: + $ref: "./common.yaml#/components/schemas/ResourceRef" + description: Historical configuration from the structured report snapshot; absent on report lists. + ResultCount: type: object properties: diff --git a/worklog.md b/worklog.md index bcdb688d..fe98fe7d 100644 --- a/worklog.md +++ b/worklog.md @@ -66,3 +66,5 @@ - #734 slice-boundary correction: explicit u32 schema bounds now live with application counts, not the later reference slice. Added generated schema regression; preserved curated limits. - #735: open JSON type on full/summary result NVTs; typed note/override references no longer mislabel discriminator as family. Aggregate sources retain absence. - #735 acceptance review: typed classic/nonclassic/future/empty/absent discriminator projections qualified; description comments corrected. + +- #736: detail/JSON-export scope selected; typed structured report snapshot supplies task.scanConfig; generic list cannot supply it without upstream generic model extension. From 2c5d74146845ffc10804a500677746d1e0c8405d Mon Sep 17 00:00:00 2001 From: hive-bumblebee Date: Thu, 19 Nov 2026 18:49:53 +0000 Subject: [PATCH 2/3] fix(reports): keep snapshot metadata additive on older backends (#736) --- .../src/gvmd_adapter/ports/reports.rs | 20 +++-- .../tests/gvmd_adapter_test.rs | 86 +++++++++++++++++++ docs/report-projection-adoption.md | 3 +- worklog.md | 1 + 4 files changed, 104 insertions(+), 6 deletions(-) diff --git a/crates/gvm-gateway-gvmd/src/gvmd_adapter/ports/reports.rs b/crates/gvm-gateway-gvmd/src/gvmd_adapter/ports/reports.rs index 9f7b8e19..96676b78 100644 --- a/crates/gvm-gateway-gvmd/src/gvmd_adapter/ports/reports.rs +++ b/crates/gvm-gateway-gvmd/src/gvmd_adapter/ports/reports.rs @@ -102,11 +102,21 @@ impl ReportPort for GvmdAdapter { "reports.snapshot", gvm_gmp::commands::reports::GetScanReportRequest::new(parse_entity_id(id)?), ) - .await?; - report.task = snapshot - .report - .task - .and_then(crate::conversions::report_task_from_snapshot); + .await; + match snapshot { + Ok(snapshot) => { + report.task = snapshot + .report + .task + .and_then(crate::conversions::report_task_from_snapshot) + .or(report.task); + } + // This additive metadata must not make older report reads fail. + // The typed capability check rejects unsupported commands before + // transport. Do not suppress permission, parse or backend errors. + Err(GatewayError::NotImplemented(_)) => {} + Err(error) => return Err(error), + } // Fetch the explicitly requested embedded-result window for this report. let filter = paginated_filter( diff --git a/crates/gvm-gateway-gvmd/tests/gvmd_adapter_test.rs b/crates/gvm-gateway-gvmd/tests/gvmd_adapter_test.rs index b3b1d86c..d6720dab 100644 --- a/crates/gvm-gateway-gvmd/tests/gvmd_adapter_test.rs +++ b/crates/gvm-gateway-gvmd/tests/gvmd_adapter_test.rs @@ -6149,3 +6149,89 @@ async fn ad_verification_uses_discovery_and_status_only_fixture_without_persiste ); server.shutdown().await; } + +#[tokio::test] +async fn report_snapshot_metadata_is_additive_on_older_backends() { + // Intent (#736): a typed unsupported snapshot command on GMP 22.7 must + // not break existing report reads or invent scanConfig via today's task. + let report_id = uuid::Uuid::new_v4(); + let task_id = uuid::Uuid::new_v4(); + let server = MockGmpServer::builder() + .mode(ServerMode::Stateful) + .version(MockVersion::V22_7) + .seed(move |store| { + store.create(Resource::with_id("task", "Existing task", task_id)); + let mut report = Resource::with_id("report", "Older report", report_id); + report.set_attr("usage_type", "scan"); + report.set_attr("task_id", &task_id.to_string()); + store.create(report); + }) + .unix_socket_auto() + .build() + .await + .unwrap(); + let adapter = GvmdAdapter::unix_socket(server.socket_path().unwrap()); + adapter + .connect_session("token", "admin", "admin") + .await + .unwrap(); + server.clear_history(); + let report = adapter + .get_report("token", &report_id.to_string(), &GetReportOpts::default()) + .await + .expect("optional metadata must not raise the existing read version floor"); + let task = report.task.expect("generic report task remains present"); + assert_eq!(task.id, task_id.to_string()); + assert!(task.scan_config.is_none()); + let history = server.command_history(); + assert!(history + .iter() + .any(|entry| entry.command_name() == "get_reports")); + assert!(history.iter().all(|entry| !matches!( + entry.command_name(), + "get_scan_report" | "get_tasks" | "get_configs" | "get_scan_configs" + ))); + server.shutdown().await; +} + +#[tokio::test] +async fn report_snapshot_backend_failure_is_not_optional_absence() { + // Intent (#736): only unsupported optional capability may be omitted; + // a failed real snapshot read must not become a successful stale report. + let report_id = uuid::Uuid::new_v4(); + let server = MockGmpServer::builder() + .mode(ServerMode::Stateful) + .version(MockVersion::V22_8) + .seed(move |store| { + let mut report = Resource::with_id("report", "Faulted snapshot", report_id); + report.set_attr("usage_type", "scan"); + store.create(report); + }) + .inject_fault(Fault::on_command( + "get_scan_report", + FaultKind::ErrorStatus { + code: 503, + message: "snapshot unavailable".into(), + }, + )) + .unix_socket_auto() + .build() + .await + .unwrap(); + let adapter = GvmdAdapter::unix_socket(server.socket_path().unwrap()); + adapter + .connect_session("token", "admin", "admin") + .await + .unwrap(); + server.clear_history(); + let error = adapter + .get_report("token", &report_id.to_string(), &GetReportOpts::default()) + .await + .expect_err("real snapshot errors must propagate"); + assert!(matches!(error, GatewayError::BackendUnavailable(_))); + assert!(server + .command_history() + .iter() + .all(|entry| entry.command_name() != "get_results")); + server.shutdown().await; +} diff --git a/docs/report-projection-adoption.md b/docs/report-projection-adoption.md index 9a2365e9..43abc03b 100644 --- a/docs/report-projection-adoption.md +++ b/docs/report-projection-adoption.md @@ -10,4 +10,5 @@ JSON type is an optional open string. Ordinary results (including report embedde ## #736 report snapshot scan configuration -Detail GET /reports/{id} and gateway JSON exports preserve optional task.scanConfig (UUID/name) using typed GetScanReportRequest / StructuredReportTask.scan_config. Generic GET /reports list task references omit scanConfig: upstream generic Report has only NamedEntity and would need an upstream extension for list coverage. No current task lookup, XML parsing or audit/delta surface is added. Existing metadata and explicit result pagination are retained. This structured helper requires upstream GMP 22.8 support; backend failures propagate, never fabricated metadata. +Detail GET /reports/{id} and gateway JSON exports preserve optional task.scanConfig (UUID/name) using typed GetScanReportRequest / StructuredReportTask.scan_config. Generic GET /reports list task references omit scanConfig: upstream generic Report has only NamedEntity and would need an upstream extension for list coverage. No current task lookup, XML parsing or audit/delta surface is added. Existing metadata and explicit result pagination are retained. This structured helper requires upstream GMP 22.8 support; typed unsupported-command capability results omit this optional enrichment and retain the generic task reference. An absent snapshot task also retains that reference without a configuration. Permission, parse and backend failures propagate, never fabricated metadata. + diff --git a/worklog.md b/worklog.md index fe98fe7d..e48a01e5 100644 --- a/worklog.md +++ b/worklog.md @@ -68,3 +68,4 @@ - #735 acceptance review: typed classic/nonclassic/future/empty/absent discriminator projections qualified; description comments corrected. - #736: detail/JSON-export scope selected; typed structured report snapshot supplies task.scanConfig; generic list cannot supply it without upstream generic model extension. +- #736 compatibility review: unsupported snapshot omits enrichment only; real backend errors propagate. Focused older-backend/error regressions pass. From 0d1b9c8e4b8e38dcfd8ba089fc87cc41ab46087f Mon Sep 17 00:00:00 2001 From: hive-bumblebee Date: Thu, 19 Nov 2026 18:53:52 +0000 Subject: [PATCH 3/3] fix(reports): omit unavailable structured task names (#736) --- crates/gvm-gateway-gvmd/src/conversions.rs | 2 +- crates/gvm-gateway-gvmd/src/conversions_test.rs | 12 ++++++++++++ worklog.md | 1 + 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/crates/gvm-gateway-gvmd/src/conversions.rs b/crates/gvm-gateway-gvmd/src/conversions.rs index 4eab561b..260602e4 100644 --- a/crates/gvm-gateway-gvmd/src/conversions.rs +++ b/crates/gvm-gateway-gvmd/src/conversions.rs @@ -1288,7 +1288,7 @@ pub(crate) fn report_task_from_snapshot( ) -> Option { task.id.map(|id| gvm_gateway_domain::ReportTaskRef { id: id.to_string(), - name: Some(task.name), + name: (!task.name.is_empty()).then_some(task.name), scan_config: task.scan_config.map(resource_ref_from_named_entity), }) } diff --git a/crates/gvm-gateway-gvmd/src/conversions_test.rs b/crates/gvm-gateway-gvmd/src/conversions_test.rs index 703702a6..fa83b386 100644 --- a/crates/gvm-gateway-gvmd/src/conversions_test.rs +++ b/crates/gvm-gateway-gvmd/src/conversions_test.rs @@ -1707,3 +1707,15 @@ fn snapshot_config_preserves_identity_name_and_absence() { } } } + +#[test] +fn snapshot_task_omits_unavailable_name_like_generic_report_task() { + // Intent (#736): snapshot enrichment must retain the generic reference's + // optional-name convention when gvmd does not provide a task name. + let parsed = gvm_gmp::responses::GetScanReportResponse::from_response(&GmpResponse::from( + r#"Report"#, + )).unwrap(); + let task = report_task_from_snapshot(parsed.report.task.unwrap()).unwrap(); + assert!(task.name.is_none()); + assert!(task.scan_config.is_none()); +} diff --git a/worklog.md b/worklog.md index e48a01e5..dca76526 100644 --- a/worklog.md +++ b/worklog.md @@ -69,3 +69,4 @@ - #736: detail/JSON-export scope selected; typed structured report snapshot supplies task.scanConfig; generic list cannot supply it without upstream generic model extension. - #736 compatibility review: unsupported snapshot omits enrichment only; real backend errors propagate. Focused older-backend/error regressions pass. +- #736 absent snapshot task names remain absent, with targeted regression coverage.