Loheide-eu-mitarbeiterplatt.../vendor/web-auth/cose-lib/RELEASES.md
Friederich Loheide 9c0f8de791
Some checks failed
CI / PHP 8.3 / mariadb:10.6 (pull_request) Successful in 1m14s
CI / PHP 8.4 / mariadb:10.6 (pull_request) Successful in 1m12s
CI / PHP 8.4 / mariadb:11.4 (pull_request) Successful in 1m7s
CI / PHP 8.3 / mariadb:11.4 (pull_request) Successful in 1m19s
CI / PHP 8.3 / mysql:8.0 (pull_request) Successful in 1m32s
CI / PHP 8.4 / mysql:8.0 (pull_request) Successful in 1m22s
CI / PHP 8.4 / mysql:8.4 (pull_request) Successful in 1m32s
CI / PHP 8.3 / mysql:8.4 (pull_request) Successful in 1m35s
CI / Build-Artefakte aktuell (pull_request) Failing after 1m7s
Phase 0: Fundament für Inhaus
- Laravel 13 mit Filament 5 (Admin), Inertia 3 + Vue 3 + Vuetify 4 (Material 3)
- Anmeldung über Fortify (Login, Passwort vergessen/ändern), keine Selbstregistrierung
- Profil mit Profilbild (WebP in festen Größen), Personenseiten, Header mit Avatar-Menü
- Material-3-Farbschema aus der Primärfarbe, hell/dunkel/System pro Person
- Basis-Branding (Portalname, Logo, Primärfarbe) im Admin unter „Erscheinungsbild“
- Benutzerverwaltung im Admin, Zugang vorläufig über is_admin
- vendor/ (ohne Dev-Pakete) und Frontend-Build mitversioniert, Dev-Pakete in vendor-dev/
- PHPUnit-Tests gegen MySQL/MariaDB, Forgejo-CI-Matrix, Docker-Entwicklungsumgebung
- VERSION, CHANGELOG.md und CONTRIBUTING.md mit Release-Ablauf

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-09-25 20:35:30 +00:00

3.4 KiB

Versioning and Release

This document describes the versioning and release process of the COSE Library for PHP. This document is a living document, contents will be updated according to each release.

Releases

Releases will be versioned using dotted triples, similar to Semantic Version. For this specific document, we will refer to the respective components of this triple as <major>.<minor>.<patch>. The version number may have additional information, such as "-rc1,-rc2,-rc3" to mark release candidate builds for earlier access. Such releases will be considered as "pre-releases".

Minor Release Support Matrix

This matrix is the single source of truth for the branches under support; SECURITY.md refers to it.

Version Supported
4.8.x ✅ (in development)
4.7.x ✅
4.6.x ✅ (security fix only)
4.5.x ✅ (security fix only)
< 4.5.x ❌

Upgrading

4.7.x to 4.8.x

The six COSE message classes are deprecated. Cose\Signature\CoseSign1Tag, Cose\Signature\CoseSignTag, Cose\Mac\CoseMac0Tag, Cose\Mac\CoseMacTag, Cose\Encryption\CoseEncrypt0Tag and Cose\Encryption\CoseEncryptTag raise an E_USER_DEPRECATED on construction and are removed in 5.0.0. They were ported into spomky-labs/cbor-php 3.4.0, as CBOR\Tag\CoseSign1Tag and its siblings, which is where a description of a CBOR structure belongs. The wire format is identical, so a message written by a deprecated class is read by its replacement and the reverse; the migration is documented in doc/Usage.md. Two points are not mechanical: the four-argument create() becomes createFromComponents(), and the header accessors move to Cose\Structure\CoseHeaders.

Their behaviour is otherwise frozen for the whole 4.8.x line: a deprecation is not the place to change what a class accepts.

The cbor-php floor moves to 3.4.0 (conflict: <3.4.0), so the classes the deprecation points at are guaranteed to be installable.

New: the RFC 9052 rules that sit above the CBOR shape. These are what stays in this library after 5.0.0, and they work on the upstream message classes:

  • Cose\Structure\CoseHeaders reads the two header buckets of any COSE message. A label is an integer or a text string (§1.5) and the two never answer for each other, even though cbor-php normalizes them to the same map offset; the zero-length protected header is accepted (§3) and trailing bytes inside the protected bucket are not; the protected value wins a combined lookup.
  • Cose\Signature\CoseSignature and Cose\Structure\CoseRecipient are the checked views over the signatures and recipients lists, applying the [+ ...] rule of §§4.1 and 5.1, nested recipients included.
  • Cose\Structure\HeaderMapHelper holds the same rules as static functions, including encodeProtected() (which emits the h'' §3 prefers for an empty map) and assertTagNumber().
  • The cryptographic structures are complete: Signature (§4.4, with sign_protected), Mac0Structure and MacStructure (§6.3), Encrypt0Structure, EncryptStructure and RecipientStructure (§5.3) join Signature1, which gained the optional external_aad every structure now takes.