Documentation
The product’s own docs, published from its repository at v0.1.0-rc.6, the release you can install, so each page describes what that release does.
Start here
- Getting started
Install a verified release, run a first scan, sign and verify the report, or build from source
- The airlock, step by step
Take a model through the airlock on an intake host, with every command, and the console
- Running Socair as your model intake host
The intake host for an on-prem GPU cluster: its shape, the one-time setup, bringing a model in, reading the clean store, and the record
- Verifying a Socair release
Checksums, build provenance, the SBOM, offline verification, and a rebuild from source
Run the airlock
- The airlock
Pull, ingest, promote, the trust policy, the log, the signed inventory export
- Running Socair on Kubernetes
The Helm chart: the airlock and the wizard in a cluster, who can reach them, and handing promoted models to LLMKube
- The click-ops wizard
The local web app over the engine: the scan wizard and the airlock console
- The engine API
The local HTTP API the wizard and the console call
- The hub endpoint
Serving the models the store admits, read-only, over the Hugging Face Hub API, so an inference server downloads from the clean store
- Converting a checkpoint, and the derivation record
Rebuilding a pickle checkpoint as safetensors without unpickling it, and the signed derivation record
Gate where models are served
- Attestations on OCI model artifacts
Attach and verify, the binding to the manifest digest, which layouts are matched, cosign and Kyverno
- Admission: refusing a model pod without an authorized binding
The Kyverno policies: which pod fields they read, what they check and what they do not, KServe, image volumes, and the policy-controller gap
What the checks read
- Provenance and trust inputs bundle spec
The inputs that move each row: mirrors, denylists, provenance, signatures, a license policy, acceptances
- Intake policy
Your organization's rules, which can only withhold: allowed formats, publisher allow and deny lists, required publisher signatures
- Signed reference feeds
Your organization's own known-bad hashes, reviewed chat templates, and canonical tokenizers, signed for air-gapped import: the format, verification, and building one
- Tensor fingerprints and the Tensor reference row
Fingerprint every tensor, and compare a model's weights with the reviewed model's, tensor by tensor
- ONNX models
What Socair reads in an ONNX model: tensors, external data, operator domains, and metadata
- OpenVINO IR models
What Socair reads in an OpenVINO IR model: the graph, the ranges it reads in its .bin, and rt_info text
- Keras models
What Socair reads in a Keras model: the HDF5 layout, a .keras archive's members, and code in the config
- Tier 2: measurements made by running the model
Opt-in, and no real Tier 2 check ships yet: the node-class record, the probe-helper protocol, isolation, and the roadmap
Hand the report to other tools
- Control mapping
Which rows and features are evidence for which framework controls (MITRE ATLAS, OWASP LLM, NIST, AI supply-chain guidance), full or partial, and why
- CycloneDX ML-BOM
What each field holds and when it is left out, the G7 SBOM for AI minimum elements, and signing a BOM
- SARIF
The log for code-scanning tools: what each result holds, how a finding's fingerprint is computed, and uploading to GitHub code scanning
What a report says, and how it was measured
- Model Assurance Attestation
The attestation, section by section: the source of truth for what a report contains
- Check-set versions
The version every report records: what a version covers, when it changes, and the rule changes in each one
- Threat model
What Socair protects, whom it trusts for what, and what it does not defend against
- Detection benchmark
Detection on reproductions of published attacks, misses pinned, beside picklescan, ModelScan, ModelAudit, and Fickling
- False-positive baseline
How each detector was measured against real models
Copied from the repository at v0.1.0-rc.6 (commit e3d1bf2a6cb2) by scripts/sync-docs.mjs, byte for byte, and rendered here. Links between docs stay on this site; any other link into the repository goes to the same tag.