pub mod schema;
include!(concat!(env!("OUT_DIR"), "/ocsf_generated.rs"));
use crate::AuditBackend;
use serde::Serialize;
pub trait OcsfEvent: Serialize {
fn class_uid(&self) -> i32;
fn category_uid(&self) -> i32;
}
pub fn log_ocsf_event<E: OcsfEvent>(backend: &dyn AuditBackend, event: &E) {
match serde_json::to_value(event) {
Ok(json) => backend.security_log(&json),
Err(e) => eprintln!("[OCSF ERROR] Failed to serialize OCSF event: {e}"),
}
}
pub fn log_ocsf_event_validated<E: OcsfEvent>(
backend: &dyn AuditBackend,
event: &E,
) -> Result<(), schema::OcsfValidationError> {
match serde_json::to_value(event) {
Ok(json) => {
schema::validate_ocsf_event(&json)?;
backend.security_log(&json);
Ok(())
}
Err(e) => Err(schema::OcsfValidationError {
details: vec![format!("serialization failed: {e}")],
}),
}
}
#[cfg(test)]
mod tests {
use super::*;
fn make_meta() -> OcsfMetadata {
OcsfMetadata::from_product(OcsfProduct::new("TestApp", "TestOrg"))
}
#[test]
fn test_authentication_builder_and_trait() {
let event = OcsfAuthentication::builder()
.activity_id(OcsfAuthActivityId::Logon)
.time(1_700_000_000_000)
.metadata(make_meta())
.severity_id(OcsfSeverityId::Informational)
.user(OcsfUser::with_name("alice"))
.src_endpoint(OcsfNetworkEndpoint::from_ip("10.0.0.1"))
.status_id(OcsfStatusId::Success)
.build();
assert_eq!(event.class_uid(), 3002);
assert_eq!(event.category_uid(), 3);
assert_eq!(event.type_uid, 300_201);
}
#[test]
fn test_authentication_new_activities_180() {
let preauth = OcsfAuthentication::builder()
.activity_id(OcsfAuthActivityId::Preauth)
.time(1_700_000_000_000)
.metadata(make_meta())
.build();
assert_eq!(preauth.type_uid, 3002 * 100 + 6);
let switch = OcsfAuthentication::builder()
.activity_id(OcsfAuthActivityId::AccountSwitch)
.time(1_700_000_000_000)
.metadata(make_meta())
.build();
assert_eq!(switch.type_uid, 3002 * 100 + 7);
}
#[test]
fn test_account_change_builder() {
let event = OcsfAccountChange::builder()
.activity_id(OcsfAccountChangeActivityId::Create)
.time(1_700_000_000_000)
.metadata(make_meta())
.user(OcsfUser::with_name("bob"))
.build();
assert_eq!(event.class_uid(), 3001);
assert_eq!(event.category_uid(), 3);
assert_eq!(event.type_uid, 300_101);
}
#[test]
fn test_authorize_session_builder() {
let event = OcsfAuthorizeSession::builder()
.activity_id(OcsfAuthorizeSessionActivityId::Assign)
.time(1_700_000_000_000)
.metadata(make_meta())
.build();
assert_eq!(event.class_uid(), 3003);
assert_eq!(event.type_uid, 300_301);
}
#[test]
fn test_network_activity_listen_180() {
let event = OcsfNetworkActivity::builder()
.activity_id(OcsfNetworkActivityId::Listen)
.time(1_700_000_000_000)
.metadata(make_meta())
.src_endpoint(OcsfNetworkEndpoint::from_ip("0.0.0.0"))
.build();
assert_eq!(event.class_uid(), 4001);
assert_eq!(event.type_uid, 400_107);
}
#[test]
fn test_network_activity_open() {
let event = OcsfNetworkActivity::builder()
.activity_id(OcsfNetworkActivityId::Open)
.time(1_700_000_000_000)
.metadata(make_meta())
.bytes_in(1024)
.bytes_out(2048)
.build();
assert_eq!(event.class_uid(), 4001);
assert_eq!(event.type_uid, 400_101);
}
#[test]
fn test_process_activity_builder() {
let event = OcsfProcessActivity::builder()
.activity_id(OcsfProcessActivityId::Launch)
.time(1_700_000_000_000)
.metadata(make_meta())
.process(OcsfProcess {
pid: Some(1234),
name: Some("bash".to_string()),
cmd_line: Some("/bin/bash -i".to_string()),
uid: None,
file_path: None,
parent_process_pid: None,
})
.build();
assert_eq!(event.class_uid(), 1007);
assert_eq!(event.type_uid, 100_701);
}
#[test]
fn test_process_activity_set_user_id_180() {
let event = OcsfProcessActivity::builder()
.activity_id(OcsfProcessActivityId::SetUserId)
.time(1_700_000_000_000)
.metadata(make_meta())
.build();
assert_eq!(event.type_uid, 100_705);
}
#[test]
fn test_detection_finding_builder() {
let info = OcsfFindingInfo::new("RULE-001", "Suspicious login");
let event = OcsfDetectionFinding::builder()
.activity_id(OcsfDetectionFindingActivityId::Create)
.time(1_700_000_000_000)
.metadata(make_meta())
.finding_info(info)
.severity_id(OcsfSeverityId::High)
.is_alert(true)
.build();
assert_eq!(event.class_uid(), 2004);
assert_eq!(event.category_uid(), 2);
assert_eq!(event.type_uid, 200_401);
}
#[test]
fn test_vulnerability_finding_builder() {
let info = OcsfFindingInfo::new("CVE-2024-0001", "Critical buffer overflow");
let vuln = OcsfVulnerability {
cve_uid: Some("CVE-2024-0001".to_string()),
desc: Some("Heap buffer overflow in libssl".to_string()),
severity: Some("Critical".to_string()),
fix_available: Some(true),
references: None,
};
let event = OcsfVulnerabilityFinding::builder()
.activity_id(OcsfVulnerabilityFindingActivityId::Create)
.time(1_700_000_000_000)
.metadata(make_meta())
.finding_info(info)
.vulnerabilities(vec![vuln])
.severity_id(OcsfSeverityId::Critical)
.build();
assert_eq!(event.class_uid(), 2002);
assert_eq!(event.type_uid, 200_201);
}
#[test]
fn test_api_activity_builder() {
let event = OcsfApiActivity::builder()
.activity_id(OcsfApiActivityId::Read)
.time(1_700_000_000_000)
.metadata(make_meta())
.api(OcsfApi {
service_name: Some("s3".to_string()),
operation: Some("GetObject".to_string()),
version: Some("2006-03-01".to_string()),
request_uid: Some("abc-123".to_string()),
})
.build();
assert_eq!(event.class_uid(), 6003);
assert_eq!(event.category_uid(), 6);
assert_eq!(event.type_uid, 600_302);
}
#[test]
fn test_log_ocsf_event_with_noop_backend() {
use crate::NoopAuditBackend;
let event = OcsfAuthentication::builder()
.activity_id(OcsfAuthActivityId::Logoff)
.time(1_700_000_000_000)
.metadata(make_meta())
.build();
log_ocsf_event(&NoopAuditBackend, &event);
}
#[test]
fn test_log_ocsf_event_validated_passes() {
use crate::NoopAuditBackend;
let event = OcsfAuthentication::builder()
.activity_id(OcsfAuthActivityId::Logon)
.time(1_700_000_000_000)
.metadata(make_meta())
.severity_id(OcsfSeverityId::Informational)
.status_id(OcsfStatusId::Success)
.build();
assert!(log_ocsf_event_validated(&NoopAuditBackend, &event).is_ok());
}
#[test]
fn test_serialization_roundtrip() {
let event = OcsfAuthentication::builder()
.activity_id(OcsfAuthActivityId::Logon)
.time(1_700_000_000_000)
.metadata(make_meta())
.build();
let json = serde_json::to_value(&event).unwrap();
assert_eq!(json["class_uid"], 3002);
assert_eq!(json["category_uid"], 3);
assert!(json["metadata"]["product"]["name"].is_string());
}
#[test]
fn test_metadata_version_is_180() {
let meta = make_meta();
assert_eq!(meta.version, "1.8.0");
}
}