Update db.pp to handle suspicious comments #143
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Greetings,
I am a security researcher, who is looking for security smells in Puppet scripts. I found instances
of suspicious comments i.e. comments with content that are indicative of bad practices. If there are keywords such as TODO, HACK, FIXME and bug/issue information is exposed through comments, then such comments should be avoided. According to the Common Weakness Enumeration (CWE) organization
Many suspicious comments, such as BUG, HACK, FIXME, LATER, LATER2, TODO, in the code indicate missing security functionality and checking. Others indicate code problems that programmers should fix, such as hard-coded variables, error handling, not using stored procedures, and performance issues.
Reff: https://cwe.mitre.org/data/definitions/546.htmlI followed the recommendations from CWE and removed such comments. Any feedback is appreciated.