Skip to content

fix(javascript-sdk): prioritize displayName for WebAuthn name attribute #527

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 19, 2024
Merged

fix(javascript-sdk): prioritize displayName for WebAuthn name attribute #527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/great-bobcats-fry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@forgerock/javascript-sdk': patch
---

In order to display a more user-friendly name when saving a WebAuthn/Passkey device to an account, we prioritized displayName over userName for assignment to the `name` property of the WebAuthn options object. This avoids the display of UUIDs for saved credentials.
9 changes: 5 additions & 4 deletions e2e/autoscript-apps/src/authn-webauthn/autoscript.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
*
* autoscript.ts
*
* Copyright (c) 2020 ForgeRock. All rights reserved.
* Copyright (c) 2024 Ping Identity. All rights reserved.
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
Expand Down Expand Up @@ -61,8 +62,8 @@ function autoscript() {
rxDelay(delay),
mergeMap((step) => {
console.log('Choose Passwordless login');
const cb = step.getCallbackOfType('ChoiceCallback');
cb.setChoiceIndex(0);
const cb = step.getCallbackOfType('ConfirmationCallback');
Copy link
Contributor

@george-bafaloukas-forgerock george-bafaloukas-forgerock Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

has the test journey change and send a confirmation callback?

Copy link
Contributor Author

@cerebrl cerebrl Dec 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test journey was removed, so I duplicated a journey that Stoyan uses, and it had a Confirmation Callback instead. This is a manual test, and not automation, so changes here don't affect CI.

cb.setOptionIndex(0);
return forgerock.FRAuth.next(step);
}),
rxDelay(delay),
Expand Down Expand Up @@ -128,7 +129,7 @@ function autoscript() {
// Needed for testing WebAuthn on Safari due to user event needed
console.log('Click the continue button!');
const continueBtn = document.querySelector('.continue-btn');
return rxjs.fromEvent(continueBtn, 'click');
return fromEvent(continueBtn, 'click');
}),
mergeMap(() => {
console.log('Log back in with WebAuthn');
Expand Down
5 changes: 3 additions & 2 deletions packages/javascript-sdk/src/fr-webauthn/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
*
* index.ts
*
* Copyright (c) 2020 ForgeRock. All rights reserved.
* Copyright (c) 2024 Ping Identity. All rights reserved.
*
* This software may be modified and distributed under the terms
* of the MIT license. See the LICENSE file for details.
*/
Expand Down Expand Up @@ -461,7 +462,7 @@ abstract class FRWebAuthn {
user: {
displayName: displayName || userName,
id: Int8Array.from(userId.split('').map((c: string) => c.charCodeAt(0))),
name: userName,
name: displayName || userName,
},
};
}
Expand Down
Loading