Skip to content
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.

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

Make user.displayName optional? #2024

Closed
emlun opened this issue Feb 14, 2024 · 2 comments
Closed

Make user.displayName optional? #2024

emlun opened this issue Feb 14, 2024 · 2 comments
Assignees

Comments

@emlun
Copy link
Member

emlun commented Feb 14, 2024

This was brought up in #1942: Since PR #1932, the description of PublicKeyCredentialUserEntity.displayName includes:

[...] If no suitable or human-palatable name is available, the Relying Party SHOULD set this value to an empty string.

The motivation for this being that setting displayName to empty seemed preferable to setting both name and displayName to the same value. With this in mind, should PublicKeyCredentialUserEntity.displayName be made optional, defaulting to an empty string?

@emlun
Copy link
Member Author

emlun commented Feb 14, 2024

This change may be backwards-incompatible: RPs would still have to set a displayName value in case the browser hasn't yet updated to WebAuthn L3 and therefore would return an error instead of assigning displayName the new default value.

@MasterKale
Copy link
Contributor

There's too much of a foot gun for RP's right now to consider omitting displayName when displayName: "" would maintain backwards compatibility with clients that hadn't updated to support optional displayName, if that change were to be made to the spec.

I vote we close this issue out, the benefits don't seem to outweigh the potential risks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants