|
@@ -22,12 +22,24 @@ go get -u github.com/zricethezav/gitleaks
|
|
|
|
|
|
|
|

|
|

|
|
|
|
|
|
|
|
-```sh
|
|
|
|
|
|
|
+```bash
|
|
|
./gitleaks {git url}
|
|
./gitleaks {git url}
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-This will clone the target `{git url}` and run a diff on all commits. A report will be output to `{repo_name}.json`
|
|
|
|
|
-Gitleaks scans all lines of all commit diffs and checks if there are any regular expression matches. The regexs are defined in `main.go`. For example if a line in a commit diff like `AWS_KEY='AKAI...'` exists then the value after the assignment operator will be checked for entropy. If the value is above a certain entropy threshold then we assume that the line contains a key/secret. Work largely based on [https://people.eecs.berkeley.edu/~rohanpadhye/files/key_leaks-msr15.pdf](https://people.eecs.berkeley.edu/~rohanpadhye/files/key_leaks-msr15.pdf)
|
|
|
|
|
|
|
+This example will clone the target `{git url}` and run a diff on all commits. A report will be output to `{repo_name}_leaks.json`
|
|
|
|
|
+Gitleaks scans all lines of all commits and checks if there are any regular expression matches. The regexs are defined in `main.go`. For example if a line in a commit diff like `AWS_KEY='AKAI...'` exists then the value after the assignment operator will be checked for entropy. If the value is above a certain entropy threshold then we assume that the line contains a key/secret. Work largely based on [https://people.eecs.berkeley.edu/~rohanpadhye/files/key_leaks-msr15.pdf](https://people.eecs.berkeley.edu/~rohanpadhye/files/key_leaks-msr15.pdf)
|
|
|
|
|
+
|
|
|
|
|
+#### Help
|
|
|
|
|
+```
|
|
|
|
|
+usage: gitleaks [options] [git url]
|
|
|
|
|
+
|
|
|
|
|
+Options:
|
|
|
|
|
+ -c Concurrency factor (potential number of git files open)
|
|
|
|
|
+ -u Git user url
|
|
|
|
|
+ -r Git repo url
|
|
|
|
|
+ -o Git organization url
|
|
|
|
|
+ -h --help Display this message
|
|
|
|
|
+```
|
|
|
|
|
|
|
|
#### TODO
|
|
#### TODO
|
|
|
|
|
|