CachyOS / CachyOS/CachyOS-Settings

Improving cachyos-bugreport.sh redaction

Open
#250 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
443
Forks
76
PR merge metrics
No merged PRs in 30d

Description

Piggybacking off #227, I think some improvements can be made to the redaction system.

From reading the bug report on my own PC, it doesn't seem like anything personally identifying will ever be leaked in the first few sections, so running sed on those lines only adds a risk of giving away information through redaction. The dmesg and journalctl are the sections that may reveal identifying information. I can see some users in the forum have "cachyos" as their hostname because it is redacted in this section.
Although I just said we should not redact the first few sections, we may want to redact UUIDs in all sections. Machine UUID and storage UUIDs are found in top sections and in dmesg from /dev/disk/by-uuid/ messages.
I had over 1000 files leaked by xdg-desktop-portal-kde:
`Aug 07 12:05:47 xdg-desktop-portal-kde[1474]: No node found for item that was just removed: QUrl("file:///mnt/drive/folder/file.txt")`
We could filter xdg-desktop-portal-kde or redact anything from `"file://` to the ending quotation mark. I don't think either of these are likely to be relevant to the subject of a user's bug report.
I also noticed UFW shows IPv6 addresses unredacted.

There's a lot of required information that is personally identifying in the bug report so this may not be that helpful, but I think the principle stands that we shouldn't require any unnecessary information. If anyone else thinks this is worth doing I can work on this.

Contributor guide

Open the contributing guide

Research direction

Start by locating cachyos-bugreport.sh and reading how redaction is applied across its report sections. Check the generated output against the cases mentioned here: UUIDs, IPv6 addresses, and xdg-desktop-portal-kde file:// paths; done means unnecessary identifying data is removed without obscuring the required bug-report information.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli, security
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
56/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.