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

Redact sensitive data in Plugwise diagnostics #116338

Draft
wants to merge 4 commits into
base: dev
Choose a base branch
from

Conversation

bouwew
Copy link
Contributor

@bouwew bouwew commented Apr 28, 2024

Proposed change

Redact sensitive data in Plugwise diagnostics.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • 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:

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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @CoMPaTech, @frenck, mind taking a look at this pull request as it has been labeled with an integration (plugwise) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of plugwise can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign plugwise Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@bouwew bouwew marked this pull request as ready for review April 28, 2024 13:28
@bouwew bouwew requested a review from frenck as a code owner April 28, 2024 13:28
@joostlek
Copy link
Member

What's the main reason you want to hide this? I think this data is helpful with checking what device is problematic

@bouwew
Copy link
Contributor Author

bouwew commented Apr 29, 2024

Hi Joost, the non-MAC-related parts often contain privacy-sensitive information like a persons name, that's why they are proposed to be redacted.

But now that I think about this again, I would like to redact the separate schedule-names each, and show when the select_schedule is "off" or "None" instead of a schedule-name.

@bouwew bouwew marked this pull request as draft April 29, 2024 06:06
@bouwew bouwew marked this pull request as ready for review May 2, 2024 06:41
@bouwew
Copy link
Contributor Author

bouwew commented May 2, 2024

@joostlek The code was updated in such a way that all info us code-owners want to retain, while redacting the actual info, is still present.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

I think I agree with @joostlek here, I'm not sure what is sensitive here, especially looking at the zigbee addresses in this case.

Also there is some custom logic in here that does stuff with our general redaction (like adding a postfix **REDACTED_4**).

@home-assistant home-assistant bot marked this pull request as draft May 13, 2024 18:46
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

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

Successfully merging this pull request may close these issues.

None yet

3 participants