Skip to content

Commit 4dfc4dd

Browse files
committed
fix(ocsf): align downgrade with schema version
Signed-off-by: John Myers <[email protected]>
1 parent 1c3d1fa commit 4dfc4dd

2 files changed

Lines changed: 28 additions & 10 deletions

File tree

‎crates/openshell-ocsf/src/format/downgrade.rs‎

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ pub fn downgrade_event(event: &mut Value, target_version: &str) -> bool {
5757
}
5858
}
5959

60-
if modified && let Some(metadata) = obj.get_mut("metadata").and_then(Value::as_object_mut) {
60+
if let Some(metadata) = obj.get_mut("metadata").and_then(Value::as_object_mut) {
6161
let original_version = metadata
6262
.get("version")
6363
.and_then(Value::as_str)
@@ -67,6 +67,7 @@ pub fn downgrade_event(event: &mut Value, target_version: &str) -> bool {
6767
"version".to_string(),
6868
Value::String(target_version.to_string()),
6969
);
70+
modified = true;
7071

7172
let unmapped = obj
7273
.entry("unmapped")
@@ -102,7 +103,7 @@ mod tests {
102103
"time": 1_234_567_890,
103104
"severity_id": 1,
104105
"metadata": {
105-
"version": "1.7.0",
106+
"version": crate::OCSF_VERSION,
106107
"profiles": ["security_control", "network_proxy", "container", "host"]
107108
},
108109
"device": {"hostname": "sandbox-1"},
@@ -151,16 +152,16 @@ mod tests {
151152
downgrade_event(&mut event, "1.1.0");
152153

153154
assert_eq!(event["metadata"]["version"], "1.1.0");
154-
assert_eq!(event["unmapped"]["downgraded_from"], "1.7.0");
155+
assert_eq!(event["unmapped"]["downgraded_from"], crate::OCSF_VERSION);
155156
}
156157

157158
#[test]
158159
fn test_no_downgrade_for_current_version() {
159160
let mut event = test_event();
160-
let modified = downgrade_event(&mut event, "1.7.0");
161+
let modified = downgrade_event(&mut event, crate::OCSF_VERSION);
161162

162163
assert!(!modified);
163-
assert_eq!(event["metadata"]["version"], "1.7.0");
164+
assert_eq!(event["metadata"]["version"], crate::OCSF_VERSION);
164165
}
165166

166167
#[test]
@@ -203,21 +204,38 @@ mod tests {
203204
let mut event = serde_json::json!({
204205
"class_uid": 4001,
205206
"metadata": {
206-
"version": "1.7.0",
207+
"version": crate::OCSF_VERSION,
207208
"profiles": ["container"]
208209
},
209210
"container": {"name": "sandbox-1"}
210211
});
211212
let modified = downgrade_event(&mut event, "1.1.0");
212213

213214
assert!(modified);
214-
assert_eq!(event["unmapped"]["downgraded_from"], "1.7.0");
215+
assert_eq!(event["unmapped"]["downgraded_from"], crate::OCSF_VERSION);
216+
}
217+
218+
#[test]
219+
fn test_downgrade_rewrites_version_without_strippable_fields() {
220+
let mut event = serde_json::json!({
221+
"class_uid": 0,
222+
"metadata": {
223+
"version": crate::OCSF_VERSION,
224+
"profiles": ["host"]
225+
}
226+
});
227+
228+
let modified = downgrade_event(&mut event, "1.3.0");
229+
230+
assert!(modified);
231+
assert_eq!(event["metadata"]["version"], "1.3.0");
232+
assert_eq!(event["unmapped"]["downgraded_from"], crate::OCSF_VERSION);
215233
}
216234

217235
#[test]
218236
fn test_no_downgrade_omits_breadcrumb() {
219237
let mut event = test_event();
220-
downgrade_event(&mut event, "1.7.0");
238+
downgrade_event(&mut event, crate::OCSF_VERSION);
221239

222240
assert!(
223241
event

‎docs/observability/ocsf-json-export.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ OCSF API:INFERENCE [INFO] Success claude-haiku-4-5-20251001 via https://api.anth
170170

171171
## SIEM Schema Version Compatibility
172172

173-
OpenShell emits OCSF v1.7.0 events internally, but many SIEMs only support older schema versions. The `ocsf_schema_version` setting tells the JSONL layer to downgrade events before writing, stripping fields and profiles that don't exist in the target version.
173+
OpenShell emits OCSF v1.8.0 events internally, but many SIEMs only support older schema versions. The `ocsf_schema_version` setting tells the JSONL layer to downgrade events before writing, stripping fields and profiles that don't exist in the target version.
174174

175175
Set the target version globally:
176176

@@ -192,7 +192,7 @@ Supported target versions are `1.1` and `1.3`. When set, the JSONL layer applies
192192
- Removes unknown profile names from `metadata.profiles`: `ai_operation`, `container`
193193
- Rewrites `metadata.version` to match the target version
194194

195-
The shorthand log output is unaffected. The internal event model stays at v1.7.0; only the serialized JSONL is transformed.
195+
The shorthand log output is unaffected. The internal event model stays at v1.8.0; only the serialized JSONL is transformed.
196196

197197
When unset or empty, no downgrade is applied and events are written at the current schema version.
198198

0 commit comments

Comments
 (0)