@dynamic-labs/webauthn 3.0.0-alpha.46

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Dynamic Labs, 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,11 @@
+# webauthn
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build webauthn` to build the library.
+
+## Running unit tests
+
+Run `nx test webauthn` to execute the unit tests via [Jest](https://jestjs.io).

package/_virtual/_tslib.cjs

@@ -0,0 +1,36 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+exports.__awaiter = __awaiter;

package/_virtual/_tslib.js

@@ -0,0 +1,32 @@
+'use client'
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+export { __awaiter };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@dynamic-labs/webauthn",
+  "version": "3.0.0-alpha.46",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dynamic-labs/dynamic-auth.git",
+    "directory": "packages/webauthn"
+  },
+  "description": "A React SDK for implementing wallet web3 authentication and authorization to your website.",
+  "bugs": {
+    "url": "https://github.com/dynamic-labs/DynamicAuth/issues"
+  },
+  "homepage": "https://github.com/dynamic-labs/DynamicAuth#readme",
+  "author": "Dynamic Labs, Inc.",
+  "license": "MIT",
+  "main": "./src/index.cjs",
+  "module": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "require": "./src/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@simplewebauthn/browser": "9.0.1",
+    "@simplewebauthn/types": "9.0.1",
+    "@dynamic-labs/logger": "3.0.0-alpha.46"
+  },
+  "peerDependencies": {}
+}

package/src/index.cjs

@@ -0,0 +1,18 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var WebauthnNotSupportedError = require('./lib/errors/WebauthnNotSupportedError.cjs');
+var createWebauthnCredential = require('./lib/createWebauthnCredential.cjs');
+var verifyWebauthnCredential = require('./lib/verifyWebauthnCredential.cjs');
+var convertTransportEnumToTurnkeyEnum = require('./lib/adapters/convertTransportEnumToTurnkeyEnum.cjs');
+var getWebAuthnAttestationTurnkeyAdapter = require('./lib/adapters/getWebAuthnAttestationTurnkeyAdapter.cjs');
+
+
+
+exports.WebauthnNotSupportedError = WebauthnNotSupportedError.WebauthnNotSupportedError;
+exports.createWebauthnCredential = createWebauthnCredential.createWebauthnCredential;
+exports.verifyWebauthnCredential = verifyWebauthnCredential.verifyWebauthnCredential;
+exports.convertTransportEnumToTurnkeyEnum = convertTransportEnumToTurnkeyEnum.convertTransportEnumToTurnkeyEnum;
+exports.getWebAuthnAttestationTurnkeyAdapter = getWebAuthnAttestationTurnkeyAdapter.getWebAuthnAttestationTurnkeyAdapter;

package/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from './lib/errors/WebauthnNotSupportedError';
+export * from './lib/createWebauthnCredential';
+export * from './lib/verifyWebauthnCredential';
+export * from './types';
+export * from './lib/adapters/convertTransportEnumToTurnkeyEnum';
+export * from './lib/adapters/getWebAuthnAttestationTurnkeyAdapter';

package/src/index.js

@@ -0,0 +1,6 @@
+'use client'
+export { WebauthnNotSupportedError } from './lib/errors/WebauthnNotSupportedError.js';
+export { createWebauthnCredential } from './lib/createWebauthnCredential.js';
+export { verifyWebauthnCredential } from './lib/verifyWebauthnCredential.js';
+export { convertTransportEnumToTurnkeyEnum } from './lib/adapters/convertTransportEnumToTurnkeyEnum.js';
+export { getWebAuthnAttestationTurnkeyAdapter } from './lib/adapters/getWebAuthnAttestationTurnkeyAdapter.js';

package/src/lib/adapters/convertTransportEnumToTurnkeyEnum.cjs

@@ -0,0 +1,29 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const convertTransportEnumToTurnkeyEnum = (transportEnum) => {
+    switch (transportEnum) {
+        case 'internal': {
+            return 'AUTHENTICATOR_TRANSPORT_INTERNAL';
+        }
+        case 'usb': {
+            return 'AUTHENTICATOR_TRANSPORT_USB';
+        }
+        case 'nfc': {
+            return 'AUTHENTICATOR_TRANSPORT_NFC';
+        }
+        case 'ble': {
+            return 'AUTHENTICATOR_TRANSPORT_BLE';
+        }
+        case 'hybrid': {
+            return 'AUTHENTICATOR_TRANSPORT_HYBRID';
+        }
+        default: {
+            throw new Error('unsupported transport format ' + transportEnum);
+        }
+    }
+};
+
+exports.convertTransportEnumToTurnkeyEnum = convertTransportEnumToTurnkeyEnum;

package/src/lib/adapters/convertTransportEnumToTurnkeyEnum.d.ts

@@ -0,0 +1,2 @@
+import { AuthenticatorTransportFuture } from '@simplewebauthn/types';
+export declare const convertTransportEnumToTurnkeyEnum: (transportEnum: AuthenticatorTransportFuture) => "AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_HYBRID";

package/src/lib/adapters/convertTransportEnumToTurnkeyEnum.js

@@ -0,0 +1,25 @@
+'use client'
+const convertTransportEnumToTurnkeyEnum = (transportEnum) => {
+    switch (transportEnum) {
+        case 'internal': {
+            return 'AUTHENTICATOR_TRANSPORT_INTERNAL';
+        }
+        case 'usb': {
+            return 'AUTHENTICATOR_TRANSPORT_USB';
+        }
+        case 'nfc': {
+            return 'AUTHENTICATOR_TRANSPORT_NFC';
+        }
+        case 'ble': {
+            return 'AUTHENTICATOR_TRANSPORT_BLE';
+        }
+        case 'hybrid': {
+            return 'AUTHENTICATOR_TRANSPORT_HYBRID';
+        }
+        default: {
+            throw new Error('unsupported transport format ' + transportEnum);
+        }
+    }
+};
+
+export { convertTransportEnumToTurnkeyEnum };

package/src/lib/adapters/getWebAuthnAttestationTurnkeyAdapter.cjs

@@ -0,0 +1,41 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _tslib = require('../../../_virtual/_tslib.cjs');
+var browser = require('@simplewebauthn/browser');
+var createWebauthnCredential = require('../createWebauthnCredential.cjs');
+var convertTransportEnumToTurnkeyEnum = require('./convertTransportEnumToTurnkeyEnum.cjs');
+
+// As part of migrating off of turnkey for passkeys, swap out the turnkey implementation of this
+// with our own. Next we should move the PasskeyService out of embedded-wallets in favor of purely in
+// the `passkey` package GVTY-2169
+// for now continue to use the turnkey input and output types here to not make any breaking changes.
+// input: turnkey type => convert to our type => create attestation => output: converted to turnkey type
+const getWebAuthnAttestationTurnkeyAdapter = (options) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    if (!options.publicKey) {
+        throw new Error('Invalid options. Public key attribute must be defined');
+    }
+    const convertedOptions = Object.assign(Object.assign({}, options.publicKey), { challenge: bufferSourceToString(options.publicKey.challenge), excludeCredentials: (_a = options.publicKey.excludeCredentials) === null || _a === void 0 ? void 0 : _a.map((cred) => (Object.assign(Object.assign({}, cred), { id: bufferSourceToString(cred.id) }))), user: Object.assign(Object.assign({}, options.publicKey.user), { id: bufferSourceToString(options.publicKey.user.id) }) });
+    const attestation = yield createWebauthnCredential.createWebauthnCredential(convertedOptions);
+    return {
+        attestationObject: attestation.response.attestationObject,
+        clientDataJson: attestation.response.clientDataJSON,
+        credentialId: attestation.rawId,
+        transports: ((_b = attestation.response.transports) === null || _b === void 0 ? void 0 : _b.map(convertTransportEnumToTurnkeyEnum.convertTransportEnumToTurnkeyEnum)) ||
+            [],
+    };
+});
+const bufferSourceToString = (buf) => {
+    if (buf instanceof ArrayBuffer) {
+        return browser.bufferToBase64URLString(buf);
+    }
+    else {
+        const arr = new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength);
+        return browser.bufferToBase64URLString(arr);
+    }
+};
+
+exports.getWebAuthnAttestationTurnkeyAdapter = getWebAuthnAttestationTurnkeyAdapter;

package/src/lib/adapters/getWebAuthnAttestationTurnkeyAdapter.d.ts

@@ -0,0 +1,6 @@
+export declare const getWebAuthnAttestationTurnkeyAdapter: (options: CredentialCreationOptions) => Promise<{
+    attestationObject: string;
+    clientDataJson: string;
+    credentialId: string;
+    transports: ("AUTHENTICATOR_TRANSPORT_INTERNAL" | "AUTHENTICATOR_TRANSPORT_USB" | "AUTHENTICATOR_TRANSPORT_NFC" | "AUTHENTICATOR_TRANSPORT_BLE" | "AUTHENTICATOR_TRANSPORT_HYBRID")[];
+}>;

package/src/lib/adapters/getWebAuthnAttestationTurnkeyAdapter.js

@@ -0,0 +1,37 @@
+'use client'
+import { __awaiter } from '../../../_virtual/_tslib.js';
+import { bufferToBase64URLString } from '@simplewebauthn/browser';
+import { createWebauthnCredential } from '../createWebauthnCredential.js';
+import { convertTransportEnumToTurnkeyEnum } from './convertTransportEnumToTurnkeyEnum.js';
+
+// As part of migrating off of turnkey for passkeys, swap out the turnkey implementation of this
+// with our own. Next we should move the PasskeyService out of embedded-wallets in favor of purely in
+// the `passkey` package GVTY-2169
+// for now continue to use the turnkey input and output types here to not make any breaking changes.
+// input: turnkey type => convert to our type => create attestation => output: converted to turnkey type
+const getWebAuthnAttestationTurnkeyAdapter = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    if (!options.publicKey) {
+        throw new Error('Invalid options. Public key attribute must be defined');
+    }
+    const convertedOptions = Object.assign(Object.assign({}, options.publicKey), { challenge: bufferSourceToString(options.publicKey.challenge), excludeCredentials: (_a = options.publicKey.excludeCredentials) === null || _a === void 0 ? void 0 : _a.map((cred) => (Object.assign(Object.assign({}, cred), { id: bufferSourceToString(cred.id) }))), user: Object.assign(Object.assign({}, options.publicKey.user), { id: bufferSourceToString(options.publicKey.user.id) }) });
+    const attestation = yield createWebauthnCredential(convertedOptions);
+    return {
+        attestationObject: attestation.response.attestationObject,
+        clientDataJson: attestation.response.clientDataJSON,
+        credentialId: attestation.rawId,
+        transports: ((_b = attestation.response.transports) === null || _b === void 0 ? void 0 : _b.map(convertTransportEnumToTurnkeyEnum)) ||
+            [],
+    };
+});
+const bufferSourceToString = (buf) => {
+    if (buf instanceof ArrayBuffer) {
+        return bufferToBase64URLString(buf);
+    }
+    else {
+        const arr = new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength);
+        return bufferToBase64URLString(arr);
+    }
+};
+
+export { getWebAuthnAttestationTurnkeyAdapter };

package/src/lib/createWebauthnCredential.cjs

@@ -0,0 +1,26 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _tslib = require('../../_virtual/_tslib.cjs');
+var browser = require('@simplewebauthn/browser');
+var WebauthnNotSupportedError = require('./errors/WebauthnNotSupportedError.cjs');
+var logger = require('./logger.cjs');
+
+const createWebauthnCredential = (options) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+    if (!browser.browserSupportsWebAuthn()) {
+        throw new WebauthnNotSupportedError.WebauthnNotSupportedError();
+    }
+    let attestationResp;
+    try {
+        attestationResp = yield browser.startRegistration(options);
+    }
+    catch (error) {
+        logger.logger.debug('Failed to create webauthn credential', error);
+        throw error;
+    }
+    return attestationResp;
+});
+
+exports.createWebauthnCredential = createWebauthnCredential;

package/src/lib/createWebauthnCredential.d.ts

@@ -0,0 +1,2 @@
+import { CreateWebauthnCredentialOptions, CreateWebauthnCredentialsResponse } from '../types';
+export declare const createWebauthnCredential: (options: CreateWebauthnCredentialOptions) => Promise<CreateWebauthnCredentialsResponse>;

package/src/lib/createWebauthnCredential.js

@@ -0,0 +1,22 @@
+'use client'
+import { __awaiter } from '../../_virtual/_tslib.js';
+import { browserSupportsWebAuthn, startRegistration } from '@simplewebauthn/browser';
+import { WebauthnNotSupportedError } from './errors/WebauthnNotSupportedError.js';
+import { logger } from './logger.js';
+
+const createWebauthnCredential = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!browserSupportsWebAuthn()) {
+        throw new WebauthnNotSupportedError();
+    }
+    let attestationResp;
+    try {
+        attestationResp = yield startRegistration(options);
+    }
+    catch (error) {
+        logger.debug('Failed to create webauthn credential', error);
+        throw error;
+    }
+    return attestationResp;
+});
+
+export { createWebauthnCredential };

package/src/lib/errors/WebauthnNotSupportedError.cjs

@@ -0,0 +1,12 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+class WebauthnNotSupportedError extends Error {
+    constructor() {
+        super('Webauthn is not supported on this device');
+    }
+}
+
+exports.WebauthnNotSupportedError = WebauthnNotSupportedError;

package/src/lib/errors/WebauthnNotSupportedError.d.ts

@@ -0,0 +1,3 @@
+export declare class WebauthnNotSupportedError extends Error {
+    constructor();
+}

package/src/lib/errors/WebauthnNotSupportedError.js

@@ -0,0 +1,8 @@
+'use client'
+class WebauthnNotSupportedError extends Error {
+    constructor() {
+        super('Webauthn is not supported on this device');
+    }
+}
+
+export { WebauthnNotSupportedError };

package/src/lib/logger.cjs

@@ -0,0 +1,10 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var logger$1 = require('@dynamic-labs/logger');
+
+const logger = new logger$1.Logger('Webauthn');
+
+exports.logger = logger;

package/src/lib/logger.d.ts

@@ -0,0 +1,2 @@
+import { Logger } from '@dynamic-labs/logger';
+export declare const logger: Logger;

package/src/lib/logger.js

@@ -0,0 +1,6 @@
+'use client'
+import { Logger } from '@dynamic-labs/logger';
+
+const logger = new Logger('Webauthn');
+
+export { logger };

package/src/lib/verifyWebauthnCredential.cjs

@@ -0,0 +1,26 @@
+'use client'
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _tslib = require('../../_virtual/_tslib.cjs');
+var browser = require('@simplewebauthn/browser');
+var WebauthnNotSupportedError = require('./errors/WebauthnNotSupportedError.cjs');
+var logger = require('./logger.cjs');
+
+const verifyWebauthnCredential = (options) => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+    if (!browser.browserSupportsWebAuthn()) {
+        throw new WebauthnNotSupportedError.WebauthnNotSupportedError();
+    }
+    let assertionResp;
+    try {
+        assertionResp = yield browser.startAuthentication(options);
+    }
+    catch (error) {
+        logger.logger.debug('Failed to verify webauthn credential', error);
+        throw error;
+    }
+    return assertionResp;
+});
+
+exports.verifyWebauthnCredential = verifyWebauthnCredential;

package/src/lib/verifyWebauthnCredential.d.ts

@@ -0,0 +1,2 @@
+import { VerifyWebauthnCredentialOptions, VerifyWebauthnCredentialsResponse } from '../types';
+export declare const verifyWebauthnCredential: (options: VerifyWebauthnCredentialOptions) => Promise<VerifyWebauthnCredentialsResponse>;

package/src/lib/verifyWebauthnCredential.js

@@ -0,0 +1,22 @@
+'use client'
+import { __awaiter } from '../../_virtual/_tslib.js';
+import { browserSupportsWebAuthn, startAuthentication } from '@simplewebauthn/browser';
+import { WebauthnNotSupportedError } from './errors/WebauthnNotSupportedError.js';
+import { logger } from './logger.js';
+
+const verifyWebauthnCredential = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!browserSupportsWebAuthn()) {
+        throw new WebauthnNotSupportedError();
+    }
+    let assertionResp;
+    try {
+        assertionResp = yield startAuthentication(options);
+    }
+    catch (error) {
+        logger.debug('Failed to verify webauthn credential', error);
+        throw error;
+    }
+    return assertionResp;
+});
+
+export { verifyWebauthnCredential };

package/src/types.d.ts

@@ -0,0 +1,5 @@
+import { AuthenticationResponseJSON, PublicKeyCredentialCreationOptionsJSON, PublicKeyCredentialRequestOptionsJSON, RegistrationResponseJSON } from '@simplewebauthn/types';
+export type CreateWebauthnCredentialOptions = PublicKeyCredentialCreationOptionsJSON;
+export type CreateWebauthnCredentialsResponse = RegistrationResponseJSON;
+export type VerifyWebauthnCredentialOptions = PublicKeyCredentialRequestOptionsJSON;
+export type VerifyWebauthnCredentialsResponse = AuthenticationResponseJSON;