From ccac96ae7e4a905e8d92dc70ca3f7463cacc5347 Mon Sep 17 00:00:00 2001
From: hjaber <hjaberx@gmail.com>
Date: Thu, 14 Nov 2024 13:54:28 -0800
Subject: [PATCH] Allow passing custom AbortController to register and
 authenticate functions without breaking existing behavior

---
 src/client.ts | 45 +++++++++++++++++++++++++++++++++------------
 src/types.ts  |  2 ++
 2 files changed, 35 insertions(+), 12 deletions(-)

diff --git a/src/client.ts b/src/client.ts
index d3d8f67..f756acb 100644
--- a/src/client.ts
+++ b/src/client.ts
@@ -1,4 +1,4 @@
-import { AuthenticateOptions, AuthenticationJSON, Base64URLString, CredentialDescriptor, ExtendedAuthenticatorTransport, PublicKeyCredentialHints, RegisterOptions, RegistrationJSON, User, WebAuthnCreateOptions, WebAuthnGetOptions } from './types.js'
+import { AuthenticateOptions, AuthenticationJSON, Base64URLString, CredentialDescriptor, PublicKeyCredentialHints, RegisterOptions, RegistrationJSON, User, WebAuthnCreateOptions, WebAuthnGetOptions } from './types.js'
 import * as utils from './utils'
 
 /**
@@ -53,6 +53,8 @@ let ongoingAuth: AbortController | null = null;
  * @param {'discouraged'|'preferred'|'required'} [discoverable] A "discoverable" credential can be selected using `authenticate(...)` without providing credential IDs.
  *              Instead, a native pop-up will appear for user selection.
  *              This may have an impact on the "passkeys" user experience and syncing behavior of the key.
+ * * @param {AbortSignal} [signal] An optional AbortSignal to allow aborting the registration process.
+ * If not provided, a global AbortController is used to abort any ongoing authentication.
  */
 export async function register(options: RegisterOptions): Promise<RegistrationJSON> {
 
@@ -97,14 +99,23 @@ export async function register(options: RegisterOptions): Promise<RegistrationJS
 
     console.debug(creationOptions)
 
-    if (ongoingAuth != null)
-        ongoingAuth.abort('Cancel ongoing authentication')
-    ongoingAuth = new AbortController();
+    let signal: AbortSignal;
+    if (options.signal) {
+        // Use the provided signal
+        signal = options.signal;
+    } else {
+        // Use the global ongoingAuth
+        if (ongoingAuth != null) {
+            ongoingAuth.abort('Cancel ongoing authentication');
+        }
+        ongoingAuth = new AbortController();
+        signal = ongoingAuth.signal;
+    }
 
     const raw = await navigator.credentials.create({
         publicKey: creationOptions,
-        signal: ongoingAuth?.signal
-    }) as PublicKeyCredential
+        signal: signal,
+    }) as PublicKeyCredential;
     const response = raw.response as AuthenticatorAttestationResponse
 
     ongoingAuth = null;
@@ -150,6 +161,8 @@ export async function isAutocompleteAvailable() {
  * @param {number} [timeout=60000] Number of milliseconds the user has to respond to the biometric/PIN check.
  * @param {'required'|'preferred'|'discouraged'} [userVerification='required'] Whether to prompt for biometric/PIN check or not.
  * @param {boolean} [conditional] Does not return directly, but only when the user has selected a credential in the input field with `autocomplete="username webauthn"`
+ * @param {AbortSignal} [options.signal] An optional signal to abort the authentication request.
+ * If not provided, a global AbortController is used to abort any ongoing authentication.
  */
 export async function authenticate(options: AuthenticateOptions): Promise<AuthenticationJSON> {
     if (!utils.isBase64url(options.challenge))
@@ -169,16 +182,24 @@ export async function authenticate(options: AuthenticateOptions): Promise<Authen
 
     console.debug(authOptions)
 
-    if(ongoingAuth != null)
-        ongoingAuth.abort('Cancel ongoing authentication')
-    
-    ongoingAuth = new AbortController();
+    let signal: AbortSignal;
+    if (options.signal) {
+        // Use the provided signal
+        signal = options.signal;
+    } else {
+        // Use the global ongoingAuth
+        if (ongoingAuth != null) {
+            ongoingAuth.abort('Cancel ongoing authentication');
+        }
+        ongoingAuth = new AbortController();
+        signal = ongoingAuth.signal;
+    }
     
     const raw = await navigator.credentials.get({
         publicKey: authOptions,
         mediation: options.autocomplete ? 'conditional' : undefined,
-        signal: ongoingAuth?.signal
-    }) as PublicKeyCredential
+        signal: signal,
+    }) as PublicKeyCredential;
 
     if (raw.type != "public-key")
         throw "Unexpected credential type!";
diff --git a/src/types.ts b/src/types.ts
index 36b5733..18b485a 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -35,6 +35,7 @@ export interface CommonOptions {
 export interface RegisterOptions extends CommonOptions {
   attestation?: boolean
   discoverable?: ResidentKeyRequirement
+  signal?: AbortSignal
   user: string | User
 }
 
@@ -56,6 +57,7 @@ export interface CredentialDescriptor {
 export interface AuthenticateOptions extends CommonOptions {
   allowCredentials?: (CredentialDescriptor | string)[]
   autocomplete?: boolean
+  signal?: AbortSignal
 }