@0xkey-io/http 0.1.0

package/dist/webauthn.js

@@ -0,0 +1,97 @@
+'use strict';
+
+var index = require('./webauthn-json/index.js');
+
+const defaultTimeout = 5 * 60 * 1000; // five minutes
+const defaultUserVerification = "preferred";
+const defaultSigningOptions = {
+    publicKey: {
+        timeout: defaultTimeout,
+        userVerification: defaultUserVerification,
+    },
+};
+async function getCredentialRequestOptions(payload, tkSigningOptions = defaultSigningOptions) {
+    const challenge = await getChallengeFromPayload(payload);
+    const signingOptions = {
+        ...tkSigningOptions,
+        publicKey: {
+            ...defaultSigningOptions.publicKey,
+            ...tkSigningOptions.publicKey,
+            challenge,
+        },
+    };
+    return signingOptions;
+}
+async function getChallengeFromPayload(payload) {
+    const messageBuffer = new TextEncoder().encode(payload);
+    const hashBuffer = await crypto.subtle.digest("SHA-256", messageBuffer);
+    const hexString = Buffer.from(hashBuffer).toString("hex");
+    const hexBuffer = Buffer.from(hexString, "utf8");
+    return new Uint8Array(hexBuffer);
+}
+/* Pulled from https://www.w3.org/TR/webauthn-2/#enum-transport */
+function protocolTransportEnumToInternalEnum(protocolEnum) {
+    switch (protocolEnum) {
+        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");
+        }
+    }
+}
+function toInternalAttestation(attestation) {
+    return {
+        credentialId: attestation.rawId,
+        attestationObject: attestation.response.attestationObject,
+        clientDataJson: attestation.response.clientDataJSON,
+        transports: attestation.response.transports.map(protocolTransportEnumToInternalEnum),
+    };
+}
+async function getWebAuthnAssertion(payload, options) {
+    const webAuthnSupported = hasWebAuthnSupport();
+    if (!webAuthnSupported) {
+        throw new Error("webauthn is not supported by this browser");
+    }
+    const signingOptions = await getCredentialRequestOptions(payload, options);
+    const clientGetResult = await index.get(signingOptions);
+    const assertion = clientGetResult.toJSON();
+    const stamp = {
+        authenticatorData: assertion.response.authenticatorData,
+        clientDataJson: assertion.response.clientDataJSON,
+        credentialId: assertion.id,
+        signature: assertion.response.signature,
+    };
+    return JSON.stringify(stamp);
+}
+async function getWebAuthnAttestation(options) {
+    const webAuthnSupported = hasWebAuthnSupport();
+    if (!webAuthnSupported) {
+        throw new Error("webauthn is not supported by this browser");
+    }
+    const res = await index.create(options);
+    return toInternalAttestation(res.toJSON());
+}
+// `hasWebAuthnSupport` checks for barebones webauthn support.
+// For additional details and granular settings, see:
+// https://web.dev/articles/passkey-form-autofill#feature-detection, https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredential
+function hasWebAuthnSupport() {
+    return !!window.PublicKeyCredential;
+}
+
+exports.getWebAuthnAssertion = getWebAuthnAssertion;
+exports.getWebAuthnAttestation = getWebAuthnAttestation;
+exports.protocolTransportEnumToInternalEnum = protocolTransportEnumToInternalEnum;
+//# sourceMappingURL=webauthn.js.map

package/dist/webauthn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webauthn.js","sources":["../src/webauthn.ts"],"sourcesContent":[null],"names":["webauthnCredentialGet","webauthnCredentialCreate"],"mappings":";;;;AAcA,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AACrC,MAAM,uBAAuB,GAAG,WAAW;AAwB3C,MAAM,qBAAqB,GAAqC;AAC9D,IAAA,SAAS,EAAE;AACT,QAAA,OAAO,EAAE,cAAc;AACvB,QAAA,gBAAgB,EAAE,uBAAuB;AAC1C,KAAA;CACF;AAED,eAAe,2BAA2B,CACxC,OAAe,EACf,mBAAqD,qBAAqB,EAAA;AAE1E,IAAA,MAAM,SAAS,GAAG,MAAM,uBAAuB,CAAC,OAAO,CAAC;AAExD,IAAA,MAAM,cAAc,GAA6B;AAC/C,QAAA,GAAG,gBAAgB;AACnB,QAAA,SAAS,EAAE;YACT,GAAG,qBAAqB,CAAC,SAAS;YAClC,GAAG,gBAAgB,CAAC,SAAS;YAC7B,SAAS;AACV,SAAA;KACF;AAED,IAAA,OAAO,cAAc;AACvB;AAEA,eAAe,uBAAuB,CAAC,OAAe,EAAA;IACpD,MAAM,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC;AACvD,IAAA,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC;AACvE,IAAA,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;IACzD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC;AAChD,IAAA,OAAO,IAAI,UAAU,CAAC,SAAS,CAAC;AAClC;AAEA;AACM,SAAU,mCAAmC,CACjD,YAA6C,EAAA;IAE7C,QAAQ,YAAY;QAClB,KAAK,UAAU,EAAE;AACf,YAAA,OAAO,kCAAkC;QAC3C;QACA,KAAK,KAAK,EAAE;AACV,YAAA,OAAO,6BAA6B;QACtC;QACA,KAAK,KAAK,EAAE;AACV,YAAA,OAAO,6BAA6B;QACtC;QACA,KAAK,KAAK,EAAE;AACV,YAAA,OAAO,6BAA6B;QACtC;QACA,KAAK,QAAQ,EAAE;AACb,YAAA,OAAO,gCAAgC;QACzC;QACA,SAAS;AACP,YAAA,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC;QACjD;;AAEJ;AAEA,SAAS,qBAAqB,CAC5B,WAAmD,EAAA;IAEnD,OAAO;QACL,YAAY,EAAE,WAAW,CAAC,KAAK;AAC/B,QAAA,iBAAiB,EAAE,WAAW,CAAC,QAAQ,CAAC,iBAAiB;AACzD,QAAA,cAAc,EAAE,WAAW,CAAC,QAAQ,CAAC,cAAc;QACnD,UAAU,EAAE,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAC7C,mCAAmC,CACpC;KACF;AACH;AAEO,eAAe,oBAAoB,CACxC,OAAe,EACf,OAA0C,EAAA;AAE1C,IAAA,MAAM,iBAAiB,GAAG,kBAAkB,EAAE;IAE9C,IAAI,CAAC,iBAAiB,EAAE;AACtB,QAAA,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC;IAC9D;IAEA,MAAM,cAAc,GAAG,MAAM,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC;AAC1E,IAAA,MAAM,eAAe,GAAG,MAAMA,SAAqB,CAAC,cAAc,CAAC;AACnE,IAAA,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,EAAE;AAC1C,IAAA,MAAM,KAAK,GAAmB;AAC5B,QAAA,iBAAiB,EAAE,SAAS,CAAC,QAAQ,CAAC,iBAAiB;AACvD,QAAA,cAAc,EAAE,SAAS,CAAC,QAAQ,CAAC,cAAc;QACjD,YAAY,EAAE,SAAS,CAAC,EAAE;AAC1B,QAAA,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,SAAS;KACxC;AAED,IAAA,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;AAC9B;AAEO,eAAe,sBAAsB,CAC1C,OAA0C,EAAA;AAE1C,IAAA,MAAM,iBAAiB,GAAG,kBAAkB,EAAE;IAE9C,IAAI,CAAC,iBAAiB,EAAE;AACtB,QAAA,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC;IAC9D;AAEA,IAAA,MAAM,GAAG,GAAG,MAAMC,YAAwB,CAAC,OAAO,CAAC;AAEnD,IAAA,OAAO,qBAAqB,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;AAC5C;AAEA;AACA;AACA;AACA,SAAS,kBAAkB,GAAA;AACzB,IAAA,OAAO,CAAC,CAAC,MAAM,CAAC,mBAAmB;AACrC;;;;;;"}

package/dist/webauthn.mjs

@@ -0,0 +1,93 @@
+import { create, get } from './webauthn-json/index.mjs';
+
+const defaultTimeout = 5 * 60 * 1000; // five minutes
+const defaultUserVerification = "preferred";
+const defaultSigningOptions = {
+    publicKey: {
+        timeout: defaultTimeout,
+        userVerification: defaultUserVerification,
+    },
+};
+async function getCredentialRequestOptions(payload, tkSigningOptions = defaultSigningOptions) {
+    const challenge = await getChallengeFromPayload(payload);
+    const signingOptions = {
+        ...tkSigningOptions,
+        publicKey: {
+            ...defaultSigningOptions.publicKey,
+            ...tkSigningOptions.publicKey,
+            challenge,
+        },
+    };
+    return signingOptions;
+}
+async function getChallengeFromPayload(payload) {
+    const messageBuffer = new TextEncoder().encode(payload);
+    const hashBuffer = await crypto.subtle.digest("SHA-256", messageBuffer);
+    const hexString = Buffer.from(hashBuffer).toString("hex");
+    const hexBuffer = Buffer.from(hexString, "utf8");
+    return new Uint8Array(hexBuffer);
+}
+/* Pulled from https://www.w3.org/TR/webauthn-2/#enum-transport */
+function protocolTransportEnumToInternalEnum(protocolEnum) {
+    switch (protocolEnum) {
+        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");
+        }
+    }
+}
+function toInternalAttestation(attestation) {
+    return {
+        credentialId: attestation.rawId,
+        attestationObject: attestation.response.attestationObject,
+        clientDataJson: attestation.response.clientDataJSON,
+        transports: attestation.response.transports.map(protocolTransportEnumToInternalEnum),
+    };
+}
+async function getWebAuthnAssertion(payload, options) {
+    const webAuthnSupported = hasWebAuthnSupport();
+    if (!webAuthnSupported) {
+        throw new Error("webauthn is not supported by this browser");
+    }
+    const signingOptions = await getCredentialRequestOptions(payload, options);
+    const clientGetResult = await get(signingOptions);
+    const assertion = clientGetResult.toJSON();
+    const stamp = {
+        authenticatorData: assertion.response.authenticatorData,
+        clientDataJson: assertion.response.clientDataJSON,
+        credentialId: assertion.id,
+        signature: assertion.response.signature,
+    };
+    return JSON.stringify(stamp);
+}
+async function getWebAuthnAttestation(options) {
+    const webAuthnSupported = hasWebAuthnSupport();
+    if (!webAuthnSupported) {
+        throw new Error("webauthn is not supported by this browser");
+    }
+    const res = await create(options);
+    return toInternalAttestation(res.toJSON());
+}
+// `hasWebAuthnSupport` checks for barebones webauthn support.
+// For additional details and granular settings, see:
+// https://web.dev/articles/passkey-form-autofill#feature-detection, https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredential
+function hasWebAuthnSupport() {
+    return !!window.PublicKeyCredential;
+}
+
+export { getWebAuthnAssertion, getWebAuthnAttestation, protocolTransportEnumToInternalEnum };
+//# sourceMappingURL=webauthn.mjs.map

package/dist/webauthn.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"webauthn.mjs","sources":["../src/webauthn.ts"],"sourcesContent":[null],"names":["webauthnCredentialGet","webauthnCredentialCreate"],"mappings":";;AAcA,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AACrC,MAAM,uBAAuB,GAAG,WAAW;AAwB3C,MAAM,qBAAqB,GAAqC;AAC9D,IAAA,SAAS,EAAE;AACT,QAAA,OAAO,EAAE,cAAc;AACvB,QAAA,gBAAgB,EAAE,uBAAuB;AAC1C,KAAA;CACF;AAED,eAAe,2BAA2B,CACxC,OAAe,EACf,mBAAqD,qBAAqB,EAAA;AAE1E,IAAA,MAAM,SAAS,GAAG,MAAM,uBAAuB,CAAC,OAAO,CAAC;AAExD,IAAA,MAAM,cAAc,GAA6B;AAC/C,QAAA,GAAG,gBAAgB;AACnB,QAAA,SAAS,EAAE;YACT,GAAG,qBAAqB,CAAC,SAAS;YAClC,GAAG,gBAAgB,CAAC,SAAS;YAC7B,SAAS;AACV,SAAA;KACF;AAED,IAAA,OAAO,cAAc;AACvB;AAEA,eAAe,uBAAuB,CAAC,OAAe,EAAA;IACpD,MAAM,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC;AACvD,IAAA,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,aAAa,CAAC;AACvE,IAAA,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC;IACzD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC;AAChD,IAAA,OAAO,IAAI,UAAU,CAAC,SAAS,CAAC;AAClC;AAEA;AACM,SAAU,mCAAmC,CACjD,YAA6C,EAAA;IAE7C,QAAQ,YAAY;QAClB,KAAK,UAAU,EAAE;AACf,YAAA,OAAO,kCAAkC;QAC3C;QACA,KAAK,KAAK,EAAE;AACV,YAAA,OAAO,6BAA6B;QACtC;QACA,KAAK,KAAK,EAAE;AACV,YAAA,OAAO,6BAA6B;QACtC;QACA,KAAK,KAAK,EAAE;AACV,YAAA,OAAO,6BAA6B;QACtC;QACA,KAAK,QAAQ,EAAE;AACb,YAAA,OAAO,gCAAgC;QACzC;QACA,SAAS;AACP,YAAA,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC;QACjD;;AAEJ;AAEA,SAAS,qBAAqB,CAC5B,WAAmD,EAAA;IAEnD,OAAO;QACL,YAAY,EAAE,WAAW,CAAC,KAAK;AAC/B,QAAA,iBAAiB,EAAE,WAAW,CAAC,QAAQ,CAAC,iBAAiB;AACzD,QAAA,cAAc,EAAE,WAAW,CAAC,QAAQ,CAAC,cAAc;QACnD,UAAU,EAAE,WAAW,CAAC,QAAQ,CAAC,UAAU,CAAC,GAAG,CAC7C,mCAAmC,CACpC;KACF;AACH;AAEO,eAAe,oBAAoB,CACxC,OAAe,EACf,OAA0C,EAAA;AAE1C,IAAA,MAAM,iBAAiB,GAAG,kBAAkB,EAAE;IAE9C,IAAI,CAAC,iBAAiB,EAAE;AACtB,QAAA,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC;IAC9D;IAEA,MAAM,cAAc,GAAG,MAAM,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC;AAC1E,IAAA,MAAM,eAAe,GAAG,MAAMA,GAAqB,CAAC,cAAc,CAAC;AACnE,IAAA,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,EAAE;AAC1C,IAAA,MAAM,KAAK,GAAmB;AAC5B,QAAA,iBAAiB,EAAE,SAAS,CAAC,QAAQ,CAAC,iBAAiB;AACvD,QAAA,cAAc,EAAE,SAAS,CAAC,QAAQ,CAAC,cAAc;QACjD,YAAY,EAAE,SAAS,CAAC,EAAE;AAC1B,QAAA,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,SAAS;KACxC;AAED,IAAA,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;AAC9B;AAEO,eAAe,sBAAsB,CAC1C,OAA0C,EAAA;AAE1C,IAAA,MAAM,iBAAiB,GAAG,kBAAkB,EAAE;IAE9C,IAAI,CAAC,iBAAiB,EAAE;AACtB,QAAA,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC;IAC9D;AAEA,IAAA,MAAM,GAAG,GAAG,MAAMC,MAAwB,CAAC,OAAO,CAAC;AAEnD,IAAA,OAAO,qBAAqB,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;AAC5C;AAEA;AACA;AACA;AACA,SAAS,kBAAkB,GAAA;AACzB,IAAA,OAAO,CAAC,CAAC,MAAM,CAAC,mBAAmB;AACrC;;;;"}

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@0xkey-io/http",
+  "version": "0.1.0",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "license": "Apache-2.0",
+  "description": "Typed HTTP client for interacting with 0xkey API",
+  "keywords": [
+    "0xkey"
+  ],
+  "author": {
+    "name": "0xkey",
+    "url": "https://0xkey.com/"
+  },
+  "homepage": "https://github.com/0xkey-io/sdk-js/tree/main/packages/http",
+  "bugs": {
+    "url": "https://github.com/0xkey-io/sdk-js/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/0xkey-io/sdk-js.git",
+    "directory": "packages/http"
+  },
+  "files": [
+    "dist/",
+    "CHANGELOG.md",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "cross-fetch": "^3.1.5",
+    "@0xkey-io/encoding": "0.1.0",
+    "@0xkey-io/api-key-stamper": "0.1.0",
+    "@0xkey-io/webauthn-stamper": "0.1.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "version": "node -p \"'export const VERSION = ' + JSON.stringify(require('./package.json').name + '@' + require('./package.json').version) + ';'\" > src/version.ts",
+    "build": "rollup -c",
+    "clean": "rimraf ./dist ./.cache",
+    "test": "jest",
+    "typecheck": "tsc -p tsconfig.typecheck.json"
+  }
+}