Skip to content

v0.2.4

Choose a tag to compare

@github-actions github-actions released this 28 Oct 18:46
· 33 commits to main since this release
v0.2.4
f49f7bd

Release v0.2.4

Durable-record/v1 records body lifecycle; release tag tooling closes four silent defaults.

This release adds journal entries that record the publication and removal of
bytes held by body references, so a removal leaves portable evidence that can
be told apart from loss. It also moves the checks that the v0.2.3 release made
by hand into the release scripts. The change to durable-record/v1 adds fields
and entry types; existing v1 records, digests and pins are unchanged. The v0
family and every other contract family are unchanged.

Highlights

Durable-record/v1 body lifecycle

  • Designated stream. A store whose profile declares
    deletion.external_bodies: supported names runtime.body_removal_stream,
    an ordinary v1 stream. The profile names one exactly when external bodies
    are supported. That stream carries only stream_opened and the three
    lifecycle entry types; a lifecycle entry anywhere else is refused.
  • Three entries. Each names a body by {digest, length} and an
    incarnation, a positive integer that strictly increases per body, with
    gaps permitted. body_published commits a publication. body_removal_started
    is written before any byte is removed and carries the decision: reason
    (retention, operator or rights_restricted), provenance and an optional
    authorization. body_removed is written after the bytes are observed absent;
    its at is completion time.
  • Transitions. A removal starts only from a live latest publication and
    completes only on that incarnation's open start. A later publication
    abandons an open removal. A completion or retry for an older incarnation is
    refused. A start alone is not evidence of removal.
  • Fencing and eligibility. Publication, removal and republication of a
    body are fenced by incarnation through their physical effects. Lifecycle
    entries grant no removal eligibility: removal must honor every applicable
    hold in every stream sharing the bytes, and physical removal stays
    fail-closed until a removal policy is specified.
  • Reader states. At a consistent cut, with an observation of the bytes that
    agrees with it, a body is available, integrity_loss, removal_pending,
    removed, publishing or unpublished. A failed or unknown observation is
    none of these.

New refusals are body_removal_stream, body_lifecycle and
body_observation; a new body-state-request schema describes the logical
state step. The v1 logical controls grow from 124 vectors, 25 schema rejects
and 53 mutation witnesses to 172, 36 and 75. Every v0.2.3 vector gives the same
outcome under this release. These are logical fixture controls: they qualify
no store, fencing, unlink ordering or concurrency.

Release tag tooling

  • Signing keyring. make release-tag refuses a signing keyring that is the
    default keyring by either gpgconf's homedir or the account home from the
    user database, and stops if either cannot be resolved.
  • Signer. Signing uses OpenPGP through gpg. The signing command pins
    gpg.format, gpg.program and gpg.openpgp.program on its command line,
    which overrides Git signing configuration from files and Git configuration
    environment variables. It uses gpg from the trusted PATH and exports
    GNUPGHOME from the validated dedicated-keyring input. A configured value
    the pin overrides, such as a global gpg.program naming a wrapper, is
    reported and does not stop the release; the step stops only if the pin
    would not take effect.
  • Push transport. make release-push-tag fetches, checks, pushes and
    confirms over https://github.com/3leaps/crucible.git, not origin. The org
    token direnv loads is the only credential, passed through gh's credential
    helper. git runs with an empty home, no global or system configuration, and
    no proxy, GIT_SSL_* or curl-trace environment. URL rewrites, extra headers,
    cookie files, proxy, TLS and credential-username settings are refused, and
    the refusal names only their kind and scope.
  • Read-only ruleset check. The release workflow reports a bypass list it
    cannot see as not checked, never as a match.
  • The one-time v0.2.3 tag ceremony section is removed from
    RELEASE_CHECKLIST.md; tags are made with make release-tag and
    make release-push-tag.

What a release carries

A crucible release is a GPG-signed annotated Git tag. It publishes no assets,
so there are no SHA256SUMS or SHA512SUMS files to verify. See
docs/security/README.md.

Upgrade notes

  • For durable-record/v1 implementers: a store that supports removing
    external bodies names body_removal_stream in its profile and records the
    lifecycle there. A store that does not support it needs no change. Existing
    v1 journals remain valid.
  • For release maintainers: run the release with an org .envrc above the
    repository that sets GH_TOKEN; the push no longer uses origin or a stored
    login.
  • durable-record v0 and every other contract family are unchanged.

References