@dnsid-ai/sdk 0.20.1

package/LICENSE

@@ -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 {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/README.md

@@ -0,0 +1,121 @@
+# @dnsid-ai/sdk
+
+Ergonomic aggregate package for DNSid TypeScript consumers.
+
+The root `@dnsid-ai/sdk` entrypoint is runtime-neutral: callers inject DNS resolution, JSON fetching, key-provider, cache, and log implementations. Node.js defaults live behind the `@dnsid-ai/sdk/node` subpath and optional `@dnsid-ai/transport` peer.
+
+## Package layout
+
+- **Root export (`@dnsid-ai/sdk`)** — runtime-neutral. No Node built-ins, `Buffer`, filesystem, or `undici` imports; you inject `dnsResolver`, `fetchJson`, and key providers. Safe to bundle for browsers and other non-Node runtimes. Its managed C2SP workflows use the portable writer-only binding entrypoint.
+- **`@dnsid-ai/sdk/node` subpath** — Node conveniences: `LocalKeyProvider`, `configFromEnvironment`, `createNodeIdentityManager`, `createNodeIdentityManagerFromDnsid`. Loads the optional `@dnsid-ai/transport` peer when HTTPS defaults are needed.
+- **OIDC lives in `@dnsid-ai/oidc`** — deliberately not re-exported from the root because its default transport is Node-bound, and private-key token minting belongs server-side. Import it directly.
+
+## Install
+
+```sh
+npm install @dnsid-ai/sdk
+```
+
+For Node defaults:
+
+```sh
+npm install @dnsid-ai/sdk @dnsid-ai/transport
+```
+
+## Runtime-neutral usage
+
+```ts
+import { createIdentityManager } from '@dnsid-ai/sdk';
+
+const idm = createIdentityManager({ identity, verification }, {
+  keyProvider,       // operational ku key
+  entityKeyProvider, // accountable-entity ek key
+  dnsResolver,
+  fetchJson,
+});
+```
+
+For verification-only use, no local identity configuration or key provider is needed:
+
+```ts
+import { createIdentityVerifier } from '@dnsid-ai/sdk';
+
+const verifier = createIdentityVerifier(
+  { verification: { trustedEntities: [{ governanceId: 'acme.example' }] } },
+  { dnsResolver, fetchJson, logRegistry },
+);
+const verified = await verifier.verifyDomain('agent.example.com');
+```
+
+JOSE, HTTP Message Signature, and OIDC profiles may use this verifier as their
+`identityResolver` while omitting `keyProvider`. Their signing or minting methods
+then fail with `ArgumentError`.
+
+### Registry-managed C2SP key rotation
+
+`rotateManagedOperationalKey()` composes the registry client, C2SP prepared-event
+binding, and operational `KeyProvider`. It validates and signs the registry's
+prepared bytes, then activates the pending key only after the registry accepts
+those exact bytes. This does not change the generic/self-managed
+`IdentityManager.rotateOperationalKey()` workflow.
+
+If the result is pending, or `ManagedKeyRotationSubmissionError` reports
+`retryWithSameBytes`, persist its rotation state, pause new application signing,
+and call `resumeManagedOperationalKeyRotation()` with that exact state. Do not
+generate a replacement event or idempotency key.
+
+If `ManagedKeyRotationActivationError` is raised, registry acceptance succeeded
+but local key-state reconciliation is incomplete. Resume with the error's exact
+rotation state; already-completed activation or supersession is not repeated.
+
+## Node.js convenience usage
+
+```ts
+import { configFromEnvironment, createNodeIdentityManager, LocalKeyProvider } from '@dnsid-ai/sdk/node';
+
+const { config, keyStorePath } = configFromEnvironment();
+const keyProvider = await LocalKeyProvider.load(keyStorePath ?? '.dnsid/keys.json', true);
+const entityKeyProvider = await LocalKeyProvider.load('.dnsid/entity.keys.json', true);
+const idm = await createNodeIdentityManager(config, { keyProvider, entityKeyProvider });
+```
+
+`config.transport.dnsServer`/`caBundlePath` configure only the SDK-managed default resolver and
+fetcher; a setting is rejected when every dependency it would configure is injected.
+
+`LocalKeyProvider.load(path)` loads an existing store; pass `true` to create one when missing.
+Use only one provider instance/process per store; mutations within that instance are serialized.
+Persistence uses flushed, mode-0600 sibling files and atomic replacement, keeping the previous
+successful generation at `<path>.bak`. Existing symlinks are resolved at load time; mutations and
+backups use the resolved target path without replacing the link. The filesystem must support atomic rename, hard links,
+and directory fsync. Protect and exclude the store, backup, and sibling `*.tmp` files from source
+control; backups and crash-leftover temp files contain private keys. This is not an off-host backup.
+If a mutation fails before replacement, the live store and in-memory keys are unchanged. A directory
+fsync failure after replacement is reported, but memory follows the now-visible file; inspect it
+before retrying. Recovery is manual: stop all users of the store, preserve both files, and validate
+the backup against the registry/log state before restoring it. A backup can predate key activation
+or contain a superseded key; it is never automatically loaded.
+For `dnsid-draft-01` publishing, set `DNSID_EK_URL` to the accountable-entity JWKS URL and `DNSID_KU_URL` to the operational JWKS URL.
+The Node helper uses the system or configured DNS resolver by default. It reports `UNKNOWN`, which the default `auto` policy permits and preserves. Inject a DNSSEC-aware resolver for `validated` or `required` policy.
+
+If the registry CLI has already written `~/.dnsid/config.json` and `~/.dnsid/<fqdn>/private.jwk`:
+
+```ts
+import { createNodeIdentityManagerFromDnsid } from '@dnsid-ai/sdk/node';
+
+const idm = await createNodeIdentityManagerFromDnsid();
+```
+
+DNSSEC modes are: `auto` (default), which rejects `FAILED` and permits `VALID`, `UNSIGNED`, or `UNKNOWN`; `validated`, which permits `VALID` or `UNSIGNED`; and `required`, which permits only `VALID`.
+
+## Included surfaces
+
+`@dnsid-ai/sdk` re-exports the common core and profile surfaces and namespaces:
+
+- `@dnsid-ai/protocol`
+- `@dnsid-ai/jose`
+- `@dnsid-ai/http-signatures`
+- `@dnsid-ai/registry`
+
+Use DNSid OIDC token minting and verification through `@dnsid-ai/oidc`. It is intentionally not re-exported here because its default transport is Node-bound; private-key token minting belongs in server-side code, not browser/client code.
+
+Use lower-level packages directly when you need narrower dependencies or custom composition.