[github] Add check for data obfuscation

[jcastill]

This patch adds a new line to the github PR
template so users can assess that they have
obfuscated any password or similar from the
code they are submitting.

Closes: #3427

---

Please place an 'X' inside each '[]' to confirm you adhere to our Contributor Guidelines

• Is the commit message split over multiple lines and hard-wrapped at 72 characters?
• Is the subject and message clear and concise?
• Does the subject start with [plugin_name] if submitting a plugin patch or a [section_name] if part of the core sosreport code?
• Does the commit contain a Signed-off-by: First Lastname [email protected]?
• Are any related Issues or existing PRs properly referenced via a Closes (Issue) or Resolved (PR) line?

[jcastill]

I'm not too convinced by the actual text of the check, so any help rewording it will be very welcome!

[packit-as-a-service]

Congratulations! One of the builds has completed. 🍾

You can install the built RPMs by following these steps:

• sudo yum install -y dnf-plugins-core on RHEL 8
• sudo dnf install -y dnf-plugins-core on Fedora
• dnf copr enable packit/sosreport-sos-3427
• And now you can install the packages.

Please note that the RPMs should be used only in a testing environment.

[arif-ali]

I know what obfuscate means :). maybe slight improvement for simple english. And maybe point to implementing postproc() and maybe a link to an example?

[jcastill]

I know what obfuscate means :). maybe slight improvement for simple english.

Thank you! I always doubt since English is not my first language.

And maybe point to implementing postproc() and maybe a link to an example?

This is a fantastic idea. I can create an internal page in https://github.com/sosreport/sos/wiki/Data-privacy-and-obfuscation.rst and point the check to that url. What do you think?

[arif-ali]

Thank you! I always doubt since English is not my first language.

It's my first language, but still had to look it up the first time 😄

This is a fantastic idea. I can create an internal page in https://github.com/sosreport/sos/wiki/Data-privacy-and-obfuscation.rst and point the check to that url. What do you think?

yeah, like the idea

[jcastill]

I don't think I have access to edit the Wiki, so somebody else will have to do it.
Anyway, do you think it may be better as a section in the 'how to write a plugin' page instead of a completely new page?

[arif-ali]

I don't have access either, we're both in the same stance.

Looking a the Contribution Guidelines, I do see the 2 comments below. So, I think if we could expand on it would make more sense. Maybe others might have other ideas

• All regex substitutions (i.e. postproc() obfuscations) must include an example in comments
  • Required as of 4.1. Older regex substitutions may not have examples, but these should be updated over time.

[pmoravec]

I added there https://github.com/sosreport/sos/wiki/How-to-Write-a-Plugin#how-to-prevent-collecting-passwords .

[jcastill]

OK, I pushed the change with the link to the new section in the wiki, thank you @pmoravec for creating it!

[arif-ali]

I've restarted the failed test, but looks good to me