tebako-release 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd3ef0747dda2fc3ea4d7fcd7f35fe9aeba66cec808604ff7933ba3f644e0191
-  data.tar.gz: 24374660ac6c58c5b0d226b67224d84b1f18f3f0f415c666657a6b9aeeebe015
+  metadata.gz: da808fc0759260d4b29d60ffb1d51622cb07c3f8cf3125b4ea01025f1db4f927
+  data.tar.gz: 8d21389348ae2bb086aaf17f3901f386e62598be12bee027e653b76b361e8d1b
 SHA512:
-  metadata.gz: 15a427891a21fb83094aa5f6dd1970a5efe45cb9431b8ab62ad2e7b6faea108c26d7ca66b2743c332c8f4600b3072fa131f0b5002496c90448a5f60da7671305
-  data.tar.gz: 23ecefb7508b57e6d9c907e867b8825b54b0915a084a04ff7cf88d1c81f42a1c469b01cd4a6fc1ade5faddfa2a250860e94306c69738c37e8d58d4c33fdd0981
+  metadata.gz: d73130a2cbd8d1de0df2bb1cf1d801bfe260db9b5569cc04e736eca3324d945576cf8ee9c13c22eb31000872e9229cfb5931c553a491e72188bf58d793206cba
+  data.tar.gz: c111f4d684714a0b03fbc92891b9e2f6640f8cc05369b77870e73bc04f34847367692c89cbaf06c48138fbf8d6172fe675c4124add72be2da7ba8c2bcd674915

data/README.md

@@ -1,4 +1,4 @@
-# tebako-release-tooling
+# tebako-release
 
 The tebako factories' release machinery — the **single owner** of the per-leg
 publish uploader and the no-fold OpenPGP release signer that every runtime
@@ -24,6 +24,14 @@ through a small adapter file and pin this gem — they never carry copies.
   yield identical bytes). A factory opts into the bundle-era publish shape
   through its adapter (`bundle_publish? → true`); the per-file shape stays
   the default for pre-bundle lines.
+- **`TebakoRelease::Blksum`** — the spec 39 §3 block-group digest sidecar
+  (`<image>.blksum.json`: one sha256 per 4 MiB group of env-image bytes,
+  the lazy mount's range-GET trust anchor). The uploader derives it
+  in-process from the staged image at entry-build time — a pure function
+  of the served bytes, the same class as the `.sha256` sidecars — pins it
+  in the shard (`image.blksum {filename, sha256}`), and uploads it as a
+  standalone asset in both publish eras. The render is byte-exact with
+  `tpkg::lazy::Blksum::render`, golden-pinned in `spec/blksum_spec.rb`.
 - **`TebakoRelease::Platform`** — the release-side platform vocabulary
   (the `(os, arch) → host_id` table; mirrors `tpkg::Platform`, drift fails
   loudly in factory CI).
@@ -35,7 +43,7 @@ A factory adds the gem, pinned through its `contract.yml` SSOT:
 ```ruby
 # Gemfile
 gem "tebako-release",
-    git: "https://github.com/tamatebako/tebako-release-tooling.git",
+    git: "https://github.com/tamatebako/tebako-release.git",
     tag: YAML.load_file("contract.yml").fetch("release_tooling")
 ```
 

data/lib/tebako_release/blksum.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2026 [Ribose Inc](https://www.ribose.com).
+# All rights reserved.
+# This file is a part of tamatebako
+
+require "digest"
+require "json"
+require "pathname"
+
+module TebakoRelease
+  # The spec 39 §3 block-group digest sidecar (`<image>.blksum.json`): one
+  # sha256 per 4 MiB group of image bytes plus the whole-image sha256,
+  # authored by the PUBLISHER in-process (a resolver never derives one).
+  # For the factories the publisher invocation is `tebako-release upload`,
+  # so the derivation lives here — a pure function of the staged image
+  # bytes, the same derivable-metadata class as the `.sha256` sidecars.
+  #
+  # The render is byte-exact with tpkg::lazy::Blksum::render (the product's
+  # single owner of the grammar): compact machine JSON, keys in schema
+  # order, lowercase hex, no trailing newline. spec/blksum_spec.rb pins
+  # tpkg-minted golden vectors against this render — a drift fails the
+  # suite, never ships.
+  class Blksum
+    # The locked fetch unit (spec 39 §11.3): 4 MiB of image bytes; the
+    # final group is short. Tunable only by a measured product follow-up.
+    GROUP_SIZE = 4 * 1024 * 1024
+
+    # `schema_version` of the v1 document.
+    SCHEMA_VERSION = 1
+
+    # The served asset name is the image's name plus this suffix.
+    SIDECAR_SUFFIX = ".blksum.json"
+
+    # The sidecar asset name for an image name (or an image path).
+    def self.sidecar_name(image)
+      "#{Pathname.new(image).basename}#{SIDECAR_SUFFIX}"
+    end
+
+    def self.blksum_file?(path)
+      path.basename.to_s.end_with?(SIDECAR_SUFFIX)
+    end
+
+    # Derive the sidecar of a staged image: streams the file in GROUP_SIZE
+    # chunks (the runtime env images are 50–200 MB — never held whole),
+    # one sha256 per group plus the whole-image sha256. An absent or empty
+    # image is a named refusal (spec 39 §3: size_bytes >= 1).
+    def self.for_image(image_path)
+      path = Pathname.new(image_path)
+      assert_derivable!(path)
+      whole, groups = hash_stream(path)
+      new(size_bytes: path.size, sha256: whole.hexdigest, groups: groups)
+    end
+
+    def self.assert_derivable!(path)
+      raise Error, "the blksum sidecar cannot be derived: #{path} does not exist" unless path.file?
+      raise Error, "the blksum sidecar cannot be derived: #{path} is empty (size_bytes >= 1)" if path.empty?
+    end
+
+    def self.hash_stream(path)
+      whole = Digest::SHA256.new
+      groups = []
+      path.open("rb") do |io|
+        while (chunk = io.read(GROUP_SIZE))
+          whole.update(chunk)
+          groups << Digest::SHA256.hexdigest(chunk)
+        end
+      end
+      [whole, groups]
+    end
+
+    attr_reader :size_bytes, :sha256, :groups
+
+    def initialize(size_bytes:, sha256:, groups:)
+      @size_bytes = size_bytes
+      @sha256 = sha256
+      @groups = groups
+    end
+
+    # The machine JSON form (keys in schema order) — byte-exact with
+    # tpkg::lazy::Blksum::render, golden-pinned in spec/blksum_spec.rb.
+    def render
+      JSON.generate(
+        schema_version: SCHEMA_VERSION,
+        group_size: GROUP_SIZE,
+        size_bytes: size_bytes,
+        sha256: sha256,
+        groups: groups
+      )
+    end
+
+    # The sidecar document's own sha256 (the manifest's
+    # `image.blksum.sha256` pin — spec 39 §3).
+    def digest
+      Digest::SHA256.hexdigest(render)
+    end
+  end
+end

data/lib/tebako_release/uploader.rb

@@ -442,7 +442,8 @@ module TebakoRelease
       contract = contract_sidecar(package)
       filename = package.basename.to_s
       sha256 = Digest::SHA256.file(package).hexdigest
-      register_current_shas(package, image, dll, bundle)
+      blksum = derive_blksum(image) if image
+      register_current_shas(package, image, dll, bundle, blksum)
       {
         tebako_version: @version,
         contract_era: contract.fetch("contract_era"),
@@ -466,7 +467,7 @@ module TebakoRelease
         # selector axis. Sourced from the factory's adapter (the same truth
         # its boot smoke asserts), so manifest and smoke can never disagree.
         entry[:capabilities] = @config.adapter.capabilities(version: runtime_version, platform_id: platform)
-        entry[:image] = image_entry(image) if image
+        entry[:image] = image_entry(image, blksum) if image
         entry[:dll] = dll_entry(dll, runtime_version, platform) if dll
         entry[:bundle] = bundle_entry(bundle) if bundle
         declare_signatures(entry)
@@ -486,12 +487,36 @@ module TebakoRelease
     end
 
     # The idempotent upload skip reads these (same name + same sha = kept):
-    # the exe, its facets, and the bundle (spec 36's bundle-era asset).
-    def register_current_shas(package, image, dll, bundle) # rubocop:disable Metrics/AbcSize
+    # the exe, its facets, the derived blksum sidecar (spec 39 §3), and the
+    # bundle (spec 36's bundle-era asset).
+    def register_current_shas(package, image, dll, bundle, blksum = nil) # rubocop:disable Metrics/AbcSize
       current_shas[package.basename.to_s] = Digest::SHA256.file(package).hexdigest
       current_shas[image_name_for(package)] = Digest::SHA256.file(image).hexdigest if image
       current_shas[dll_name_for(package)] = Digest::SHA256.file(dll).hexdigest if dll
       current_shas[bundle.basename.to_s] = Digest::SHA256.file(bundle).hexdigest if bundle
+      current_shas[Blksum.sidecar_name(image)] = blksum.digest if blksum
+    end
+
+    # The spec 39 §3 derivation: the publisher authors the block-group
+    # digest sidecar in-process from the staged image bytes (a pure
+    # function of them — the same derivable-metadata class as the .sha256
+    # sidecars), stages it BESIDE the image so the leg's attestation glob
+    # (runtime-packages/*) covers it, and the entry's `image.blksum` block
+    # pins the document's own sha256. support_file? keeps a staged sidecar
+    # from classifying as a package on a re-run validation.
+    def derive_blksum(image)
+      blksum = Blksum.for_image(image)
+      path = Pathname.new("#{image}#{Blksum::SIDECAR_SUFFIX}")
+      path.write(blksum.render)
+      staged_blksums[path.basename.to_s] = path
+      blksum
+    end
+
+    # The derived sidecar paths this invocation staged, keyed by asset
+    # name — the upload leg's source (entries are built before uploads in
+    # every publish shape, so a declared sidecar is always staged).
+    def staged_blksums
+      @staged_blksums ||= {}
     end
 
     # Spec 13 §2a / spec 09 §5: on signing-enabled lines every artifact the
@@ -573,12 +598,19 @@ module TebakoRelease
     end
 
     # The additive image metadata: name, sha256, size (consumers ignoring the
-    # `image` key keep working; item 30's compat rule).
-    def image_entry(image)
+    # `image` key keep working; item 30's compat rule) — plus the additive
+    # `blksum` pin (spec 39 §3: {filename, sha256} of the derived block-group
+    # digest sidecar; consumers that predate the key ignore it, and the
+    # loader's lazy arm falls back to eager loudly when it is absent).
+    def image_entry(image, blksum)
       {
         filename: image.basename.to_s,
         sha256: Digest::SHA256.file(image).hexdigest,
-        size_bytes: image.size
+        size_bytes: image.size,
+        blksum: {
+          filename: Blksum.sidecar_name(image),
+          sha256: blksum.digest
+        }
       }
     end
 
@@ -805,6 +837,7 @@ module TebakoRelease
       bundles = build_bundles(packages)
       entries = build_manifest_entries(packages, bundles: bundles)
       bundles.each_value { |bundle| upload_package(release, bundle) }
+      upload_blksum_sidecars(release, entries)
       entries.each { |entry| ensure_package_metadata(release, entry) }
       print_settled_summary
     end
@@ -867,10 +900,32 @@ module TebakoRelease
     # the release notes are written once at creation.
     def publish_release(release, packages, entries)
       packages.each { |package| upload_package(release, package) }
+      upload_blksum_sidecars(release, entries)
       entries.each { |entry| ensure_package_metadata(release, entry) }
       print_settled_summary
     end
 
+    # The spec 39 §3 sidecars ride along in BOTH publish eras as STANDALONE
+    # assets — never bundle members: the lazy resolver fetches the sidecar
+    # with a plain GET against its own release-asset URL
+    # (`{dir_url}/{image.blksum.filename}`), in the bundle era too. Derived
+    # at entry-build time and staged beside the images; uploaded before the
+    # metadata so the shard that pins them never precedes them.
+    def upload_blksum_sidecars(release, entries)
+      entries.each do |entry|
+        name = entry.dig(:image, :blksum, :filename)
+        next unless name
+
+        path = staged_blksums[name]
+        unless path
+          raise Error, "the blksum sidecar #{name} was declared but never staged — " \
+                       "the derivation runs at entry-build time; this is a machinery bug"
+        end
+
+        upload_package(release, path)
+      end
+    end
+
     # The package's metadata assets, byte-truthful for the SERVED bytes: a
     # settled package (the byte-immutable keep, or a wedged recovery
     # replace) publishes the PREVIOUS entry's shard and sidecars — the
@@ -888,13 +943,18 @@ module TebakoRelease
     # era: the exe, its .tfs image and its .dll facet. Bundle era (spec 36
     # §3): the bundle is the ONE served payload asset — the entry's
     # exe/image/dll fields are member pins, not served names, so they earn
-    # no sidecar.
+    # no sidecar. Both eras: the derived blksum sidecar (spec 39 §3) IS a
+    # served standalone asset, so it earns its own .sha256 sidecar like
+    # every served name.
     def metadata_assets(entry)
-      return { entry[:bundle][:filename] => entry[:bundle][:sha256] } if entry[:bundle]
-
-      { entry[:filename] => entry[:sha256] }
-        .merge(facet_metadata(entry, :image))
-        .merge(facet_metadata(entry, :dll))
+      served = if entry[:bundle]
+                 { entry[:bundle][:filename] => entry[:bundle][:sha256] }
+               else
+                 { entry[:filename] => entry[:sha256] }
+                   .merge(facet_metadata(entry, :image))
+                   .merge(facet_metadata(entry, :dll))
+               end
+      served.merge(blksum_metadata(entry))
     end
 
     def facet_metadata(entry, facet)
@@ -902,6 +962,14 @@ module TebakoRelease
       block ? { block[:filename] => block[:sha256] } : {}
     end
 
+    # The blksum sidecar's name -> sha256 pair when the entry declares it
+    # (spec 39 §3's `image.blksum` pin); a pre-blksum previous entry
+    # declares nothing and earns nothing (byte-truthful metadata).
+    def blksum_metadata(entry)
+      block = entry.dig(:image, :blksum)
+      block ? { block[:filename] => block[:sha256] } : {}
+    end
+
     def shard_name_for(entry)
       "#{package_stem(entry[:filename])}#{SHARD_SUFFIX}"
     end
@@ -910,7 +978,8 @@ module TebakoRelease
     # with the previous entry's voice; a never-published settle has nothing
     # truthful to keep and never reaches here (upload_package re-raised).
     def effective_entry(entry)
-      names = [entry[:filename], entry.dig(:image, :filename), entry.dig(:dll, :filename)].compact
+      names = [entry[:filename], entry.dig(:image, :filename), entry.dig(:dll, :filename),
+               entry.dig(:image, :blksum, :filename)].compact
       return entry unless names.any? { |name| settled?(name) }
 
       previous_entry_for(entry[:filename]) || entry
@@ -1095,7 +1164,9 @@ module TebakoRelease
 
     def missing_assets(release, packages, require_signatures: false)
       present = all_assets(release).map(&:name)
-      packages.flat_map { |name| missing_package_assets(present, name, require_signatures: require_signatures) }
+      packages.flat_map do |name|
+        missing_package_assets(release, present, name, require_signatures: require_signatures)
+      end
     end
 
     # One expected package's gaps. Windows executables may or may not carry
@@ -1103,11 +1174,16 @@ module TebakoRelease
     # expectation matches both. Metadata expectations ride on what actually
     # landed — a package whose exe never landed reports its own name only,
     # never a cascade of secondary sidecar/shard gaps (one error per gap).
-    def missing_package_assets(present, name, require_signatures: false)
-      return missing_bundle_assets(present, name, require_signatures: require_signatures) if bundle_publish?
+    # The blksum sidecar (spec 39 §3) is expected ONLY when the package's
+    # shard declares the `image.blksum` pin — a pre-blksum release's audit
+    # stays green (the additive-key compat rule), and a missing shard
+    # reports its own gap only.
+    def missing_package_assets(release, present, name, require_signatures: false)
+      return missing_bundle_assets(release, present, name, require_signatures: require_signatures) if bundle_publish?
 
       exe = [name, "#{name}.exe"].find { |candidate| present.include?(candidate) }
       landed, missing = expected_facets(name).partition { |facet| present.include?(facet) }
+      landed, missing = split_blksum_expectation(release, present, name, landed, missing)
       missing.unshift(name) unless exe
       return missing if exe.nil?
 
@@ -1116,12 +1192,49 @@ module TebakoRelease
 
     # Spec 36's completeness shape: the bundle is the leg's ONE payload
     # asset; a landed bundle owes its sidecar and the package's shard
-    # (plus an .asc of each on signing-enabled audits).
-    def missing_bundle_assets(present, name, require_signatures: false)
+    # (plus an .asc of each on signing-enabled audits). The declared
+    # blksum sidecar (spec 39 §3) is a standalone served asset in this
+    # era too — expected, with its own metadata, when the shard pins it.
+    def missing_bundle_assets(release, present, name, require_signatures: false)
       bundle = "#{name}#{Bundler::BUNDLE_SUFFIX}"
       return [bundle] unless present.include?(bundle)
 
-      missing_metadata(present, name, [bundle], require_signatures: require_signatures)
+      landed, missing = split_blksum_expectation(release, present, name, [bundle], [])
+      missing + missing_metadata(present, name, landed, require_signatures: require_signatures)
+    end
+
+    # The shard-declared blksum expectation (spec 39 §3): the shard is the
+    # declaration's only authority (the additive `image.blksum` key), so
+    # the audit reads it. A shard that declares no pin expects nothing (a
+    # pre-blksum release audits green); a shard that never landed already
+    # reports its own gap, so it adds no secondary blksum gaps; an
+    # unreadable shard warns and expects nothing (never a silent failure —
+    # the shard's own gap is the gate's business). A DECLARED sidecar that
+    # never landed reports its own name only — its sidecar/.asc cascade
+    # rides the landed set, one error per gap.
+    def split_blksum_expectation(release, present, name, landed, missing)
+      declared = declared_blksum_name(release, present, name)
+      return [landed, missing] unless declared
+
+      if present.include?(declared)
+        [landed + [declared], missing]
+      else
+        [landed, missing + [declared]]
+      end
+    end
+
+    # The sidecar name the package's shard declares (`image.blksum`),
+    # nil when undeclared, when the shard never landed, or when it cannot
+    # be read (loudly — the audit never guesses an expectation).
+    def declared_blksum_name(release, present, name)
+      shard = "#{name}#{SHARD_SUFFIX}"
+      return nil unless present.include?(shard)
+
+      download_asset_json(find_asset(release, shard)).dig("image", "blksum", "filename")
+    rescue StandardError => e
+      puts "::warning::could not read #{shard} for the blksum expectation (#{e.class}: #{e.message}) — " \
+           "no blksum sidecar is expected of this package"
+      nil
     end
 
     # The non-executable artifacts a package is expected to carry: the
@@ -1448,12 +1561,13 @@ module TebakoRelease
     end
 
     # The package stem an asset name belongs to: the exe (with or without
-    # .exe), its .tfs image, its .dll facet and its .tar.gz bundle (spec 36)
-    # share one stem — settling is package-scoped so a wedged exe also
-    # stands down its facets (a fresh facet over previous package bytes
-    # would be a mixed-version package).
+    # .exe), its .tfs image, its .dll facet, the derived blksum sidecar
+    # (spec 39 §3) and its .tar.gz bundle (spec 36) share one stem —
+    # settling is package-scoped so a wedged exe also stands down its
+    # facets (a fresh facet over previous package bytes would be a
+    # mixed-version package). Longest suffix first.
     def package_stem(filename)
-      filename.sub(/\.tar\.gz\z/, "").sub(/\.(exe|tfs|dll)\z/, "")
+      filename.sub(/\.tar\.gz\z/, "").sub(/\.tfs\.blksum\.json\z/, "").sub(/\.(exe|tfs|dll)\z/, "")
     end
 
     def settled?(filename)
@@ -1586,18 +1700,13 @@ module TebakoRelease
 
     # The sha256 the previous manifest records for this asset: the entry's
     # own sha for the executable, the image/dll facet block's sha for a
-    # facet (facets key under their package's entry), the bundle block's
-    # sha for the bundle (spec 36 — the bundle-era served asset).
+    # facet (facets key under their package's entry), the image's blksum
+    # pin for the derived sidecar (spec 39 §3), the bundle block's sha for
+    # the bundle (spec 36 — the bundle-era served asset).
     def previous_sha_for(entry, filename)
-      if entry.dig(:image, :filename) == filename
-        entry.dig(:image, :sha256)
-      elsif entry.dig(:dll, :filename) == filename
-        entry.dig(:dll, :sha256)
-      elsif entry.dig(:bundle, :filename) == filename
-        entry.dig(:bundle, :sha256)
-      else
-        entry[:sha256]
-      end
+      blocks = [entry.dig(:image, :blksum), entry[:image], entry[:dll], entry[:bundle]]
+      block = blocks.find { |candidate| candidate && candidate[:filename] == filename }
+      block ? block[:sha256] : entry[:sha256]
     end
 
     def validate_environment
@@ -1624,13 +1733,16 @@ module TebakoRelease
     end
 
     # `.abi` sidecars (the runtime's platform string), `.contract.yaml`
-    # sidecars (the era-2 release card provenance) and `.sha256` markers
+    # sidecars (the era-2 release card provenance), `.sha256` markers
     # (the image's store-layout trust anchor, spec 22 §6 — the boot
-    # smoke's image-key input) are manifest inputs / build outputs read
-    # in place — never packages of their own.
+    # smoke's image-key input) and `.blksum.json` sidecars (the spec 39 §3
+    # derivation staged beside its image at entry-build time — still in
+    # the directory when a re-run validates) are manifest inputs / build
+    # outputs read in place — never packages of their own.
     def support_file?(path)
       path.extname == ".abi" || path.extname == ".sha256" ||
-        path.basename.to_s.end_with?(CONTRACT_SIDECAR_SUFFIX)
+        path.basename.to_s.end_with?(CONTRACT_SIDECAR_SUFFIX) ||
+        Blksum.blksum_file?(path)
     end
   end
 end

data/lib/tebako_release/version.rb

@@ -5,5 +5,5 @@
 # This file is a part of tamatebako
 
 module TebakoRelease
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/tebako_release.rb

@@ -10,6 +10,7 @@ require_relative "tebako_release/adapter"
 require_relative "tebako_release/config"
 require_relative "tebako_release/platform"
 require_relative "tebako_release/bundler"
+require_relative "tebako_release/blksum"
 require_relative "tebako_release/uploader"
 require_relative "tebako_release/signer"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tebako-release
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ribose Inc
@@ -39,6 +39,7 @@ files:
 - exe/tebako-release
 - lib/tebako_release.rb
 - lib/tebako_release/adapter.rb
+- lib/tebako_release/blksum.rb
 - lib/tebako_release/bundler.rb
 - lib/tebako_release/config.rb
 - lib/tebako_release/error.rb
@@ -46,7 +47,7 @@ files:
 - lib/tebako_release/signer.rb
 - lib/tebako_release/uploader.rb
 - lib/tebako_release/version.rb
-homepage: https://github.com/tamatebako/tebako-release-tooling
+homepage: https://github.com/tamatebako/tebako-release
 licenses:
 - BSD-2-Clause
 metadata: