Add Occurences to Potential Secrets #527
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lorenzodb1
reviewed
Apr 1, 2022
| @@ -180,7 +187,11 @@ def trim( | |||
| # Only update line numbers if we're tracking them. | |||
| existing_secret.line_number = secret.line_number | |||
There was a problem hiding this comment.
Looking at your implementation, it looks like it could be fairly trivial to track the line number of each of the occurrences found and report them as it was mentioned in #493.
|
Hi, @lorenzodb1 Is this feature already added, or it is still in pending review state? I mean is this feature coming in the next release? It seems to me that it would be a good one to add. |
|
Hi, Any update on this feature? it seems open for very long time. Thanks, |
…-add-occurences-to-potential-secrets
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A potential secret is uniquely identified by three main properties:
filename, secret_hash, type. Sinceline_numberis not included this means we will only track a single potential secret in a file although it may appear on multiple lines. This is a fundamental design decision.The idea behind this pull request is to give users some insight to how many occurences a potential secret is showing up in their files. This does not violate the fundamental design above but rather serves as an improvement hopefully giving better insight to developers on the overall scope of their potential secrets.
One of the key changes is changing the
SecretsCollectiondata structure from aSetto aList. The reasoning behind this decision is when we are scanning through the file - we do not only want to deny duplicate secrets to the data structure but alter the existing potential secrets occurrences.Listgives us a lot of flexibility with changing properties in the data structure whileSetis a little restricted. The newListwill operate almost identically to the previousSetin terms of not allowing duplicate secrets but with the addition of tracking occurrences.The
occurrencesproperty will operate very similar to theline_numberproperty. They are similar in the way that we will not alert on the change of this property but rather only notify the user that the baseline file changed with updated information on their secrets.