@dfns/sdk-browser 0.6.0-rc1 → 0.6.0

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@dfns/sdk-browser",
-  "version": "0.6.0-rc1",
+  "version": "0.6.0",
   "dependencies": {
     "buffer": "6.0.3",
     "cross-fetch": "3.1.6",
     "uuid": "9.0.0"
   },
   "peerDependencies": {
-    "@dfns/sdk": "0.6.0-rc1"
+    "@dfns/sdk": "0.6.0"
   },
   "main": "./index.js",
   "type": "commonjs"

package/signers/webauthn.d.ts

@@ -1,13 +1,31 @@
 import { CredentialSigner, CredentialStore, Fido2Assertion, Fido2Attestation, UserActionChallenge } from '@dfns/sdk';
 import { CreateCredentialChallengeResponse, CreateRegistrationChallengeResponse } from '@dfns/sdk/generated/auth';
 export declare const DEFAULT_WAIT_TIMEOUT = 60000;
+interface WebAuthnSignerConf {
+    /**
+     * The relying party identifies your application to users, when users create/use passkeys. (Read more [here](https://www.w3.org/TR/webauthn-2/#relying-party)).
+     * - id: The relying party identifier is a valid domain string identifying the WebAuthn Relying Party.
+     * In other words, its the domain your application is running on, which will be tied to the passkeys that users create.
+     * We advise to use the root domain, not the full domain (eg `acme.com`, not `app.acme.com` nor `foo.app.acme.com`), that way, passkeys created
+     * by your users can be re-used on other subdomains (eg. on `foo.acme.com` and `bar.acme.com`) in the future. Read more [here](https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredentialCreationOptions#rp).
+     * - name: A string representing the name of the relying party (e.g. "Acme"). This is the name the user will be presented with when creating or validating a WebAuthn operation.
+     */
+    relyingParty: {
+        id: string;
+        name: string;
+    };
+    /**
+     * Timeout to use for navigotor.credentials calls. That's the time after which if user did not successfully
+     * select and use his passkey, an error will be thrown by webauthn client. Read more [here](https://developer.mozilla.org/en-US/docs/Web/API/PublicKeyCredentialCreationOptions#timeout).
+     * */
+    timeout?: number;
+}
 export declare class WebAuthnSigner implements CredentialSigner<Fido2Assertion>, CredentialStore<Fido2Attestation> {
-    private options?;
-    constructor(options?: {
-        timeout?: number | undefined;
-    } | undefined);
+    private conf;
+    constructor(conf: WebAuthnSignerConf);
     sign(challenge: UserActionChallenge): Promise<Fido2Assertion>;
     create(challenge: CreateRegistrationChallengeResponse | (CreateCredentialChallengeResponse & {
         kind: 'Fido2';
     })): Promise<Fido2Attestation>;
 }
+export {};

package/signers/webauthn.js

@@ -6,8 +6,11 @@ const utils_1 = require("@dfns/sdk/utils");
 const buffer_1 = require("buffer");
 exports.DEFAULT_WAIT_TIMEOUT = 60000;
 class WebAuthnSigner {
-    constructor(options) {
-        this.options = options;
+    constructor(conf) {
+        this.conf = conf;
+        if (!this.conf?.relyingParty?.id || !this.conf?.relyingParty?.name) {
+            throw new sdk_1.DfnsError(-1, `Relying party ID and name must be specified in the WebauthnSigner initializer`);
+        }
     }
     async sign(challenge) {
         const response = await navigator.credentials.get({
@@ -17,9 +20,9 @@ class WebAuthnSigner {
                     id: (0, utils_1.fromBase64Url)(id),
                     type,
                 })),
-                rpId: challenge.rp.id,
+                rpId: this.conf.relyingParty.id,
                 userVerification: challenge.userVerification,
-                timeout: this.options?.timeout ?? exports.DEFAULT_WAIT_TIMEOUT,
+                timeout: this.conf.timeout ?? exports.DEFAULT_WAIT_TIMEOUT,
             },
         });
         if (response === null) {
@@ -43,7 +46,7 @@ class WebAuthnSigner {
             publicKey: {
                 challenge: buffer_1.Buffer.from(challenge.challenge),
                 pubKeyCredParams: challenge.pubKeyCredParams,
-                rp: challenge.rp,
+                rp: this.conf.relyingParty,
                 user: {
                     displayName: challenge.user.displayName,
                     id: buffer_1.Buffer.from(challenge.user.id),
@@ -55,7 +58,7 @@ class WebAuthnSigner {
                     type,
                 })),
                 authenticatorSelection: challenge.authenticatorSelection,
-                timeout: this.options?.timeout ?? exports.DEFAULT_WAIT_TIMEOUT,
+                timeout: this.conf.timeout ?? exports.DEFAULT_WAIT_TIMEOUT,
             },
         };
         const response = await navigator.credentials.create(options);