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

Allow Supervisor token authentication from landing page #5321

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

agners
Copy link
Member

@agners agners commented Oct 3, 2024

Proposed change

The landing page provides the Supervisor token as authentication, so consider the landingpage as new enough too.

This will enable network configuration (e.g. DNS) from the landing page.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:
  • Link to cli pull request:
  • Link to client library pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Ruff (ruff format supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints or add-on configuration are added/changed:

Summary by CodeRabbit

  • New Features

    • Enhanced request validation for Home Assistant based on version checks.
  • Bug Fixes

    • Improved logic in the core_proxy middleware to ensure compatibility with the latest Home Assistant version.

The landing page provides the Supervisor token as authentication, so
consider the landingpage as new enough too.
Copy link

coderabbitai bot commented Oct 3, 2024

📝 Walkthrough

Walkthrough

The changes involve modifications to the core_proxy middleware method within the supervisor/api/middleware/security.py file. A new import statement for LANDINGPAGE has been added, and the logic of the middleware has been updated to include an additional condition that checks the request[REQUEST_FROM] against self.sys_homeassistant. The original condition was simplified to verify if self.sys_homeassistant.version equals LANDINGPAGE, alongside an existing check for version compatibility with _CORE_VERSION.

Changes

File Path Change Summary
supervisor/api/middleware/security.py Added import for LANDINGPAGE and modified core_proxy method logic to include an additional version check.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Middleware
    participant HomeAssistant

    Client->>Middleware: Send request
    Middleware->>HomeAssistant: Check version
    alt Version is LANDINGPAGE
        Middleware-->>Client: Allow request
    else Version is new enough
        Middleware-->>Client: Allow request
    else Version is not valid
        Middleware-->>Client: Reject request
    end
Loading

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?

❤️ Share
🪧 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 @coderabbitai in 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 @coderabbitai in 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 pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file 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.

agners added a commit to home-assistant/landingpage that referenced this pull request Oct 3, 2024
Check host network connectivity and offer DNS alternatives in case host
internet is not available. This allows users with broken DNS setup
to configure the host network with a working DNS.

Requires home-assistant/supervisor#5321.
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 911f9d6 and 0ca469a.

📒 Files selected for processing (1)
  • supervisor/api/middleware/security.py (2 hunks)
🔇 Additional comments (2)
supervisor/api/middleware/security.py (2)

12-13: LGTM: Import statement for LANDINGPAGE added.

The addition of the LANDINGPAGE import from supervisor.homeassistant.const aligns with the PR objective of enabling Supervisor token authentication from the landing page.


Line range hint 1-338: Summary: Changes align with PR objective, minor fix needed.

The modifications to the security.py file successfully implement the ability to authenticate Supervisor tokens from the landing page. This is achieved by:

  1. Importing the LANDINGPAGE constant.
  2. Modifying the core_proxy middleware to allow requests when the Home Assistant version is LANDINGPAGE.

These changes align well with the PR objective and maintain backwards compatibility. The existing security measures remain intact, ensuring that the new functionality doesn't compromise the system's security.

However, there's a minor indentation issue in the core_proxy method that needs to be corrected to prevent syntax errors.

Once the indentation is fixed, the implementation looks good to merge.

To ensure that the LANDINGPAGE constant is correctly defined and imported, please run the following verification script:

supervisor/api/middleware/security.py Show resolved Hide resolved
agners added a commit to home-assistant/landingpage that referenced this pull request Oct 3, 2024
Check host network connectivity and offer DNS alternatives in case host
internet is not available. This allows users with broken DNS setup
to configure the host network with a working DNS.

Requires home-assistant/supervisor#5321.
agners added a commit to home-assistant/landingpage that referenced this pull request Oct 3, 2024
Check host network connectivity and offer DNS alternatives in case host
internet is not available. This allows users with broken DNS setup
to configure the host network with a working DNS.

Requires home-assistant/supervisor#5321.
@agners agners merged commit ee5ded2 into main Oct 3, 2024
21 checks passed
@agners agners deleted the allow-token-auth-for-landingpage branch October 3, 2024 16:17
@github-actions github-actions bot locked and limited conversation to collaborators Oct 5, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants