zricethezav 8 лет назад
Родитель
Сommit
2533ea6661
2 измененных файлов с 16 добавлено и 4 удалено
  1. 15 3
      README.md
  2. 1 1
      main.go

+ 15 - 3
README.md

@@ -22,12 +22,24 @@ go get -u github.com/zricethezav/gitleaks
 
 
 ![Alt Text](https://github.com/zricethezav/gifs/blob/master/gitleaks.gif)
 ![Alt Text](https://github.com/zricethezav/gifs/blob/master/gitleaks.gif)
 
 
-```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
 
 

+ 1 - 1
main.go

@@ -72,7 +72,7 @@ func repoScan(opts *Options) []RepoElem {
 		targetType = "users"
 		targetType = "users"
 	} else {
 	} else {
 		targetURL = opts.OrgURL
 		targetURL = opts.OrgURL
-		targetType = "org"
+		targetType = "orgs"
 	}
 	}
 	splitTargetURL := strings.Split(targetURL, "/")
 	splitTargetURL := strings.Split(targetURL, "/")
 	target = splitTargetURL[len(splitTargetURL)-1]
 	target = splitTargetURL[len(splitTargetURL)-1]