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

Output reasons for exclusions in verbose mode #342

Open
cburton-godaddy opened this issue Mar 29, 2022 · 0 comments
Open

Output reasons for exclusions in verbose mode #342

cburton-godaddy opened this issue Mar 29, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@cburton-godaddy
Copy link

Feature Request

@jwilhelm-godaddy As discussed.

Is your feature request related to a problem? Please describe.

If I have a repository that contains a tartufo.toml such as below.

[tool.tartufo]

exclude-path-patterns = [
    {path-pattern = 'yarn.lock', reason = 'auto generated, contains shas'},
    {path-pattern = '.yalc/', reason = 'auto generated linked deps, contains shas'}
]

exclude-signatures = [
    {signature = 'abc123', reason = 'Represents some fake data for testing purposes'},
    {signature = 'foobar', reason = 'Represents some fake data for testing purposes'}
]

When I run the following command

docker run --rm -v "$(pwd):/git" godaddy/tartufo --config /git/tartufo.toml -v scan-local-repo /git > tartufo-output.txt

I get an output of

Time: 2022-03-29T07:55:16.397387
All clear. No secrets detected.

Excluded paths:
re.compile('yarn.lock')
re.compile('.yalc/')

Excluded signatures:
f44745a1b05ed928e9a19fb2875411334
67b69634f9880a282c14a0f0cb7ba20cf5d677e9

Excluded entropy patterns:

Which does not include the reasons I have entered in my tartufo.toml

Describe the solution you'd like

I would like the output of the tartufo scan to include the reasons I have added to my tartufo.toml, for example something like the below would be useful.

Time: 2022-03-29T07:55:16.397387
All clear. No secrets detected.

Excluded paths:
re.compile('yarn.lock') - auto generated, contains shas
re.compile('.yalc/') - auto generated linked deps, contains shas

Excluded signatures:
f44745a1b05ed928e9a19fb2875411334 - Represents some fake data for testing purposes
67b69634f9880a282c14a0f0cb7ba20cf5d677e9 - Represents some fake data for testing purposes

Excluded entropy patterns:

Describe alternatives you've considered

The alternative is to not output the reasons for the exclusions, but the fact we already output the exclusions it seems a little counter intuitive to not output the reasons why they are excluded also.

Teachability, Documentation, Adoption, Migration Strategy

The -v option doesn't have much documentation around it, this may be a good time to add examples of what the verbose output looks like and how it can help users.

@cburton-godaddy cburton-godaddy added the enhancement New feature or request label Mar 29, 2022
mgaspar-godaddy added a commit to mgaspar-godaddy/tartufo that referenced this issue Aug 16, 2022
mgaspar-godaddy added a commit to mgaspar-godaddy/tartufo that referenced this issue Aug 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant