Gitleaks
This Azure DevOps task downloads gitleaks and runs a gitleak scan on the specified location.
- Thanks to Zachary Rice for creating and maintaining gitleaks.
- Thanks to Jesse Houwing for providing a gitleaks config that has most of Microsoft's deprecated credscan rules ported to it.
Please note that task v1 will no longer work since gitleaks v7 is no longer downloadable.
YAML Snippet
# Run Gitleaks on Source Repository
- task: Gitleaks@2
inputs:
scanlocation: '$(Build.SourcesDirectory)'
configtype: 'predefined'
predefinedconfigfile: 'GitleaksUdmCombo.toml'
reportformat: 'sarif'
Prerequisites
- Linux/Osx based agents requires tar to unpack Gitleaks from GitHub
- Windows based agents require zip to unpack Gitleaks from GitHub
Original Authors
Any feedback on gitleaks, please reach out to Zachary Rice for creating and maintaining gitleaks.
Any feedback on the Azure configuration file ('UDMSecretChecks.toml') is welcome. See Jesse Houwing's GitHub repo.
The configuration file isn't as good as credscan was before, it had a bunch of helper functions to rule out false positives that aren't (yet) possible with gitleaks.
Contributions
Thanks to Dariusz Porowski for contributing and making awesome adjustments!
Thanks to John Lokerse for providing feedback on this extension.
FetchDepth
Since September 12th (Sprint 209) release of Azure DevOps new pipelines will have a fetch depth of 1. When the fetch depth is set to 1. That means that previous commits are not fetched and cannot be scanned. This results in Gitleaks reporting: ERR [git] fatal: bad object
To solve this issue, there are two options:
Set the fetch depth to 0
When the Fetch Depth is set to 0, all the commits are downloaded. This needs to be set for every pipeline:
steps:
- checkout: self
fetchDepth: 0
See also the Microsoft Documentation on this
For coorporate environments setting variable Agent.Source.Git.ShallowFetchDepth to 0 can set this for every pipeline.
Set the scan mode to nogit
This means that commits are not scanned but flat files. In this case you scan the as-if situation. Secrets commited but that are not in the HEAD will not be found.
# Run Gitleaks on Source Repository
- task: Gitleaks@2
inputs:
scanlocation: '$(Build.SourcesDirectory)'
configtype: 'predefined'
predefinedconfigfile: 'GitleaksUdmCombo.toml'
scanmode: 'nogit'
reportformat: 'sarif'
Arguments for Version 2 of the Task
| Name |
Description |
| scanlocation |
The location to be scanned.
Defaults to $(Build.SourcesDirectory). |
| configtype |
Can be 'default', 'predefined', 'custom'.
'default' for GitLeaks default configuration.
'predefined' allows you to select a predefined configurations.
'custom' allows you to set a custom configuration file. |
| predefinedconfigfile |
Can be 'UDMSecretChecksv8.toml' or 'GitleaksUdmCombo.toml'.
'UDMSecretChecksv8.toml' uses the Credscan config file provided by Jesse Houwing.
'GitleaksUdmCombo.toml' uses the default GitLeaks configuration icm the CredScan configuration. |
| configfile |
Sets the custom configfile in your repo. |
| scanmode |
'all' will scan all commits.
'prevalidation' will scan only the commits that are part of a Pull Request.
'changes' will scan only the changes between this build and the previous build.
'smart' will detect the best scanmode.
'nogit' will run GitLeaks in no-git mode (flat file scan).
'custom' will allow you to provide custom -log-opts. |
| logoptions |
When scanmode is set to 'custom', this allows you to fill in custom log-options that are passed to GitLeaks |
| redact |
Redact secrets from log messages and leaks. Default is true. |
| baselinePath |
Specify a baseline file (old report) so that only new findings are reported. The baseline file/report should be in json format. |
| taskfail |
Sets the behavior of the task when secrets are detected.
When set to true, fail the task. When set to false and secrets present end with warning. Default is true |
| uploadresults |
When set to true, the results of gitleaks will be uploaded as an artifact to Azure DevOps. Default is true. |
| reportartifactname |
When uploadresults is set to true, you can specify the artifact name in Azure DevOps. For the SARIF SAST extension to work, this should be CodeAnalysisLogs. |
| reportformat |
Sets gitleaks report format. Default is 'sarif'). |
| reportfolder |
Specify the report folder. Default is the agent tempdirectory. |
| reportname |
Sets the report file name. Default this will be 'gitleaks-. |
| verbose |
When set to true, gitleaks prints verbose output. Default is false. |
| version |
Version of Gitleaks to be used. See the GitLeaks GitHub page.
Set to 'latest' to download the latest version of GitLeaks. |
| customtoollocation |
You can set the custom location of GitLeaks. When set, GitLeaks will not be downloaded but fetched from this location. An alternative is setting a system variable named 'AGENT_TOOLSGITLEAKSDIRECTORY' to the Gitleaks tool location. This is specially for agents that do not have an internet connection. You can only set file paths. |
| taskfailonexecutionerror |
Sets the behavior of the task when execution errors occurs.
When set to true, fail the task. When set to false and the tasks fails to execute the task is SuccededWithWarnings. Default is true |
Notes for GitHub repositories:
Only Git repositories hosted in Azure DevOps are supported for prevalidation/smart scanning mode. This is because the extension fetches the Pull Request changes from the Azure DevOps API. The API has no knowledge on the PR's on GitHub.
SARIF display in Summary
You can display gitleaks report nicely in your Pipeline run summary. To realize it set reportformat to sarif and make sure your Azure DevOps organization has SARIF SAST Scans Tab extension installed.
How do I remove a secret from git's history?
GitHub has a great article on this using the BFG Repo Cleaner.
