@aws/dogwood-wasm 0.0.0-placeholder.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,2 @@
+Dogwood
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

package/README.md

@@ -1 +1,218 @@
-# @aws/dogwood-wasm (placeholder) — see https://github.com/dogwood-policy/dogwood-wasm
+# Dogwood — TypeScript / WebAssembly Bindings
+
+Typed WASM bindings for [Dogwood](https://github.com/dogwood-policy/dogwood), the Cedar-derived governance language for AI agents (temporal conditions + information providers).
+
+Two shapes are exposed:
+
+- **Batch operations** (`validate`, `lower`, `replay`, `explain`, schema checks) — source strings in, typed report objects out. For policy authoring, CI, and tooling.
+- **Live authorizer** (`DogwoodAuthorizer`) — lower once, feed events as they happen, get a decision per event with temporal history accumulating across calls. For agent gateways, MCP proxies, and anything deciding in real time.
+
+The bindings wrap the same public surface of `dogwood-language` that the CLI drives. `ops.rs` and `error.rs` are copies of `dogwood-cli`'s, plus wasm-only additions (`Tsify` derives, and blocks marked `// wasm-only`). CI checks the copies against the pinned upstream release on every push, and against upstream `main` weekly — see [Syncing with dogwood-cli](#syncing-with-dogwood-cli).
+
+## Layout
+
+```
+dogwood-wasm/
+├── src/
+│   ├── lib.rs          # wasm-bindgen surface (batch ops + error projection)
+│   ├── live.rs         # stateful DogwoodAuthorizer class
+│   ├── ops.rs          # frontend operations (copied from dogwood-cli)
+│   ├── error.rs        # miette → structured diagnostic (copied from dogwood-cli)
+│   ├── fail_closed.rs  # deny-on-evaluation-error rule shared by replay and live
+│   └── providers.rs    # wasm-specific guard on provider declarations
+├── scripts/
+│   ├── check-cli-sync.sh  # diff ops.rs/error.rs against upstream dogwood-cli
+│   ├── prepare-release.sh # pre-publish checks on pkg/ (run by the release workflow)
+│   └── third-party-notices.sh # THIRD-PARTY-NOTICES for the npm package (cargo-about)
+├── pkg/                # generated by `npm run build` (git-ignored)
+├── test.cjs            # batch-operation smoke tests
+├── test-live.cjs       # live-authorizer semantics (parity with replay)
+├── test-coverage.cjs   # full surface coverage (every function, field, error path)
+├── example.ts          # strict-mode type-check of the generated .d.ts
+├── package.json        # build / test / typecheck scripts
+├── RELEASING.md        # npm publishing setup and release procedure
+└── .github/workflows/  # ci (build, tests, audits), dogwood-cli sync, release
+```
+
+## Build
+
+Requires Rust ≥ 1.85 (edition 2024), the wasm target, `wasm-pack`, and Node ≥ 16.
+
+```bash
+rustup target add wasm32-unknown-unknown
+cargo install wasm-pack
+
+git clone https://github.com/dogwood-policy/dogwood-wasm.git
+cd dogwood-wasm
+npm run build                   # → pkg/ (Node/CommonJS target, uses wasm-pack)
+npm install && npm run verify   # runtime tests + tsc --strict typecheck
+```
+
+Other targets: `npm run build:bundler` (Vite/webpack, ESM) and `npm run build:web` (no bundler).
+
+`npm run build:dev` is an unoptimized debug build with the `dev` feature, which logs Rust panic messages to `console.error`. Release builds leave the panic hook out, because a panic message can contain policy or event data.
+
+## Batch Operations
+
+All take source strings and return typed report objects. Fatal errors are thrown as `DogwoodError`; non-fatal findings come back in the report.
+
+| Function | Purpose | Returns |
+|---|---|---|
+| `checkParse(src, …)` | parse + macro-expand | `CheckParseReport` |
+| `validate(src, actionSchema, …)` | lower + type-check | `ValidateReport` |
+| `lower(src, actionSchema, …)` | emit Cedar artifacts | `LowerArtifacts` |
+| `replay(src, actionSchema, log, …)` | lower + replay a `.log` trace | `ReplayReport` |
+| `explain(src, actionSchema?, …)` | informalize rules into semi-English | `ExplainReport` |
+| `checkActionSchema(src)` | validate a `.cedarschema` | `SchemaCheckReport` |
+| `checkEventSchema(src)` | validate a `.dwschema` | `SchemaCheckReport` |
+| `checkProviders(json)` | validate a `providers.json` | `SchemaCheckReport` |
+| `mcpToCedarSchema(json)` | MCP `tools/list` → Cedar action schema | `string` |
+
+The trailing `eventSchema? / providers? / macros?` arguments are optional service-schema overrides. Omit for defaults.
+
+```js
+const dw = require("./pkg/dogwood_wasm.js");
+
+const actionSchema = `namespace Drupe {
+  entity User; entity Gateway;
+  action "Read" appliesTo {
+    principal: [User], resource: [Gateway],
+    context: { input: { document: String, user: String } }
+  };
+}`;
+
+const policy = `permit(principal, action == Drupe::Action::"Read", resource)
+when { context.input.document like "*report*" };`;
+
+const report = dw.validate(policy, actionSchema);
+console.log(report.passed); // true
+```
+
+## Live Authorizer
+
+```js
+const auth = new dw.DogwoodAuthorizer(policy, actionSchema);
+
+const decision = auth.isAuthorized({
+  action: "Drupe::Action::Read",
+  kind: "request",
+  timestamp: Math.floor(Date.now() / 1000),
+  principal: { type: "Drupe::User", id: "alice" },
+  resource:  { type: "Drupe::Gateway", id: "gw1" },
+  logged:  { input: { document: "quarterly report", user: "alice" } },
+  context: { input: { document: "quarterly report", user: "alice" } },
+  entities: [{ type: "Drupe::User", id: "alice", attrs: { dept: "eng" } }],
+});
+
+if (!decision.allowed) throw new Error("denied");
+```
+
+History-only events (anything other than `kind: "request"` by default) return `undefined` — they update temporal state but yield no verdict.
+
+### Key Semantics
+
+- **Timestamps are seconds**, not milliseconds. A `within 1h` window is 3600. Passing `Date.now()` raw inflates every window by 1000×.
+- **`logged` and `context` are distinct.** `logged` is the durable temporal record; `context` is the ephemeral Cedar request bag. A field both need (typically `input`) must appear in both.
+- **Entity references are structured** (`{ type, id }`), never string literals. The id is escaped exactly once — no double-escaping footgun.
+- **Any evaluation error is a deny.** Cedar skips a rule whose condition errors (for example, a context argument of the wrong type, or a missing one) and decides from the remaining rules, so an errored `forbid` could otherwise let a `permit` through. The authorizer returns `allowed: false` whenever `errors` is non-empty, and `replay` applies the same rule to every verdict, so a deny with errors is a fail-closed evaluation failure, not "policy said no."
+
+### Input Validation
+
+The authorizer rejects (without observing into history):
+
+| Rejected | Why |
+|---|---|
+| Unknown action | Would silently deny with empty `errors`, indistinguishable from "policy said no" |
+| Unknown kind | Would return `undefined` forever — nothing is ever authorized |
+| Backwards timestamp | Would silently produce wrong temporal answers |
+| Interior `::` in action id | Would resolve to nothing via the `::` split |
+| Oversized event (see below) | Would overflow the wasm stack and leave the module unusable |
+
+#### Input limits
+
+Event data usually comes from a model's tool arguments, so its size and shape are untrusted. Each limit is checked before any recursive code sees the event, and an event over a limit throws a `DogwoodError` rather than being decided:
+
+| Limit | Value |
+|---|---|
+| Nesting depth of a value, counting each `context` / `logged` group (`context.input`) or entity attribute as level 0 | 128 levels, the same limit `replay` applies to `.log` values |
+| Values in one event (scalars, arrays and objects at any depth) | 100,000 |
+| Total length of all strings in one event, object keys included | 16 Mi characters (`string.length` units) |
+
+`mcpToCedarSchema` rejects a manifest over 4 MiB or nested deeper than 128 levels.
+
+A thrown `isAuthorized` call means **no decision**. The host must treat it as a deny.
+
+#### If a call traps
+
+A `WebAssembly.RuntimeError` (for example out-of-memory) is not a `DogwoodError`. It means the wasm module itself is in an undefined state, not just one instance: every later call into the module, on any `DogwoodAuthorizer`, may fail or trap. Deny the current request, stop using the module, and restart the process or worker that loaded it. The input limits above exist so that event data cannot cause a trap.
+
+Introspection getters (`actions`, `eventKinds`, `decisionKinds`, `lastTimestamp`) let a host verify its wiring at startup.
+
+### Lifecycle
+
+`DogwoodAuthorizer` owns wasm-heap memory that GC does not reclaim. Free it explicitly:
+
+```ts
+const auth = new DogwoodAuthorizer(policy, actionSchema);
+try { /* … */ } finally { auth.free(); }
+
+// or with explicit resource management (TS ≥ 5.2):
+using auth = new DogwoodAuthorizer(policy, actionSchema);
+```
+
+`reset()` drops accumulated history and re-lowers the same sources. `decisionCount` tracks decisions returned.
+
+Temporal history is never pruned: every event is kept until `reset()` or `free()` (on the order of 1.6 KB per event). Use one instance per session or per principal, and `reset()` or replace it when the session ends, so history does not grow without limit.
+
+## Errors
+
+Fatal failures throw a `DogwoodError` with structured `.diagnostic`:
+
+```ts
+import { validate, type DogwoodError } from "./pkg/dogwood_wasm.js";
+
+try {
+  validate("permit(", actionSchema);
+} catch (e) {
+  const err = e as DogwoodError;
+  // err.diagnostic: { message, severity, code?, labels[], help?, related? }
+}
+```
+
+Byte offsets in `labels` index the source string you passed in.
+
+## Information Providers
+
+Rhai providers work — the interpreter compiles to wasm. But the script must be **inline** (`implementation.script`). A `scriptFile` reference is rejected up front with an actionable error, because `wasm32-unknown-unknown` has no filesystem and an unresolvable reference would silently fail closed at authorize time.
+
+## Testing
+
+`npm run verify` runs 89 assertions across three suites plus `tsc --strict`.
+
+| Suite | Coverage |
+|---|---|
+| `test.cjs` | Smoke: does each batch operation work? |
+| `test-live.cjs` | Replay-parity: does the live authorizer produce identical verdicts to `replay` on the same scenario? |
+| `test-coverage.cjs` | Every exported function, field, optional argument, error path, and value-conversion branch |
+
+## Syncing with dogwood-cli
+
+`scripts/check-cli-sync.sh [REF]` strips the wasm-only additions from `src/ops.rs` and `src/error.rs` and diffs the rest against `dogwood-cli/src/` at `REF` in [dogwood-policy/dogwood](https://github.com/dogwood-policy/dogwood). `REF` defaults to `PINNED_REF` in the script, which must match the `dogwood-language` version in `Cargo.lock` (the script checks this).
+
+To take a new upstream release:
+
+1. Bump `dogwood-language` in `Cargo.toml` (`cargo update -p dogwood-language`) and `PINNED_REF` in the script.
+2. Run `scripts/check-cli-sync.sh` and apply the upstream changes it shows, keeping the `Tsify` derives and the `// wasm-only` blocks.
+3. Expose any new operation in `src/lib.rs`, then `npm run build && npm run verify`.
+
+## Limitations
+
+- Dogwood is a **reference interpreter, not for production**; these bindings inherit that.
+- The `net` feature (HTTP providers) is off — cannot work in wasm.
+- **Temporal history is never pruned.** Growth is ~1.6 KB/event with no plateau. Long-lived instances must `reset()` periodically or cap their lifetime.
+- The live authorizer's input checks do **not** apply to `replay` (which uses the frontend's internal parser). A bare action id or backwards timestamps in a `.log` trace pass through unremarked.
+- Module size is **~8.7 MB** (~2.6 MB gzipped). Cedar, Rhai, and the parser dominate.
+
+## Contributing, security, and license
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). To report a security issue, follow [SECURITY.md](SECURITY.md) rather than opening a public issue. Releases are published to npm by CI only; see [RELEASING.md](RELEASING.md). Licensed under [Apache-2.0](LICENSE); see [NOTICE](NOTICE).