-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Taiki Ono <taiki@finatext.com>
- Loading branch information
Showing
5 changed files
with
18 additions
and
18 deletions.
There are no files selected for viewing
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,39 @@ | ||
# gitleaks-support | ||
# gls | ||
|
||
gitleaks-support enhances the development of gitleaks rules and allowlists, and extends gitleaks features with: | ||
gls (gitleaks-support) enhances the development of gitleaks rules and allowlists, and extends gitleaks features with: | ||
|
||
- Support for multiple global and rule-specific allowlists. | ||
- Ability to handle multiple configuration files. | ||
|
||
## Design | ||
|
||
Instead of using the original gitleaks allowlist feature, gitleaks-support requires all allowlists to be defined in its own configuration files. | ||
Instead of using the original gitleaks allowlist feature, gls requires all allowlists to be defined in its own configuration files. | ||
|
||
During the detection phase, gitleaks produces findings which are then filtered by gitleaks-support according to its allowlist configurations. | ||
During the detection phase, gitleaks produces findings which are then filtered by gls according to its allowlist configurations. | ||
|
||
## User Journey | ||
|
||
There are two main phases: config development and detection. | ||
|
||
### Config Development | ||
|
||
To set up for development, gitleaks-support provides the following CLI commands: | ||
To set up for development, gls provides the following CLI commands: | ||
|
||
- `extract-allowlist`: This command extracts allowlist items from a specified gitleaks configuration file to a gitleaks-support configuration file. | ||
- `extract-allowlist`: This command extracts allowlist items from a specified gitleaks configuration file to a gls configuration file. | ||
- `cleanup-allowlist`: This removes all allowlist items from a specified gitleaks configuration file. | ||
- `cleanup-rule`: This removes all detection rules from a specified gitleaks configuration file. | ||
|
||
Once the gitleaks configuration file is cleaned and the gitleaks-support allowlist configuration files are set, you can validate and develop your allowlist configuration. | ||
Once the gitleaks configuration file is cleaned and the gls allowlist configuration files are set, you can validate and develop your allowlist configuration. | ||
|
||
- `scan`: Executes the gitleaks detection command on specified git repositories using multiple threads. | ||
- `review`: Reviews the results of the aforementioned scan (gitleaks report JSON files), including summaries, lists of findings per detection rule, and lists of results per allowlist. | ||
|
||
For ongoing configuration development in day-to-day operations, gitleaks-support also offers: | ||
For ongoing configuration development in day-to-day operations, gls also offers: | ||
|
||
- `diff`: Compares two `gitleaks-support review` result JSON files to identify differences in both allowed and confirmed findings. | ||
- `diff`: Compares two `gls review` result JSON files to identify differences in both allowed and confirmed findings. | ||
|
||
### Detection | ||
|
||
To filter the results from `gitleaks detect`: | ||
|
||
- `apply`: Takes gitleaks-support configuration files and a gitleaks detection result JSON file, and outputs the actual confirmed findings. | ||
- `apply`: Takes gls configuration files and a gitleaks detection result JSON file, and outputs the actual confirmed findings. |
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