@totemsdk/edge-coap 0.1.0 → 0.3.0

package/LICENSE

@@ -1,21 +1,202 @@
-MIT License
-
-Copyright (c) 2024 Totem SDK Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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,60 @@
+Totem SDK
+Copyright 2024-2026 Totem SDK Contributors
+
+This product includes software and material derived from the projects listed
+below. The notices are provided for attribution and do not modify the Apache
+License, Version 2.0.
+
+Minima
+------
+Minima protocol and application
+https://github.com/minima-global/Minima
+Licensed under the Apache License, Version 2.0.
+
+Portions of the Totem SDK core, KISSVM, serialization, transaction and wallet
+surfaces are translated or adapted from Minima's Java implementation. Those
+portions remain subject to the Apache License, Version 2.0 and retain the
+applicable copyright and attribution notices.
+
+Bouncy Castle
+-------------
+Legion of the Bouncy Castle Inc.
+https://www.bouncycastle.org/
+Licensed under the Bouncy Castle License (MIT-style).
+
+The Winternitz/GMSS-compatible WOTS implementation follows the algorithms and
+behaviour of Bouncy Castle's WinternitzOTSignature, WinternitzOTSVerify and
+GMSSRandom classes.
+
+QVAC
+----
+QVAC SDK
+https://www.npmjs.com/package/@qvac/sdk
+Licensed under the Apache License, Version 2.0.
+
+The vendored type surface in packages/qvac/src/vendor/qvac-sdk.d.ts is
+reconstructed from the @qvac/sdk type declarations for build-time use.
+
+Protocol Buffers
+----------------
+Protocol Buffers - Google's data interchange format
+Copyright 2008 Google Inc. All rights reserved.
+https://developers.google.com/protocol-buffers/
+Licensed under the BSD 3-Clause License.
+
+The generated file packages/agent-policy/src/generated/google/protobuf/struct.ts
+retains its original BSD 3-Clause header.
+
+BIP39
+-----
+BIP39 English word list
+https://github.com/bitcoin/bips/blob/master/bip-0039/english.txt
+Licensed under the MIT License.
+
+Contributor Covenant
+--------------------
+Contributor Covenant, version 2.1
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+Licensed under the Creative Commons Attribution 4.0 International License.
+
+The Totem SDK Code of Conduct is adapted from Contributor Covenant 2.1.

package/README.md

@@ -74,6 +74,145 @@ await bridge.start();
 |--------|---------------|
 | GET | `get(path, host, port)` |
 | POST | `post(path, payload, host, port)` |
+| GET + Observe (RFC 7641) | `observe(path, host, port, handler)` |
+
+## Timing
+
+Requests are CON messages and are retransmitted with exponential backoff until
+acknowledged, a response arrives, or the request deadline expires.
+
+| Option | Default | Meaning |
+|--------|---------|---------|
+| `requestTimeoutMs` | `10000` | Overall deadline; retransmission cannot extend it |
+| `ackTimeoutMs` | `2000` | Initial retransmission interval; doubles per attempt. `0` disables retransmission |
+| `maxRetransmits` | `4` | Upper bound on retransmissions before waiting for the deadline |
+
+```ts
+createCoapGateway({ runtime, transport, localPort: 5683, timing: { ackTimeoutMs: 1000 } });
+```
+
+An empty ACK stops retransmission and keeps the request pending for a separate
+response. Responses are accepted only from the addressed host/port and on the
+matching four-byte token; RST and non-2.xx responses settle as failures.
+
+## CBOR payloads
+
+CoAP carries the content format in option 12. `application/cbor` is format 60.
+The gateway returns the raw payload plus `contentFormat`, and exports a
+minimal RFC 8949 decoder:
+
+```ts
+import { decodeCbor } from '@totemsdk/edge-coap';
+
+const result = await gateway.get(['sensors', 'temp'], host, port);
+if (result.ok && result.data?.contentFormat === 60) {
+  const reading = decodeCbor(result.data.payload); // e.g. { temp: 21.5 }
+}
+```
+
+`decodeCbor` rejects truncated input, reserved additional information, trailing
+bytes, duplicate map keys and nesting beyond 32 levels. Integers above
+`Number.MAX_SAFE_INTEGER` decode as `bigint`; tagged values are unwrapped.
+
+The sensor bridge decodes CBOR automatically when a binding's response uses
+format 60 and adds `contentFormat`, `observe` (for notifications) and `cbor` to
+the proof claims. A payload that claims CBOR but fails to decode is not signed.
+
+## Observations
+
+`observe` registers with the Observe option and keeps the token live after the
+initial response. Notifications with a fresh 24-bit sequence are delivered to
+the handler; stale duplicates are dropped, confirmable notifications are
+acknowledged, and `cancel()` deregisters with `Observe: 1`.
+
+```ts
+const registered = await gateway.observe(['sensors', 'temp'], host, port, (notification) => {
+  const reading = notification.contentFormat === 60
+    ? decodeCbor(notification.payload)
+    : notification.payload;
+  console.log(notification.observe, reading);
+});
+if (registered.ok) {
+  // later
+  await registered.data?.cancel();
+}
+```
+
+Sensor bindings can use `observe: true` to feed proofs from notifications
+instead of polling; if registration is refused the bridge falls back to
+interval polling.
+
+## Blockwise transfer (RFC 7959)
+
+Payloads larger than the configured block size are uploaded as Block1
+requests, and blockwise responses are assembled transparently:
+
+```ts
+const gateway = createCoapGateway({
+  runtime, transport, localPort: 5683,
+  blockwise: { blockSize: 256, maxBodySize: 1024 * 1024 },
+});
+const result = await gateway.post(['firmware'], largePayload, host, port);
+```
+
+- `blockSize` must be a power of two from 16 to 1024 (default 1024).
+- Block1 uploads validate the echoed block number and size; a server that
+  reduces the block size mid-transfer fails the request with an explicit error.
+- Block2 responses are followed until `more` is clear and assembled up to
+  `maxBodySize` (default 1 MiB).
+- `get`/`post` return `block1`, `block2`, `size1` and `size2` when present.
+- Blockwise observation notifications, multicast and Block1 size
+  renegotiation are not implemented.
+
+## Security boundary (OSCORE)
+
+`createCoapGateway({ security })` accepts a `CoapSecurityPort`. The connector
+owns framing, correlation and observation semantics; the port owns AEAD, HKDF,
+replay windows and OSCORE option encoding.
+
+```ts
+import type { CoapSecurityPort } from '@totemsdk/edge-coap';
+
+const security: CoapSecurityPort = reviewedOscoreContext;
+const gateway = createCoapGateway({ runtime, transport, localPort: 5683, security });
+```
+
+- `protects(host, port)` marks endpoints that must use OSCORE.
+- `protect(message)` adds protection and may add the OSCORE option;
+  `unprotect(message)` authenticates and decrypts inbound messages.
+- The boundary fails closed: a plaintext reply from a protected endpoint is
+  dropped, an OSCORE message from an unconfigured endpoint is dropped, and a
+  protection failure fails the request before anything is sent. Empty ACK/RST
+  messages remain valid because OSCORE does not protect them.
+
+### Node OSCORE context
+
+`createOscoreContext` is a Node.js client-role OSCORE implementation behind the
+port. It uses AES-CCM-16-64-128 and HKDF-SHA-256, derives sender/recipient keys
+and the common IV per RFC 8613, encodes the OSCORE option, tracks request
+Partial IVs for response binding, applies a 32-entry replay window and uses the
+FETCH outer code for Observe requests.
+
+```ts
+import { createOscoreContext } from '@totemsdk/edge-coap';
+
+const security = await createOscoreContext({
+  masterSecret,
+  masterSalt,
+  senderId,          // e.g. new Uint8Array([0x01])
+  recipientId,       // server sender ID
+  idContext,         // optional
+  endpoints: [{ host: '192.168.1.100', port: 5683 }],
+});
+const gateway = createCoapGateway({ runtime, transport, localPort: 5683, security });
+```
+
+It is validated against RFC 8613 Appendix C test vectors 4–8 (request
+protection, responses with and without Partial IV, replay rejection and
+authentication failure). Limitations: client requests only (no server-side
+response protection), no Class I options, no Uri-Host/Uri-Port/Uri-Query
+modeling, and no blockwise/multicast. Supply a different `CoapSecurityPort` for
+those profiles.
 
 ## Capabilities
 
@@ -81,4 +220,65 @@ await bridge.start();
 
 ## License
 
-MIT
+Apache-2.0 — see [LICENSE](./LICENSE) and [NOTICE](./NOTICE).
+
+
+## Native sidecar
+
+`NativeCoapTransport` speaks newline-delimited JSON to the Go bridge on
+`COAP_LISTEN_ADDR` (default `127.0.0.1:15003`):
+
+- `send` requests validate the destination and payload, emit the datagram and
+  answer immediately (`ok`);
+- every inbound datagram is pushed back as a `message` and correlated by the
+  gateway's token and endpoint checks;
+- `error` pushes cover UDP read failures; an unexpected close rejects pending
+  sends and marks the gateway `error`.
+
+The bridge binds UDP on `COAP_BIND_PORT` (`5683` by default; `0` selects an
+ephemeral port), exposes `edge-coap --version` (protocol 1) and is documented by
+[sidecar.json](./sidecar.json). It is source-built; no binaries are bundled.
+
+## Testing
+
+Tests live outside the published package. Package `test:*` scripts are
+repository delegates; tests are not shipped.
+
+- Unit: `tests/unit/edge-coap/` (`npm test`)
+- Go bridge validation: `npm run test:go`
+- RFC 7252 conformance (fixed vectors, malformed input, token/endpoint
+  correlation, retransmission, separate responses, blockwise transfer,
+  deadlines): `npm run test:conformance`
+- RFC 8613 OSCORE client vectors: `npm run test:oscore`
+- Real Go sidecar + independent UDP peer (GET/POST, errors, separate responses,
+  blockwise transfer, bridge validation): `npm run test:integration`
+- Peer outage, sidecar crash/restart, uncertain pending requests, teardown:
+  `npm run test:recovery`
+- Packed ESM/CJS consumer with strict type imports: `npm run test:consumer`
+
+## Qualification status
+
+`@totemsdk/edge-coap` is **v1** for the qualified constrained-device profile:
+plaintext or OSCORE unicast CoAP with RFC 7252 framing, CON retransmission,
+separate responses, token/endpoint correlation, explicit RST/error handling,
+deadlines and teardown, CBOR content-format decoding, RFC 7641 observations
+feeding signed proof claims, RFC 7959 blockwise transfer and an OSCORE client
+and server-role context. Conformance, integration, recovery and
+packed-consumer evidence exist for that profile. The shared consumer probe
+installs the packed local workspace closure, so sibling publication state does
+not block the gate. The support tier remains outside the first-line production
+surface.
+
+The OSCORE profile (Node `createOscoreContext`, Appendix C vectors) is
+qualified for client and server roles, including Uri-Host/Uri-Port/Uri-Query
+handling. Not qualified:
+
+- DTLS (transport-owned);
+- blockwise observation notifications and multicast;
+- OSCORE Class I options (none are currently defined).
+
+## Next profile
+
+DTLS, blockwise observations and multicast remain outside the qualified
+profile. Any security context must stay behind `CoapSecurityPort`; the
+connector does not own cryptographic primitives.

package/dist/cbor.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Minimal CBOR (RFC 8949) decoder for constrained-device payloads.
+ *
+ * Supports the deterministic core used by sensors: unsigned/negative
+ * integers, byte/text strings, arrays, maps, tags (unwrapped), booleans, null,
+ * undefined, half/single/double floats and indefinite-length containers.
+ * Maps with all-text keys decode to plain objects; other maps decode to `Map`.
+ *
+ * This is a decoder, not a general CBOR library: it does not expose tag
+ * semantics and rejects malformed, truncated, duplicate-key or over-deep input.
+ */
+export type CborValue = null | undefined | boolean | number | bigint | string | Uint8Array | CborValue[] | {
+    [key: string]: CborValue;
+} | Map<CborValue, CborValue>;
+export interface CborDecodeOptions {
+    /** Maximum nesting depth. Default 32. */
+    maxDepth?: number;
+}
+export declare class CborDecodeError extends Error {
+    constructor(message: string);
+}
+export declare function decodeCbor(input: Uint8Array, options?: CborDecodeOptions): CborValue;