Eksportskema
Denne side er skemaet for den fulde dataeksport: hvad bundtet indeholder, og hvilken form hver post har. Hvordan du starter en eksport, verificerer den, og hvilke grænser der gælder, står på siden om dataeksport. Databehandleraftalen §9 henviser hertil.
Bundtets struktur
export-<your-org-slug>-<YYYY-MM-DDTHH-MM-SS-mmmZ>.tar.gz
├── VERIFY.md — step-by-step verification recipe
├── manifest.json — every file below, SHA-256 and size
├── manifest.json.intoto.jsonl — DSSE-signed in-toto Statement over manifest.json
├── audit.ndjson — your org's audit events, last 90 days
├── access-log.ndjson — your registry access log (package and container downloads, uploads and deletes; CI cache hits are in pulled-versions.ndjson)
├── bundles/
│ ├── <repo>.bundle — git bundle: full history, every ref
│ └── <repo>.empty — instead of a bundle, for a repository with no commits (zero bytes)
├── findings/ — scan findings, see "Scan findings, policy, attestations and SBOMs" below
├── policy/ — package policy, verdicts, exceptions and scanner settings
├── attestations/ — build provenance and release attestations, with their signatures
├── sboms/ — repository and container-image SBOMs, with an index
└── metadata/
├── packages.ndjson — package inventory, see "Packages" below
├── packages-files.ndjson — every file of every package version
├── packages-container-tags.ndjson — container image tag → manifest digest
├── components.ndjson — third-party component inventory, see "Component inventory" below
├── deployments.ndjson — deployments your CI/CD reported, see "Deployments" below
├── pulled-versions.ndjson — package versions pulled per day and consumer, see "Pulled versions" below
└── <repo>/
├── repo.ndjson — repository settings, description, topics
├── issues.ndjson — every issue, open and closed
├── pulls.ndjson — every pull request, open and closed
├── comments.ndjson — issue and pull-request comments
├── labels.ndjson
├── milestones.ndjson — open and closed
├── releases.ndjson — release metadata; see "Release assets" below
└── lfs-manifest.ndjson — LFS object inventory, see "LFS content" belowRepository-navne med tegn uden for a-z 0-9 . _ - vises med de tegn erstattet af _.
Anvendte standarder:
- Repositories: Gits eget
git bundle-format.git clone <bundle>genskaber repository’et fuldt ud, inklusive historik, branches og tags. Et repository uden commits har intet at bundte og optræder i stedet som en tom fil,<repo>.empty. - Issues, pull requests og de øvrige filer i
metadata/: NDJSON, ét JSON-objekt pr. linje, i samme form som Forgejo API’et returnerer for hvert objekt. - Revisionslog: NDJSON, én hændelse pr. linje (
id,action,actor,fields_json,created_at). Samme form som fremforges interne revisionsstrøm. - Adgangslog for registry’et: NDJSON, ældste først, én hændelse pr. linje i den form,
GET /orgs/{slug}/access-logreturnerer, med klient-IP’er og logins, som de blev registreret. Den dækker alt, der stadig opbevares inden for din opbevaringsperiode for revisionsloggen. Se Registrets adgangslog. - Integritet:
manifest.jsonlister hver fil med dens SHA-256-hash og størrelse. Manifestet er DSSE-signeret med fremforges Ed25519-builder-nøgle; signaturen ligger imanifest.json.intoto.jsonlog verificeres mod den offentlige trust root påhttps://www.frem.sh/.well-known/slsa-trust-root.jsonmedopenssl,jq,python3ogcurl— intet fremforge-værktøj kræves. Den fulde opskrift står iVERIFY.mdi bundtet og i §“Verificér det signerede manifest” på siden om dataeksport. Det er den samme trust root, som er offentliggjort for SLSA build-attestationer: én nøgle, to predicate-typer, ingen afhængighed af Sigstore.
Ingen proprietære formater. Hvert artifact i bundtet kan læses med almindelige open source-værktøjer. Intet fremforge-CLI kræves.
Pakker
metadata/packages.ndjson er oversigten over din organisations pakke-registry: én linje pr. pakkeversion med dens type (container, npm, maven, pypi, generic, …), name og version, som Forgejos pakke-API lister dem.
metadata/packages-files.ndjson lister hver fil i hver af de versioner, én linje pr. fil:
| Felt | Betydning |
|---|---|
owner, type, name, version | den pakkeversion, filen hører til |
file_id, file_name | filens id og navn i registry’et |
size | størrelse i bytes |
sha256 | filens SHA-256; også sha512, hvor registry’et registrerer en |
download_path | sti på frem.sh, der henter præcis denne fil med et API-token (Authorization: token …); registry’et kan svare med en redirect til object storage. null for registry-typer, hvor filens URL ikke kan udledes af oversigten alene (for eksempel Maven); brug web_path til dem |
web_path | filens downloadlink på dens pakkeside, til en browser, hvor du er logget ind |
For container-images er en pakkeversion et tag (eller, for et manifest uden tag, som én platform af et multi-arch-image, selve digesten). metadata/packages-container-tags.ndjson knytter hvert tag til dets manifest-digest (owner, name, tag, manifest_digest), som er det, docker pull <image>@sha256:… og andre OCI-værktøjer bruger. Imagets lag og config står i packages-files.ndjson som filer navngivet efter deres digest, med download_path, der peger på registry’ets endpoints /v2/…/blobs/… og /v2/…/manifests/….
Tjek en downloadet fil mod oversigten:
row=$(jq -c 'select(.name=="@acme/lib" and .version=="1.2.0")' metadata/packages-files.ndjson)
curl -sSL -H "Authorization: token $TOKEN" -o pkg.bin "https://frem.sh$(jq -r .download_path <<<"$row")"
echo "$(jq -r .sha256 <<<"$row") pkg.bin" | sha256sum -c -Oversigten er altid med i bundtet. Selve pakkefilerne kommer kun på anmodning, som et separat arkiv: se §“Pakkeindhold”.
Komponentoversigt
metadata/components.ndjson er din organisations oversigt over tredjepartskomponenter: én linje pr. komponent og pr. sted, hvor den bruges eller har været brugt — de samme rækker, som GET /orgs/{slug}/components/usages svarer med. Anvendelser, der er ophørt, bevares i 180 dage og er med, så historikken følger med dig.
| Felt | Betydning |
|---|---|
purl, ecosystem, name, version | komponenten, som en package URL og dens dele |
licence, licence_source | licensudtrykket, og hvor det blev læst fra |
subject_kind, subject_name, subject_ref | hvor den bruges: repository’et, pakken eller imaget og ref’en eller digesten |
image_tags | for et image de tags, der peger på det; ellers tom |
source_repo | det repository, der byggede den, hvor det er kendt |
is_direct | true for en direkte afhængighed, false for en transitiv, null, hvor SBOM’en ikke siger noget |
environment, environment_source | miljøklassen (sandbox, development, test eller production), og hvordan den blev sat |
is_current, first_seen_at, last_seen_at, removed_at | om anvendelsen er aktuel, og hvornår den først og sidst blev set og blev fjernet |
Udrulninger
metadata/deployments.ndjson indeholder alle udrulninger, din CI/CD har rapporteret med POST /orgs/{slug}/repos/{repo}/deployments, én linje pr. udrulning, ældste først efter id.
| Felt | Betydning |
|---|---|
id | udrulningens id |
repository, environment, environment_class | repository’et (owner/name), det miljønavn, du angav, og dets klasse (sandbox, development, test, staging eller production) |
ref, sha, task, description | den ref og det commit, der blev udrullet, opgaven (deploy, medmindre du angav en anden) og din beskrivelse |
image_digests, packages | de image-digests og pakke-URL’er, udrulningen nævner |
state | den seneste status: pending, queued, in_progress, success, failure, error eller inactive |
creator_kind, creator, run_id | hvem der rapporterede den (job, robot, user eller token), navnet, og Actions-kørslen for et job |
created_at, updated_at | hvornår den blev rapporteret og sidst ændret |
statuses | alle statusser, nyeste først: state, description, log_url, environment_url, creator_kind, creator, created_at |
Hentede versioner
metadata/pulled-versions.ndjson er hentningsoptællingen: én linje pr. UTC-dag, pakkeversion og forbruger, for de dage, der stadig opbevares inden for din opbevaringsperiode for adgangsloggen. Siden 2026-10-13 er den den eneste registrering af de downloads, et CI-job har foretaget gennem afhængighedsproxyen, og som proxyen leverede fra sin cache; de er ikke med i access-log.ndjson. Det er de rækker, GET /orgs/{slug}/components/pulled lægger sammen; de sårbarheder, det endpoint kobler på, er ikke med i filen.
| Felt | Betydning |
|---|---|
day | UTC-dagen, YYYY-MM-DD |
origin | registry for dine egne pakker, proxy for afhængighedsproxyen |
ecosystem, name, version | pakketypen (npm, pypi, maven, nuget, go, container, …), navn og version |
consumer | hvem der hentede den: kind (job, robot, bot, user eller anonymous), name (jobbets repository, robottens navn eller login; null for anonym), id, for en robot dens login og for et job run_ids, de Actions-kørsler, der hentede den den dag (nyeste først, højst 100; tom før 2026-10-13) |
pulls | vellykkede downloads den dag |
first_seen_at, last_seen_at | den første og den sidste af dem, i UTC med mikrosekunder |
Scanningsfund, politik, attestationer og SBOM’er
Hver eksport indeholder de sikkerhedsdata, fremforge har om din organisation, som NDJSON (ét JSON-objekt pr. linje), dækket af det signerede manifest som alle andre filer. Hver linje er den fulde post, fremforge gemmer, bortset fra det interne tenant-id og lagerstier; afviste fund er med, sammen med hvem der afviste dem, hvorfor og indtil hvornår. Rækker, der vedrører en registry-pakke, har et package-objekt (type, owner, name, version, file, blob_sha256).
findings/
├── sast.ndjson — static analysis (rule, file, line, severity)
├── dependencies.ndjson — dependency vulnerabilities, with CVSS and EPSS where known
├── dependency-dismissals.ndjson — repository-wide dependency dismissals
├── licences.ndjson — licence findings, each with its licence policy decision
├── container-images.ndjson — container image vulnerabilities
├── container-image-dismissals.ndjson
├── secrets.ndjson — rule, file, line and fingerprint; the secret value is never stored
├── secrets-public-leaks.ndjson — frem.sh credentials found in public code: public URL, repository, commit,
path, line, when found, token kind and reference, and what was done;
never the token or a hash of it
├── malware-uploads.ndjson — malware found in uploads
├── malware-dependencies.ndjson — known-malicious dependencies
├── malware-container-layers.ndjson — per image manifest, each layer's malware verdict
├── packages.ndjson — vulnerabilities found in your registry packages
├── package-licences.ndjson — declared and detected licences of your registry packages
└── sha-pinning.ndjson — workflow actions not pinned to a commit
policy/
├── package-policy.ndjson — your package policy (mode, thresholds, licence lists, minimum age)
├── package-policy-rules.ndjson — allow and deny rules
├── package-policy-approvers.ndjson
├── package-policy-verdicts.ndjson — the current verdict for each package file, with reasons
├── package-gate-decisions.ndjson — downloads blocked, or that would have been blocked in shadow mode
├── exceptions.ndjson — policy exceptions, who requested and who approved them
├── malware-overrides.ndjson
├── package-access-packages.ndjson — per-package access: each configured package (mode, inheritance)
├── package-access-grants.ndjson — per-package access grants (teams, Actions repositories)
├── package-protection-rules.ndjson — protected package names
├── scan-overrides.ndjson — per-repository scanner mode overrides
└── settings/ — each scanner's org settings (sast, dependencies, licences, container-images, secrets),
and licence-repo-overrides.ndjson: per-repository licence policy overrides
and package-access.ndjson: the per-package access default
and retention.ndjson: one line per evidence retention class, with what you set,
what applies, the default, the bounds and whether a legal hold is active
and public-leak.ndjson: public leak monitoring, notify and revoke or notify only
attestations/
├── build-provenance.ndjson — one line per build provenance attestation
├── build-provenance/<id>.intoto.jsonl — its DSSE envelope (the Ed25519 signature)
├── build-provenance/<id>.sigstore.json — its keyless Sigstore bundle, where one was made
├── releases.ndjson — release attestations: subjects, the frozen release manifest, status, and envelope_path
├── sbom-ingest.ndjson — attestations uploaded together with an SBOM
└── sbom-ingest/<sbom id>.intoto.jsonl
sboms/
├── index.ndjson — one line per SBOM, see below
├── repos/<id>.cdx.json — a repository SBOM, CycloneDX (<id>.spdx.json for SPDX)
└── images/<id>.cdx.json — a container image SBOM- Signaturerne følger med attestationerne. Hver envelope verificeres mod den samme trust root som bundtet, med scriptet i §“Verificér det signerede manifest” rettet mod envelopen i stedet for
manifest.json.intoto.jsonl(spring tjekkene afmanifestSha256ogpredicateTypeover; de gælder kun eksportbundter). Sigstore-bundlerne er signeret mod fremforges egen Fulcio og tidsstempelautoritet, ikke den offentlige Sigstore; se SLSA provenance. - En manglende signatur vises, den skjules ikke. En linje med
"envelope_status": "missing"er en attestation, hvis signaturobjekt ikke længere lå i lageret, da eksporten kørte. Enhver anden lagerfejl får eksporten til at fejle. - Container-lag. Et lags malware-afgørelse hører til dets indhold, så et lag, der deles med et andet image, listes med sin afgørelse under hvert af dine manifester, der bruger det. Images, der hentes gennem afhængighedsproxyen, listes kun, mens din organisation har ClamAV-scanning af proxyens hentninger slået til; når den er slået fra (standard), ClamAV-scannes de ikke og har ingen lag-afgørelser.
- Release-attestationer findes for repositories med uforanderlige releases. En release, hvis
statusikke ersigned, har ingen envelope (envelope_pathernull). - SBOM’er.
sboms/indeholder hver SBOM, fremforge gemmer for dine repositories (builds af releases og af default-branchen, uanset om de er uploadet eller lavet af den centrale scanning) og for dine container-images (registry’ets oversigt pr. manifest), som selve dokumentet. Et repository-build har som regel både et CycloneDX- og et SPDX-dokument; se SBOM’er. Hver linje isboms/index.ndjsoner den gemte SBOM-post (id,subject_kindrepoellerimage,format,repo_full_nameellerartifact_name,release_tag,image_tags,manifest_digest,created_at,sha256_digestog resten af den gemte post, uden lagerstier) plus tre felter om filen i dette bundt:document_path,document_sha256ogdocument_status, som erok, når dokumentet matcher den SHA-256, der blev registreret, da det blev gemt,digest_mismatch, når det ikke gør (bytes eksporteres alligevel, og begge digests står på linjen), ogmissing, når dokumentet ikke længere lå i lageret. Enhver anden lagerfejl får eksporten til at fejle. - Pakke-SBOM’er ligger ikke i
sboms/. SBOM’en for hver pakkefil i registry’et følger med filen i arkivet med pakkeindhold, som du selv vælger til.