Debug logs should not expose sensitive data
jeff-winn opened this issue · comments
Is your feature request related to a problem? Please describe:
While trying to help users that need assistance with problems, it is very difficult to ask them to send logs when those logs knowingly contain sensitive data.
Describe the solution you'd like:
I would like the sensitive data to be masked by default and the ability to unmask the data by opt-in. Also, tokenization or hashing could be helpful with the mower ids to enable troubleshooting while protecting the user data.
Describe alternatives you've considered:
Leaving the sensitive data being logged.
Additional context:
This mostly came from the past few people to ask for help. It’s hard to say give me the logs, but oh yeah there’s a lot of stuff you won’t want me to have in there. At least with masking I can show them where to confirm it within their logs while not shipping the sensitive data.
Examples (but not limited to):
- Client id and secret / username and password
- User Id
- GPS mower positions
- HTTP request and response headers
It would be nice if this was something controlled within the user interface so it was easily changed by the user.
The debug setting is in a bit of an obscure spot to adhere to the Homebridge convention for enabling debug logging, but this I want to make sure anyone turning it on is clear on the implications.