improved cli. removed useless import

bin/finder.py

@@ -7,7 +7,7 @@
 #
 # This software is part of cve-search.org
 #
-# Copyright (c) 2019 Alexandre Dulaunoy - a@foo.be
+# Copyright (c) 2019-2020 Alexandre Dulaunoy - a@foo.be
 
 
 import git
@@ -17,102 +17,103 @@ import argparse
 import typing
 
 from git_vuln_finder import (
-    build_pattern,
     get_patterns,
     find_vuln,
-    summary,
+    summary
-    extract_cve
 )
 
-PATTERNS_PATH="./git_vuln_finder/patterns"
-
-parser = argparse.ArgumentParser(description = "Finding potential software vulnerabilities from git commit messages.", epilog = "More info: https://github.com/cve-search/git-vuln-finder")
-parser.add_argument("-v", help="increase output verbosity", action="store_true")
-parser.add_argument("-r", type=str, help="git repository to analyse")
-parser.add_argument("-o", type=str, help="Output format: [json]", default="json")
-parser.add_argument("-s", type=str, help="State of the commit found", default="under-review")
-parser.add_argument("-p", type=str, help="Matching pattern to use: [vulnpatterns, cryptopatterns, cpatterns] - the pattern 'all' is used to match all the patterns at once.", default="vulnpatterns")
-parser.add_argument("-c", help="output only a list of the CVE pattern found in commit messages (disable by default)", action="store_true")
-parser.add_argument("-t", help="Include tags matching a specific commit", action="store_true")
-args = parser.parse_args()
-
-
-patterns = get_patterns()
-vulnpatterns = patterns["en"]["medium"]["vuln"]
-cryptopatterns = patterns["en"]["medium"]["crypto"]
-cpatterns = patterns["en"]["medium"]["c"]
-
-if args.p == "vulnpatterns":
-    defaultpattern = vulnpatterns
-elif args.p == "cryptopatterns":
-    defaultpattern = cryptopatterns
-elif args.p == "cpatterns":
-    defaultpattern = cpatterns
-elif args.p == "all":
-    defaultpattern = [vulnpatterns, cryptopatterns, cpatterns]
-else:
-    parser.print_usage()
-    parser.exit()
-
-if not args.r:
-    parser.print_usage()
-    parser.exit()
-else:
-    repo = git.Repo(args.r)
-
-
-found = 0
-all_potential_vulnerabilities = {}
-cve_found = set()
 
 def main():
-    pass
+    """Point of entry for the script.
+    """
+    # Parsing arguments
+    parser = argparse.ArgumentParser(description = "Finding potential software vulnerabilities from git commit messages.", epilog = "More info: https://github.com/cve-search/git-vuln-finder")
+    parser.add_argument("-v", help="increase output verbosity", action="store_true")
+    parser.add_argument("-r", type=str, help="git repository to analyse")
+    parser.add_argument("-o", type=str, help="Output format: [json]", default="json")
+    parser.add_argument("-s", type=str, help="State of the commit found", default="under-review")
+    parser.add_argument("-p", type=str, help="Matching pattern to use: [vulnpatterns, cryptopatterns, cpatterns] - the pattern 'all' is used to match all the patterns at once.", default="vulnpatterns")
+    parser.add_argument("-c", help="output only a list of the CVE pattern found in commit messages (disable by default)", action="store_true")
+    parser.add_argument("-t", help="Include tags matching a specific commit", action="store_true")
+    args = parser.parse_args()
 
 
-repo_heads = repo.heads
+    patterns = get_patterns()
-repo_heads_names = [h.name for h in repo_heads]
+    vulnpatterns = patterns["en"]["medium"]["vuln"]
-print(repo_heads_names, file=sys.stderr)
+    cryptopatterns = patterns["en"]["medium"]["crypto"]
-origin = repo.remotes.origin.url
+    cpatterns = patterns["en"]["medium"]["c"]
-if args.t:
-    tagmap = {}
-    for t in repo.tags:
-        tagmap.setdefault(repo.commit(t).hexsha, []).append(str(t))
 
-for branch in repo_heads_names:
+
-    commits = list(repo.iter_commits(branch))
+    if args.p == "vulnpatterns":
-    defaultpattern
+        defaultpattern = vulnpatterns
-    for commit in commits:
+    elif args.p == "cryptopatterns":
-        if isinstance(defaultpattern, typing.Pattern):
+        defaultpattern = cryptopatterns
-            ret = find_vuln(commit, pattern=defaultpattern, versbose=args.v)
+    elif args.p == "cpatterns":
-            if ret:
+        defaultpattern = cpatterns
-                rcommit = ret['commit']
+    elif args.p == "all":
-                _, potential_vulnerabilities = summary(rcommit,
+        defaultpattern = [vulnpatterns, cryptopatterns, cpatterns]
-                                                       branch,
+    else:
-                                                       defaultpattern,
+        parser.print_usage()
-                                                       origin=origin,
+        parser.exit()
-                                                       vuln_match=ret['match'],
+
-                                                       tags_matching=args.t,
+    if not args.r:
-                                                       commit_state=args.s)
+        parser.print_usage()
-                all_potential_vulnerabilities.update(potential_vulnerabilities)
+        parser.exit()
-                found += 1
+    else:
-        elif isinstance(defaultpattern, list):
+        repo = git.Repo(args.r)
-            for p in defaultpattern:
+
-                ret = find_vuln(commit, pattern=p, versbose=args.v)
+
+    # Initialization of the variables for the results
+    found = 0
+    all_potential_vulnerabilities = {}
+    cve_found = set()
+
+
+    repo_heads = repo.heads
+    repo_heads_names = [h.name for h in repo_heads]
+    print(repo_heads_names, file=sys.stderr)
+    origin = repo.remotes.origin.url
+    if args.t:
+        tagmap = {}
+        for t in repo.tags:
+            tagmap.setdefault(repo.commit(t).hexsha, []).append(str(t))
+
+    for branch in repo_heads_names:
+        commits = list(repo.iter_commits(branch))
+        defaultpattern
+        for commit in commits:
+            if isinstance(defaultpattern, typing.Pattern):
+                ret = find_vuln(commit, pattern=defaultpattern, versbose=args.v)
                 if ret:
                     rcommit = ret['commit']
                     _, potential_vulnerabilities = summary(rcommit,
                                                            branch,
-                                                           p,
+                                                           defaultpattern,
                                                            origin=origin,
                                                            vuln_match=ret['match'],
                                                            tags_matching=args.t,
                                                            commit_state=args.s)
                     all_potential_vulnerabilities.update(potential_vulnerabilities)
                     found += 1
-if not args.c:
+            elif isinstance(defaultpattern, list):
-    print(json.dumps(all_potential_vulnerabilities))
+                for p in defaultpattern:
-elif args.c:
+                    ret = find_vuln(commit, pattern=p, versbose=args.v)
-    print(json.dumps(list(cve_found)))
+                    if ret:
+                        rcommit = ret['commit']
+                        _, potential_vulnerabilities = summary(rcommit,
+                                                               branch,
+                                                               p,
+                                                               origin=origin,
+                                                               vuln_match=ret['match'],
+                                                               tags_matching=args.t,
+                                                               commit_state=args.s)
+                        all_potential_vulnerabilities.update(potential_vulnerabilities)
+                        found += 1
 
-print("{} CVE referenced found in commit(s)".format(len(list(cve_found))), file=sys.stderr)
+    if not args.c:
-print("Total potential vulnerability found in {} commit(s)".format(found), file=sys.stderr)
+        print(json.dumps(all_potential_vulnerabilities))
+    elif args.c:
+        print(json.dumps(list(cve_found)))
+
+    print("{} CVE referenced found in commit(s)".format(len(list(cve_found))), file=sys.stderr)
+    print("Total potential vulnerability found in {} commit(s)".format(found), file=sys.stderr)

git_vuln_finder/finder.py

@@ -7,7 +7,7 @@
 #
 # This software is part of cve-search.org
 #
-# Copyright (c) 2019 Alexandre Dulaunoy - a@foo.be
+# Copyright (c) 2019-2020 Alexandre Dulaunoy - a@foo.be
 
 
 import os