summaryrefslogtreecommitdiffhomepage
path: root/packages/browser/src/methods
diff options
context:
space:
mode:
Diffstat (limited to 'packages/browser/src/methods')
-rw-r--r--packages/browser/src/methods/startAssertion.test.ts127
-rw-r--r--packages/browser/src/methods/startAssertion.ts1
-rw-r--r--packages/browser/src/methods/startAttestation.test.ts87
-rw-r--r--packages/browser/src/methods/startAttestation.ts1
4 files changed, 151 insertions, 65 deletions
diff --git a/packages/browser/src/methods/startAssertion.test.ts b/packages/browser/src/methods/startAssertion.test.ts
index c74b88f..c077219 100644
--- a/packages/browser/src/methods/startAssertion.test.ts
+++ b/packages/browser/src/methods/startAssertion.test.ts
@@ -1,6 +1,8 @@
import {
AssertionCredential,
PublicKeyCredentialRequestOptionsJSON,
+ AuthenticationExtensionsClientInputs,
+ AuthenticationExtensionsClientOutputs,
} from '@simplewebauthn/typescript-types';
import supportsWebauthn from '../helpers/supportsWebauthn';
@@ -40,13 +42,6 @@ const goodOpts2UTF8: PublicKeyCredentialRequestOptionsJSON = {
};
beforeEach(() => {
- mockNavigatorGet.mockReset();
- mockSupportsWebauthn.mockReset();
-});
-
-test('should convert options before passing to navigator.credentials.get(...)', async done => {
- mockSupportsWebauthn.mockReturnValue(true);
-
// Stub out a response so the method won't throw
mockNavigatorGet.mockImplementation(
(): Promise<any> => {
@@ -59,6 +54,15 @@ test('should convert options before passing to navigator.credentials.get(...)',
},
);
+ mockSupportsWebauthn.mockReturnValue(true);
+});
+
+afterEach(() => {
+ mockNavigatorGet.mockReset();
+ mockSupportsWebauthn.mockReset();
+});
+
+test('should convert options before passing to navigator.credentials.get(...)', async done => {
await startAssertion(goodOpts1);
const argsPublicKey = mockNavigatorGet.mock.calls[0][0].publicKey;
@@ -73,20 +77,6 @@ test('should convert options before passing to navigator.credentials.get(...)',
});
test('should support optional allowCredential', async () => {
- mockSupportsWebauthn.mockReturnValue(true);
-
- // Stub out a response so the method won't throw
- mockNavigatorGet.mockImplementation(
- (): Promise<any> => {
- return new Promise(resolve => {
- resolve({
- response: {},
- getClientExtensionResults: () => ({}),
- });
- });
- },
- );
-
await startAssertion({
challenge: bufferToBase64URLString(toUint8Array('fizz')),
timeout: 1,
@@ -96,20 +86,6 @@ test('should support optional allowCredential', async () => {
});
test('should convert allow allowCredential to undefined when empty', async () => {
- mockSupportsWebauthn.mockReturnValue(true);
-
- // Stub out a response so the method won't throw
- mockNavigatorGet.mockImplementation(
- (): Promise<any> => {
- return new Promise(resolve => {
- resolve({
- response: {},
- getClientExtensionResults: () => ({}),
- });
- });
- },
- );
-
await startAssertion({
challenge: bufferToBase64URLString(toUint8Array('fizz')),
timeout: 1,
@@ -119,8 +95,6 @@ test('should convert allow allowCredential to undefined when empty', async () =>
});
test('should return base64url-encoded response values', async done => {
- mockSupportsWebauthn.mockReturnValue(true);
-
mockNavigatorGet.mockImplementation(
(): Promise<AssertionCredential> => {
return new Promise(resolve => {
@@ -162,8 +136,6 @@ test("should throw error if WebAuthn isn't supported", async done => {
});
test('should throw error if assertion is cancelled for some reason', async done => {
- mockSupportsWebauthn.mockReturnValue(true);
-
mockNavigatorGet.mockImplementation(
(): Promise<null> => {
return new Promise(resolve => {
@@ -178,20 +150,6 @@ test('should throw error if assertion is cancelled for some reason', async done
});
test('should handle UTF-8 challenges', async done => {
- mockSupportsWebauthn.mockReturnValue(true);
-
- // Stub out a response so the method won't throw
- mockNavigatorGet.mockImplementation(
- (): Promise<any> => {
- return new Promise(resolve => {
- resolve({
- response: {},
- getClientExtensionResults: () => ({}),
- });
- });
- },
- );
-
await startAssertion(goodOpts2UTF8);
const argsPublicKey = mockNavigatorGet.mock.calls[0][0].publicKey;
@@ -221,3 +179,66 @@ test('should handle UTF-8 challenges', async done => {
done();
});
+
+test('should send extensions to authenticator if present in options', async done => {
+ const extensions: AuthenticationExtensionsClientInputs = {
+ credProps: true,
+ appid: 'appidHere',
+ uvm: true,
+ appidExclude: 'appidExcludeHere',
+ };
+ const optsWithExts: PublicKeyCredentialRequestOptionsJSON = {
+ ...goodOpts1,
+ extensions,
+ };
+ await startAssertion(optsWithExts);
+
+ const argsExtensions = mockNavigatorGet.mock.calls[0][0].publicKey.extensions;
+
+ expect(argsExtensions).toEqual(extensions);
+
+ done();
+});
+
+test('should not set any extensions if not present in options', async done => {
+ await startAssertion(goodOpts1);
+
+ const argsExtensions = mockNavigatorGet.mock.calls[0][0].publicKey.extensions;
+
+ expect(argsExtensions).toEqual(undefined);
+
+ done();
+});
+
+test('should include extension results', async done => {
+ const extResults: AuthenticationExtensionsClientOutputs = {
+ appid: true,
+ credProps: {
+ rk: true,
+ },
+ };
+
+ // Mock extension return values from authenticator
+ mockNavigatorGet.mockImplementation(
+ (): Promise<any> => {
+ return new Promise(resolve => {
+ resolve({ response: {}, getClientExtensionResults: () => extResults });
+ });
+ },
+ );
+
+ // Extensions aren't present in this object, but it doesn't matter since we're faking the response
+ const response = await startAssertion(goodOpts1);
+
+ expect(response.clientExtensionResults).toEqual(extResults);
+
+ done();
+});
+
+test('should include extension results when no extensions specified', async done => {
+ const response = await startAssertion(goodOpts1);
+
+ expect(response.clientExtensionResults).toEqual({});
+
+ done();
+});
diff --git a/packages/browser/src/methods/startAssertion.ts b/packages/browser/src/methods/startAssertion.ts
index e02e577..fa25f47 100644
--- a/packages/browser/src/methods/startAssertion.ts
+++ b/packages/browser/src/methods/startAssertion.ts
@@ -60,5 +60,6 @@ export default async function startAssertion(
userHandle,
},
type,
+ clientExtensionResults: credential.getClientExtensionResults(),
};
}
diff --git a/packages/browser/src/methods/startAttestation.test.ts b/packages/browser/src/methods/startAttestation.test.ts
index 0723213..b4cfa52 100644
--- a/packages/browser/src/methods/startAttestation.test.ts
+++ b/packages/browser/src/methods/startAttestation.test.ts
@@ -1,5 +1,7 @@
import {
AttestationCredential,
+ AuthenticationExtensionsClientInputs,
+ AuthenticationExtensionsClientOutputs,
PublicKeyCredentialCreationOptionsJSON,
} from '@simplewebauthn/typescript-types';
@@ -46,22 +48,24 @@ const goodOpts1: PublicKeyCredentialCreationOptionsJSON = {
};
beforeEach(() => {
- mockNavigatorCreate.mockReset();
- mockSupportsWebauthn.mockReset();
-});
-
-test('should convert options before passing to navigator.credentials.create(...)', async done => {
- mockSupportsWebauthn.mockReturnValue(true);
-
// Stub out a response so the method won't throw
mockNavigatorCreate.mockImplementation(
(): Promise<any> => {
return new Promise(resolve => {
- resolve({ response: {} });
+ resolve({ response: {}, getClientExtensionResults: () => ({}) });
});
},
);
+ mockSupportsWebauthn.mockReturnValue(true);
+});
+
+afterEach(() => {
+ mockNavigatorCreate.mockReset();
+ mockSupportsWebauthn.mockReset();
+});
+
+test('should convert options before passing to navigator.credentials.create(...)', async done => {
await startAttestation(goodOpts1);
const argsPublicKey = mockNavigatorCreate.mock.calls[0][0].publicKey;
@@ -81,8 +85,6 @@ test('should convert options before passing to navigator.credentials.create(...)
});
test('should return base64url-encoded response values', async done => {
- mockSupportsWebauthn.mockReturnValue(true);
-
mockNavigatorCreate.mockImplementation(
(): Promise<AttestationCredential> => {
return new Promise(resolve => {
@@ -120,8 +122,6 @@ test("should throw error if WebAuthn isn't supported", async done => {
});
test('should throw error if attestation is cancelled for some reason', async done => {
- mockSupportsWebauthn.mockReturnValue(true);
-
mockNavigatorCreate.mockImplementation(
(): Promise<null> => {
return new Promise(resolve => {
@@ -134,3 +134,66 @@ test('should throw error if attestation is cancelled for some reason', async don
done();
});
+
+test('should send extensions to authenticator if present in options', async done => {
+ const extensions: AuthenticationExtensionsClientInputs = {
+ credProps: true,
+ appid: 'appidHere',
+ uvm: true,
+ appidExclude: 'appidExcludeHere',
+ };
+ const optsWithExts: PublicKeyCredentialCreationOptionsJSON = {
+ ...goodOpts1,
+ extensions,
+ };
+ await startAttestation(optsWithExts);
+
+ const argsExtensions = mockNavigatorCreate.mock.calls[0][0].publicKey.extensions;
+
+ expect(argsExtensions).toEqual(extensions);
+
+ done();
+});
+
+test('should not set any extensions if not present in options', async done => {
+ await startAttestation(goodOpts1);
+
+ const argsExtensions = mockNavigatorCreate.mock.calls[0][0].publicKey.extensions;
+
+ expect(argsExtensions).toEqual(undefined);
+
+ done();
+});
+
+test('should include extension results', async done => {
+ const extResults: AuthenticationExtensionsClientOutputs = {
+ appid: true,
+ credProps: {
+ rk: true,
+ },
+ };
+
+ // Mock extension return values from authenticator
+ mockNavigatorCreate.mockImplementation(
+ (): Promise<any> => {
+ return new Promise(resolve => {
+ resolve({ response: {}, getClientExtensionResults: () => extResults });
+ });
+ },
+ );
+
+ // Extensions aren't present in this object, but it doesn't matter since we're faking the response
+ const response = await startAttestation(goodOpts1);
+
+ expect(response.clientExtensionResults).toEqual(extResults);
+
+ done();
+});
+
+test('should include extension results when no extensions specified', async done => {
+ const response = await startAttestation(goodOpts1);
+
+ expect(response.clientExtensionResults).toEqual({});
+
+ done();
+});
diff --git a/packages/browser/src/methods/startAttestation.ts b/packages/browser/src/methods/startAttestation.ts
index 0b2235d..22ebe64 100644
--- a/packages/browser/src/methods/startAttestation.ts
+++ b/packages/browser/src/methods/startAttestation.ts
@@ -51,6 +51,7 @@ export default async function startAttestation(
clientDataJSON: bufferToBase64URLString(response.clientDataJSON),
},
type,
+ clientExtensionResults: credential.getClientExtensionResults(),
};
/**
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-28 13:09:35 +0000