Skip to content

docs: fix package name, enforcement mode, add pos/neg test columns #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
imran-siddique merged 1 commit into from
Jun 21, 2026
Merged

docs: fix package name, enforcement mode, add pos/neg test columns #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/error-codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,14 @@ All TRACE test failures emit a structured error code of the form `TR-<MODULE>-<N
|------|-------------|
| TR-RTE-001 | `runtime.platform` is not a recognised TEE enum value |
| TR-RTE-002 | `runtime.measurement` is not a valid `sha256:` digest |
| TR-RTE-003 | RIM URI present but does not resolve to a valid reference image |

## TR-POL — Policy

| Code | Description |
|------|-------------|
| TR-POL-001 | `policy.bundle_hash` is not a valid `sha256:` digest |
| TR-POL-002 | `policy.enforcement_mode` is not `enforce` or `monitor` |
| TR-POL-002 | `policy.enforcement_mode` is not `enforce`, `advisory`, or `silent` |

## TR-TXN — Transcript

Expand Down
8 changes: 4 additions & 4 deletions docs/modules/tr-anc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Tests transparency anchoring via SCITT.

## Required at Level 2+

| Test ID | Description |
|---------|-------------|
| TR-ANC-001 | `transparency` is a non-empty URI |
| TR-ANC-002 | URI scheme is `https://` |
| Test ID | Description | Positive Case | Negative Case |
|---------|-------------|---------------|---------------|
| TR-ANC-001 | `transparency` is a non-empty URI | `https://transparency.example/entries/abc123` | missing field, empty string |
| TR-ANC-002 | URI scheme is `https://` | `https://` prefix | `http://`, bare path, `ipfs://` |
8 changes: 4 additions & 4 deletions docs/modules/tr-pol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Tests Cedar policy bundle binding.

## Required at Level 0+

| Test ID | Description |
|---------|-------------|
| TR-POL-001 | `policy.bundle_hash` is a valid `sha256:` digest |
| TR-POL-002 | `policy.enforcement_mode` is `enforce` or `monitor` |
| Test ID | Description | Positive Case | Negative Case |
|---------|-------------|---------------|---------------|
| TR-POL-001 | `policy.bundle_hash` is a valid `sha256:` digest | `sha256:` followed by 64 hex chars | missing, wrong prefix, wrong length |
| TR-POL-002 | `policy.enforcement_mode` is `enforce`, `advisory`, or `silent` | `enforce` | `strict`, `monitor`, absent |
10 changes: 5 additions & 5 deletions docs/modules/tr-rte.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Tests TEE platform attestation in the `runtime` field.

## Required at Level 1+

| Test ID | Description |
|---------|-------------|
| TR-RTE-001 | `runtime.platform` is a known TEE enum value |
| TR-RTE-002 | `runtime.measurement` is a valid `sha256:` digest |
| TR-RTE-003 | RIM URI (if present) resolves to a valid reference image |
| Test ID | Description | Positive Case | Negative Case |
|---------|-------------|---------------|---------------|
| TR-RTE-001 | `runtime.platform` is a known TEE enum value | `tpm2`, `sev-snp`, `tdx`, `opaque` | `"software"`, `"cloud"`, absent |
| TR-RTE-002 | `runtime.measurement` is a valid `sha256:` digest | `sha256:` followed by 64 hex chars | missing, wrong prefix, all zeros |
| TR-RTE-003 | RIM URI (if present) resolves to a valid reference image | valid `https://` URI returning a reference manifest | non-HTTPS URI, 404 response |
8 changes: 4 additions & 4 deletions docs/modules/tr-sca.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Tests SLSA build provenance.

## Required at Level 1+

| Test ID | Description |
|---------|-------------|
| TR-SCA-001 | `build_provenance.slsa_level` is 0–4 |
| TR-SCA-002 | `build_provenance.digest` is a valid `sha256:` digest |
| Test ID | Description | Positive Case | Negative Case |
|---------|-------------|---------------|---------------|
| TR-SCA-001 | `build_provenance.slsa_level` is 0–4 | `0`, `1`, `2`, `3`, `4` | `5`, `-1`, `"high"`, absent |
| TR-SCA-002 | `build_provenance.digest` is a valid `sha256:` digest | `sha256:` followed by 64 hex chars | missing, wrong prefix, wrong length |
12 changes: 6 additions & 6 deletions docs/modules/tr-sig.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Tests Ed25519 signature binding on the TRACE Trust Record.

## Required at Level 0+

| Test ID | Description |
|---------|-------------|
| TR-SIG-001 | Signature algorithm is Ed25519 (OKP crv=Ed25519) |
| TR-SIG-002 | `cnf.jwk` present and carries the public key |
| TR-SIG-003 | Signature verifies over the canonical record bytes (RFC 8785 JCS) |
| TR-SIG-004 | `cnf.jwk` does not contain private key material (`d` member absent) |
| Test ID | Description | Positive Case | Negative Case |
|---------|-------------|---------------|---------------|
| TR-SIG-001 | Signature algorithm is Ed25519 (OKP crv=Ed25519) | `{"kty":"OKP","crv":"Ed25519"}` | ES256, RS256, missing `alg` |
| TR-SIG-002 | `cnf.jwk` present and carries the public key | JWK with `x` member set | missing `cnf`, missing `jwk`, missing `x` |
| TR-SIG-003 | Signature verifies over the canonical record bytes (RFC 8785 JCS) | valid Ed25519 signature | bit-flipped signature, wrong key |
| TR-SIG-004 | `cnf.jwk` does not contain private key material (`d` member absent) | JWK with only `x` | JWK with `d` present |
8 changes: 4 additions & 4 deletions docs/modules/tr-txn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Tests tool-call transcript binding.

## Required at Level 2+

| Test ID | Description |
|---------|-------------|
| TR-TXN-001 | `tool_transcript.hash` is a valid `sha256:` digest |
| TR-TXN-002 | `tool_transcript.call_count` is a non-negative integer |
| Test ID | Description | Positive Case | Negative Case |
|---------|-------------|---------------|---------------|
| TR-TXN-001 | `tool_transcript.hash` is a valid `sha256:` digest | `sha256:` followed by 64 hex chars | missing, wrong prefix, wrong length |
| TR-TXN-002 | `tool_transcript.call_count` is a non-negative integer | `0`, `1`, `42` | `-1`, `"three"`, absent |
11 changes: 10 additions & 1 deletion docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Install

```bash
pip install agentrust-trace-tests
pip install trace-tests
```

## Run against a Trust Record
Expand Down Expand Up @@ -41,3 +41,12 @@ TR-RTE-001 FAIL Runtime: TEE measurement missing (required at level 1)
```

Error codes follow the form `TR-<MODULE>-<NNN>`.

## Next steps

| What | Where |
|------|-------|
| Understand what each test checks | [Test Modules](../modules.md) |
| Look up a specific error code | [Error Codes](../error-codes.md) |
| Write your own conformance tests | [Tutorial: Writing conformance tests](tutorials/writing-conformance-tests.md) |
| Set up CI | [Tutorial: CI integration](tutorials/ci-integration.md) |
Loading