@vanaheimr/cose 0.9.0

package/CHANGELOG.md

@@ -0,0 +1,81 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+Until 1.0.0 the public API may change in minor releases.
+
+## [0.1.0] — 2026-08-22
+
+**The first version published to npm**, on 2026-08-22 — by hand, with
+multi-factor authentication and a maintainer at the keyboard, as every release
+of this package will be; see
+[docs/releasing.md](https://github.com/Vanaheimr/COSE.TS/blob/master/docs/releasing.md)
+for why that is not a workflow's to do.
+
+### Added
+
+- **`COSE_Sign1` and `COSE_Sign`** (RFC 9052), with detached payloads,
+  external additional authenticated data, and the `crit` header parameter
+  throughout.
+- **CBOR payloads are signed and authenticated in their deterministic
+  spelling** (RFC 8949 §4.2.1): a payload that is one well-formed CBOR item is
+  rewritten into that encoding before `CoseSign1`, `CoseSign`, `CoseMac0` or
+  `CoseMac` covers it, unless `canonicalizePayload: false` asks for the bytes
+  as given. A MAC dies the same death as a signature when a hop re-encodes. Forwarding is the reason — every hop that parses and
+  re-encodes a record writes the deterministic form, and a signature over any
+  other spelling arrives unaltered in meaning and broken in fact. A payload
+  that is not CBOR passes through untouched, since text, JSON or an image has
+  no canonical CBOR form to be rewritten into.
+- **`COSE_Mac0` and `COSE_Mac`** with HMAC, including the truncated
+  `HMAC 256/64`.
+- **`COSE_Encrypt0` and `COSE_Encrypt`** with AES-GCM, and recipient
+  structures carrying the content key by `direct` or AES key wrap (RFC 3394).
+- **The version 2 countersignatures** of RFC 9338.
+- **COSE keys** of key type EC2, OKP, AKP and Symmetric, with the key
+  thumbprints of RFC 9679.
+- **Three signature families, kept apart by the API**: the ECDSA algorithms of
+  RFC 9053 and RFC 9864 — including all four brainpool curves, with
+  brainpoolP320r1 defined from its RFC 5639 domain parameters — EdDSA of
+  RFC 8032, and ML-DSA of RFC 9964.
+- **X.509 chains** (RFC 9360): DER read by its own reader, chains walked to a
+  trust anchor and bound to the key that signed — so a certificate on a
+  brainpool curve or an ML-DSA key verifies through the same path as every
+  other signature here.
+- **Runs under Node and in browsers alike**: the cryptography is the `@noble`
+  family end to end, nothing touches `node:crypto` or WebCrypto, and
+  `tests/bundle.test.ts` proves it by running the bundled library in a V8
+  context with no Node globals at all.
+- **Published as ESM** with one bundled `dist/index.js` and per-module
+  declaration files. Deliberately no `.cjs` twin: every runtime dependency
+  ships as ESM only, so a CommonJS build would promise a compatibility its
+  own imports cannot honour. Node that can `require(esm)` — 20.19 and later —
+  loads the ESM build fine.
+- **A fuzz suite** (`tests/fuzz`): every parser against damaged messages,
+  damaged certificates and arbitrary bytes — a value or a typed refusal,
+  never a third thing; whatever is accepted re-encodes to a fixed point; a
+  `COSE_Sign1` signature with any single byte damaged never verifies. Two
+  thousand cases per property on every test run, two hundred thousand in the
+  nightly.
+- **The toolchain the codec has**: ESLint with the typed rule sets, coverage,
+  an API reference that validates as it renders, and a nightly dependency
+  audit — with `npm run verify` running the lot.
+
+### Fixed
+
+- **Two untyped escapes in the DER string reader**, both found by the fuzz
+  suite's first run: a certificate name holding invalid UTF-8 escaped as the
+  platform's own `TypeError`, and a UniversalString character beyond U+10FFFF
+  would have escaped as a `RangeError`. Both are `CoseError` refusals now,
+  and the wide-string decoder builds its result a character at a time, so a
+  large enough hostile string is no longer a stack overflow.
+
+### Verified against
+
+- RFC 9052 C.1.1, C.1.2 and C.2.1, RFC 9338 A.2.1, RFC 6979 A.2.5 and
+  RFC 4231 — published vectors, byte for byte.
+- The worked signed record of the Metrological CBOR specification, produced
+  by the C# reference implementation and never seen being made.
+- Certificates minted by Bouncy Castle rather than by this package's own
+  writer, so the DER reader cannot agree with itself about a misreading.

package/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2010-2026 GraphDefined GmbH <achim.friedland@graphdefined.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,31 @@
+Vanaheimr COSE for TypeScript
+Copyright 2026 GraphDefined GmbH
+
+This product includes software developed by GraphDefined GmbH
+(https://www.graphdefined.com).
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+--------------------------------------------------------------------------------
+
+This package implements CBOR Object Signing and Encryption as specified in
+RFC 9052 and RFC 9053, together with RFC 9338 (countersignatures), RFC 9360
+(X.509 header parameters), RFC 9679 (key thumbprints), RFC 9864
+(fully-specified ECDSA algorithms) and RFC 9964 (ML-DSA), and reads the
+brainpoolP320r1 domain parameters from RFC 5639.
+
+No third-party code is bundled with this package. Its cryptography is
+provided by the separately installed npm dependencies @noble/curves,
+@noble/hashes, @noble/ciphers and @noble/post-quantum (MIT licensed), and
+its CBOR codec by @vanaheimr/metrological-cbor (Apache-2.0); none of them
+is vendored into the published artifact.