Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
51aae6665a | ||
|
|
0e5a2d7e43 |
Generated
-7
@@ -5089,12 +5089,6 @@ dependencies = [
|
|||||||
"digest",
|
"digest",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "sha1_smol"
|
|
||||||
version = "1.0.1"
|
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
|
||||||
checksum = "bbfa15b3dddfee50a0fff136974b3e1bde555604ba463834a7eb7deb6417705d"
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "sha2"
|
name = "sha2"
|
||||||
version = "0.10.9"
|
version = "0.10.9"
|
||||||
@@ -6478,7 +6472,6 @@ dependencies = [
|
|||||||
"getrandom 0.4.1",
|
"getrandom 0.4.1",
|
||||||
"js-sys",
|
"js-sys",
|
||||||
"serde_core",
|
"serde_core",
|
||||||
"sha1_smol",
|
|
||||||
"wasm-bindgen",
|
"wasm-bindgen",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -28,7 +28,7 @@ reqwest = { version = "0.12", features = ["json", "rustls-tls", "multipart", "co
|
|||||||
thiserror = "2"
|
thiserror = "2"
|
||||||
sha2 = "0.10"
|
sha2 = "0.10"
|
||||||
hex = "0.4"
|
hex = "0.4"
|
||||||
uuid = { version = "1", features = ["v4", "v5", "serde"] }
|
uuid = { version = "1", features = ["v4", "serde"] }
|
||||||
secrecy = { version = "0.10", features = ["serde"] }
|
secrecy = { version = "0.10", features = ["serde"] }
|
||||||
regex = "1"
|
regex = "1"
|
||||||
zip = { version = "2", features = ["aes-crypto", "deflate"] }
|
zip = { version = "2", features = ["aes-crypto", "deflate"] }
|
||||||
|
|||||||
@@ -10,7 +10,6 @@ pub mod issues;
|
|||||||
pub mod mcp_tokens;
|
pub mod mcp_tokens;
|
||||||
pub mod notifications;
|
pub mod notifications;
|
||||||
pub mod onboarding;
|
pub mod onboarding;
|
||||||
pub mod oscal;
|
|
||||||
pub mod pentest_handlers;
|
pub mod pentest_handlers;
|
||||||
pub use pentest_handlers as pentest;
|
pub use pentest_handlers as pentest;
|
||||||
pub mod sbom;
|
pub mod sbom;
|
||||||
|
|||||||
@@ -1,89 +0,0 @@
|
|||||||
//! OSCAL assessment endpoint.
|
|
||||||
//!
|
|
||||||
//! Assesses a target's findings against the breakpilot-compliance control
|
|
||||||
//! catalog and returns a standard OSCAL assessment-results document. Ties
|
|
||||||
//! together the ingest provider ([`OscalControlsProvider`]) and the assessment
|
|
||||||
//! emitter (`compliance_core::models::oscal_assessment`).
|
|
||||||
|
|
||||||
use axum::extract::Extension;
|
|
||||||
use axum::http::StatusCode;
|
|
||||||
use axum::response::{IntoResponse, Response};
|
|
||||||
use axum::Json;
|
|
||||||
use mongodb::bson::doc;
|
|
||||||
use serde::Deserialize;
|
|
||||||
|
|
||||||
use compliance_core::models::onboarding::ComplianceFramework;
|
|
||||||
use compliance_core::models::oscal_assessment::{assess, ControlLinker};
|
|
||||||
use compliance_core::models::Finding;
|
|
||||||
use compliance_core::tenant_ctx::TenantCtx;
|
|
||||||
|
|
||||||
use super::dto::{collect_cursor_async, tenant_db, AgentExt};
|
|
||||||
use crate::controls::OscalControlsProvider;
|
|
||||||
|
|
||||||
#[derive(Debug, Deserialize)]
|
|
||||||
pub struct AssessRequest {
|
|
||||||
/// The target / repo id whose findings are assessed.
|
|
||||||
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,
|
|
||||||
/// and emit an OSCAL assessment-results document linking findings to controls.
|
|
||||||
pub async fn assess_target(
|
|
||||||
Extension(agent): AgentExt,
|
|
||||||
tenant: TenantCtx,
|
|
||||||
Json(req): Json<AssessRequest>,
|
|
||||||
) -> 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 {
|
|
||||||
Ok(db) => db,
|
|
||||||
Err(code) => return code.into_response(),
|
|
||||||
};
|
|
||||||
|
|
||||||
let findings: Vec<Finding> = match db.findings().find(doc! { "repo_id": &req.target_id }).await
|
|
||||||
{
|
|
||||||
Ok(cursor) => collect_cursor_async(cursor).await,
|
|
||||||
Err(e) => {
|
|
||||||
tracing::warn!(error = %e, "failed to load findings for OSCAL assessment");
|
|
||||||
return StatusCode::INTERNAL_SERVER_ERROR.into_response();
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
let provider = OscalControlsProvider::new(
|
|
||||||
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()
|
|
||||||
}
|
|
||||||
@@ -6,7 +6,6 @@ use crate::api::handlers;
|
|||||||
pub fn build_router() -> Router {
|
pub fn build_router() -> Router {
|
||||||
Router::new()
|
Router::new()
|
||||||
.route("/api/v1/health", get(handlers::health))
|
.route("/api/v1/health", get(handlers::health))
|
||||||
.route("/api/v1/oscal/assess", post(handlers::oscal::assess_target))
|
|
||||||
.route("/api/v1/stats/overview", get(handlers::stats_overview))
|
.route("/api/v1/stats/overview", get(handlers::stats_overview))
|
||||||
.route(
|
.route(
|
||||||
"/api/v1/settings/ssh-public-key",
|
"/api/v1/settings/ssh-public-key",
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
use compliance_core::config::{BreakpilotConfig, PlcRuntimeConfig};
|
use compliance_core::config::PlcRuntimeConfig;
|
||||||
use compliance_core::AgentConfig;
|
use compliance_core::AgentConfig;
|
||||||
use secrecy::SecretString;
|
use secrecy::SecretString;
|
||||||
|
|
||||||
@@ -66,7 +66,6 @@ pub fn load_config() -> Result<AgentConfig, AgentError> {
|
|||||||
tenant_registry_url: env_var_opt("TENANT_REGISTRY_URL"),
|
tenant_registry_url: env_var_opt("TENANT_REGISTRY_URL"),
|
||||||
plc_runtime: load_plc_runtime_config(),
|
plc_runtime: load_plc_runtime_config(),
|
||||||
werkbank_runner_token: env_secret_opt("WERKBANK_RUNNER_TOKEN"),
|
werkbank_runner_token: env_secret_opt("WERKBANK_RUNNER_TOKEN"),
|
||||||
breakpilot: load_breakpilot_config(),
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -91,14 +90,3 @@ fn load_plc_runtime_config() -> PlcRuntimeConfig {
|
|||||||
.unwrap_or(d.openplc_password),
|
.unwrap_or(d.openplc_password),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Assemble the breakpilot OSCAL-catalog source from env, defaulting the snapshot
|
|
||||||
/// directory. A missing `BREAKPILOT_BASE_URL` leaves the controls provider off.
|
|
||||||
fn load_breakpilot_config() -> BreakpilotConfig {
|
|
||||||
let d = BreakpilotConfig::default();
|
|
||||||
BreakpilotConfig {
|
|
||||||
base_url: env_var_opt("BREAKPILOT_BASE_URL"),
|
|
||||||
token: env_secret_opt("BREAKPILOT_TOKEN"),
|
|
||||||
snapshot_dir: env_var_opt("BREAKPILOT_SNAPSHOT_DIR").unwrap_or(d.snapshot_dir),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -344,7 +344,6 @@ mod tests {
|
|||||||
tenant_registry_url: None,
|
tenant_registry_url: None,
|
||||||
plc_runtime: compliance_core::PlcRuntimeConfig::default(),
|
plc_runtime: compliance_core::PlcRuntimeConfig::default(),
|
||||||
werkbank_runner_token: None,
|
werkbank_runner_token: None,
|
||||||
breakpilot: compliance_core::config::BreakpilotConfig::default(),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -60,7 +60,6 @@ pub fn dev_config(mongodb_uri: String, db_name: String) -> AgentConfig {
|
|||||||
tenant_registry_url: None,
|
tenant_registry_url: None,
|
||||||
plc_runtime: compliance_core::PlcRuntimeConfig::default(),
|
plc_runtime: compliance_core::PlcRuntimeConfig::default(),
|
||||||
werkbank_runner_token: Some(SecretString::from(TEST_RUNNER_TOKEN.to_string())),
|
werkbank_runner_token: Some(SecretString::from(TEST_RUNNER_TOKEN.to_string())),
|
||||||
breakpilot: compliance_core::config::BreakpilotConfig::default(),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -58,33 +58,6 @@ pub struct AgentConfig {
|
|||||||
/// jobs — NOT a Keycloak JWT, since a runner acts across tenants. When
|
/// jobs — NOT a Keycloak JWT, since a runner acts across tenants. When
|
||||||
/// `None`, those endpoints are not mounted at all.
|
/// `None`, those endpoints are not mounted at all.
|
||||||
pub werkbank_runner_token: Option<SecretString>,
|
pub werkbank_runner_token: Option<SecretString>,
|
||||||
/// Source for the OSCAL control catalog pulled from breakpilot-compliance
|
|
||||||
/// (drives the [`crate::traits::ControlsProvider`]). Disabled when
|
|
||||||
/// `base_url` is `None`.
|
|
||||||
pub breakpilot: BreakpilotConfig,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Where to pull the OSCAL control catalog from breakpilot-compliance, and where
|
|
||||||
/// to snapshot it for deterministic / offline reuse.
|
|
||||||
#[derive(Debug, Clone)]
|
|
||||||
pub struct BreakpilotConfig {
|
|
||||||
/// Backend base URL (e.g. `http://backend-compliance:8002`). `None` disables
|
|
||||||
/// the OSCAL controls provider.
|
|
||||||
pub base_url: Option<String>,
|
|
||||||
/// Optional bearer token for the catalog endpoint.
|
|
||||||
pub token: Option<SecretString>,
|
|
||||||
/// Directory for catalog snapshots.
|
|
||||||
pub snapshot_dir: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for BreakpilotConfig {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self {
|
|
||||||
base_url: None,
|
|
||||||
token: None,
|
|
||||||
snapshot_dir: "/data/compliance-scanner/oscal".to_string(),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Configuration for the ephemeral soft-PLC "provision-and-test" path (#183).
|
/// Configuration for the ephemeral soft-PLC "provision-and-test" path (#183).
|
||||||
|
|||||||
@@ -11,7 +11,6 @@ pub mod mcp_token;
|
|||||||
pub mod notification;
|
pub mod notification;
|
||||||
pub mod onboarding;
|
pub mod onboarding;
|
||||||
pub mod oscal;
|
pub mod oscal;
|
||||||
pub mod oscal_assessment;
|
|
||||||
pub mod pentest;
|
pub mod pentest;
|
||||||
pub mod repository;
|
pub mod repository;
|
||||||
pub mod sbom;
|
pub mod sbom;
|
||||||
@@ -42,7 +41,6 @@ pub use onboarding::{
|
|||||||
TargetScanConfig, TargetType, TargetTypeCandidate, WebArtifactConfig,
|
TargetScanConfig, TargetType, TargetTypeCandidate, WebArtifactConfig,
|
||||||
};
|
};
|
||||||
pub use oscal::OscalDocument;
|
pub use oscal::OscalDocument;
|
||||||
pub use oscal_assessment::{assess, AssessmentResultsDoc, ControlLinker};
|
|
||||||
pub use pentest::{
|
pub use pentest::{
|
||||||
AttackChainNode, AttackNodeStatus, AuthMode, CodeContextHint, Environment, IdentityProvider,
|
AttackChainNode, AttackNodeStatus, AuthMode, CodeContextHint, Environment, IdentityProvider,
|
||||||
PentestAuthConfig, PentestConfig, PentestEvent, PentestMessage, PentestSession, PentestStats,
|
PentestAuthConfig, PentestConfig, PentestEvent, PentestMessage, PentestSession, PentestStats,
|
||||||
|
|||||||
@@ -1,402 +0,0 @@
|
|||||||
//! OSCAL 1.1 assessment-results — assess our findings against catalog controls.
|
|
||||||
//!
|
|
||||||
//! The catalog (domain content) comes from the producer; the **assessment** is
|
|
||||||
//! ours. This links compliance [`Finding`]s to catalog control-ids and emits a
|
|
||||||
//! standard OSCAL assessment-results document: an observation per linked finding,
|
|
||||||
//! and a per-control finding with a `not-satisfied` status. `reviewed-controls`
|
|
||||||
//! records the full catalog set we considered.
|
|
||||||
//!
|
|
||||||
//! Deterministic: stable `uuid5` ids; the caller supplies the assessment
|
|
||||||
//! timestamp. Pure — no DB, no network.
|
|
||||||
|
|
||||||
use std::collections::HashMap;
|
|
||||||
|
|
||||||
use chrono::{DateTime, Utc};
|
|
||||||
use serde::Serialize;
|
|
||||||
use uuid::Uuid;
|
|
||||||
|
|
||||||
use crate::models::finding::Finding;
|
|
||||||
use crate::traits::Control;
|
|
||||||
|
|
||||||
const OSCAL_VERSION: &str = "1.1.2";
|
|
||||||
/// Same namespace as the catalog exporter, so ids are stable and correlatable.
|
|
||||||
const NAMESPACE: Uuid = Uuid::from_bytes([
|
|
||||||
0x6f, 0x1e, 0x7c, 0x2a, 0x3b, 0x4d, 0x5e, 0x6f, 0x8a, 0x9b, 0x0c, 0x1d, 0x2e, 0x3f, 0x4a, 0x5b,
|
|
||||||
]);
|
|
||||||
|
|
||||||
fn det_uuid(name: &str) -> String {
|
|
||||||
Uuid::new_v5(&NAMESPACE, name.as_bytes()).to_string()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Links findings to the catalog control-ids they provide evidence for.
|
|
||||||
pub struct ControlLinker {
|
|
||||||
cwe_to_controls: HashMap<u32, Vec<String>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl ControlLinker {
|
|
||||||
/// Build a linker from an explicit CWE → control-id map.
|
|
||||||
pub fn new(cwe_to_controls: HashMap<u32, Vec<String>>) -> Self {
|
|
||||||
Self { cwe_to_controls }
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Seed of CWE → CRA Annex I control mappings (mirrors breakpilot's
|
|
||||||
/// `_CWE_TO_REQ`; extend as scanner coverage grows).
|
|
||||||
pub fn cra_seed() -> Self {
|
|
||||||
let pairs: &[(u32, &str)] = &[
|
|
||||||
(798, "cra-ai-8"),
|
|
||||||
(259, "cra-ai-8"),
|
|
||||||
(1392, "cra-ai-8"),
|
|
||||||
(327, "cra-ai-13"),
|
|
||||||
(326, "cra-ai-13"),
|
|
||||||
(319, "cra-ai-15"),
|
|
||||||
(311, "cra-ai-15"),
|
|
||||||
(89, "cra-ai-20"),
|
|
||||||
(79, "cra-ai-20"),
|
|
||||||
(78, "cra-ai-20"),
|
|
||||||
(22, "cra-ai-20"),
|
|
||||||
];
|
|
||||||
let mut map: HashMap<u32, Vec<String>> = HashMap::new();
|
|
||||||
for (cwe, id) in pairs {
|
|
||||||
map.entry(*cwe).or_default().push((*id).to_string());
|
|
||||||
}
|
|
||||||
Self::new(map)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Parse a CWE token such as `"CWE-798"` or `"798"` into its number.
|
|
||||||
fn parse_cwe(raw: &str) -> Option<u32> {
|
|
||||||
raw.trim_start_matches(|c: char| !c.is_ascii_digit())
|
|
||||||
.split(|c: char| !c.is_ascii_digit())
|
|
||||||
.next()
|
|
||||||
.filter(|s| !s.is_empty())
|
|
||||||
.and_then(|s| s.parse().ok())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The control-ids a finding provides evidence for (via its CWE).
|
|
||||||
pub fn controls_for(&self, finding: &Finding) -> Vec<String> {
|
|
||||||
finding
|
|
||||||
.cwe
|
|
||||||
.as_deref()
|
|
||||||
.and_then(Self::parse_cwe)
|
|
||||||
.and_then(|cwe| self.cwe_to_controls.get(&cwe))
|
|
||||||
.cloned()
|
|
||||||
.unwrap_or_default()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Assess `findings` against `controls`: link findings to control-ids and build a
|
|
||||||
/// standard OSCAL assessment-results document. `at` is the assessment timestamp.
|
|
||||||
pub fn assess(
|
|
||||||
controls: &[Control],
|
|
||||||
findings: &[Finding],
|
|
||||||
linker: &ControlLinker,
|
|
||||||
at: DateTime<Utc>,
|
|
||||||
) -> AssessmentResultsDoc {
|
|
||||||
let ts = at.to_rfc3339();
|
|
||||||
|
|
||||||
let mut observations = Vec::new();
|
|
||||||
let mut obs_by_control: HashMap<String, Vec<String>> = HashMap::new();
|
|
||||||
for finding in findings {
|
|
||||||
let targets = linker.controls_for(finding);
|
|
||||||
if targets.is_empty() {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
let obs_uuid = det_uuid(&format!("obs:{}", finding.fingerprint));
|
|
||||||
let location = match (&finding.file_path, finding.line_number) {
|
|
||||||
(Some(f), Some(l)) => Some(format!("{f}:{l}")),
|
|
||||||
(Some(f), None) => Some(f.clone()),
|
|
||||||
_ => None,
|
|
||||||
};
|
|
||||||
observations.push(Observation {
|
|
||||||
uuid: obs_uuid.clone(),
|
|
||||||
description: finding.title.clone(),
|
|
||||||
methods: vec!["TEST".to_string()],
|
|
||||||
collected: ts.clone(),
|
|
||||||
relevant_evidence: vec![RelevantEvidence {
|
|
||||||
href: location.map(|l| format!("file://{l}")),
|
|
||||||
description: format!("[{}] {}", finding.scanner, finding.title),
|
|
||||||
}],
|
|
||||||
});
|
|
||||||
for control_id in targets {
|
|
||||||
obs_by_control
|
|
||||||
.entry(control_id)
|
|
||||||
.or_default()
|
|
||||||
.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();
|
|
||||||
hit_controls.sort();
|
|
||||||
let ar_findings: Vec<ArFinding> = hit_controls
|
|
||||||
.into_iter()
|
|
||||||
.map(|control_id| {
|
|
||||||
let title = titles.get(control_id.as_str()).copied().unwrap_or("");
|
|
||||||
ArFinding {
|
|
||||||
uuid: det_uuid(&format!("finding:{control_id}")),
|
|
||||||
title: format!("Findings affect {control_id}: {title}"),
|
|
||||||
target: FindingTarget {
|
|
||||||
target_type: "statement-id".to_string(),
|
|
||||||
target_id: format!("{control_id}_smt"),
|
|
||||||
status: TargetStatus {
|
|
||||||
state: "not-satisfied".to_string(),
|
|
||||||
},
|
|
||||||
},
|
|
||||||
related_observations: obs_by_control[control_id]
|
|
||||||
.iter()
|
|
||||||
.map(|u| RelatedObservation {
|
|
||||||
observation_uuid: u.clone(),
|
|
||||||
})
|
|
||||||
.collect(),
|
|
||||||
}
|
|
||||||
})
|
|
||||||
.collect();
|
|
||||||
|
|
||||||
let include_controls = controls
|
|
||||||
.iter()
|
|
||||||
.map(|c| SelectControlById {
|
|
||||||
control_id: c.id.clone(),
|
|
||||||
})
|
|
||||||
.collect();
|
|
||||||
|
|
||||||
let result = ArResult {
|
|
||||||
uuid: det_uuid("result:cra"),
|
|
||||||
title: "Automated code-compliance assessment".to_string(),
|
|
||||||
description: format!(
|
|
||||||
"{} finding-linked observation(s) across {} reviewed control(s)",
|
|
||||||
observations.len(),
|
|
||||||
controls.len()
|
|
||||||
),
|
|
||||||
start: ts.clone(),
|
|
||||||
reviewed_controls: ReviewedControls {
|
|
||||||
control_selections: vec![ControlSelection { include_controls }],
|
|
||||||
},
|
|
||||||
observations,
|
|
||||||
findings: ar_findings,
|
|
||||||
};
|
|
||||||
|
|
||||||
AssessmentResultsDoc {
|
|
||||||
assessment_results: AssessmentResults {
|
|
||||||
uuid: det_uuid("assessment-results:cra"),
|
|
||||||
metadata: ArMetadata {
|
|
||||||
title: "Compliance scanner — OSCAL assessment results".to_string(),
|
|
||||||
last_modified: ts,
|
|
||||||
version: "1.0.0".to_string(),
|
|
||||||
oscal_version: OSCAL_VERSION.to_string(),
|
|
||||||
},
|
|
||||||
import_ap: ImportAp {
|
|
||||||
href: "#cra-annex-i".to_string(),
|
|
||||||
},
|
|
||||||
results: vec![result],
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ── OSCAL assessment-results document (serialise) ────────────────────────────
|
|
||||||
|
|
||||||
/// The root OSCAL assessment-results document.
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct AssessmentResultsDoc {
|
|
||||||
#[serde(rename = "assessment-results")]
|
|
||||||
pub assessment_results: AssessmentResults,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct AssessmentResults {
|
|
||||||
pub uuid: String,
|
|
||||||
pub metadata: ArMetadata,
|
|
||||||
#[serde(rename = "import-ap")]
|
|
||||||
pub import_ap: ImportAp,
|
|
||||||
pub results: Vec<ArResult>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct ArMetadata {
|
|
||||||
pub title: String,
|
|
||||||
#[serde(rename = "last-modified")]
|
|
||||||
pub last_modified: String,
|
|
||||||
pub version: String,
|
|
||||||
#[serde(rename = "oscal-version")]
|
|
||||||
pub oscal_version: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct ImportAp {
|
|
||||||
pub href: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct ArResult {
|
|
||||||
pub uuid: String,
|
|
||||||
pub title: String,
|
|
||||||
pub description: String,
|
|
||||||
pub start: String,
|
|
||||||
#[serde(rename = "reviewed-controls")]
|
|
||||||
pub reviewed_controls: ReviewedControls,
|
|
||||||
#[serde(skip_serializing_if = "Vec::is_empty")]
|
|
||||||
pub observations: Vec<Observation>,
|
|
||||||
#[serde(skip_serializing_if = "Vec::is_empty")]
|
|
||||||
pub findings: Vec<ArFinding>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct ReviewedControls {
|
|
||||||
#[serde(rename = "control-selections")]
|
|
||||||
pub control_selections: Vec<ControlSelection>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct ControlSelection {
|
|
||||||
#[serde(rename = "include-controls", skip_serializing_if = "Vec::is_empty")]
|
|
||||||
pub include_controls: Vec<SelectControlById>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct SelectControlById {
|
|
||||||
#[serde(rename = "control-id")]
|
|
||||||
pub control_id: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct Observation {
|
|
||||||
pub uuid: String,
|
|
||||||
pub description: String,
|
|
||||||
pub methods: Vec<String>,
|
|
||||||
pub collected: String,
|
|
||||||
#[serde(rename = "relevant-evidence", skip_serializing_if = "Vec::is_empty")]
|
|
||||||
pub relevant_evidence: Vec<RelevantEvidence>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct RelevantEvidence {
|
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
|
||||||
pub href: Option<String>,
|
|
||||||
pub description: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct ArFinding {
|
|
||||||
pub uuid: String,
|
|
||||||
pub title: String,
|
|
||||||
pub target: FindingTarget,
|
|
||||||
#[serde(rename = "related-observations", skip_serializing_if = "Vec::is_empty")]
|
|
||||||
pub related_observations: Vec<RelatedObservation>,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct FindingTarget {
|
|
||||||
#[serde(rename = "type")]
|
|
||||||
pub target_type: String,
|
|
||||||
#[serde(rename = "target-id")]
|
|
||||||
pub target_id: String,
|
|
||||||
pub status: TargetStatus,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct TargetStatus {
|
|
||||||
pub state: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Clone, Serialize)]
|
|
||||||
pub struct RelatedObservation {
|
|
||||||
#[serde(rename = "observation-uuid")]
|
|
||||||
pub observation_uuid: String,
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
#[allow(clippy::unwrap_used)]
|
|
||||||
mod tests {
|
|
||||||
use super::*;
|
|
||||||
use crate::models::finding::Severity;
|
|
||||||
use crate::models::onboarding::ComplianceFramework;
|
|
||||||
use crate::models::scan::ScanType;
|
|
||||||
|
|
||||||
fn control(id: &str, title: &str) -> Control {
|
|
||||||
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(
|
|
||||||
"repo".into(),
|
|
||||||
fp.into(),
|
|
||||||
"semgrep".into(),
|
|
||||||
ScanType::Sast,
|
|
||||||
"hardcoded credential".into(),
|
|
||||||
"desc".into(),
|
|
||||||
Severity::High,
|
|
||||||
);
|
|
||||||
f.cwe = cwe.map(Into::into);
|
|
||||||
f.file_path = Some("src/auth.rs".into());
|
|
||||||
f.line_number = Some(42);
|
|
||||||
f
|
|
||||||
}
|
|
||||||
|
|
||||||
fn at() -> DateTime<Utc> {
|
|
||||||
DateTime::parse_from_rfc3339("2026-07-20T00:00:00Z")
|
|
||||||
.unwrap()
|
|
||||||
.with_timezone(&Utc)
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn links_cwe_finding_to_control_not_satisfied() {
|
|
||||||
let controls = vec![
|
|
||||||
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];
|
|
||||||
assert_eq!(r.observations.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.status.state, "not-satisfied");
|
|
||||||
assert_eq!(r.findings[0].related_observations.len(), 1);
|
|
||||||
assert_eq!(
|
|
||||||
r.reviewed_controls.control_selections[0]
|
|
||||||
.include_controls
|
|
||||||
.len(),
|
|
||||||
2
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn unlinked_finding_yields_no_control_finding() {
|
|
||||||
let controls = vec![control("cra-ai-8", "x")];
|
|
||||||
let findings = vec![finding("f1", Some("CWE-99999"))];
|
|
||||||
let doc = assess(&controls, &findings, &ControlLinker::cra_seed(), at());
|
|
||||||
let r = &doc.assessment_results.results[0];
|
|
||||||
assert!(r.observations.is_empty());
|
|
||||||
assert!(r.findings.is_empty());
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn output_is_deterministic_and_valid_oscal() {
|
|
||||||
let controls = vec![control("cra-ai-8", "x")];
|
|
||||||
let findings = vec![finding("f1", Some("798"))];
|
|
||||||
let a = serde_json::to_string(&assess(
|
|
||||||
&controls,
|
|
||||||
&findings,
|
|
||||||
&ControlLinker::cra_seed(),
|
|
||||||
at(),
|
|
||||||
))
|
|
||||||
.unwrap();
|
|
||||||
let b = serde_json::to_string(&assess(
|
|
||||||
&controls,
|
|
||||||
&findings,
|
|
||||||
&ControlLinker::cra_seed(),
|
|
||||||
at(),
|
|
||||||
))
|
|
||||||
.unwrap();
|
|
||||||
assert_eq!(a, b);
|
|
||||||
assert!(a.contains("\"oscal-version\":\"1.1.2\""));
|
|
||||||
assert!(a.contains("\"not-satisfied\""));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user