@opendpp/webhooks 0.1.0

package/LICENSE

@@ -0,0 +1,176 @@
+                                 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

package/NOTICE

@@ -0,0 +1,12 @@
+@opendpp/webhooks
+Copyright (c) Opendpp UAB.
+
+This product includes software developed by Opendpp UAB.
+Licensed under the Apache License, Version 2.0 (see the LICENSE file).
+
+"OpenDPP" is a trademark of Opendpp UAB. Per Section 6 of the Apache License,
+Version 2.0, this license does not grant permission to use the "OpenDPP" trade
+names, trademarks, service marks, or product names. Forks may rebuild and
+redistribute this code but must adopt a different name and may not represent
+themselves as "OpenDPP" or as "OpenDPP-conformant".
+Trademark policy: https://github.com/OpenDPP/opendpp-interop

package/README.md

@@ -0,0 +1,107 @@
+# @opendpp/webhooks
+
+Typed **webhook event names + envelope shape** for the
+[OpenDPP](https://opendpp-node.eu) Digital Product Passport service, plus a
+zero-dependency, **constant-time HMAC-SHA256 signature verifier** so you can
+trust an inbound webhook before acting on it (ESM, Node ≥ 26).
+
+> Part of the OpenDPP **open client** surface (Apache-2.0). The hosted node —
+> delivery, retries, the per-subscription secret, resolver, eIDAS sealing, 15-year
+> persistence — stays a service you call. See
+> [`opendpp-interop`](https://github.com/OpenDPP/opendpp-interop).
+
+## Install
+
+```sh
+npm install @opendpp/webhooks
+```
+
+## Verify an inbound webhook
+
+Verify over the **raw request body** — re-serialising a parsed object changes key
+order/whitespace and breaks the HMAC. Example with Express:
+
+```ts
+import express from "express";
+import { verifyWebhookRequest, parseWebhookEnvelope } from "@opendpp/webhooks";
+
+const app = express();
+
+app.post(
+  "/webhooks/opendpp",
+  express.raw({ type: "application/json" }), // keep the raw body
+  (req, res) => {
+    const rawBody = req.body.toString("utf8");
+    const ok = verifyWebhookRequest(rawBody, {
+      get: (name) => req.header(name) ?? null,
+    }, process.env.OPENDPP_WEBHOOK_SECRET!);
+
+    if (!ok) return res.sendStatus(401);
+
+    const event = parseWebhookEnvelope(rawBody); // typed { id, type, created, data }
+    // dedupe on event.id (stable across retries), then handle event.type …
+    res.sendStatus(200); // return 2xx within ~5s or it counts as failed
+  },
+);
+```
+
+`verifyWebhookSignature({ payload, signature, secret, timestamp })` is the
+lower-level primitive if you extract the headers yourself.
+
+## The signing recipe
+
+The signature OpenDPP sends in `X-OpenDPP-Signature` is:
+
+```
+HMAC_SHA256( secret, `${timestamp}.${rawBody}` )   // hex, lowercase
+```
+
+- `secret` — the full `whsec_…` per-subscription secret (returned once at create /
+  rotate-secret; format `whsec_` + 32 lowercase hex chars).
+- `timestamp` — the `X-OpenDPP-Timestamp` header (unix seconds), prefixed into the
+  signed content as a replay defence.
+- `rawBody` — the exact JSON request body.
+
+Reject a delivery whose timestamp is more than ~5 minutes from now (the verifier
+does this by default, `toleranceSeconds: 300`). Delivery is **at-least-once** with
+up to 5 retries (exponential backoff) — **dedupe on `X-OpenDPP-Delivery`** (the
+envelope `id`), which is stable across retries.
+
+## Events
+
+`passport.ingested` · `passport.updated` · `passport.sealed` · `passport.recalled`
+· `passport.status_updated`. Envelope: `{ id, type, created, data }`, where `data`
+is the public redacted JSON-LD passport document. Exported as
+`OPENDPP_WEBHOOK_EVENT_TYPES`, `OpenDppWebhookEventType`, and
+`OpenDppWebhookEnvelope<TData>`.
+
+## Python reference receiver
+
+The recipe is trivially portable — verify with the standard library:
+
+```python
+import hashlib
+import hmac
+import time
+
+def verify_opendpp_webhook(raw_body: str, signature: str, timestamp: str,
+                           secret: str, tolerance_seconds: int = 300) -> bool:
+    if tolerance_seconds > 0 and abs(time.time() - int(timestamp)) > tolerance_seconds:
+        return False
+    expected = hmac.new(
+        secret.encode(), f"{timestamp}.{raw_body}".encode(), hashlib.sha256
+    ).hexdigest()
+    return hmac.compare_digest(expected, signature)
+```
+
+```python
+# Flask:
+#   raw = request.get_data(as_text=True)
+#   ok = verify_opendpp_webhook(raw, request.headers["X-OpenDPP-Signature"],
+#                               request.headers["X-OpenDPP-Timestamp"], SECRET)
+```
+
+## License
+
+[Apache-2.0](./LICENSE) © Opendpp UAB. See [`NOTICE`](./NOTICE). "OpenDPP" is a
+trademark of Opendpp UAB; this license grants no rights to the marks.

package/dist/index.d.ts

@@ -0,0 +1,110 @@
+/**
+ * @opendpp/webhooks — OpenDPP webhook event types + HMAC-verify reference receiver
+ *
+ * Typed event names + the signed-envelope shape OpenDPP delivers, plus a constant-time
+ * HMAC-SHA256 signature verifier so an integrator can trust an inbound webhook. Pure ESM,
+ * Node >=26, zero runtime dependencies (uses only the built-in `node:crypto`).
+ *
+ * This is a fresh reference implementation derived from the public webhook contract
+ * (openapi.json `webhooks` + the documented signing scheme) — NOT a lift of the hosted
+ * node's delivery internals. The hosted node remains authoritative for delivery,
+ * retries, and the per-subscription secret.
+ *
+ * SIGNING RECIPE (must match the server byte-for-byte): the signature is
+ * `HMAC-SHA256(secret, `${timestamp}.${rawBody}`)` hex-encoded (lowercase), where
+ * `secret` is the full `whsec_…` per-subscription value, `timestamp` is the
+ * `X-OpenDPP-Timestamp` header (unix seconds), and `rawBody` is the EXACT request body
+ * string. Verify over the raw body — re-serialising a parsed object changes key order /
+ * whitespace and breaks the HMAC.
+ *
+ * Copyright (c) Opendpp UAB.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * 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.
+ *
+ * "OpenDPP" is a trademark of Opendpp UAB; the Apache-2.0 license grants no rights to the marks.
+ */
+/** The webhook event types OpenDPP delivers (the `type` field + the `X-OpenDPP-Event` header). */
+export declare const OPENDPP_WEBHOOK_EVENT_TYPES: readonly ["passport.ingested", "passport.updated", "passport.sealed", "passport.recalled", "passport.status_updated"];
+export type OpenDppWebhookEventType = (typeof OPENDPP_WEBHOOK_EVENT_TYPES)[number];
+/** A subscription event filter — a specific event type, or `"*"` for all events. */
+export type OpenDppWebhookEventFilter = OpenDppWebhookEventType | "*";
+/**
+ * The signed webhook envelope OpenDPP POSTs to a subscription URL. `id` is the stable delivery id
+ * (constant across retries — dedupe on it), `type` is the event, `created` is an ISO-8601 timestamp,
+ * and `data` is the public redacted JSON-LD passport document.
+ */
+export interface OpenDppWebhookEnvelope<TData = unknown> {
+    id: string;
+    type: OpenDppWebhookEventType;
+    created: string;
+    data: TData;
+}
+/** The OpenDPP webhook header names (case-insensitive on the wire). */
+export declare const OPENDPP_WEBHOOK_HEADERS: {
+    /** Event type, for routing. */
+    readonly event: "X-OpenDPP-Event";
+    /** Stable delivery id (= envelope `id`); dedupe on this for at-least-once delivery. */
+    readonly delivery: "X-OpenDPP-Delivery";
+    /** Unix-seconds timestamp; prefixed into the signed content (replay defence). */
+    readonly timestamp: "X-OpenDPP-Timestamp";
+    /** Lowercase-hex HMAC-SHA256 signature. */
+    readonly signature: "X-OpenDPP-Signature";
+};
+/** The per-subscription secret format: `whsec_` + 32 lowercase hex chars. */
+export declare const WEBHOOK_SECRET_PATTERN: RegExp;
+/** Type guard for a known OpenDPP webhook event type. */
+export declare function isOpenDppWebhookEventType(value: unknown): value is OpenDppWebhookEventType;
+export interface VerifyWebhookSignatureOptions {
+    /** The RAW request body string, exactly as received. Do NOT re-stringify a parsed object. */
+    payload: string;
+    /** The `X-OpenDPP-Signature` header value (lowercase-hex HMAC-SHA256). */
+    signature: string;
+    /** The full per-subscription secret (the `whsec_…` value returned once at create / rotate). */
+    secret: string;
+    /** The `X-OpenDPP-Timestamp` header value (unix seconds). */
+    timestamp: string | number;
+    /** Max accepted clock skew in seconds for the replay check (default 300 = 5 min; 0 disables it). */
+    toleranceSeconds?: number;
+    /** Current unix-seconds time; injectable for deterministic tests (default `Date.now()/1000`). */
+    nowSeconds?: number;
+}
+/**
+ * Verifies an OpenDPP webhook signature in constant time, and (unless disabled) rejects a stale
+ * timestamp outside the tolerance window. Returns `true` only when the HMAC matches AND the timestamp
+ * is fresh. The signed content is `${timestamp}.${payload}` and the HMAC is keyed with the full secret.
+ *
+ * The hosted node re-mints a fresh `(timestamp, signature)` pair on every retry, so a retried delivery
+ * always carries a valid pair; dedupe on `X-OpenDPP-Delivery` (the envelope `id`).
+ */
+export declare function verifyWebhookSignature(options: VerifyWebhookSignatureOptions): boolean;
+/** A minimal headers reader — satisfied by the Fetch `Headers` object and most framework header bags. */
+export interface WebhookHeaderReader {
+    get(name: string): string | null | undefined;
+}
+export interface VerifyWebhookRequestOptions {
+    /** Max accepted clock skew in seconds (default 300 = 5 min; 0 disables the replay check). */
+    toleranceSeconds?: number;
+    /** Current unix-seconds time; injectable for deterministic tests. */
+    nowSeconds?: number;
+}
+/**
+ * Convenience over {@link verifyWebhookSignature}: reads the signature + timestamp headers off a
+ * Fetch-style `Headers` object (or anything with a `get(name)` method) and verifies the raw body.
+ */
+export declare function verifyWebhookRequest(rawBody: string, headers: WebhookHeaderReader, secret: string, options?: VerifyWebhookRequestOptions): boolean;
+/**
+ * Parses a verified raw body into a typed envelope. Call this AFTER {@link verifyWebhookSignature} /
+ * {@link verifyWebhookRequest} — it does no verification itself. Throws if the body is not a
+ * well-formed OpenDPP envelope.
+ */
+export declare function parseWebhookEnvelope<TData = unknown>(rawBody: string): OpenDppWebhookEnvelope<TData>;

package/dist/index.js

@@ -0,0 +1,125 @@
+/**
+ * @opendpp/webhooks — OpenDPP webhook event types + HMAC-verify reference receiver
+ *
+ * Typed event names + the signed-envelope shape OpenDPP delivers, plus a constant-time
+ * HMAC-SHA256 signature verifier so an integrator can trust an inbound webhook. Pure ESM,
+ * Node >=26, zero runtime dependencies (uses only the built-in `node:crypto`).
+ *
+ * This is a fresh reference implementation derived from the public webhook contract
+ * (openapi.json `webhooks` + the documented signing scheme) — NOT a lift of the hosted
+ * node's delivery internals. The hosted node remains authoritative for delivery,
+ * retries, and the per-subscription secret.
+ *
+ * SIGNING RECIPE (must match the server byte-for-byte): the signature is
+ * `HMAC-SHA256(secret, `${timestamp}.${rawBody}`)` hex-encoded (lowercase), where
+ * `secret` is the full `whsec_…` per-subscription value, `timestamp` is the
+ * `X-OpenDPP-Timestamp` header (unix seconds), and `rawBody` is the EXACT request body
+ * string. Verify over the raw body — re-serialising a parsed object changes key order /
+ * whitespace and breaks the HMAC.
+ *
+ * Copyright (c) Opendpp UAB.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * 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.
+ *
+ * "OpenDPP" is a trademark of Opendpp UAB; the Apache-2.0 license grants no rights to the marks.
+ */
+import { createHmac, timingSafeEqual } from "node:crypto";
+/** The webhook event types OpenDPP delivers (the `type` field + the `X-OpenDPP-Event` header). */
+export const OPENDPP_WEBHOOK_EVENT_TYPES = [
+    "passport.ingested",
+    "passport.updated",
+    "passport.sealed",
+    "passport.recalled",
+    "passport.status_updated",
+];
+/** The OpenDPP webhook header names (case-insensitive on the wire). */
+export const OPENDPP_WEBHOOK_HEADERS = {
+    /** Event type, for routing. */
+    event: "X-OpenDPP-Event",
+    /** Stable delivery id (= envelope `id`); dedupe on this for at-least-once delivery. */
+    delivery: "X-OpenDPP-Delivery",
+    /** Unix-seconds timestamp; prefixed into the signed content (replay defence). */
+    timestamp: "X-OpenDPP-Timestamp",
+    /** Lowercase-hex HMAC-SHA256 signature. */
+    signature: "X-OpenDPP-Signature",
+};
+/** The per-subscription secret format: `whsec_` + 32 lowercase hex chars. */
+export const WEBHOOK_SECRET_PATTERN = /^whsec_[0-9a-f]{32}$/;
+/** Type guard for a known OpenDPP webhook event type. */
+export function isOpenDppWebhookEventType(value) {
+    return typeof value === "string" && OPENDPP_WEBHOOK_EVENT_TYPES.includes(value);
+}
+/**
+ * Verifies an OpenDPP webhook signature in constant time, and (unless disabled) rejects a stale
+ * timestamp outside the tolerance window. Returns `true` only when the HMAC matches AND the timestamp
+ * is fresh. The signed content is `${timestamp}.${payload}` and the HMAC is keyed with the full secret.
+ *
+ * The hosted node re-mints a fresh `(timestamp, signature)` pair on every retry, so a retried delivery
+ * always carries a valid pair; dedupe on `X-OpenDPP-Delivery` (the envelope `id`).
+ */
+export function verifyWebhookSignature(options) {
+    const { payload, signature, secret, timestamp } = options;
+    if (typeof payload !== "string" || typeof signature !== "string" || typeof secret !== "string") {
+        return false;
+    }
+    if (signature.length === 0)
+        return false;
+    const toleranceSeconds = options.toleranceSeconds ?? 300;
+    if (toleranceSeconds > 0) {
+        const ts = Number(timestamp);
+        if (!Number.isFinite(ts))
+            return false;
+        const now = options.nowSeconds ?? Math.floor(Date.now() / 1000);
+        if (Math.abs(now - ts) > toleranceSeconds)
+            return false;
+    }
+    const expected = createHmac("sha256", secret).update(`${timestamp}.${payload}`).digest("hex");
+    const provided = Buffer.from(signature, "utf8");
+    const computed = Buffer.from(expected, "utf8");
+    // timingSafeEqual throws on a length mismatch — guard first; a different length is a non-match anyway.
+    if (provided.length !== computed.length)
+        return false;
+    return timingSafeEqual(provided, computed);
+}
+/**
+ * Convenience over {@link verifyWebhookSignature}: reads the signature + timestamp headers off a
+ * Fetch-style `Headers` object (or anything with a `get(name)` method) and verifies the raw body.
+ */
+export function verifyWebhookRequest(rawBody, headers, secret, options = {}) {
+    const signature = headers.get(OPENDPP_WEBHOOK_HEADERS.signature) ?? "";
+    const timestamp = headers.get(OPENDPP_WEBHOOK_HEADERS.timestamp) ?? "";
+    return verifyWebhookSignature({
+        payload: rawBody,
+        signature,
+        secret,
+        timestamp,
+        toleranceSeconds: options.toleranceSeconds,
+        nowSeconds: options.nowSeconds,
+    });
+}
+/**
+ * Parses a verified raw body into a typed envelope. Call this AFTER {@link verifyWebhookSignature} /
+ * {@link verifyWebhookRequest} — it does no verification itself. Throws if the body is not a
+ * well-formed OpenDPP envelope.
+ */
+export function parseWebhookEnvelope(rawBody) {
+    const value = JSON.parse(rawBody);
+    if (typeof value !== "object" ||
+        value === null ||
+        typeof value.id !== "string" ||
+        typeof value.created !== "string" ||
+        !isOpenDppWebhookEventType(value.type)) {
+        throw new Error("Not a well-formed OpenDPP webhook envelope.");
+    }
+    return value;
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@opendpp/webhooks",
+  "version": "0.1.0",
+  "description": "OpenDPP webhook event types + a zero-dependency, constant-time HMAC-SHA256 signature verifier for inbound OpenDPP webhooks (ESM, Node >=26).",
+  "keywords": [
+    "opendpp",
+    "dpp",
+    "digital-product-passport",
+    "webhooks",
+    "hmac",
+    "signature",
+    "webhook-verification",
+    "esm"
+  ],
+  "license": "Apache-2.0",
+  "author": "Giovanni Savastano <giovanni.savastano@opendpp-node.eu>",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "LICENSE",
+    "NOTICE",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=26"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OpenDPP/opendpp-interop.git",
+    "directory": "packages/webhooks"
+  },
+  "homepage": "https://github.com/OpenDPP/opendpp-interop#readme",
+  "bugs": {
+    "url": "https://github.com/OpenDPP/opendpp-interop/issues"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "node --test --import tsx 'test/*.test.ts'",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@types/node": "^26.0.0",
+    "tsx": "^4.22.4",
+    "typescript": "^6.0.3"
+  }
+}