@@ -370,6 +370,9 @@ at_rest:
370370 per_repo_adoption:
371371 - repo: "lcb-website"
372372 status: "DEPLOYED"
373+ # TEMPLATE NOTE: replace {{THIS_REPO}} with the repo name (e.g. "boj-server") and
374+ # {{REPO_SOPS_ADOPTION_STATUS}} with one of: "DEPLOYED", "PENDING — runtime-only via Rokur,
375+ # no at-rest secrets in this repo", or a concise description of the actual status.
373376 - repo: "{{THIS_REPO}}"
374377 status: "{{REPO_SOPS_ADOPTION_STATUS}}"
375378 pre_commit_hooks:
@@ -391,6 +394,9 @@ llm_agents:
391394 tool: "RGTV"
392395 status: "ALPHA — NOT production-ready, see RGTV/README.adoc known-unsafe list"
393396 scope: "LLM-agent credential brokering only — opaque one-use grants"
397+ # TEMPLATE NOTE: replace {{RGTV_ENABLED_FOR_REPO}} with "true" if this repo brokers
398+ # LLM-agent credentials via RGTV, or "false — <reason>" if not. Most repos will be false.
399+ # RGTV is ALPHA; see RGTV/README.adoc for the known-unsafe list.
394400 enabled_here: "{{RGTV_ENABLED_FOR_REPO}}"
395401security:
396402 proof: "Secrets.Hygiene.idr"
@@ -503,6 +509,8 @@ theorems:
503509compiler:
504510 idris2_version: "0.8.0"
505511 zig_version: "0.15.2"
512+ # TEMPLATE NOTE: replace {{LAST_PROOF_CHECK_DATE}} with the ISO-8601 date of the last
513+ # Idris2 proof rebuild in this repo (e.g. "2026-04-17"). Updated at each proof-rebuild session.
506514 last_check: "{{LAST_PROOF_CHECK_DATE}}"
507515axioms:
508516 declared: []
@@ -558,6 +566,8 @@ policy: |
558566 Responsible disclosure welcomed. Researchers reporting real vulnerabilities
559567 in good faith receive acknowledgement in SECURITY.adoc and in
560568 /.well-known/security-acknowledgments. See security.txt for contact path.
569+ # TEMPLATE NOTE: replace {{SECURITY_CONTACT}} with a mailto: URI for this repo's
570+ # security contact, e.g. "mailto:j.d.a.jewell@open.ac.uk".
561571contact: "{{SECURITY_CONTACT}}"
562572recognition:
563573 mechanism: "security-acknowledgments list"
@@ -768,7 +778,12 @@ security_txt:
768778 enabled: true
769779 contact: "mailto:j.d.a.jewell@open.ac.uk"
770780 preferred_languages: "en"
781+ # TEMPLATE NOTE: replace {{SECURITY_TXT_EXPIRES}} with an RFC 3339 datetime 1 year from deployment,
782+ # e.g. "2027-04-17T00:00:00Z". Auto-renewed by CI.
771783 expires: "{{SECURITY_TXT_EXPIRES}}"
784+ # TEMPLATE NOTE: replace {{DOMAIN}} with the canonical domain for this repo (bare domain or
785+ # GitHub Pages URL), e.g. "boj-server.hyperpolymath.dev" or "github.com/hyperpolymath/<repo>".
786+ # Used in all /.well-known/ paths below.
772787 policy: "https://{{DOMAIN}}/.well-known/security-policy"
773788 acknowledgments: "https://{{DOMAIN}}/.well-known/security-acknowledgments"
774789 encryption: "https://{{DOMAIN}}/.well-known/pgp-key.txt"
@@ -805,6 +820,9 @@ rate_limiting:
805820 - "shadow-ban for persistent offenders"
806821 cost_ceiling:
807822 policy: "operator-managed emergency brake above tier 1"
823+ # TEMPLATE NOTE: replace {{COST_CEILING_POLICY}} with a concise operator policy string,
824+ # e.g. "operator-managed; emergency brake above edge-tier rate limits; specific cap TBD".
825+ # This is an operator-choice field — no universal default.
808826 note: "{{COST_CEILING_POLICY}}"
809827 security:
810828 proof: "RateLimiting.Policy.idr"
@@ -1060,6 +1078,10 @@ idris2:
10601078 mechanism: ".ipkg with dep version pinning"
10611079 adoption_status: "PENDING — estate-wide pinning in CRG contractile"
10621080proven_library:
1081+ # TEMPLATE NOTE: replace {{PROVEN_HASH}} with the SHA-256 hex digest of
1082+ # verification-ecosystem/proven/ffi/zig/zig-out/lib/libproven_ffi.a obtained via
1083+ # `sha256sum .../libproven_ffi.a`. Set to "PENDING" with a note if the lib has not
1084+ # yet been built for this repo.
10631085 hash_attestation: "{{PROVEN_HASH}}"
10641086 source: "verification-ecosystem/proven"
10651087 verification: "libproven_ffi.a rebuilt on source change; downstream relink verified"
0 commit comments