OpenVoiceOS / OpenVoiceOS/raspOVOS
Implement data redaction in ovos-support script
Open
@JarbasAl is already working on this.
Since Jan 18, 2025.
- Dominant language
- Shell
- Stars
- 52
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Overview
The ovos-support script currently handles sensitive information (logs, configs) but lacks implementation for data redaction. This needs to be addressed to prevent accidental exposure of private information.
Required Changes
-
Add a function to redact sensitive patterns:
- IP addresses
- API keys
- Location data
- Other personally identifiable information
-
Implement redaction before copying:
- Use regex patterns for log files
- Use jq filtering for JSON configs
- Add clear warnings about shared information
-
Update the script to:
- Clearly indicate what information might be shared
- Provide options to skip sensitive data
- Document the redaction process
References
- Pull Request: #129
- Discussion: https://github.com/OpenVoiceOS/raspOVOS/pull/129#discussion_r1920938183
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.