Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added whitelist reviewDate feature #259

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

wilsonwaters
Copy link

@wilsonwaters wilsonwaters commented Jul 11, 2022

We occasionally add whitelist entries for vulnerabilities which don't have a current solution, but are likely to be resolved by package maintainers at some point in the future. The risk in adding a whitelist entry is we will undoubtedly forget to come back and fix the issue / upgrade packages once the vulnerability has been resolved.

This PR adds a whitelist reviewDate field, which will cause the audit to fail after the date passes. This is useful to ensure temporary whitelist entried don't get "forgotten" by causing the audit to fail.

This pull request makes the following changes:

  • Updates VulnerabilitiyExcluder to handle optional reviewDate field in auditjs.json whitelist file
  • Add unit tests
  • Update README.md documention for whitelist usage

It relates to the following issue #s:

cc @bhamail / @DarthHater / @allenhsieh / @ken-duck

@wilsonwaters
Copy link
Author

Hey @bhamail , thought I'd see if you have any thoughts of this PR? Does it make sense?

I note you came across the exact same issue with node-fetch that inspired me to open this PR. Also interesting to note you added a date in the reason field of the whitelist file, which is basically what this PR is trying to address in a strcutured manner.

@bhamail
Copy link
Contributor

bhamail commented Jul 22, 2022

@wilsonwaters I think this PR is great.
I’ve been putting off review in the hope we could make more progress in changing the term “whitelist” to something like “ignore” or “ignore list” see: issue #202 . The concern being making “more to change later”.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Whitelist entries should (optionally) be time-limited
2 participants