Add webauthn auth provider UI components
Breaking change
Proposed change
Add webauthn auth provider UI functionality.
Core PR: https://github.com/home-assistant/core/pull/122725
Type of change
- [ ] Dependency upgrade
- [ ] Bugfix (non-breaking change which fixes an issue)
- [x] New feature (thank you!)
- [ ] Breaking change (fix/feature causing existing functionality to break)
- [ ] Code quality improvements to existing code or addition of tests
Example configuration
homeassistant:
auth_providers:
- type: homeassistant
- type: webauthn
rp_id: localhost
expected_origin: http://localhost:8123
Additional information
- This PR fixes or closes issue: fixes #
- This PR is related to issue or discussion:
- Link to documentation pull request: https://github.com/home-assistant/home-assistant.io/pull/33998
Checklist
- [x] The code change is tested and works locally.
- [x] There is no commented out code in this PR.
- [ ] Tests have been added to verify that the new code works.
If user exposed functionality or configuration variables are added/changed:
- [ ] Documentation added/updated for www.home-assistant.io
Summary by CodeRabbit
Summary by CodeRabbit
-
New Features
- Introduced support for WebAuthn authentication, enhancing security with passkey management.
- Added a new interface for managing passkeys and related authentication processes.
- Implemented a user-friendly component for viewing, adding, renaming, and deleting passkeys within user profiles.
-
Bug Fixes
- Improved error handling for passkey operations to enhance user experience.
-
Documentation
- Updated translations to include new user interface elements and prompts related to passkeys and WebAuthn.
[!IMPORTANT]
Review skipped
Auto reviews are disabled on this repository.
Please check the settings in the CodeRabbit UI or the
.coderabbit.yamlfile in this repository. To trigger a single review, invoke the@coderabbitai reviewcommand.You can disable this status message by setting the
reviews.review_statustofalsein the CodeRabbit configuration file.
Walkthrough
The recent changes integrate WebAuthn functionality to enhance authentication security within the application. Key updates include the introduction of TypeScript interfaces for passkeys, modifications to the authentication flow to manage credentials, and the addition of a user-friendly component for passkey management in user profiles. These enhancements modernize the authentication process and improve user experience with clear interactions and informative feedback.
Changes
| Files | Change Summary |
|---|---|
src/auth/ha-auth-flow.ts |
Expanded HaAuthFlow class to handle WebAuthn, adding methods for credential management and improved error handling. |
src/data/webauthn.ts |
Introduced interfaces for handling WebAuthn passkeys and credentials, defining structures for credential requests, user entities, and various authentication options. |
src/data/data_entry_flow.ts, src/panels/profile/ha-profile-section-security.ts, src/panels/profile/ha-setup-passkey-card.ts |
Added passkey management features, including new types and methods to refresh passkey data, and implemented a component for users to manage passkeys. |
src/translations/en.json |
Added new translations for passkeys and WebAuthn-related strings, enhancing user interface feedback during authentication workflows. |
src/panels/config/integrations/integration-panels/matter/matter-add-device.ts, src/panels/config/integrations/integration-panels/zwave_js/zwave_js-add-node.ts |
Transitioned components to extend LitElement for improved rendering and state management. |
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
🪧 Tips
Chat
There are 3 ways to chat with CodeRabbit:
- Review comments: Directly reply to a review comment made by CodeRabbit. Example:
I pushed a fix in commit <commit_id>, please review it.Generate unit testing code for this file.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai generate unit testing code for this file.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.@coderabbitai read src/utils.ts and generate unit testing code.@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.@coderabbitai help me debug CodeRabbit configuration file.
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.
CodeRabbit Commands (Invoked using PR comments)
@coderabbitai pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile to the root of your repository. - Please see the configuration documentation for more information.
- If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation:
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
Documentation and Community
- Visit our Documentation for detailed information on how to use CodeRabbit.
- Join our Discord Community to get help, request features, and share feedback.
- Follow us on X/Twitter for updates and announcements.
@silamon Thanks for your review. All your comments were counted in the following commits.
The failing lint isn't related to your pull request, but I'm not sure why it pops up here for the first time either. Anyway, those changes shouldn't be added to this branch.
Okay, I will remove the last commit, thanks.
P.S. Meanwhile, I pulled the current dev, ran lint there, and faced the same errors that CI
Okay, I will remove the last commit, thanks.
P.S. Meanwhile, I pulled the current dev, ran lint there, and faced the same errors that CI
I've opened a separate pull request with the commit. It's the cache on dev being valid, hence not detecting the error.
any reason this was closed as it was getting near to being merged?
any reason this was closed as it was getting near to being merged?
https://github.com/home-assistant/core/pull/122725#issuecomment-2477530830 🪓