summaryrefslogtreecommitdiffhomepage
path: root/packages/browser/src/helpers/webAuthnAbortService.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/browser/src/helpers/webAuthnAbortService.ts')
-rw-r--r--packages/browser/src/helpers/webAuthnAbortService.ts33
1 files changed, 26 insertions, 7 deletions
diff --git a/packages/browser/src/helpers/webAuthnAbortService.ts b/packages/browser/src/helpers/webAuthnAbortService.ts
index 50e00ba..395ceea 100644
--- a/packages/browser/src/helpers/webAuthnAbortService.ts
+++ b/packages/browser/src/helpers/webAuthnAbortService.ts
@@ -1,13 +1,10 @@
-/**
- * A way to cancel an existing WebAuthn request, for example to cancel a
- * WebAuthn autofill authentication request for a manual authentication attempt.
- */
-class WebAuthnAbortService {
+class BaseWebAuthnAbortService {
private controller: AbortController | undefined;
/**
* Prepare an abort signal that will help support multiple auth attempts without needing to
- * reload the page
+ * reload the page. This is automatically called whenever `startRegistration()` and
+ * `startAuthentication()` are called.
*/
createNewAbortSignal() {
// Abort any existing calls to navigator.credentials.create() or navigator.credentials.get()
@@ -24,6 +21,28 @@ class WebAuthnAbortService {
this.controller = newController;
return newController.signal;
}
+
+ /**
+ * Manually cancel any active WebAuthn registration or authentication attempt.
+ */
+ cancelCeremony() {
+ if (this.controller) {
+ const abortError = new Error(
+ 'Manually cancelling existing WebAuthn API call',
+ );
+ abortError.name = 'AbortError';
+ this.controller.abort(abortError);
+
+ this.controller = undefined;
+ }
+ }
}
-export const webauthnAbortService = new WebAuthnAbortService();
+/**
+ * A service singleton to help ensure that only a single WebAuthn ceremony is active at a time.
+ *
+ * Users of **@simplewebauthn/browser** shouldn't typically need to use this, but it can help e.g.
+ * developers building projects that use client-side routing to better control the behavior of
+ * their UX in response to router navigation events.
+ */
+export const WebAuthnAbortService = new BaseWebAuthnAbortService();