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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hide credentials from generated titles in generic camera #70204

Merged

Conversation

davet2001
Copy link
Contributor

@davet2001 davet2001 commented Apr 17, 2022

Proposed change

When the generic camera integration is set up via a config flow, a title is automatically generated based on the url.

Unfortunately the generated string also includes credentials
e.g.
rtsp://username:pass@192.168.0.10/xxx
creates title
username_pass_192_168_0_10_xxx

This PR drops the credentials from the URL before generating the title string.

Update:
To deal with other places there could be sensitive parameters, the PR now just uses the hostname.

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)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

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 Black (black --fast 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.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

To help with the load of incoming pull requests:

@davet2001 davet2001 changed the title Hide credentials from generated titles Hide credentials from generated titles in generic camera Apr 17, 2022
@bdraco bdraco added this to the 2022.4.6 milestone Apr 17, 2022
def slug_url(url) -> str | None:
"""Convert a camera url into a string suitable for a camera name."""
if not url:
return None
url = URL_RE.sub("//", url)
url_no_scheme = urlparse(url)._replace(scheme="")
Copy link
Member

@bdraco bdraco Apr 17, 2022

Choose a reason for hiding this comment

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

Untested, but I think it makes sense to do something like _replace(username=None)._replace(password=None) instead?

https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlparse

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, will try it.

Copy link
Member

Choose a reason for hiding this comment

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

Let's use yarl instead of urlparse. We use that in most other places in Home Assistant that do URL manipulation too.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done a0cf823

@balloob balloob merged commit d69a7e7 into home-assistant:dev Apr 18, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Apr 19, 2022
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.

Hide credentials in Generic Camera items
4 participants