summaryrefslogtreecommitdiffhomepage
path: root/packages/browser/src/helpers/identifyAuthenticationError.ts
blob: bf88628358ab70856f9997a34964db176e275803 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
import { isValidDomain } from './isValidDomain';
import { WebAuthnError } from './structs';


/**
 * Attempt to intuit _why_ an error was raised after calling `navigator.credentials.get()`
 */
export function identifyAuthenticationError({
  error,
  options,
}: {
  error: Error,
  options: CredentialRequestOptions,
}): WebAuthnError | Error {
  const { publicKey } = options;

  if (!publicKey) {
    throw Error('options was missing required publicKey property');
  }

  if (error.name === 'AbortError') {
    if (options.signal === (new AbortController()).signal) {
      // https://www.w3.org/TR/webauthn-2/#sctn-createCredential (Step 16)
      return new WebAuthnError('Authentication ceremony was sent an abort signal (AbortError)');
    }
  } else if (error.name === 'NotAllowedError') {
    if (publicKey.allowCredentials?.length) {
      // https://www.w3.org/TR/webauthn-2/#sctn-discover-from-external-source (Step 17)
      // https://www.w3.org/TR/webauthn-2/#sctn-op-get-assertion (Step 6)
      return new WebAuthnError(
        'No available authenticator recognized any of the allowed credentials (NotAllowedError)'
      );
    }

    // https://www.w3.org/TR/webauthn-2/#sctn-discover-from-external-source (Step 18)
    // https://www.w3.org/TR/webauthn-2/#sctn-op-get-assertion (Step 7)
    return new WebAuthnError('User clicked cancel, or the authentication ceremony timed out (NotAllowedError)');
  } else if (error.name === 'SecurityError') {
    const effectiveDomain = window.location.hostname;
    if (!isValidDomain(effectiveDomain)) {
      // https://www.w3.org/TR/webauthn-2/#sctn-discover-from-external-source (Step 5)
      return new WebAuthnError(`${window.location.hostname} is an invalid domain (SecurityError)`);
    } else if (publicKey.rpId !== effectiveDomain) {
      // https://www.w3.org/TR/webauthn-2/#sctn-discover-from-external-source (Step 6)
      return new WebAuthnError(`The RP ID "${publicKey.rpId}" is invalid for this domain (SecurityError)`);
    }
  } else if (error.name === 'UnknownError') {
    // https://www.w3.org/TR/webauthn-2/#sctn-op-get-assertion (Step 1)
    // https://www.w3.org/TR/webauthn-2/#sctn-op-get-assertion (Step 12)
    return new WebAuthnError(
      'The authenticator was unable to process the specified options, or could not create a new assertion signature (UnknownError)'
    );
  }

  return error;
}