@multiplatform.one/gpg 7.18.0 → 7.20.0

package/src/signer.ts

@@ -0,0 +1,142 @@
+import { useSyncExternalStore } from "react";
+import { gpgSignatureCovers } from "./signature";
+
+export { gpgSignatureCovers } from "./signature";
+
+// The GPG copy/paste signer as a client, shared by login (GpgProvider) and any
+// other signing an app needs. There is no wallet to talk to: signMessage parks a
+// request, the app shows the terminal command, the user pastes the output back
+// and submit() resolves the pending promise. Only react and @noble/hashes are
+// imported, so the `@multiplatform.one/gpg/signer` subpath stays out of the
+// connectkit graph.
+
+export const GPG_SIGNATURE_BEGIN = "-----BEGIN PGP SIGNATURE-----";
+export const GPG_PUBLIC_KEY_BEGIN = "-----BEGIN PGP PUBLIC KEY BLOCK-----";
+
+/**
+ * The terminal command that signs `message`: a detached armored signature plus
+ * the exported public key, which is the blob the user pastes back. printf %s adds
+ * no newline, so the signed bytes equal `message`. Single quotes are POSIX-escaped
+ * so a message cannot break out of the quoting.
+ */
+export function gpgSignCommand(message: string): string {
+  return `{ printf %s '${message.replace(/'/g, "'\\''")}' | gpg --detach-sign --armor; gpg --armor --export; }`;
+}
+
+/** Trim the pasted terminal output and reject it unless it holds both armored blocks. */
+export function assertGpgSignature(blob: string): string {
+  const trimmed = blob.trim();
+  if (!trimmed.includes(GPG_SIGNATURE_BEGIN) || !trimmed.includes(GPG_PUBLIC_KEY_BEGIN)) {
+    throw new Error(
+      "Paste the FULL output — it must contain both a PGP SIGNATURE and a PUBLIC KEY block.",
+    );
+  }
+  return trimmed;
+}
+
+export interface GpgSignRequest {
+  message: string;
+  command: string;
+}
+
+export interface GpgSigner {
+  readonly family: "gpg";
+  /** A GPG identity is the key fingerprint, which only arrives with the signature. */
+  readonly address: null;
+  readonly capabilities: readonly "signMessage"[];
+  /** The request waiting for pasted output, or null. */
+  readonly pending: GpgSignRequest | null;
+  /**
+   * Ask the user to sign `message` in their terminal. Resolves with the pasted
+   * armored signature followed by the armored public key, the same blob Keycloak's
+   * GPG verifier takes. A second call cancels the first.
+   */
+  signMessage(message: string): Promise<string>;
+  /**
+   * Hand pasted output to `request`, the pending request the paste box showed.
+   * Throws, and keeps the request pending, when `request` is no longer the
+   * pending one, when the paste is incomplete, or when its signature was made
+   * over a different message.
+   */
+  submit(blob: string, request: GpgSignRequest): void;
+  cancel(reason?: Error): void;
+  subscribe(listener: () => void): () => void;
+}
+
+export function createGpgSigner(): GpgSigner {
+  let pending: GpgSignRequest | null = null;
+  let settle: { resolve: (blob: string) => void; reject: (error: Error) => void } | null = null;
+  const listeners = new Set<() => void>();
+  const emit = () => {
+    for (const listener of listeners) listener();
+  };
+
+  const signer: GpgSigner = {
+    family: "gpg",
+    address: null,
+    capabilities: ["signMessage"],
+    get pending() {
+      return pending;
+    },
+    signMessage(message) {
+      settle?.reject(new Error("GPG signing was superseded by a newer request"));
+      return new Promise<string>((resolve, reject) => {
+        settle = { resolve, reject };
+        pending = { message, command: gpgSignCommand(message) };
+        emit();
+      });
+    },
+    submit(blob, request) {
+      if (!settle || !pending) throw new Error("No GPG signature was requested");
+      if (request !== pending) {
+        throw new Error(
+          "That GPG request was superseded; run the current command and paste its output",
+        );
+      }
+      const signature = assertGpgSignature(blob);
+      if (!gpgSignatureCovers(signature, pending.message)) {
+        throw new Error(
+          "That signature is over a different message; run the current command and paste its output",
+        );
+      }
+      const { resolve } = settle;
+      settle = null;
+      pending = null;
+      emit();
+      resolve(signature);
+    },
+    cancel(reason) {
+      if (!settle) return;
+      const { reject } = settle;
+      settle = null;
+      pending = null;
+      emit();
+      reject(reason ?? new Error("GPG signing was cancelled"));
+    },
+    subscribe(listener) {
+      listeners.add(listener);
+      return () => listeners.delete(listener);
+    },
+  };
+  return signer;
+}
+
+/**
+ * Subscribe a component to a GPG signer so it re-renders when a request is
+ * parked or settled. Omitted, it is the app-wide signer, so the component that
+ * asks for a signature and the one that shows the paste box share one request.
+ */
+export function useGpgSigner(signer: GpgSigner = defaultSigner()): GpgSigner {
+  useSyncExternalStore(
+    signer.subscribe,
+    () => signer.pending,
+    () => signer.pending,
+  );
+  return signer;
+}
+
+let sharedSigner: GpgSigner | null = null;
+function defaultSigner(): GpgSigner {
+  sharedSigner ??= createGpgSigner();
+  return sharedSigner;
+}

package/types/GpgProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GpgProvider.d.ts","sourceRoot":"","sources":["../src/GpgProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAyC,MAAM,OAAO,CAAC;AAIzE,OAAO,EAAc,SAAS,EAAkB,MAAM,cAAc,CAAC;AAErE,KAAK,KAAK,GAAG,SAAS,GAAG;IACvB,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,mBAAmB,eAAe,CAAC;AAkBhD,eAAO,MAAM,WAAW,GAAI,mFAOzB,KAAK,4CAqGP,CAAC"}
+{"version":3,"file":"GpgProvider.d.ts","sourceRoot":"","sources":["../src/GpgProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAyC,MAAM,OAAO,CAAC;AAIzE,OAAO,EAAc,SAAS,EAAkB,MAAM,cAAc,CAAC;AAGrE,KAAK,KAAK,GAAG,SAAS,GAAG;IACvB,QAAQ,EAAE,SAAS,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;CACvB,CAAC;AAEF,eAAO,MAAM,mBAAmB,eAAe,CAAC;AAkBhD,eAAO,MAAM,WAAW,GAAI,mFAOzB,KAAK,4CAwFP,CAAC"}

package/types/index.d.ts

@@ -1,4 +1,5 @@
 export { useGpg } from "./useGpg";
+export { createGpgSigner, useGpgSigner, gpgSignCommand, assertGpgSignature, gpgSignatureCovers, type GpgSigner, type GpgSignRequest, } from "./signer";
 export { GpgProvider, GPG_NONCE_QUERY_KEY } from "./GpgProvider";
 export { GpgContext, GpgStatusState } from "./GpgContext";
 export type { GpgConfig, GpgContextValue } from "./GpgContext";

package/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC1D,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/D,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExE,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EACL,eAAe,EACf,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,KAAK,SAAS,EACd,KAAK,cAAc,GACpB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC1D,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/D,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,OAAO,IAAI,mBAAmB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExE,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC"}

package/types/signature.d.ts

@@ -0,0 +1,6 @@
+/**
+ * True when every signature in the pasted armored PGP SIGNATURE block was made
+ * over `message`'s UTF-8 bytes. Throws on a block it cannot read.
+ */
+export declare function gpgSignatureCovers(blob: string, message: string): boolean;
+//# sourceMappingURL=signature.d.ts.map

package/types/signature.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signature.d.ts","sourceRoot":"","sources":["../src/signature.ts"],"names":[],"mappings":"AA2GA;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAQzE"}

package/types/signer.d.ts

@@ -0,0 +1,47 @@
+export { gpgSignatureCovers } from "./signature";
+export declare const GPG_SIGNATURE_BEGIN = "-----BEGIN PGP SIGNATURE-----";
+export declare const GPG_PUBLIC_KEY_BEGIN = "-----BEGIN PGP PUBLIC KEY BLOCK-----";
+/**
+ * The terminal command that signs `message`: a detached armored signature plus
+ * the exported public key, which is the blob the user pastes back. printf %s adds
+ * no newline, so the signed bytes equal `message`. Single quotes are POSIX-escaped
+ * so a message cannot break out of the quoting.
+ */
+export declare function gpgSignCommand(message: string): string;
+/** Trim the pasted terminal output and reject it unless it holds both armored blocks. */
+export declare function assertGpgSignature(blob: string): string;
+export interface GpgSignRequest {
+    message: string;
+    command: string;
+}
+export interface GpgSigner {
+    readonly family: "gpg";
+    /** A GPG identity is the key fingerprint, which only arrives with the signature. */
+    readonly address: null;
+    readonly capabilities: readonly "signMessage"[];
+    /** The request waiting for pasted output, or null. */
+    readonly pending: GpgSignRequest | null;
+    /**
+     * Ask the user to sign `message` in their terminal. Resolves with the pasted
+     * armored signature followed by the armored public key, the same blob Keycloak's
+     * GPG verifier takes. A second call cancels the first.
+     */
+    signMessage(message: string): Promise<string>;
+    /**
+     * Hand pasted output to `request`, the pending request the paste box showed.
+     * Throws, and keeps the request pending, when `request` is no longer the
+     * pending one, when the paste is incomplete, or when its signature was made
+     * over a different message.
+     */
+    submit(blob: string, request: GpgSignRequest): void;
+    cancel(reason?: Error): void;
+    subscribe(listener: () => void): () => void;
+}
+export declare function createGpgSigner(): GpgSigner;
+/**
+ * Subscribe a component to a GPG signer so it re-renders when a request is
+ * parked or settled. Omitted, it is the app-wide signer, so the component that
+ * asks for a signature and the one that shows the paste box share one request.
+ */
+export declare function useGpgSigner(signer?: GpgSigner): GpgSigner;
+//# sourceMappingURL=signer.d.ts.map

package/types/signer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AASjD,eAAO,MAAM,mBAAmB,kCAAkC,CAAC;AACnE,eAAO,MAAM,oBAAoB,yCAAyC,CAAC;AAE3E;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED,yFAAyF;AACzF,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAQvD;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC;IACvB,oFAAoF;IACpF,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;IACvB,QAAQ,CAAC,YAAY,EAAE,SAAS,aAAa,EAAE,CAAC;IAChD,sDAAsD;IACtD,QAAQ,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IACxC;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9C;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IACpD,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC;IAC7B,SAAS,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC;CAC7C;AAED,wBAAgB,eAAe,IAAI,SAAS,CAwD3C;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,MAAM,GAAE,SAA2B,GAAG,SAAS,CAO3E"}