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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Print trufflehog version in output reports (both json and normal) #885

Closed
kishaningithub opened this issue Oct 31, 2022 · 0 comments
Closed

Comments

@kishaningithub
Copy link

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<johndoe@example.com>",
        "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",
   ...
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants