sova-format / README.md
Gautam-R-Patil's picture
SOVA format conformance kit 0.1, schemas and example scenarios
e239563 verified
|
Raw History Blame Contribute Delete
8.85 kB
---
license: apache-2.0
language:
- en
pretty_name: SOVA format conformance kit 0.1
tags:
- truscor
- sova
- security
- ai-safety
- ai-agents
- json-schema
- conformance
viewer: false
---
# SOVA format conformance kit 0.1
By Gautam R. Patil, TRUSCOR Private Limited. Part of
[SOVA OSS](https://github.com/TRUSCOR/SOVA-OSS) (`pip install sova-oss`). Papers with their full
data, code and protocols: [TRUSCOR/research](https://github.com/TRUSCOR/research).
## What it is
Files for anyone writing their own reader or writer of `.sova` files without using the SOVA Python
package:
- `sova-conformance-0.1.zip`: the conformance kit exported by `sova conformance export` from
`sova-oss` 0.1.1. It holds every packaged JSON Schema (61, all experimental), two golden vectors
(canonical JSON, and keeping an unknown extension unchanged) and a manifest with the size and
SHA-256 of every other entry.
- `kit/`: the same ZIP unpacked, so the files can be read on this page.
- `examples/`: the 8 example scenarios from `examples/scenarios/` in the SOVA OSS repository,
copied unchanged.
The repository holds no table, so the dataset viewer is turned off in the card metadata
(`viewer: false`).
## What passing the kit means
From the conformance kit specification,
[docs/specifications/conformance-kit-0.1.md](https://github.com/TRUSCOR/SOVA-OSS/blob/v0.1.1/docs/specifications/conformance-kit-0.1.md):
> Passing establishes only the included schema and vector contracts. It does not
> establish executor, behavioral, security, or semantic-reproduction equivalence.
In other words, a reader or writer that passes the kit agrees with SOVA 0.1.1 on the published
schemas and the two vectors. That says nothing about whether it runs scenarios the same way,
behaves the same way, is secure, or reproduces findings the same way.
The same specification says what `sova conformance verify` checks: it rejects traversal,
backslashes, absolute paths, symlinks, duplicate and directory entries, undeclared entries, digest
and size changes, too many entries or too many bytes, and unsafe compression ratios.
## Files
```
README.md this card
sova-conformance-0.1.zip the kit as exported (66,287 bytes, 65 entries)
kit/manifest.json artifact type sova.conformance-kit, 64 entries
kit/README.md the kit's own short README
kit/schemas/*.schema.json 61 JSON Schemas, as canonical JSON
kit/vectors/canonical-json.json canonical JSON vector
kit/vectors/unknown-extension-roundtrip.json unknown-extension vector
examples/*.json 8 example scenarios (sova.scenario 0.1.0)
LICENSE Apache License 2.0, copied from TRUSCOR/SOVA-OSS
NOTICE copied from TRUSCOR/SOVA-OSS
```
SHA-256 of `sova-conformance-0.1.zip`:
```
7b13a0fb8f20c77cc462f5b59f52b142448dfb5d98ee1a074c6534e40e47ce0f
```
The manifest records `sovaVersion` 0.1.1, `formatStatus` `experimental` and `compatibilityClaim`
`tested-schema-and-vector-conformance-only`. Each manifest entry gives a path, a size in bytes and
a SHA-256 written as `sha256:<hex>`; the manifest does not list itself.
The schemas in the kit are the schemas in `src/sova/schemas/` at tag `v0.1.1`, rewritten as SOVA
canonical JSON with a final newline. They parse to the same JSON as the repository files; the bytes
differ because of the canonical form. SOVA canonical JSON is UTF-8 with unique member names, RFC
8785 UTF-16 member ordering, minimal separators and no binary floating-point values; the
[`.sova` capsule specification](https://github.com/TRUSCOR/SOVA-OSS/blob/v0.1.1/docs/specifications/sova-capsule-0.1.md)
gives the full rule.
The two vectors:
- `canonical-json.json` gives an input object, the expected canonical bytes as UTF-8 hex, and their
SHA-256.
- `unknown-extension-roundtrip.json` gives an input with an extension under an unknown name, and
the extension a reader must keep, unchanged, when it writes the object back.
## How to verify the kit
With the SOVA package (Python 3.11 to 3.14):
```
pip install sova-oss==0.1.1
sova conformance verify sova-conformance-0.1.zip
```
The result is a JSON object. For this ZIP it reads `"status":"pass"`, `"accepted":true`,
`"entryCount":64`, and empty `missing`, `undeclared` and `mismatched` lists, with
`"offline":true`.
The export is byte-reproducible. With `sova-oss` 0.1.1 installed,
```
sova conformance export sova-conformance-0.1.zip
sha256sum sova-conformance-0.1.zip
```
gives the SHA-256 above. On Windows, use `Get-FileHash sova-conformance-0.1.zip -Algorithm SHA256`.
Two exports made for this dataset were byte-identical.
Without the SOVA package: unpack the ZIP (or use `kit/`), and for each entry in
`manifest.json` check that the file exists, that its size matches `size`, and that its SHA-256
matches `sha256`. Then check that the ZIP holds no file that the manifest does not list, apart from
`manifest.json` itself. The files under `kit/` in this repository pass that check.
## Example scenarios
Each file is a `sova.scenario` document, schema version 0.1.0 (see
`kit/schemas/scenario-0.1.0.schema.json`). All 8 pass `sova validate` in `sova-oss` 0.1.1.
| File | Title | Purpose |
|---|---|---|
| `behavioral-intervention.json` | Observable context intervention | Compare outputs before and after removing one declared context item. |
| `compositional-sequence.json` | Reusable observation sequence | Demonstrate explicit composition without hiding the steps that a capable executor would run. |
| `conditional-trigger.json` | Synthetic conditional phrase | Reproduce a harmless planted behavior only after a declared phrase. |
| `portable-artifact-read.json` | Portable capsule artifact read | Exercise the same content-addressed read on scripted and restricted-local executors. |
| `refusal-regression.json` | Safe refusal regression | Compare whether model versions refuse a harmless synthetic forbidden operation. |
| `tool-approval.json` | Approval-gated fixture tool | Record a deterministic agent request that must remain blocked without approval. |
| `unsafe-egress-blocked.json` | External egress request that must remain blocked | Represent a potentially unsafe live side effect while requiring denial in every safe fixture run. |
| `unsupported-capability.json` | Unsupported capability declaration | Show that portable intent can remain inspectable while execution fails closed on an unavailable capability. |
Titles and purposes are copied from the files.
## Format specifications
The format specifications are in
[docs/specifications/](https://github.com/TRUSCOR/SOVA-OSS/tree/v0.1.1/docs/specifications) at tag
`v0.1.1`. The ones a reader or writer needs most:
- [`.sova` behavior capsule](https://github.com/TRUSCOR/SOVA-OSS/blob/v0.1.1/docs/specifications/sova-capsule-0.1.md)
- [`.sova-trace` event stream](https://github.com/TRUSCOR/SOVA-OSS/blob/v0.1.1/docs/specifications/sova-trace-0.1.md)
- [Migration and compatibility](https://github.com/TRUSCOR/SOVA-OSS/blob/v0.1.1/docs/specifications/migration-and-compatibility.md)
- [Interoperability and fidelity](https://github.com/TRUSCOR/SOVA-OSS/blob/v0.1.1/docs/specifications/interoperability.md)
- [Format threat model](https://github.com/TRUSCOR/SOVA-OSS/blob/v0.1.1/docs/specifications/threat-model.md)
- [Neutral conformance kit](https://github.com/TRUSCOR/SOVA-OSS/blob/v0.1.1/docs/specifications/conformance-kit-0.1.md)
## Version and status
All schemas in the kit are experimental version 0.1.0 formats. The
[specifications index](https://github.com/TRUSCOR/SOVA-OSS/blob/v0.1.1/docs/specifications/README.md)
says they freeze safety, identity, type-separation, canonicalization and migration invariants
without claiming that the field set is ready for 1.0. The capsule specification adds that the
Python implementation and the published canonical vectors are not yet an independent cross-language
implementation.
## Source
- Repository: [TRUSCOR/SOVA-OSS](https://github.com/TRUSCOR/SOVA-OSS), tag `v0.1.1`, commit
`023daedfc6c03ee4a9cb23b3f1dfd2ff3c2aaf44`.
- Kit: exported with `sova-oss` 0.1.1 installed from PyPI. Its schema files are the same as
`src/sova/schemas/` at that commit.
- Examples: `examples/scenarios/` at that commit.
## Licence
Apache-2.0, the licence of SOVA OSS. See `LICENSE` and `NOTICE`, both copied from the repository.
The NOTICE also covers the SOVA names and marks.
## Links
- GitHub: https://github.com/TRUSCOR/SOVA-OSS
- Format specifications: https://github.com/TRUSCOR/SOVA-OSS/tree/v0.1.1/docs/specifications
- PyPI: https://pypi.org/project/sova-oss/
- Research papers, data and protocols: https://github.com/TRUSCOR/research