SimpleWebAuthn 项目关于用户显示名称默认值的优化解析

SimpleWebAuthn 是一个优秀的 WebAuthn 实现库，近期在其服务器端组件 @simplewebauthn/server 的 10.0.0 版本中，对用户注册选项生成函数 generateRegistrationOptions() 进行了重要优化，使其更符合 WebAuthn 规范的最新要求。

背景知识

在 WebAuthn 认证流程中，PublicKeyCredentialUserEntity 是一个关键的数据结构，它包含了用户的基本信息。其中 displayName 属性用于存储用户的可读名称，这个名称主要用于界面展示。

问题发现

在早期的 WebAuthn 规范实现中，当开发者没有明确指定 displayName 时，SimpleWebAuthn 会默认使用 userName 的值作为 displayName。这种做法虽然方便，但并不完全符合 WebAuthn 规范的最新要求。

规范演进

WebAuthn 规范 Level 3 版本对 displayName 属性做出了更明确的定义：

1. 这个属性应该是用户可读的名称
2. 应该尽可能让用户自行选择这个名称
3. 当没有合适的、用户可读的名称可用时，应该将其设置为空字符串

技术实现调整

基于这一规范变化，SimpleWebAuthn 项目做出了相应调整：

1. 在 generateRegistrationOptions() 函数中
2. 当用户没有提供 displayName 时
3. 不再默认使用 userName 的值
4. 而是将其设置为空字符串

升级建议

对于使用 SimpleWebAuthn 的开发者：

1. 升级到 10.0.0 或更高版本
2. 检查现有代码中对 displayName 的处理逻辑
3. 如果需要保留原有行为，可以显式地将 userName 赋值给 displayName

总结

这一变更体现了 SimpleWebAuthn 项目对 WebAuthn 规范的严格遵守，也展示了开源项目持续改进的精神。对于开发者而言，理解这一变化有助于构建更加规范、安全的 WebAuthn 认证流程。