@messh/sdk 0.0.0-stage → 0.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/README.md

@@ -1,3 +1,44 @@
-# Temporary Holding Version
+# @messh/sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Sign and verify HTTP requests as a [messh](https://messh.io) identity with **Web Bot Auth**: RFC 9421 HTTP Message Signatures, Ed25519, `tag="web-bot-auth"`. No runtime dependencies; Node 20+.
+
+```sh
+npm install @messh/sdk
+```
+
+## Sign (agent)
+
+```ts
+import { MesshClient, keyFile } from "@messh/sdk";
+
+const client = await MesshClient.create({ identity: "mukul", key: keyFile("~/.ssh/id_ed25519") });
+await client.fetch("https://api.example.com/deploy", { method: "POST", body: JSON.stringify({ env: "staging" }) });
+```
+
+Use the ssh-ed25519 key you published with `messh publish`. The private key never leaves your machine.
+
+## Agents and CI
+
+Configure it with environment variables instead of code: `MESSH_IDENTITY`, `MESSH_KEY` (PEM, or base64 of PEM or PKCS#8 DER) or `MESSH_KEY_FILE`, and `MESSH_REGISTRY`. `whoami` checks the key is published, so a missing `messh publish` fails at startup with `not_published` instead of every API answering 401.
+
+```ts
+const client = await MesshClient.fromEnv();
+const me = await client.whoami(); // { identity, keyName, keyId, fingerprint, agentUrl }
+```
+
+Passphrase-protected key? Load it into ssh-agent (`ssh-add`) and pass `key: sshAgent()`.
+
+## Verify (API)
+
+```ts
+import { messhAuth, Verifier } from "@messh/sdk/verify";
+
+app.use("/api", messhAuth({ trust: ["mukul"] }));    // Express: mount before express.json(); then req.agent
+
+const verifier = new Verifier({ trust: ["mukul"] }); // fetch-style runtimes (Workers, Hono, Next.js)
+const agent = await verifier.verifyRequest(request);
+```
+
+Full reference (every function, input and error code): https://github.com/messhio/messh/blob/main/sdk/README.md
+
+License: Apache-2.0

package/dist/errors.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Client-side error: invalid_identity, invalid_key, invalid_option,
+ * sign_failed; from whoami(): not_published, registry_unreachable.
+ */
+export declare class MesshError extends Error {
+    readonly code: string;
+    constructor(code: string, message: string);
+}
+/**
+ * Verification failure. Codes follow the messh spec: missing_signature,
+ * bad_signature, digest_mismatch, clock_skew, nonce_replayed, unknown_key
+ * (401); untrusted (403); body_too_large (413).
+ */
+export declare class VerifyError extends Error {
+    readonly code: string;
+    readonly detail: string;
+    readonly status: number;
+    constructor(code: string, detail: string, status?: number);
+    toJSON(): {
+        error: string;
+        message: string;
+    };
+}

package/dist/errors.js

@@ -0,0 +1,32 @@
+/**
+ * Client-side error: invalid_identity, invalid_key, invalid_option,
+ * sign_failed; from whoami(): not_published, registry_unreachable.
+ */
+export class MesshError extends Error {
+    code;
+    constructor(code, message) {
+        super(`${code}: ${message}`);
+        this.code = code;
+        this.name = "MesshError";
+    }
+}
+/**
+ * Verification failure. Codes follow the messh spec: missing_signature,
+ * bad_signature, digest_mismatch, clock_skew, nonce_replayed, unknown_key
+ * (401); untrusted (403); body_too_large (413).
+ */
+export class VerifyError extends Error {
+    code;
+    detail;
+    status;
+    constructor(code, detail, status = 401) {
+        super(`${code}: ${detail}`);
+        this.code = code;
+        this.detail = detail;
+        this.status = status;
+        this.name = "VerifyError";
+    }
+    toJSON() {
+        return { error: this.code, message: this.detail };
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,80 @@
+import { type KeySource } from "./keys.js";
+export { MesshError, VerifyError } from "./errors.js";
+export { keyEnv, keyFile, keySeed, sshAgent, type KeySource, type Signer } from "./keys.js";
+export { fingerprint, thumbprint, type Directory, type JWK } from "./wba.js";
+export declare const VERSION = "0.1.0";
+export declare const DEFAULT_REGISTRY = "https://messh.io";
+export interface ClientOptions {
+    /** messh username, e.g. "mukul". */
+    identity: string;
+    /** Signing key. Default: keyFile("~/.ssh/id_ed25519"). */
+    key?: KeySource;
+    /** messh registry base URL. Default: https://messh.io. */
+    registry?: string;
+    /** Signature lifetime in seconds. Default 60, max 300. */
+    expiresIn?: number;
+    /** Seconds since epoch (tests). */
+    clock?: () => number;
+    /** Nonce generator (tests). */
+    nonce?: () => string;
+}
+export interface SignInput {
+    method: string;
+    /** Absolute URL. */
+    url: string | URL;
+    body?: Uint8Array | string | null;
+    /** Host header, if different from the URL's host. */
+    host?: string;
+}
+/** This client's key as messh lists it: what an API will see. See {@link MesshClient.whoami}. */
+export interface PublishedKey {
+    /** messh username, e.g. "mukul". */
+    identity: string;
+    /** The key's name on messh, e.g. "build-bot". */
+    keyName: string;
+    /** RFC 7638 thumbprint, sent as keyid. */
+    keyId: string;
+    /** SHA256:… of the SSH key. */
+    fingerprint: string;
+    /** Signature-Agent: <registry>/<identity>. */
+    agentUrl: string;
+}
+export declare class MesshClient {
+    readonly identity: string;
+    readonly registry: string;
+    readonly keyId: string;
+    /** SSH fingerprint of the signing key (SHA256:…), as `messh keys` and ssh-keygen -l print it. */
+    readonly fingerprint: string;
+    private readonly signer;
+    private readonly expiresIn;
+    private readonly clock;
+    private readonly nonce;
+    private constructor();
+    /** Create a client; loads the key once. */
+    static create(options: ClientOptions): Promise<MesshClient>;
+    /**
+     * Create a client from the environment, for agents and CI: MESSH_IDENTITY
+     * (required), MESSH_KEY (PEM, or base64 of PEM or PKCS#8 DER) or
+     * MESSH_KEY_FILE (default ~/.ssh/id_ed25519), and MESSH_REGISTRY.
+     * Options you pass win over the environment.
+     */
+    static fromEnv(overrides?: Partial<ClientOptions>): Promise<MesshClient>;
+    /**
+     * Check that this client's key is published and active on messh, and how
+     * APIs will see it. Run it once at startup: it turns the most common setup
+     * mistake (an unpublished key, so every API answers 401 unknown_key) into a
+     * clear error. Throws MesshError not_published or registry_unreachable.
+     */
+    whoami(): Promise<PublishedKey>;
+    /** Signature-Agent URL: <registry>/<identity>. */
+    get agent(): string;
+    /**
+     * Headers to add: Signature-Agent, Signature-Input, Signature and, with a
+     * body, Content-Digest. Sign last; don't change the request afterwards.
+     */
+    sign(input: SignInput): Promise<Record<string, string>>;
+    /** Return a signed copy of a fetch Request. */
+    signRequest(request: Request): Promise<Request>;
+    /** fetch(), signed. Bodies must be strings or bytes (they're hashed). */
+    fetch(input: string | URL, init?: RequestInit): Promise<Response>;
+}

package/dist/index.js

@@ -0,0 +1,151 @@
+// @messh/sdk: sign HTTP requests as a messh identity (Web Bot Auth).
+import { randomBytes } from "node:crypto";
+import { homedir } from "node:os";
+import * as wba from "./wba.js";
+import { MesshError } from "./errors.js";
+import { keyEnv, keyFile, resolveKey } from "./keys.js";
+export { MesshError, VerifyError } from "./errors.js";
+export { keyEnv, keyFile, keySeed, sshAgent } from "./keys.js";
+export { fingerprint, thumbprint } from "./wba.js";
+export const VERSION = "0.1.0";
+export const DEFAULT_REGISTRY = "https://messh.io";
+const IDENTITY = /^[a-z0-9](?:[a-z0-9-]{1,28}[a-z0-9])$/;
+export class MesshClient {
+    identity;
+    registry;
+    keyId;
+    fingerprint;
+    signer;
+    expiresIn;
+    clock;
+    nonce;
+    constructor(identity, registry, keyId, 
+    /** SSH fingerprint of the signing key (SHA256:…), as `messh keys` and ssh-keygen -l print it. */
+    fingerprint, signer, expiresIn, clock, nonce) {
+        this.identity = identity;
+        this.registry = registry;
+        this.keyId = keyId;
+        this.fingerprint = fingerprint;
+        this.signer = signer;
+        this.expiresIn = expiresIn;
+        this.clock = clock;
+        this.nonce = nonce;
+    }
+    /** Create a client; loads the key once. */
+    static async create(options) {
+        const { identity, registry = DEFAULT_REGISTRY, expiresIn = 60 } = options;
+        if (!IDENTITY.test(identity ?? ""))
+            throw new MesshError("invalid_identity", `${JSON.stringify(identity)} is not a messh username`);
+        if (!/^https?:\/\//.test(registry))
+            throw new MesshError("invalid_option", "registry must be an http(s) URL");
+        if (!(expiresIn >= 1 && expiresIn <= wba.MAX_LIFETIME))
+            throw new MesshError("invalid_option", "expiresIn must be 1..300 seconds");
+        const signer = await resolveKey(options.key ?? keyFile(`${homedir()}/.ssh/id_ed25519`));
+        const pub = await signer.publicKey();
+        return new MesshClient(identity, registry.replace(/\/+$/, ""), wba.thumbprint(pub), wba.fingerprint(pub), signer, expiresIn, options.clock ?? (() => Math.floor(Date.now() / 1000)), options.nonce ?? (() => randomBytes(16).toString("base64url")));
+    }
+    /**
+     * Create a client from the environment, for agents and CI: MESSH_IDENTITY
+     * (required), MESSH_KEY (PEM, or base64 of PEM or PKCS#8 DER) or
+     * MESSH_KEY_FILE (default ~/.ssh/id_ed25519), and MESSH_REGISTRY.
+     * Options you pass win over the environment.
+     */
+    static async fromEnv(overrides = {}) {
+        const env = process.env;
+        const identity = overrides.identity ?? env.MESSH_IDENTITY;
+        if (!identity)
+            throw new MesshError("invalid_identity", "set MESSH_IDENTITY to your messh username, or pass identity");
+        const key = overrides.key ?? (env.MESSH_KEY ? keyEnv("MESSH_KEY") : env.MESSH_KEY_FILE ? keyFile(env.MESSH_KEY_FILE) : undefined);
+        return MesshClient.create({ ...overrides, identity, key, registry: overrides.registry ?? (env.MESSH_REGISTRY || undefined) });
+    }
+    /**
+     * Check that this client's key is published and active on messh, and how
+     * APIs will see it. Run it once at startup: it turns the most common setup
+     * mistake (an unpublished key, so every API answers 401 unknown_key) into a
+     * clear error. Throws MesshError not_published or registry_unreachable.
+     */
+    async whoami() {
+        const url = `${this.agent}${wba.DIRECTORY_PATH}`;
+        let res;
+        try {
+            res = await fetch(url, {
+                headers: { accept: "application/http-message-signatures-directory+json, application/json", "user-agent": `messh-js/${VERSION}` },
+                signal: AbortSignal.timeout(10_000),
+            });
+        }
+        catch (e) {
+            throw new MesshError("registry_unreachable", `can't reach ${this.registry}: ${e.message}`);
+        }
+        if (res.status === 404) {
+            throw new MesshError("not_published", `${this.registry} has no user ${this.identity}; sign up, then publish this key (${this.fingerprint}) with messh publish`);
+        }
+        const dir = res.ok ? (await res.json().catch(() => null)) : null;
+        if (!dir)
+            throw new MesshError("registry_unreachable", `${url} answered HTTP ${res.status} without a key directory`);
+        const key = (dir.keys ?? []).find((k) => k.kid === this.keyId);
+        if (!key) {
+            throw new MesshError("not_published", `this key (${this.fingerprint}) isn't an active key of ${this.agent}; publish it with messh publish --key <key>.pub --name <name>`);
+        }
+        return { identity: this.identity, keyName: key.messh_name ?? "", keyId: this.keyId, fingerprint: key.messh_fingerprint ?? this.fingerprint, agentUrl: this.agent };
+    }
+    /** Signature-Agent URL: <registry>/<identity>. */
+    get agent() {
+        return `${this.registry}/${this.identity}`;
+    }
+    /**
+     * Headers to add: Signature-Agent, Signature-Input, Signature and, with a
+     * body, Content-Digest. Sign last; don't change the request afterwards.
+     */
+    async sign(input) {
+        const u = new URL(input.url);
+        const agentHeader = wba.quote(this.agent);
+        const comps = [
+            ["@method", input.method.toUpperCase()],
+            ["@authority", (input.host ?? u.host).toLowerCase()],
+            ["@path", u.pathname || "/"],
+        ];
+        if (u.search)
+            comps.push(["@query", u.search]);
+        const headers = { "Signature-Agent": agentHeader };
+        if (input.body && input.body.length) {
+            const data = typeof input.body === "string" ? Buffer.from(input.body) : input.body;
+            headers["Content-Digest"] = wba.contentDigest(data);
+            comps.push(["content-digest", headers["Content-Digest"]]);
+        }
+        comps.push(["signature-agent", agentHeader]);
+        const created = Math.floor(this.clock());
+        const params = wba.params(comps.map(([n]) => n), created, created + this.expiresIn, this.keyId, this.nonce());
+        let sig;
+        try {
+            sig = await this.signer.sign(wba.base(comps, params));
+        }
+        catch (e) {
+            throw new MesshError("sign_failed", e.message);
+        }
+        headers["Signature-Input"] = `${wba.LABEL}=${params}`;
+        headers["Signature"] = `${wba.LABEL}=:${Buffer.from(sig).toString("base64")}:`;
+        return headers;
+    }
+    /** Return a signed copy of a fetch Request. */
+    async signRequest(request) {
+        const body = request.body ? new Uint8Array(await request.clone().arrayBuffer()) : undefined;
+        const headers = new Headers(request.headers);
+        for (const [k, v] of Object.entries(await this.sign({ method: request.method, url: request.url, body })))
+            headers.set(k, v);
+        return new Request(request, { headers, body });
+    }
+    /** fetch(), signed. Bodies must be strings or bytes (they're hashed). */
+    async fetch(input, init = {}) {
+        const body = init.body;
+        if (body != null && typeof body !== "string" && !(body instanceof Uint8Array)) {
+            throw new MesshError("sign_failed", "body must be a string or Uint8Array to be signed");
+        }
+        const headers = new Headers(init.headers);
+        const method = (init.method ?? (body != null ? "POST" : "GET")).toUpperCase();
+        for (const [k, v] of Object.entries(await this.sign({ method, url: input, body: body })))
+            headers.set(k, v);
+        if (!headers.has("user-agent"))
+            headers.set("user-agent", `messh-js/${VERSION}`);
+        return fetch(input, { ...init, method, headers });
+    }
+}

package/dist/keys.d.ts

@@ -0,0 +1,25 @@
+/** Implement to sign in a KMS, HSM or ssh-agent. */
+export interface Signer {
+    /** Raw 32-byte Ed25519 public key. */
+    publicKey(): Uint8Array | Promise<Uint8Array>;
+    /** 64-byte Ed25519 signature over data. */
+    sign(data: Uint8Array): Uint8Array | Promise<Uint8Array>;
+}
+/** A Signer, or something that loads one. */
+export type KeySource = Signer | (() => Promise<Signer>);
+/** Unencrypted ssh-ed25519 OpenSSH key or PKCS#8 PEM, e.g. ~/.ssh/id_ed25519. */
+export declare function keyFile(path: string): () => Promise<Signer>;
+/**
+ * A key held by ssh-agent, such as a passphrase-protected key you added with
+ * ssh-add. The private key stays in the agent. With several Ed25519 keys
+ * loaded, pass the fingerprint (SHA256:…) of the one you published.
+ */
+export declare function sshAgent(options?: {
+    fingerprint?: string;
+    socket?: string;
+}): () => Promise<Signer>;
+/** Key in an environment variable: PEM text, or base64 of PEM or PKCS#8 DER. */
+export declare function keyEnv(name: string): () => Promise<Signer>;
+/** Raw 32-byte Ed25519 seed. */
+export declare function keySeed(seed: Uint8Array): () => Promise<Signer>;
+export declare function resolveKey(source: KeySource): Promise<Signer>;