-
Notifications
You must be signed in to change notification settings - Fork 457
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
Improve false negative ratio by detecting keys with hyphens #49
Comments
There are also some |
I wanted to work on this issue. On doing a little bit of digging, I came up with two proposed solutions and would really appreciate any comments regarding the same:
Finally, I believe tests should go here, right? |
Those are good questions @mohit-surana! The short answers are:
Based on the entropy algorithm, it seems that the more characters in the Following this logic, it would suggest that a more liberal However, if this is true, then any additions to the Any thoughts on this? |
Theoretically, yes. It would increase the false positive rate while reducing false negative rates as well. Ultimately it will be a trade-off between false positive and false negatives. Do we have any statistics regarding the current system's false positive rates? How can we design good tests to measure the new statistics, that have a large coverage to assess the new FP/FN rates? As for new plugins, it seems to me that ultimately, making changes to the entropy calculation is a big NO as it may affect current clients. And you can make combinatorial number of plugins if we make one for each small difference. Would it be better to allow clients to pass an additional argument indicating whether they would like to include additional preset/client specified symbols? Bottom line: If FP increases a lot, we need to have the client make a conscious decision to move into a new version that supports hyphens. |
I'm in favor of the additional argument, but I don't know how that might look like with the user interface. Certainly would increase the scope of this issue (and perhaps no longer a "good first issue")! If you still wanted to take it on, we'd more than welcome the contribution! Otherwise, the As for testing FP/FN rates, we are building a large internal collection of various different secrets that we use to experiment with our new plugins. We can certainly run your plugin on our corpus, and help tweak its default sensitivity. |
Hey @domanchi. I am interested in implementing the additional argument version of the solution. I am a bit caught up with stuff at the moment and I'll get back to it as soon as time permits! The internal corpus sounds like a really good idea, and in general will help attract more users as well. As for the |
We're going to close this issue as it hasn't received any update in a very long time. Feel free to re-open it if you think it's still relevant. |
Certain API keys use hyphens.
e.g.
blahblah-aaaa-bbbb-cccc-ddddddd
This currently is not caught by the suite of HighEntropyStringPlugins.
The text was updated successfully, but these errors were encountered: