Files
Linus GasserandClaude Opus 5.5 16f0890fab Add README: how abra audit uses the advisories and the advisory format
Points to the C4DT fork of abra (c4dt branch / release tags) for
abra audit, and to --include-drafts for testing draft advisories.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 17:51:04 +01:00

3.3 KiB

Co-op Cloud advisories

Security advisories for apps deployed with abra. They are read by abra audit, which is not in upstream abra yet: it lives in the C4DT fork, c4dt/abra (see README_C4DT.md there; design: doc/DesignAudit.md). Releases are tags on the c4dt branch, e.g. 0.13.0-beta-c4dt.1.

git clone -b c4dt https://git.coopcloud.tech/c4dt/abra.git   # or -b <release tag>
cd abra && make build           # or: go build ./cmd/abra
ABRA_DIR=~/.abra ./abra audit   # ABRA_DIR (or abraDir in abra.yaml) must be set explicitly

On every run abra audit pulls this repository into $ABRA_DIR/advisories (the local copy is used if the remote cannot be reached, or with --offline), checks every deployed app on every server against the published advisories, and suggests a fix. The exit code is 1 if any app is affected.

Adding an advisory

  1. Add advisories/CCA-<year>-<nnnn>.yml, numbered after the last one.
  2. Start with status: draft, test it with abra audit --include-drafts, then set status: published. Without the flag only published advisories are checked.
  3. Commit and push.

To test without pushing, point abra at a directory that is not a git checkout: abra uses $ABRA_DIR/advisories as is if it is not a git repo.

Fields

See CCA-2026-0001 for a full example.

Field Meaning
id Required. Same as the file name, e.g. CCA-2026-0001.
title One line summary.
severity low, medium, high or critical.
status draft (default), published or withdrawn.
published Date, YYYY-MM-DD.
refs List of URLs, CVE or GHSA ids.
recipes Map of recipe name to affected (range) and/or fixed (first fixed recipe version; fixed: X alone means affected: <X).
images List of image rules, see below.
fix.strategy upgrade (recipe upgrade), refresh (redeploy pulls a rebuilt image; abra checks the registry first) or manual.
fix.notes Free text shown to operators, and as the fix for manual.

At least one of recipes or images is required.

Image rules (images[]):

Field Meaning
match Required. Glob (*, ?) on the image name, e.g. nextcloud, or on name:tag if it contains a :.
env Map of image env variable to affected range, e.g. PHP_VERSION. Images without the variable are not concerned.
version Affected range on the image's org.opencontainers.image.version.
created_after Images built at or after this time (YYYY-MM-DD or RFC 3339) are fixed.
fixed_digests List of sha256:… digests known to be fixed.
affected_digests List of sha256:… digests known to be affected.

An image matching a rule is fixed if any condition says fixed, affected if one says affected, and otherwise reported as unknown, never as OK.

Ranges are space- or comma-separated constraints that must all hold, with || between alternatives: ">=8.4.0 <8.4.28 || >=8.5.0 <8.5.13". Recipe versions compare as RECIPE+UPSTREAM; a range without + only constrains the recipe part.

Unknown fields are skipped with a warning, so new fields do not break older abra versions.