feat(oscal): emit unmapped findings as-is + MCP oscal_assessment tool
CI / Check (push) Skipped
CI / Check (pull_request) Successful in 5m50s
CI / Detect Changes (pull_request) Skipped
CI / Deploy Agent (pull_request) Skipped
CI / Deploy Dashboard (pull_request) Skipped
CI / Deploy Docs (pull_request) Skipped
CI / Deploy MCP (pull_request) Skipped

The OSCAL emitter now reports EVERY non-false-positive finding: mapped findings
(via their stamped control_refs) target their controls; UNMAPPED findings are
emitted as standalone observations, reported as-is (cwe/tool/severity props) so
nothing is lost — they can be mapped later as the LUT / master-controls grow.
assess() keys off Finding.control_refs now, not the CWE linker.

New compliance-mcp `oscal_assessment` tool serves this OSCAL over MCP — what
breakpilot's scanner_mcp_client pulls. Assess endpoint simplified to match.
Emitter tests cover mapped / unmapped-as-is / false-positive-excluded.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Sharang Parnerkar
2026-07-21 11:33:09 +02:00
co-authored by Claude Fable 5
parent c6baf72c6d
commit 54cf39383c
5 changed files with 180 additions and 136 deletions
+7 -48
View File
@@ -1,9 +1,9 @@
//! OSCAL assessment endpoint. //! OSCAL assessment endpoint.
//! //!
//! Assesses a target's findings against the breakpilot-compliance control //! Returns a standard OSCAL assessment-results document for a target's findings,
//! catalog and returns a standard OSCAL assessment-results document. Ties //! driven by each finding's stamped `control_refs` (from the scan's control-triage
//! together the ingest provider ([`OscalControlsProvider`]) and the assessment //! stage): mapped findings target their controls, unmapped findings are reported
//! emitter (`compliance_core::models::oscal_assessment`). //! as-is. See `compliance_core::models::oscal_assessment`.
use axum::extract::Extension; use axum::extract::Extension;
use axum::http::StatusCode; use axum::http::StatusCode;
@@ -12,45 +12,24 @@ use axum::Json;
use mongodb::bson::doc; use mongodb::bson::doc;
use serde::Deserialize; use serde::Deserialize;
use compliance_core::models::onboarding::ComplianceFramework; use compliance_core::models::oscal_assessment::assess;
use compliance_core::models::oscal_assessment::{assess, ControlLinker};
use compliance_core::models::Finding; use compliance_core::models::Finding;
use compliance_core::tenant_ctx::TenantCtx; use compliance_core::tenant_ctx::TenantCtx;
use super::dto::{collect_cursor_async, tenant_db, AgentExt}; use super::dto::{collect_cursor_async, tenant_db, AgentExt};
use crate::controls::OscalControlsProvider;
#[derive(Debug, Deserialize)] #[derive(Debug, Deserialize)]
pub struct AssessRequest { pub struct AssessRequest {
/// The target / repo id whose findings are assessed. /// The target / repo id whose findings are assessed.
pub target_id: String, pub target_id: String,
/// Frameworks to assess against; defaults to `[Cra]` when empty.
#[serde(default)]
pub frameworks: Vec<ComplianceFramework>,
} }
/// `POST /api/v1/oscal/assess` — pull the catalog(s), load the target's findings, /// `POST /api/v1/oscal/assess` — OSCAL assessment-results for a target's findings.
/// and emit an OSCAL assessment-results document linking findings to controls.
pub async fn assess_target( pub async fn assess_target(
Extension(agent): AgentExt, Extension(agent): AgentExt,
tenant: TenantCtx, tenant: TenantCtx,
Json(req): Json<AssessRequest>, Json(req): Json<AssessRequest>,
) -> Response { ) -> Response {
let cfg = &agent.config.breakpilot;
let Some(base_url) = cfg.base_url.clone() else {
return (
StatusCode::SERVICE_UNAVAILABLE,
"breakpilot base URL not configured (set BREAKPILOT_BASE_URL)",
)
.into_response();
};
let frameworks = if req.frameworks.is_empty() {
vec![ComplianceFramework::Cra]
} else {
req.frameworks.clone()
};
let db = match tenant_db(&agent, &tenant).await { let db = match tenant_db(&agent, &tenant).await {
Ok(db) => db, Ok(db) => db,
Err(code) => return code.into_response(), Err(code) => return code.into_response(),
@@ -65,25 +44,5 @@ pub async fn assess_target(
} }
}; };
let provider = OscalControlsProvider::new( Json(assess(&findings, chrono::Utc::now())).into_response()
agent.http.clone(),
base_url,
cfg.token.clone(),
&cfg.snapshot_dir,
);
let mut controls = Vec::new();
for framework in &frameworks {
match provider.load(*framework).await {
Ok(document) => controls.extend(document.to_controls()),
Err(e) => tracing::warn!(?framework, error = %e, "OSCAL catalog load failed"),
}
}
let assessment = assess(
&controls,
&findings,
&ControlLinker::cra_seed(),
chrono::Utc::now(),
);
Json(assessment).into_response()
} }
+109 -87
View File
@@ -15,8 +15,7 @@ use chrono::{DateTime, Utc};
use serde::Serialize; use serde::Serialize;
use uuid::Uuid; use uuid::Uuid;
use crate::models::finding::Finding; use crate::models::finding::{Finding, FindingStatus};
use crate::traits::Control;
const OSCAL_VERSION: &str = "1.1.2"; const OSCAL_VERSION: &str = "1.1.2";
/// Same namespace as the catalog exporter, so ids are stable and correlatable. /// Same namespace as the catalog exporter, so ids are stable and correlatable.
@@ -83,22 +82,23 @@ impl ControlLinker {
} }
} }
/// Assess `findings` against `controls`: link findings to control-ids and build a /// Build a standard OSCAL assessment-results document from `findings`, using each
/// standard OSCAL assessment-results document. `at` is the assessment timestamp. /// finding's stamped `control_refs` for control linkage. EVERY non-false-positive
pub fn assess( /// finding is emitted as an observation — mapped findings additionally produce a
controls: &[Control], /// per-control `not-satisfied` finding; **unmapped findings are reported as-is**
findings: &[Finding], /// (an observation carrying their CWE/tool/severity, with no control target) so
linker: &ControlLinker, /// nothing is lost. `at` is the assessment timestamp.
at: DateTime<Utc>, pub fn assess(findings: &[Finding], at: DateTime<Utc>) -> AssessmentResultsDoc {
) -> AssessmentResultsDoc {
let ts = at.to_rfc3339(); let ts = at.to_rfc3339();
let mut observations = Vec::new(); let mut observations = Vec::new();
let mut obs_by_control: HashMap<String, Vec<String>> = HashMap::new(); let mut obs_by_control: HashMap<String, Vec<String>> = HashMap::new();
let mut mapped = 0usize;
let mut unmapped = 0usize;
for finding in findings { for finding in findings {
let targets = linker.controls_for(finding); if finding.status == FindingStatus::FalsePositive {
if targets.is_empty() { continue; // flagged tool false positive — excluded from the report
continue;
} }
let obs_uuid = det_uuid(&format!("obs:{}", finding.fingerprint)); let obs_uuid = det_uuid(&format!("obs:{}", finding.fingerprint));
let location = match (&finding.file_path, finding.line_number) { let location = match (&finding.file_path, finding.line_number) {
@@ -106,58 +106,67 @@ pub fn assess(
(Some(f), None) => Some(f.clone()), (Some(f), None) => Some(f.clone()),
_ => None, _ => None,
}; };
let is_mapped = !finding.control_refs.is_empty();
if is_mapped {
mapped += 1;
} else {
unmapped += 1;
}
let mut props = vec![
ObsProp::new("tool", &finding.scanner),
ObsProp::new("severity", &finding.severity.to_string()),
ObsProp::new("mapping", if is_mapped { "mapped" } else { "unmapped" }),
];
if let Some(cwe) = &finding.cwe {
props.push(ObsProp::new("cwe", cwe));
}
observations.push(Observation { observations.push(Observation {
uuid: obs_uuid.clone(), uuid: obs_uuid.clone(),
description: finding.title.clone(), title: finding.title.clone(),
description: finding.description.clone(),
methods: vec!["TEST".to_string()], methods: vec!["TEST".to_string()],
collected: ts.clone(), collected: ts.clone(),
props,
relevant_evidence: vec![RelevantEvidence { relevant_evidence: vec![RelevantEvidence {
href: location.map(|l| format!("file://{l}")), href: location.map(|l| format!("file://{l}")),
description: format!("[{}] {}", finding.scanner, finding.title), description: format!("[{}] {}", finding.scanner, finding.title),
}], }],
}); });
for control_id in targets { for control_id in &finding.control_refs {
obs_by_control obs_by_control
.entry(control_id) .entry(control_id.clone())
.or_default() .or_default()
.push(obs_uuid.clone()); .push(obs_uuid.clone());
} }
} }
let titles: HashMap<&str, &str> = controls
.iter()
.map(|c| (c.id.as_str(), c.title.as_str()))
.collect();
let mut hit_controls: Vec<&String> = obs_by_control.keys().collect(); let mut hit_controls: Vec<&String> = obs_by_control.keys().collect();
hit_controls.sort(); hit_controls.sort();
let ar_findings: Vec<ArFinding> = hit_controls let ar_findings: Vec<ArFinding> = hit_controls
.into_iter() .iter()
.map(|control_id| { .map(|control_id| ArFinding {
let title = titles.get(control_id.as_str()).copied().unwrap_or(""); uuid: det_uuid(&format!("finding:{control_id}")),
ArFinding { title: format!("Findings affect {control_id}"),
uuid: det_uuid(&format!("finding:{control_id}")), target: FindingTarget {
title: format!("Findings affect {control_id}: {title}"), target_type: "statement-id".to_string(),
target: FindingTarget { target_id: format!("{control_id}_smt"),
target_type: "statement-id".to_string(), status: TargetStatus {
target_id: format!("{control_id}_smt"), state: "not-satisfied".to_string(),
status: TargetStatus {
state: "not-satisfied".to_string(),
},
}, },
related_observations: obs_by_control[control_id] },
.iter() related_observations: obs_by_control[*control_id]
.map(|u| RelatedObservation { .iter()
observation_uuid: u.clone(), .map(|u| RelatedObservation {
}) observation_uuid: u.clone(),
.collect(), })
} .collect(),
}) })
.collect(); .collect();
let include_controls = controls let include_controls: Vec<SelectControlById> = hit_controls
.iter() .iter()
.map(|c| SelectControlById { .map(|c| SelectControlById {
control_id: c.id.clone(), control_id: (*c).clone(),
}) })
.collect(); .collect();
@@ -165,9 +174,9 @@ pub fn assess(
uuid: det_uuid("result:cra"), uuid: det_uuid("result:cra"),
title: "Automated code-compliance assessment".to_string(), title: "Automated code-compliance assessment".to_string(),
description: format!( description: format!(
"{} finding-linked observation(s) across {} reviewed control(s)", "{} observation(s): {mapped} control-linked, {unmapped} unmapped (as-is); {} control(s) affected",
observations.len(), observations.len(),
controls.len() include_controls.len()
), ),
start: ts.clone(), start: ts.clone(),
reviewed_controls: ReviewedControls { reviewed_controls: ReviewedControls {
@@ -262,13 +271,33 @@ pub struct SelectControlById {
#[derive(Debug, Clone, Serialize)] #[derive(Debug, Clone, Serialize)]
pub struct Observation { pub struct Observation {
pub uuid: String, pub uuid: String,
pub title: String,
pub description: String, pub description: String,
pub methods: Vec<String>, pub methods: Vec<String>,
pub collected: String, pub collected: String,
#[serde(skip_serializing_if = "Vec::is_empty")]
pub props: Vec<ObsProp>,
#[serde(rename = "relevant-evidence", skip_serializing_if = "Vec::is_empty")] #[serde(rename = "relevant-evidence", skip_serializing_if = "Vec::is_empty")]
pub relevant_evidence: Vec<RelevantEvidence>, pub relevant_evidence: Vec<RelevantEvidence>,
} }
/// A name/value observation property (cwe, tool, severity, mapping status). Lets an
/// unmapped finding be reported fully as-is.
#[derive(Debug, Clone, Serialize)]
pub struct ObsProp {
pub name: String,
pub value: String,
}
impl ObsProp {
fn new(name: &str, value: &str) -> Self {
Self {
name: name.to_string(),
value: value.to_string(),
}
}
}
#[derive(Debug, Clone, Serialize)] #[derive(Debug, Clone, Serialize)]
pub struct RelevantEvidence { pub struct RelevantEvidence {
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
@@ -310,20 +339,9 @@ pub struct RelatedObservation {
mod tests { mod tests {
use super::*; use super::*;
use crate::models::finding::Severity; use crate::models::finding::Severity;
use crate::models::onboarding::ComplianceFramework;
use crate::models::scan::ScanType; use crate::models::scan::ScanType;
fn control(id: &str, title: &str) -> Control { fn finding(fp: &str, cwe: Option<&str>, refs: &[&str]) -> Finding {
Control {
id: id.into(),
framework: ComplianceFramework::Cra,
title: title.into(),
text: String::new(),
source: None,
}
}
fn finding(fp: &str, cwe: Option<&str>) -> Finding {
let mut f = Finding::new( let mut f = Finding::new(
"repo".into(), "repo".into(),
fp.into(), fp.into(),
@@ -336,6 +354,7 @@ mod tests {
f.cwe = cwe.map(Into::into); f.cwe = cwe.map(Into::into);
f.file_path = Some("src/auth.rs".into()); f.file_path = Some("src/auth.rs".into());
f.line_number = Some(42); f.line_number = Some(42);
f.control_refs = refs.iter().map(|s| s.to_string()).collect();
f f
} }
@@ -346,57 +365,60 @@ mod tests {
} }
#[test] #[test]
fn links_cwe_finding_to_control_not_satisfied() { fn mapped_finding_becomes_control_finding() {
let controls = vec![ let doc = assess(&[finding("f1", Some("CWE-798"), &["cra-ai-8"])], at());
control("cra-ai-8", "No default passwords"),
control("cra-ai-13", "Crypto"),
];
let findings = vec![finding("f1", Some("CWE-798"))];
let doc = assess(&controls, &findings, &ControlLinker::cra_seed(), at());
let r = &doc.assessment_results.results[0]; let r = &doc.assessment_results.results[0];
assert_eq!(r.observations.len(), 1); assert_eq!(r.observations.len(), 1);
assert_eq!(r.findings.len(), 1); assert_eq!(r.findings.len(), 1);
assert_eq!(r.findings[0].target.target_id, "cra-ai-8_smt"); assert_eq!(r.findings[0].target.target_id, "cra-ai-8_smt");
assert_eq!(r.findings[0].target.status.state, "not-satisfied"); assert_eq!(r.findings[0].target.status.state, "not-satisfied");
assert_eq!(r.findings[0].related_observations.len(), 1);
assert_eq!( assert_eq!(
r.reviewed_controls.control_selections[0] r.reviewed_controls.control_selections[0]
.include_controls .include_controls
.len(), .len(),
2 1
); );
} }
#[test] #[test]
fn unlinked_finding_yields_no_control_finding() { fn unmapped_finding_is_reported_as_is() {
let controls = vec![control("cra-ai-8", "x")]; let doc = assess(&[finding("f1", Some("CWE-319"), &[])], at());
let findings = vec![finding("f1", Some("CWE-99999"))];
let doc = assess(&controls, &findings, &ControlLinker::cra_seed(), at());
let r = &doc.assessment_results.results[0]; let r = &doc.assessment_results.results[0];
assert!(r.observations.is_empty()); assert_eq!(r.observations.len(), 1); // still emitted...
assert!(r.findings.is_empty()); assert!(r.findings.is_empty()); // ...but no control finding
assert!(r.reviewed_controls.control_selections[0]
.include_controls
.is_empty());
let props: Vec<(&str, &str)> = r.observations[0]
.props
.iter()
.map(|p| (p.name.as_str(), p.value.as_str()))
.collect();
assert!(props.contains(&("mapping", "unmapped")));
assert!(props.contains(&("cwe", "CWE-319")));
} }
#[test] #[test]
fn output_is_deterministic_and_valid_oscal() { fn false_positive_is_excluded() {
let controls = vec![control("cra-ai-8", "x")]; let mut f = finding("f1", Some("CWE-798"), &["cra-ai-8"]);
let findings = vec![finding("f1", Some("798"))]; f.status = FindingStatus::FalsePositive;
let a = serde_json::to_string(&assess( let doc = assess(&[f], at());
&controls, assert!(doc.assessment_results.results[0].observations.is_empty());
&findings, }
&ControlLinker::cra_seed(),
at(), #[test]
)) fn deterministic_and_valid_oscal() {
.unwrap(); let mk = || {
let b = serde_json::to_string(&assess( vec![
&controls, finding("f1", Some("CWE-798"), &["cra-ai-8"]),
&findings, finding("f2", Some("CWE-319"), &[]),
&ControlLinker::cra_seed(), ]
at(), };
)) let a = serde_json::to_string(&assess(&mk(), at())).unwrap();
.unwrap(); let b = serde_json::to_string(&assess(&mk(), at())).unwrap();
assert_eq!(a, b); assert_eq!(a, b);
assert!(a.contains("\"oscal-version\":\"1.1.2\"")); assert!(a.contains("\"oscal-version\":\"1.1.2\""));
assert!(a.contains("\"not-satisfied\"")); assert!(a.contains("\"not-satisfied\""));
assert!(a.contains("\"mapping\""));
} }
} }
+12 -1
View File
@@ -4,7 +4,7 @@ use rmcp::{
use crate::auth::current_tenant_id; use crate::auth::current_tenant_id;
use crate::database::{Database, DatabasePool}; use crate::database::{Database, DatabasePool};
use crate::tools::{dast, findings, pentest, sbom}; use crate::tools::{dast, findings, oscal, pentest, sbom};
pub struct ComplianceMcpServer { pub struct ComplianceMcpServer {
pool: DatabasePool, pool: DatabasePool,
@@ -68,6 +68,17 @@ impl ComplianceMcpServer {
findings::findings_summary(&db, params).await findings::findings_summary(&db, params).await
} }
#[tool(
description = "Emit an OSCAL 1.1 assessment-results document for a repo's findings (mapped findings target their compliance controls; unmapped findings are reported as-is)"
)]
async fn oscal_assessment(
&self,
Parameters(params): Parameters<oscal::OscalAssessmentParams>,
) -> Result<CallToolResult, rmcp::ErrorData> {
let db = self.tenant_db()?;
oscal::oscal_assessment(&db, params).await
}
// ── SBOM ────────────────────────────────────────────── // ── SBOM ──────────────────────────────────────────────
#[tool( #[tool(
+1
View File
@@ -1,4 +1,5 @@
pub mod dast; pub mod dast;
pub mod findings; pub mod findings;
pub mod oscal;
pub mod pentest; pub mod pentest;
pub mod sbom; pub mod sbom;
+51
View File
@@ -0,0 +1,51 @@
//! OSCAL assessment MCP tool.
//!
//! Emits a standard OSCAL assessment-results document for a repo's findings —
//! what breakpilot's scanner MCP client pulls. Mapped findings target their
//! compliance controls (via the stamped `control_refs`); unmapped findings are
//! reported as-is, so nothing is lost.
use mongodb::bson::doc;
use rmcp::{model::*, ErrorData as McpError};
use schemars::JsonSchema;
use serde::Deserialize;
use compliance_core::models::oscal_assessment::assess;
use compliance_core::models::Finding;
use crate::database::Database;
#[derive(Debug, Deserialize, JsonSchema)]
pub struct OscalAssessmentParams {
/// Repository / target id to assess.
pub repo_id: String,
}
pub async fn oscal_assessment(
db: &Database,
params: OscalAssessmentParams,
) -> Result<CallToolResult, McpError> {
let mut cursor = db
.findings()
.find(doc! { "repo_id": &params.repo_id })
.await
.map_err(|e| McpError::internal_error(format!("DB error: {e}"), None))?;
let mut findings: Vec<Finding> = Vec::new();
while cursor
.advance()
.await
.map_err(|e| McpError::internal_error(format!("cursor error: {e}"), None))?
{
findings.push(
cursor
.deserialize_current()
.map_err(|e| McpError::internal_error(format!("deserialize error: {e}"), None))?,
);
}
let document = assess(&findings, chrono::Utc::now());
let json = serde_json::to_string_pretty(&document)
.map_err(|e| McpError::internal_error(format!("json error: {e}"), None))?;
Ok(CallToolResult::success(vec![Content::text(json)]))
}