socketsecurity 0.0.91__tar.gz → 0.0.93__tar.gz

{socketsecurity-0.0.91/socketsecurity.egg-info → socketsecurity-0.0.93}/PKG-INFO

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

{socketsecurity-0.0.91 → socketsecurity-0.0.93}/socketsecurity/__init__.py

@@ -1,2 +1,2 @@
 __author__ = 'socket.dev'
-__version__ = '0.0.91'
+__version__ = '0.0.93'

{socketsecurity-0.0.91 → socketsecurity-0.0.93}/socketsecurity/core/__init__.py

@@ -28,7 +28,8 @@ import time
 __all__ = [
     "Core",
     "log",
-    "__version__"
+    "__version__",
+    "do_request"
 ]
 
 
@@ -63,10 +64,11 @@ def do_request(
         payload: [dict, str] = None,
         files: list = None,
         method: str = "GET",
+        base_url: str = None,
 ) -> requests.request:
     """
     do_requests is the shared function for making HTTP calls
-
+    :param base_url:
     :param path: Required path for the request
     :param headers: Optional dictionary of headers. If not set will use a default set
     :param payload: Optional dictionary or string of the payload to pass
@@ -74,8 +76,13 @@ def do_request(
     :param method: Optional method to use, defaults to GET
     :return:
     """
-    if encoded_key is None or encoded_key == "":
-        raise APIKeyMissing
+
+    if base_url is not None:
+        url = f"{base_url}/{path}"
+    else:
+        if encoded_key is None or encoded_key == "":
+            raise APIKeyMissing
+        url = f"{api_url}/{path}"
 
     if headers is None:
         headers = {
@@ -83,7 +90,6 @@ def do_request(
             'User-Agent': f'SocketPythonCLI/{__version__}',
             "accept": "application/json"
         }
-    url = f"{api_url}/{path}"
     response = requests.request(
         method.upper(),
         url,
@@ -92,8 +98,8 @@ def do_request(
         files=files,
         timeout=timeout
     )
-    output_headers = headers
-    output_headers['Authorization'] = "Basic API_KEY_REDACTED"
+    output_headers = headers.copy()
+    output_headers['Authorization'] = "API_KEY_REDACTED"
     output = {
         "url": url,
         "headers": output_headers,
@@ -107,14 +113,7 @@ def do_request(
     if response.status_code <= 399:
         return response
     elif response.status_code == 400:
-        print(f"url={url}")
-        print(f"payload={payload}")
-        print(f"files={files}")
-        error = {
-            "msg": "bad request",
-            "error": response.text
-        }
-        raise APIFailure(error)
+        raise APIFailure(output)
     elif response.status_code == 401:
         raise APIAccessDenied("Unauthorized")
     elif response.status_code == 403:
@@ -128,8 +127,10 @@ def do_request(
     else:
         msg = {
             "status_code": response.status_code,
+            "UnexpectedError": "There was an unexpected error using the API",
             "error": response.text,
-            "UnexpectedError": "There was an unexpected error using the API"
+            "payload": payload,
+            "url": url
         }
         raise APIFailure(msg)
 

{socketsecurity-0.0.91 → socketsecurity-0.0.93}/socketsecurity/core/github.py

@@ -1,8 +1,7 @@
 import json
 import os
-from socketsecurity.core import log
+from socketsecurity.core import log, do_request
 import requests
-from socketsecurity.core.exceptions import *
 from socketsecurity.core.classes import Comment
 from socketsecurity.core.scm_comments import Comments
 import sys
@@ -54,60 +53,11 @@ for env in github_variables:
         else:
             is_default_branch = True
 
-
-def do_request(
-        path: str,
-        headers: dict = None,
-        payload: [dict, str] = None,
-        files: list = None,
-        method: str = "GET",
-) -> dict:
-    """
-    do_requests is the shared function for making HTTP calls
-
-    :param path: Required path for the request
-    :param headers: Optional dictionary of headers. If not set will use a default set
-    :param payload: Optional dictionary or string of the payload to pass
-    :param files: Optional list of files to upload
-    :param method: Optional method to use, defaults to GET
-    :return:
-    """
-    if gh_api_token is None or gh_api_token == "":
-        raise APIKeyMissing
-
-    if headers is None:
-        headers = {
-            'Authorization': f"Bearer {gh_api_token}",
-            'User-Agent': 'SocketPythonScript/0.0.1',
-            "accept": "application/json"
-        }
-    url = f"{github_api_url}/{path}"
-    response = requests.request(
-        method.upper(),
-        url,
-        headers=headers,
-        data=payload,
-        files=files
-    )
-    if response.status_code <= 399:
-        try:
-            return response.json()
-        except Exception as error:
-            response = {
-                "error": error,
-                "response": response.text,
-                "payload": payload
-            }
-            return response
-    else:
-        msg = {
-            "status_code": response.status_code,
-            "UnexpectedError": "There was an unexpected error using the API",
-            "error": response.text,
-            "payload": payload,
-            "path": path
-        }
-        raise APIFailure(msg)
+headers = {
+    'Authorization': f"Bearer {gh_api_token}",
+    'User-Agent': 'SocketPythonScript/0.0.1',
+    "accept": "application/json"
+}
 
 
 class Github:
@@ -177,16 +127,22 @@ class Github:
         existing_overview_comment = comments.get("overview")
         existing_security_comment = comments.get("security")
         if new_overview_comment:
+            log.debug("New Dependency Overview comment")
             if existing_overview_comment is not None:
+                log.debug("Previous version of Dependency Overview, updating")
                 existing_overview_comment: Comment
                 Github.update_comment(overview_comment, str(existing_overview_comment.id))
             else:
+                log.debug("No previous version of Dependency Overview, posting")
                 Github.post_comment(overview_comment)
         if new_security_comment:
+            log.debug("New Security Issue Comment")
             if existing_security_comment is not None:
+                log.debug("Previous version of Security Issue comment, updating")
                 existing_security_comment: Comment
                 Github.update_comment(security_comment, str(existing_security_comment.id))
             else:
+                log.debug("No Previous version of Security Issue comment, posting")
                 Github.post_comment(security_comment)
 
     @staticmethod
@@ -197,7 +153,7 @@ class Github:
             "body": body
         }
         payload = json.dumps(payload)
-        do_request(path, payload=payload, method="POST")
+        do_request(path, payload=payload, method="POST", headers=headers, base_url=github_api_url)
 
     @staticmethod
     def update_comment(body: str, comment_id: str) -> None:
@@ -207,7 +163,7 @@ class Github:
             "body": body
         }
         payload = json.dumps(payload)
-        do_request(path, payload=payload, method="PATCH")
+        do_request(path, payload=payload, method="PATCH", headers=headers, base_url=github_api_url)
 
     @staticmethod
     def write_new_env(name: str, content: str) -> None:
@@ -219,7 +175,7 @@ class Github:
     @staticmethod
     def get_comments_for_pr(repo: str, pr: str) -> dict:
         path = f"repos/{github_repository_owner}/{repo}/issues/{pr}/comments"
-        raw_comments = do_request(path)
+        raw_comments = Comments.process_response(do_request(path, headers=headers, base_url=github_api_url))
         comments = {}
         if "error" not in raw_comments:
             for item in raw_comments:

{socketsecurity-0.0.91 → socketsecurity-0.0.93}/socketsecurity/core/gitlab.py

@@ -1,7 +1,6 @@
+import json
 import os
-from socketsecurity.core import log
-import requests
-from socketsecurity.core.exceptions import *
+from socketsecurity.core import log, do_request
 from socketsecurity.core.scm_comments import Comments
 import sys
 from socketsecurity.core.classes import Comment, Issue
@@ -41,7 +40,6 @@ gitlab_variables = [
     "GITLAB_TOKEN",
 ]
 
-
 for env in gitlab_variables:
     var_name = env.lower()
     globals()[var_name] = os.getenv(env) or None
@@ -49,60 +47,11 @@ for env in gitlab_variables:
         value = globals()[var_name]
         log.debug(f"{env}={value}")
 
-
-def do_request(
-        path: str,
-        headers: dict = None,
-        payload: [dict, str] = None,
-        files: list = None,
-        method: str = "GET",
-) -> dict:
-    """
-    do_requests is the shared function for making HTTP calls
-
-    :param path: Required path for the request
-    :param headers: Optional dictionary of headers. If not set will use a default set
-    :param payload: Optional dictionary or string of the payload to pass
-    :param files: Optional list of files to upload
-    :param method: Optional method to use, defaults to GET
-    :return:
-    """
-    if gitlab_token is None or gitlab_token == "":
-        raise APIKeyMissing
-
-    if headers is None:
-        headers = {
-            'Authorization': f"Bearer {gitlab_token}",
-            'User-Agent': 'SocketPythonScript/0.0.1',
-            "accept": "application/json"
-        }
-    url = f"{ci_api_v4_url}/{path}"
-    response = requests.request(
-        method.upper(),
-        url,
-        headers=headers,
-        data=payload,
-        files=files
-    )
-    if response.status_code <= 399:
-        try:
-            return response.json()
-        except Exception as error:
-            response = {
-                "error": error,
-                "response": response.text
-            }
-            return response
-    else:
-        msg = {
-            "status_code": response.status_code,
-            "UnexpectedError": "There was an unexpected error using the API",
-            "error": response.text,
-            "payload": payload,
-            "path": path
-        }
-        raise APIFailure(msg)
-
+headers = {
+    'Authorization': f"Bearer {gitlab_token}",
+    'User-Agent': 'SocketPythonScript/0.0.1',
+    "accept": "application/json"
+}
 
 class Gitlab:
     commit_sha: str
@@ -171,16 +120,22 @@ class Gitlab:
         existing_overview_comment = comments.get("overview")
         existing_security_comment = comments.get("security")
         if new_overview_comment:
+            log.debug("New Dependency Overview comment")
             if existing_overview_comment is not None:
+                log.debug("Previous version of Dependency Overview, updating")
                 existing_overview_comment: Comment
                 Gitlab.update_comment(overview_comment, str(existing_overview_comment.id))
             else:
+                log.debug("No previous version of Dependency Overview, posting")
                 Gitlab.post_comment(overview_comment)
         if new_security_comment:
+            log.debug("New Security Issue Comment")
             if existing_security_comment is not None:
+                log.debug("Previous version of Security Issue comment, updating")
                 existing_security_comment: Comment
                 Gitlab.update_comment(security_comment, str(existing_security_comment.id))
             else:
+                log.debug("No Previous version of Security Issue comment, posting")
                 Gitlab.post_comment(security_comment)
 
     @staticmethod
@@ -189,8 +144,7 @@ class Gitlab:
         payload = {
             "body": body
         }
-        # payload = json.dumps(payload)
-        do_request(path, payload=payload, method="POST")
+        do_request(path, payload=payload, method="POST", headers=headers, base_url=ci_api_v4_url)
 
     @staticmethod
     def update_comment(body: str, comment_id: str) -> None:
@@ -198,13 +152,12 @@ class Gitlab:
         payload = {
             "body": body
         }
-        # payload = json.dumps(payload)
-        do_request(path, payload=payload, method="PUT")
+        do_request(path, payload=payload, method="PUT", headers=headers, base_url=ci_api_v4_url)
 
     @staticmethod
     def get_comments_for_pr(repo: str, pr: str) -> dict:
         path = f"projects/{ci_merge_request_project_id}/merge_requests/{ci_merge_request_iid}/notes"
-        raw_comments = do_request(path)
+        raw_comments = Comments.process_response(do_request(path, headers=headers, base_url=ci_api_v4_url))
         comments = {}
         if "message" not in raw_comments:
             for item in raw_comments:
@@ -217,34 +170,6 @@ class Gitlab:
         socket_comments = Comments.check_for_socket_comments(comments)
         return socket_comments
 
-    @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 remove_comment_alerts(comments: dict):
         security_alert = comments.get("security")

{socketsecurity-0.0.91 → socketsecurity-0.0.93}/socketsecurity/core/scm_comments.py

@@ -1,7 +1,25 @@
 from socketsecurity.core.classes import Comment, Issue
+from socketsecurity.core import log
+from requests import Response
+import json
 
 
 class Comments:
+    @staticmethod
+    def process_response(response: Response) -> dict:
+        output = {}
+        try:
+            output = response.json()
+        except Exception as error:
+            log.debug("Unable to parse comment response json, trying as text")
+            log.debug(error)
+            try:
+                output = json.loads(response.text)
+            except Exception as error:
+                log.error("Unable to process comment data, unable to get previous comment data")
+                log.error(error)
+        return output
+
     @staticmethod
     def remove_alerts(comments: dict, new_alerts: list) -> list:
         alerts = []

{socketsecurity-0.0.91 → socketsecurity-0.0.93}/socketsecurity/socketcli.py

@@ -169,7 +169,8 @@ def main_code():
     arguments = parser.parse_args()
     debug = arguments.enable_debug
     if debug:
-        logging.basicConfig(level=logging.DEBUG)
+        log.setLevel(logging.DEBUG)
+        log.debug("Debug logging enabled")
     repo = arguments.repo
     branch = arguments.branch
     commit_message = arguments.commit_message

{socketsecurity-0.0.91 → socketsecurity-0.0.93/socketsecurity.egg-info}/PKG-INFO

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