ocsf-types 0.1.0

Strongly typed Rust structs for the OCSF (Open Cybersecurity Schema Framework)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

# OCSF Types for Rust

Strongly typed Rust structs for the [OCSF](https://schema.ocsf.io/)

This crate provides native Rust types for OCSF events, objects, and enums. It is generated programmatically from the official OCSF schema. It uses the official python OCSF compile tool to first create a flattened JSON schema then use `serde` to parse it. 

## Usage


Add this to your `Cargo.toml`:
```toml
[dependencies]
ocsf-types = "0.1.0"
```

## Example


Here is how you may use this package:
```rs
use ocsf_types_rs::AccountChange;
let mut event = AccountChange::default();
event.activity_id = 1;
event.class_uid = 1001;
event.message = Some("User password changed".to_string());
```

## Development


If you are interested in building this from scratch or contributing.

### Requirements

- git
- rust
- python ^3.13 with ocsf-lib

### Building

```sh
git submodule update --init --recursive
pip install ocsf-lib
python -m ocsf.compile ocsf-schema/ > src/resolved.json
cargo run --example generate
cargo build
```
Note - if generate.rs is failing, make sure there exists a src/ocsf_generated.rs file