csaf-rust

This repository is a reference implementation for the CSAF standard in Rust that relies on automatically generating CSAF document structs from the JSON schema.

This is work-in-progress.

Structure

• csaf-validator contains a command line tool to validate CSAF documents.
• csaf-rs contains the actual validator library which currently publishes a crate to crates.io. In the future there will be a WASM version published to NPM and also bindings to other languages via UniFFI.

Minimum required Rust version (MSRV)

1.85.1

Build

If you want to build csaf-validator on your own, please install Rust (see https://rustup.rs) and then run

# make sure submodules are up-to-date
git submodule init
git submodule update --remote

# make sure that local assets are in sync with git submodules
./update_assets.sh

# run the tests
cargo test

# build for release
cargo build --release

The final binary will be in target/release and can then be installed, for example, in a system-wide folder.

Build WASM Bindings

If you want to build the WASM bindings locally, install wasm-pack (make sure ~/.cargo/bin is in the path) and execute it:

cargo install wasm-pack
wasm-pack build csaf-rs --scope csaf-rs

This will create a JavaScript/TypeScript package in csaf-rs/pkg.

Usage

After building or downloading csaf-validator from the available releases, the usage is quite simple and additional help can be display using --help.

A validator for CSAF documents

Usage: csaf-validator [OPTIONS] <PATH>

Arguments:
  <PATH>  

Options:
  -c, --csaf-version <CSAF_VERSION>  Version of CSAF to use [default: 2.0]
  -p, --preset <PRESET>              The validation preset to use [default: basic]
  -t, --test-id <TEST_ID>            Run only the selected tests, may be specified multiple times
  -h, --help                         Print help
  -V, --version                      Print version

Some examples to use are included below. Please note that the validation is not yet fully implemented!

# validate a CSAF 2.0 document with profile basic (the default)
csaf-validator --csaf-version 2.0 my-csaf-2-0-document.json

# validate a CSAF 2.0 document with profile full
csaf-validator --csaf-version 2.0 --preset full my-csaf-2-0-document.json

# validate a CSAF 2.1 document with one specific test
csaf-validator --csaf-version 2.1 --test-id 6.1.34 my-csaf-2-1-document.json

Implementation status in regards to the Standard

• ✅ Implemented
• ⭕ Not applicable

Mandatory Tests

Test specification	2.0	2.1 (experimental)
6.1.1	✅
6.1.2	✅
6.1.3	✅
6.1.4	✅
6.1.5	✅
6.1.6
6.1.7
6.1.8	✅
6.1.9
6.1.10
6.1.11
6.1.12	✅
6.1.13
6.1.14
6.1.15
6.1.16
6.1.17
6.1.18
6.1.19
6.1.20
6.1.21
6.1.22
6.1.23
6.1.24
6.1.25
6.1.26
6.1.27
6.1.28
6.1.29
6.1.30
6.1.31
6.1.32
6.1.33
6.1.34
6.1.35
6.1.36
6.1.37
6.1.38
6.1.39
6.1.40
6.1.41
6.1.42
6.1.43
6.1.44
6.1.45
6.1.46
6.1.47
6.1.48
6.1.49
6.1.50
6.1.51
6.1.52
6.1.53
6.1.54
6.1.55