@clerk/electron-passkeys 0.0.1-snapshot.v20260617204522

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Clerk Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# @clerk/electron-passkeys
+
+Native passkey (WebAuthn) support for [`@clerk/electron`](https://github.com/clerk/javascript/tree/main/packages/electron), used when an Electron window loads a local bundle (`file://` or a custom protocol) and the renderer's built-in WebAuthn cannot satisfy the RP ID's origin checks.
+
+> [!WARNING]
+> This package is under active development and is not yet ready for production use.
+
+This package is a napi-rs native module loaded in the Electron **main** process by `createClerkBridge({ passkeys: true })` from `@clerk/electron`. You should not need to call it directly.
+
+| Platform         | Backend                                              | Authenticators                           |
+| ---------------- | ---------------------------------------------------- | ---------------------------------------- |
+| macOS 12+        | AuthenticationServices (`ASAuthorizationController`) | Touch ID, iCloud Keychain, security keys |
+| Windows 10 1903+ | `webauthn.dll` (Windows WebAuthn API)                | Windows Hello, security keys             |
+| Linux            | —                                                    | Not supported (use renderer WebAuthn)    |
+
+Prebuilt binaries ship as per-platform optional dependencies (`@clerk/electron-passkeys-darwin-arm64`, `-darwin-x64`, `-win32-x64-msvc`, `-win32-arm64-msvc`).
+
+## API
+
+```ts
+isAvailable(): boolean;
+capabilities(): { platformAuthenticator: boolean; securityKeys: boolean };
+createCredential(windowHandle: Buffer, optionsJson: string): Promise<string>;
+getCredential(windowHandle: Buffer, optionsJson: string): Promise<string>;
+```
+
+`createCredential`/`getCredential` take the window handle from `BrowserWindow#getNativeWindowHandle()` (to anchor the OS dialog) and JSON-encoded WebAuthn options with base64url binary fields. They always resolve with a JSON envelope — `{ ok: true, credential }` or `{ ok: false, error: { code, message } }` with `code` one of `cancelled | invalid_rp | not_supported | timeout | unknown` — and never reject for ceremony failures.
+
+## Building from source
+
+Requires a Rust toolchain.
+
+```sh
+pnpm --filter @clerk/electron-passkeys build
+```
+
+## License
+
+MIT — see [LICENSE](https://github.com/clerk/javascript/blob/main/packages/electron/LICENSE).

package/index.d.ts

@@ -0,0 +1,20 @@
+/** Whether this platform has a native passkey backend. */
+export function isAvailable(): boolean;
+
+export function capabilities(): {
+  platformAuthenticator: boolean;
+  securityKeys: boolean;
+};
+
+/**
+ * Runs a WebAuthn registration ceremony.
+ * `windowHandle` anchors the OS dialog; `optionsJson` is the serialized public key options.
+ * Resolves with a JSON result envelope.
+ */
+export function createCredential(windowHandle: Buffer, optionsJson: string): Promise<string>;
+
+/**
+ * Runs a WebAuthn authentication ceremony.
+ * Resolves with a JSON result envelope.
+ */
+export function getCredential(windowHandle: Buffer, optionsJson: string): Promise<string>;

package/index.js

@@ -0,0 +1,63 @@
+const { existsSync } = require('node:fs');
+const { join } = require('node:path');
+
+const PLATFORM_PACKAGES = {
+  'darwin-arm64': '@clerk/electron-passkeys-darwin-arm64',
+  'darwin-x64': '@clerk/electron-passkeys-darwin-x64',
+  'win32-arm64': '@clerk/electron-passkeys-win32-arm64-msvc',
+  'win32-x64': '@clerk/electron-passkeys-win32-x64-msvc',
+};
+
+function loadNative() {
+  const key = `${process.platform}-${process.arch}`;
+
+  // Local napi builds land next to this file; napi appends the ABI to the
+  // filename on Windows (e.g. electron-passkeys.win32-x64-msvc.node).
+  const localKey = process.platform === 'win32' ? `${key}-msvc` : key;
+  const localBinary = join(__dirname, `electron-passkeys.${localKey}.node`);
+  if (existsSync(localBinary)) {
+    return require(localBinary);
+  }
+
+  const platformPackage = PLATFORM_PACKAGES[key];
+  if (platformPackage) {
+    try {
+      return require(platformPackage);
+    } catch {
+      // Missing or unloadable optional package: report unsupported.
+    }
+  }
+  return null;
+}
+
+const native = loadNative();
+
+const notSupportedResult = () =>
+  JSON.stringify({
+    ok: false,
+    error: { code: 'not_supported', message: 'Native passkeys are not supported on this platform.' },
+  });
+
+module.exports = {
+  isAvailable() {
+    return !!native && native.isAvailable();
+  },
+  capabilities() {
+    if (!native || !native.isAvailable()) {
+      return { platformAuthenticator: false, securityKeys: false };
+    }
+    return native.capabilities();
+  },
+  createCredential(windowHandle, optionsJson) {
+    if (!native || !native.isAvailable()) {
+      return Promise.resolve(notSupportedResult());
+    }
+    return native.createCredential(windowHandle, optionsJson);
+  },
+  getCredential(windowHandle, optionsJson) {
+    if (!native || !native.isAvailable()) {
+      return Promise.resolve(notSupportedResult());
+    }
+    return native.getCredential(windowHandle, optionsJson);
+  },
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@clerk/electron-passkeys",
+  "version": "0.0.1-snapshot.v20260617204522",
+  "description": "Native passkey (WebAuthn) support for Clerk's Electron SDK",
+  "keywords": [
+    "clerk",
+    "electron",
+    "passkeys",
+    "webauthn",
+    "auth",
+    "authentication"
+  ],
+  "homepage": "https://clerk.com/",
+  "bugs": {
+    "url": "https://github.com/clerk/javascript/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/clerk/javascript.git",
+    "directory": "packages/electron-passkeys"
+  },
+  "license": "MIT",
+  "author": "Clerk",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "devDependencies": {
+    "@napi-rs/cli": "^3.0.0"
+  },
+  "optionalDependencies": {
+    "@clerk/electron-passkeys-darwin-arm64": "0.0.0",
+    "@clerk/electron-passkeys-darwin-x64": "0.0.0",
+    "@clerk/electron-passkeys-win32-arm64-msvc": "0.0.0",
+    "@clerk/electron-passkeys-win32-x64-msvc": "0.0.0"
+  },
+  "engines": {
+    "node": ">=24.15.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "napi": {
+    "binaryName": "electron-passkeys",
+    "targets": [
+      "aarch64-apple-darwin",
+      "x86_64-apple-darwin",
+      "x86_64-pc-windows-msvc",
+      "aarch64-pc-windows-msvc"
+    ]
+  },
+  "scripts": {
+    "artifacts": "napi artifacts --output-dir artifacts --npm-dir npm",
+    "build": "napi build --platform --release --no-js --dts native.d.ts",
+    "build:debug": "napi build --platform --no-js --dts native.d.ts",
+    "test": "node --test test/loader.test.cjs"
+  }
+}