socketsecurity 0.0.81__tar.gz → 0.0.83__tar.gz

{socketsecurity-0.0.81/socketsecurity.egg-info → socketsecurity-0.0.83}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: socketsecurity
-Version: 0.0.81
+Version: 0.0.83
 Summary: Socket Security CLI for CI/CD
 Author-email: Douglas Coburn <douglas@socket.dev>
 Maintainer-email: Douglas Coburn <douglas@socket.dev>

{socketsecurity-0.0.81 → socketsecurity-0.0.83}/socketsecurity/__init__.py

@@ -1,2 +1,2 @@
 __author__ = 'socket.dev'
-__version__ = '0.0.81'
+__version__ = '0.0.83'

{socketsecurity-0.0.81 → socketsecurity-0.0.83}/socketsecurity/core/__init__.py

@@ -22,6 +22,7 @@ from socketsecurity.core.classes import (
 )
 import platform
 from glob import glob
+import fnmatch
 import time
 
 __all__ = [
@@ -306,25 +307,15 @@ class Core:
         return sbom
 
     @staticmethod
-    def find_files(path: str) -> list:
+    def find_files(path: str, new_files: list = None) -> list:
         """
         Globs the path for supported manifest files.
         Note: Might move the source to a JSON file
         :param path: Str - path to where the manifest files are located
+        :param new_files:
         :return:
         """
         socket_globs = {
-            "general": {
-                "readme": {
-                    "pattern": "*readme*"
-                },
-                "notice": {
-                    "pattern": "*notice*"
-                },
-                "license": {
-                    "pattern": "{licen{s,c}e{,-*},copying}"
-                }
-            },
             "npm": {
                 "package.json": {
                     "pattern": "package.json"
@@ -399,6 +390,12 @@ class Core:
                 file_path = f"{path}/**/{pattern}"
                 files = glob(file_path, recursive=True)
                 for file in files:
+                    if "/" in file:
+                        _, base_name = file.rsplit("/", 1)
+                    else:
+                        base_name = file
+                    if new_files is not None and base_name not in new_files:
+                        continue
                     if platform.system() == "Windows":
                         file = file.replace("\\", "/")
                     found_path, file_name = file.rsplit("/", 1)
@@ -478,7 +475,7 @@ class Core:
         return full_scan
 
     @staticmethod
-    def create_new_diff(path: str, params: FullScanParams, workspace: str) -> Diff:
+    def create_new_diff(path: str, params: FullScanParams, workspace: str, new_files: list = None) -> Diff:
         """
         1. Get the head full scan. If it isn't present because this repo doesn't exist yet return an Empty full scan.
         2. Create a new Full scan for the current run
@@ -487,9 +484,10 @@ class Core:
         :param path: Str - path of where to look for manifest files for the new Full Scan
         :param params: FullScanParams - Query params for the Full Scan endpoint
         :param workspace: str - Path for workspace
+        :param new_files:
         :return:
         """
-        files = Core.find_files(path)
+        files = Core.find_files(path, new_files)
         try:
             head_full_scan_id = Core.get_head_scan_for_repo(params.repo)
             if head_full_scan_id is None or head_full_scan_id == "":

{socketsecurity-0.0.81 → socketsecurity-0.0.83}/socketsecurity/core/classes.py

@@ -13,7 +13,7 @@ __all__ = [
     "Repository",
     "Diff",
     "Purl",
-    "GithubComment"
+    "Comment"
 ]
 
 
@@ -423,3 +423,17 @@ class GitlabComment:
     def __str__(self):
         return json.dumps(self.__dict__)
 
+class Comment:
+    id: int
+    body: str
+    body_list: list
+
+    def __init__(self, **kwargs):
+        if kwargs:
+            for key, value in kwargs.items():
+                setattr(self, key, value)
+        if not hasattr(self, "body_list"):
+            self.body_list = []
+
+    def __str__(self):
+        return json.dumps(self.__dict__)

socketsecurity-0.0.83/socketsecurity/core/git_interface.py

@@ -0,0 +1,25 @@
+from git import Repo
+
+
+class Git:
+    repo: Repo
+    path: str
+
+    def __init__(self, path: str):
+        self.path = path
+        self.repo = Repo(path)
+        assert self.repo
+        self.head = self.repo.head
+        self.reference = self.head.reference
+        self.commit = self.reference.commit
+        self.repo_name = self.repo.remotes.origin.url.split('.git')[0].split('/')[-1]
+        self.branch = self.repo.active_branch
+        self.author = self.commit.author
+        self.commit_sha = self.commit.binsha
+        self.commit_message = self.commit.message
+        self.committer = self.commit.committer
+        self.show_files = self.repo.git.show(self.commit, name_only=True, format="%n").splitlines()
+        self.changed_files = []
+        for item in self.show_files:
+            if item != "":
+                self.changed_files.append(item)

{socketsecurity-0.0.81 → socketsecurity-0.0.83}/socketsecurity/core/github.py

@@ -3,7 +3,8 @@ import os
 from socketsecurity.core import log
 import requests
 from socketsecurity.core.exceptions import *
-from socketsecurity.core.classes import GithubComment, Diff, Issue
+from socketsecurity.core.classes import Comment
+from socketsecurity.core.scm_comments import Comments
 import sys
 
 
@@ -174,13 +175,13 @@ class Github:
         existing_security_comment = comments.get("security")
         if new_overview_comment:
             if existing_overview_comment is not None:
-                existing_overview_comment: GithubComment
+                existing_overview_comment: Comment
                 Github.update_comment(overview_comment, str(existing_overview_comment.id))
             else:
                 Github.post_comment(overview_comment)
         if new_security_comment:
             if existing_security_comment is not None:
-                existing_security_comment: GithubComment
+                existing_security_comment: Comment
                 Github.update_comment(security_comment, str(existing_security_comment.id))
             else:
                 Github.post_comment(security_comment)
@@ -219,128 +220,19 @@ class Github:
         comments = {}
         if "error" not in raw_comments:
             for item in raw_comments:
-                comment = GithubComment(**item)
+                comment = Comment(**item)
                 comments[comment.id] = comment
                 for line in comment.body.split("\n"):
                     comment.body_list.append(line)
         else:
             log.error(raw_comments)
-        socket_comments = Github.check_for_socket_comments(comments)
+        socket_comments = Comments.check_for_socket_comments(comments)
         return socket_comments
 
-    @staticmethod
-    def check_for_socket_comments(comments: dict):
-        socket_comments = {}
-        for comment_id in comments:
-            comment = comments[comment_id]
-            comment: GithubComment
-            if "socket-security-comment-actions" in comment.body:
-                socket_comments["security"] = comment
-            elif "socket-overview-comment-actions" in comment.body:
-                socket_comments["overview"] = comment
-            elif "SocketSecurity ignore" in comment.body:
-                if "ignore" not in socket_comments:
-                    socket_comments["ignore"] = []
-                socket_comments["ignore"].append(comment)
-        return socket_comments
-
-    @staticmethod
-    def remove_alerts(comments: dict, new_alerts: list) -> list:
-        alerts = []
-        if "ignore" not in comments:
-            return new_alerts
-        ignore_all, ignore_commands = Github.get_ignore_options(comments)
-        for alert in new_alerts:
-            alert: Issue
-            if ignore_all:
-                break
-            else:
-                purl = f"{alert.pkg_name}, {alert.pkg_version}"
-                purl_star = f"{alert.pkg_name}, *"
-                if purl in ignore_commands or purl_star in ignore_commands:
-                    log.debug(f"Alerts for {alert.pkg_name}@{alert.pkg_version} ignored")
-                else:
-                    log.debug(f"Adding alert {alert.type} for {alert.pkg_name}@{alert.pkg_version}")
-                    alerts.append(alert)
-        return alerts
-
-    @staticmethod
-    def get_ignore_options(comments: dict) -> [bool, list]:
-        ignore_commands = []
-        ignore_all = False
-
-        for comment in comments["ignore"]:
-            comment: GithubComment
-            first_line = comment.body_list[0]
-            if not ignore_all and "SocketSecurity ignore" in first_line:
-                first_line = first_line.lstrip("@")
-                _, command = first_line.split("SocketSecurity ")
-                command = command.strip()
-                if command == "ignore-all":
-                    ignore_all = True
-                else:
-                    command = command.lstrip("ignore").strip()
-                    name, version = command.rsplit("@", 1)
-                    ecosystem, name = name.split("/", 1)
-                    data = (ecosystem, name, version)
-                    ignore_commands.append(data)
-        return ignore_all, ignore_commands
-
-    @staticmethod
-    def is_ignore(
-            pkg_ecosystem: str,
-            pkg_name: str,
-            pkg_version: str,
-            ecosystem: str,
-            name: str,
-            version: str
-    ) -> bool:
-        result = False
-        if pkg_ecosystem == ecosystem and pkg_name == name and (pkg_version == version or version == "*"):
-            result = True
-        return result
-
     @staticmethod
     def remove_comment_alerts(comments: dict):
         security_alert = comments.get("security")
         if security_alert is not None:
-            security_alert: GithubComment
-            new_body = Github.process_security_comment(security_alert, comments)
+            security_alert: Comment
+            new_body = Comments.process_security_comment(security_alert, comments)
             Github.update_comment(new_body, str(security_alert.id))
-
-    @staticmethod
-    def is_heading_line(line) -> bool:
-        is_heading_line = True
-        if line != "|Alert|Package|Introduced by|Manifest File|" and ":---" not in line:
-            is_heading_line = False
-        return is_heading_line
-
-    @staticmethod
-    def process_security_comment(comment: GithubComment, comments) -> str:
-        lines = []
-        start = False
-        ignore_all, ignore_commands = Github.get_ignore_options(comments)
-        for line in comment.body_list:
-            line = line.strip()
-            if "start-socket-alerts-table" in line:
-                start = True
-                lines.append(line)
-            elif start and "end-socket-alerts-table" not in line and not Github.is_heading_line(line) and line != '':
-                title, package, introduced_by, manifest = line.strip("|").split("|")
-                details, _ = package.split("](")
-                pkg_ecosystem, details = details.strip("[").split("/", 1)
-                pkg_name, pkg_version = details.split("@")
-                ignore = False
-                for ecosystem, name, version in ignore_commands:
-                    if ignore_all or Github.is_ignore(pkg_ecosystem, pkg_name, pkg_version, ecosystem, name, version):
-                        ignore = True
-                if not ignore:
-                    lines.append(line)
-            elif "end-socket-alerts-table" in line:
-                start = False
-                lines.append(line)
-            else:
-                lines.append(line)
-        new_body = "\n".join(lines)
-        return new_body
-

{socketsecurity-0.0.81 → socketsecurity-0.0.83}/socketsecurity/core/gitlab.py

@@ -1,11 +1,10 @@
-import json
 import os
 from socketsecurity.core import log
 import requests
 from socketsecurity.core.exceptions import *
-from socketsecurity.core.classes import GitlabComment, Diff, Issue
+from socketsecurity.core.scm_comments import Comments
 import sys
-
+from socketsecurity.core.classes import Comment, Issue
 
 global ci_commit_sha
 global ci_api_v4_url
@@ -24,8 +23,6 @@ global is_default_branch
 global committer
 global gitlab_token
 
-
-
 gitlab_variables = [
     "CI_COMMIT_SHA",
     "CI_API_V4_URL",
@@ -170,13 +167,13 @@ class Gitlab:
         existing_security_comment = comments.get("security")
         if new_overview_comment:
             if existing_overview_comment is not None:
-                existing_overview_comment: GitlabComment
+                existing_overview_comment: Comment
                 Gitlab.update_comment(overview_comment, str(existing_overview_comment.id))
             else:
                 Gitlab.post_comment(overview_comment)
         if new_security_comment:
             if existing_security_comment is not None:
-                existing_security_comment: GitlabComment
+                existing_security_comment: Comment
                 Gitlab.update_comment(security_comment, str(existing_security_comment.id))
             else:
                 Gitlab.post_comment(security_comment)
@@ -206,58 +203,22 @@ class Gitlab:
         comments = {}
         if "message" not in raw_comments:
             for item in raw_comments:
-                comment = GitlabComment(**item)
+                comment = Comment(**item)
                 comments[comment.id] = comment
                 for line in comment.body.split("\n"):
                     comment.body_list.append(line)
         else:
             log.error(raw_comments)
-        socket_comments = Gitlab.check_for_socket_comments(comments)
-        return socket_comments
-
-    @staticmethod
-    def check_for_socket_comments(comments: dict):
-        socket_comments = {}
-        for comment_id in comments:
-            comment = comments[comment_id]
-            comment: GitlabComment
-            if "socket-security-comment-actions" in comment.body:
-                socket_comments["security"] = comment
-            elif "socket-overview-comment-actions" in comment.body:
-                socket_comments["overview"] = comment
-            elif "SocketSecurity ignore" in comment.body:
-                if "ignore" not in socket_comments:
-                    socket_comments["ignore"] = []
-                socket_comments["ignore"].append(comment)
+        socket_comments = Comments.check_for_socket_comments(comments)
         return socket_comments
 
-    @staticmethod
-    def remove_alerts(comments: dict, new_alerts: list) -> list:
-        alerts = []
-        if "ignore" not in comments:
-            return new_alerts
-        ignore_all, ignore_commands = Gitlab.get_ignore_options(comments)
-        for alert in new_alerts:
-            alert: Issue
-            if ignore_all:
-                break
-            else:
-                purl = f"{alert.pkg_name}, {alert.pkg_version}"
-                purl_star = f"{alert.pkg_name}, *"
-                if purl in ignore_commands or purl_star in ignore_commands:
-                    print(f"Alerts for {alert.pkg_name}@{alert.pkg_version} ignored")
-                else:
-                    print(f"Adding alert {alert.type} for {alert.pkg_name}@{alert.pkg_version}")
-                    alerts.append(alert)
-        return alerts
-
     @staticmethod
     def get_ignore_options(comments: dict) -> [bool, list]:
         ignore_commands = []
         ignore_all = False
 
         for comment in comments["ignore"]:
-            comment: GitlabComment
+            comment: Comment
             first_line = comment.body_list[0]
             if not ignore_all and "SocketSecurity ignore" in first_line:
                 first_line = first_line.lstrip("@")
@@ -283,43 +244,6 @@ class Gitlab:
     def remove_comment_alerts(comments: dict):
         security_alert = comments.get("security")
         if security_alert is not None:
-            security_alert: GitlabComment
-            new_body = Gitlab.process_security_comment(security_alert, comments)
+            security_alert: Comment
+            new_body = Comments.process_security_comment(security_alert, comments)
             Gitlab.update_comment(new_body, str(security_alert.id))
-
-    @staticmethod
-    def is_heading_line(line) -> bool:
-        is_heading_line = True
-        if line != "|Alert|Package|Introduced by|Manifest File|" and ":---" not in line:
-            is_heading_line = False
-        return is_heading_line
-
-    @staticmethod
-    def process_security_comment(comment: GitlabComment, comments) -> str:
-        lines = []
-        start = False
-        ignore_all, ignore_commands = Gitlab.get_ignore_options(comments)
-        for line in comment.body_list:
-            line = line.strip()
-            if "start-socket-alerts-table" in line:
-                start = True
-                lines.append(line)
-            elif start and "end-socket-alerts-table" not in line and not Gitlab.is_heading_line(line) and line != '':
-                title, package, introduced_by, manifest = line.lstrip("|").rstrip("|").split("|")
-                details, _ = package.split("](")
-                ecosystem, details = details.split("/", 1)
-                pkg_name, pkg_version = details.split("@")
-                ignore = False
-                for name, version in ignore_commands:
-                    if ignore_all or Gitlab.is_ignore(pkg_name, pkg_version, name, version):
-                        ignore = True
-                if not ignore:
-                    lines.append(line)
-            elif "end-socket-alerts-table" in line:
-                start = False
-                lines.append(line)
-            else:
-                lines.append(line)
-        new_body = "\n".join(lines)
-        return new_body
-

socketsecurity-0.0.83/socketsecurity/core/scm_comments.py

@@ -0,0 +1,103 @@
+from socketsecurity.core.classes import Comment, Issue
+
+
+class Comments:
+    @staticmethod
+    def remove_alerts(comments: dict, new_alerts: list) -> list:
+        alerts = []
+        if "ignore" not in comments:
+            return new_alerts
+        ignore_all, ignore_commands = Comments.get_ignore_options(comments)
+        for alert in new_alerts:
+            alert: Issue
+            if ignore_all:
+                break
+            else:
+                purl = f"{alert.pkg_name}, {alert.pkg_version}"
+                purl_star = f"{alert.pkg_name}, *"
+                if purl in ignore_commands or purl_star in ignore_commands:
+                    print(f"Alerts for {alert.pkg_name}@{alert.pkg_version} ignored")
+                else:
+                    print(f"Adding alert {alert.type} for {alert.pkg_name}@{alert.pkg_version}")
+                    alerts.append(alert)
+        return alerts
+
+    @staticmethod
+    def get_ignore_options(comments: dict) -> [bool, list]:
+        ignore_commands = []
+        ignore_all = False
+
+        for comment in comments["ignore"]:
+            comment: Comment
+            first_line = comment.body_list[0]
+            if not ignore_all and "SocketSecurity ignore" in first_line:
+                first_line = first_line.lstrip("@")
+                _, command = first_line.split("SocketSecurity ")
+                command = command.strip()
+                if command == "ignore-all":
+                    ignore_all = True
+                else:
+                    command = command.lstrip("ignore").strip()
+                    name, version = command.split("@")
+                    data = f"{name}, {version}"
+                    ignore_commands.append(data)
+        return ignore_all, ignore_commands
+
+    @staticmethod
+    def is_ignore(pkg_name: str, pkg_version: str, name: str, version: str) -> bool:
+        result = False
+        if pkg_name == name and (pkg_version == version or version == "*"):
+            result = True
+        return result
+
+    @staticmethod
+    def is_heading_line(line) -> bool:
+        is_heading_line = True
+        if line != "|Alert|Package|Introduced by|Manifest File|" and ":---" not in line:
+            is_heading_line = False
+        return is_heading_line
+
+    @staticmethod
+    def process_security_comment(comment: Comment, comments) -> str:
+        lines = []
+        start = False
+        ignore_all, ignore_commands = Comments.get_ignore_options(comments)
+        for line in comment.body_list:
+            line = line.strip()
+            if "start-socket-alerts-table" in line:
+                start = True
+                lines.append(line)
+            elif start and "end-socket-alerts-table" not in line and not Comments.is_heading_line(line) and line != '':
+                title, package, introduced_by, manifest = line.lstrip("|").rstrip("|").split("|")
+                details, _ = package.split("](")
+                ecosystem, details = details.split("/", 1)
+                pkg_name, pkg_version = details.split("@")
+                ignore = False
+                for name, version in ignore_commands:
+                    if ignore_all or Comments.is_ignore(pkg_name, pkg_version, name, version):
+                        ignore = True
+                if not ignore:
+                    lines.append(line)
+            elif "end-socket-alerts-table" in line:
+                start = False
+                lines.append(line)
+            else:
+                lines.append(line)
+        new_body = "\n".join(lines)
+        return new_body
+
+    @staticmethod
+    def check_for_socket_comments(comments: dict):
+        socket_comments = {}
+        for comment_id in comments:
+            comment = comments[comment_id]
+            comment: Comment
+            if "socket-security-comment-actions" in comment.body:
+                socket_comments["security"] = comment
+            elif "socket-overview-comment-actions" in comment.body:
+                socket_comments["overview"] = comment
+            elif "SocketSecurity ignore" in comment.body:
+                if "ignore" not in socket_comments:
+                    socket_comments["ignore"] = []
+                socket_comments["ignore"].append(comment)
+        return socket_comments

{socketsecurity-0.0.81 → socketsecurity-0.0.83}/socketsecurity/socketcli.py

@@ -3,6 +3,9 @@ import json
 from socketsecurity.core import Core, __version__
 from socketsecurity.core.classes import FullScanParams, Diff, Package
 from socketsecurity.core.messages import Messages
+from socketsecurity.core.scm_comments import Comments
+from socketsecurity.core.git_interface import Git
+from git import InvalidGitRepositoryError
 import os
 import sys
 import logging
@@ -26,7 +29,7 @@ parser.add_argument(
 )
 parser.add_argument(
     '--branch',
-    default='main',
+    default='',
     help='The name of the branch',
     required=False
 )
@@ -112,6 +115,12 @@ parser.add_argument(
     default=False
 )
 
+parser.add_argument(
+    '--files',
+    help='Specify a list of files in the format of ["file1", "file2"]',
+    default="[]"
+)
+
 
 def output_console_comments(diff_report) -> None:
     console_security_comment = Messages.create_console_security_alert_table(diff_report)
@@ -159,17 +168,41 @@ def main_code():
     sbom_file = arguments.sbom_file
     license_mode = arguments.generate_license
     enable_json = arguments.enable_json
-    license_file = f"{repo}"
-    if branch is not None:
-        license_file += f"_{branch}"
-    license_file += ".json"
+    files = arguments.files
     api_token = os.getenv("SOCKET_SECURITY_API_KEY") or arguments.api_token
+    try:
+        files = json.loads(files)
+    except Exception as error:
+        log.error(f"Unable to parse {files}")
+        log.error(error)
+        sys.exit(3)
     if api_token is None:
         log.info("Unable to find Socket API Token")
         sys.exit(3)
+    try:
+        git_repo = Git(target_path)
+        if repo is None:
+            repo = git_repo.repo_name
+        if commit_sha is None or commit_sha == '':
+            commit_sha = git_repo.commit
+        if branch is None or branch == '':
+            branch = git_repo.branch
+        if committer is None or committer == '':
+            committer = git_repo.committer
+        if commit_message is None or commit_message == '':
+            commit_message = git_repo.commit_message
+        if len(files) == 0:
+            files = git_repo.changed_files
+    except InvalidGitRepositoryError:
+        pass
+        # git_repo = None
     if repo is None:
         log.info("Repo name needs to be set")
         sys.exit(2)
+    license_file = f"{repo}"
+    if branch is not None:
+        license_file += f"_{branch}"
+    license_file += ".json"
     log.info(f"Starting Socket Security Scan version {__version__}")
     scm = None
     if scm_type == "github":
@@ -204,10 +237,10 @@ def main_code():
     elif scm is not None and scm.check_event_type() != "comment":
         log.info("Push initiated flow")
         diff: Diff
-        diff = core.create_new_diff(target_path, params, workspace=target_path)
+        diff = core.create_new_diff(target_path, params, workspace=target_path, new_files=files)
         if scm.check_event_type() == "diff":
             comments = scm.get_comments_for_pr(repo, str(pr_number))
-            diff.new_alerts = scm.remove_alerts(comments, diff.new_alerts)
+            diff.new_alerts = Comments.remove_alerts(comments, diff.new_alerts)
             overview_comment = Messages.dependency_overview_template(diff)
             security_comment = Messages.security_comment_template(diff)
             new_security_comment = True
@@ -230,7 +263,7 @@ def main_code():
     else:
         log.info("API Mode")
         diff: Diff
-        diff = core.create_new_diff(target_path, params, workspace=target_path)
+        diff = core.create_new_diff(target_path, params, workspace=target_path, new_files=files)
         if enable_json:
             output_console_json(diff)
         else:

{socketsecurity-0.0.81 → socketsecurity-0.0.83/socketsecurity.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: socketsecurity
-Version: 0.0.81
+Version: 0.0.83
 Summary: Socket Security CLI for CI/CD
 Author-email: Douglas Coburn <douglas@socket.dev>
 Maintainer-email: Douglas Coburn <douglas@socket.dev>

{socketsecurity-0.0.81 → socketsecurity-0.0.83}/socketsecurity.egg-info/SOURCES.txt

@@ -12,8 +12,10 @@ socketsecurity.egg-info/top_level.txt
 socketsecurity/core/__init__.py
 socketsecurity/core/classes.py
 socketsecurity/core/exceptions.py
+socketsecurity/core/git_interface.py
 socketsecurity/core/github.py
 socketsecurity/core/gitlab.py
 socketsecurity/core/issues.py
 socketsecurity/core/licenses.py
-socketsecurity/core/messages.py
+socketsecurity/core/messages.py
+socketsecurity/core/scm_comments.py