trufflehog
trufflehog copied to clipboard
Print trufflehog version in output reports (both json and normal)
Community Note
- Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
- Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
- If you are interested in working on this issue or have submitted a pull request, please leave a comment
Description
It would be great if we can include the trufflehog version in the output reports(both json and normal)
Problem to be Addressed
Given autoupdate is ON by default and fast releases happening in this project, when we are seeing trufflehog failures in our CI history (i.e. builds that ran like 3 days ago, 1 week ago etc) we are unable to say which exact version of trufflehog raised the given issue.
Description of the Preferred Solution
In the truffle hog result (both json and normal report) include a field which states which version of trufflehog found the issue
Additional Context
Current JSON report structure
Following is the current json report structure
{
"SourceMetadata": {
"Data": {
"Git": {
"commit": "9da022b019c42268cc8d367d2d2609b3f82850fa",
"file": "aws-credentials.yml",
"email": "John doe<[email protected]>",
"repository": "<<repo url>>",
"timestamp": "2021-10-21 13:23:10 +0200 +0200",
"line": 1
}
}
},
"SourceID": 0,
"SourceType": 16,
"SourceName": "trufflehog - git",
"DetectorType": 2,
"DetectorName": "AWS",
"DecoderName": "PLAIN",
"Verified": false,
"Raw": "AKIASCH4ZE27PCW2UNN7",
"Redacted": "AKIASCH4ZE27PCW2UNN7",
"ExtraData": null,
"StructuredData": null
}
Proposed json
{
"TruffleHogVersion: "V3.6.1",
...
}