marque-ism

ISM vocabulary types and generated CVE enums for marque.

This crate is the leaf dependency in the marque workspace. It owns the canonical parsed-marking representation (IsmAttributes), zero-copy position types (Span), page-level aggregation (PageContext), and the closed Rust enums generated at build time from ODNI ISM schemas.

This crate implements the ISM vocabulary model for the marque rule engine. For the engine itself, see marque-engine. For the CAPCO rule implementations that consume this vocabulary, see marque-capco.

Role in Marque

marque-ism is the pivot type. Every source format normalizes to IsmAttributes before rule validation runs. It sits at the bottom of the dependency graph:

marque-ism  ←  marque-core (scanner/parser)
            ←  marque-capco (rules consume generated predicates)
            ←  marque-engine, marque-wasm, ... (re-export via core)

WASM-safe: no I/O, no format dependencies, no platform-specific code. All schema parsing happens in build.rs at compile time.

Code Generation

build.rs parses ODNI ISM specification files from schemas/ISM-v2022-DEC/ and emits three modules into OUT_DIR, included via src/generated.rs:

File	Contents
`values.rs`	CVE enumeration types — closed Rust enums + lookup tables
`validators.rs`	Schematron-derived validation predicates
`migrations.rs`	Deprecated marking → replacement mappings

Source XML/XSD files consumed:

CVE_ISM/CVEnumISMClassificationAll.xml — classification levels
CVE_ISM/CVEnumISMSCIControls.xml — SCI controls
CVE_ISM/CVEnumISMDissem.xml — dissemination controls (with deprecation markers)
CVE_ISM/CVEnumISMSAR.xml — SAR identifiers (intentionally empty in public ODNI packages; see migration note)
CVE_ISM/CVEnumISMExemptFrom.xml — declassification exemptions
CVE_ISMCAT/CVEGenerated/CVEnumISMCATRelTo.xsd — country trigraphs

The active schema version is pinned in Cargo.toml under [package.metadata.marque] ism-schema-version and re-exported as SCHEMA_VERSION. build.rs asserts the on-disk schema matches this pin. Bump intentionally when ODNI publishes a new package.

Public Types

Type	Purpose
`IsmAttributes`	Canonical parsed marking. Fields use `Box<[T]>` to avoid over-allocation.
`Span`	Byte offset range into the original source buffer. Never copies.
`MarkingCandidate`, `MarkingType`	Scanner output (Portion, Banner, CAB, PageBreak).
`Zone`, `DocumentPosition`	Structural context. Both are `Option`-typed in `RuleContext`.
`PageContext`	Page-level aggregation: `max()` for classification, union for SCI/SAR/dissem, intersection (with NOFORN supersession) for `REL TO`. Reset at scanner-emitted page-break candidates.
`Classification`, `SciControl`, `DissemControl`, `Trigraph`, …	Generated CVE enums.
`SarMarking`, `SarIndicator`, `SarProgram`, `SarCompartment`	Structural SAR types (not CVE-derived — see migration note below).
`CapcoTokenSet`	Aho-Corasick automaton over CVE token list.

Usage

use marque_ism::{IsmAttributes, Classification, SCHEMA_VERSION};

assert_eq!(SCHEMA_VERSION, "ISM-v2022-DEC");

let attrs = IsmAttributes::default();
assert_eq!(attrs.classification, Classification::Unclassified);

Features

Feature	Effect
`serde`	Derives `Serialize`/`Deserialize` on public types.

WASM Compatibility

WASM-safe. No runtime I/O. All schema work runs in build.rs on the host.

Migration Notes

0.3.0: `SarIdentifier` → `SarMarking`

Prior versions exposed SarIdentifier as a CVE-derived enum re-exported from attrs. The ODNI CVEnumISMSAR.xml is empty in all published ISM packages because SAR program identifiers are agency-assigned codewords, not centrally registered. The enum was therefore a typed placeholder that never matched anything at runtime.

0.3.0 replaces the enum with a structural SarMarking type carrying programs, compartments, and sub-compartments per CAPCO-2016 §H.5 syntax. IsmAttributes.sar_identifiers: Box<[SarIdentifier]> is now IsmAttributes.sar_markings: Option<SarMarking>. The SarIdentifier enum has been removed from code generation; TokenKind::SarIdentifier remains as a #[deprecated] back-compat variant that the parser no longer emits, joined by new TokenKind::SarIndicator, SarProgram, SarCompartment, and SarSubCompartment variants.

0.x.0 (SCI compartments)

Additive. New sci_markings: Box<[SciMarking]> field on IsmAttributes provides structural SCI access (control system + compartments + sub-compartments per CAPCO-2016 §A.6); existing sci_controls: Box<[SciControl]> is preserved as a CVE enum projection for back-compat. Non-breaking.

License

Marque License 1.0 (LicenseRef-MarqueLicense-1.0). See LICENSE.md.

marque-ism 0.2.1