CheckmarxPythonSDK 1.0.6__tar.gz → 1.0.7__tar.gz

{checkmarxpythonsdk-1.0.6 → checkmarxpythonsdk-1.0.7}/CheckmarxPythonSDK/CxOne/scansAPI.py

@@ -302,6 +302,7 @@ def get_a_detailed_workflow_of_a_scan(scan_id):
         ) for item in items or []
     ]
 
+
 def sca_recalculate(project_id, branch):
     """
 
@@ -317,14 +318,15 @@ def sca_recalculate(project_id, branch):
     scan_data = json.dumps({
         "project_id": f"{project_id}",
         "branch": f"{branch}",
-        "engines":["sca"],
-        "config":[{"type":"sca","value":{"enableContainersScan":True}}]
-        })
-    
+        "engines": ["sca"],
+        "config": [{"type": "sca", "value": {"enableContainersScan": True}}]
+    })
+
     response = post_request(relative_url=relative_url, data=(scan_data))
     return response
 
-def scan_by_repo_url(project_id, repo_url, branch, engines, tag):  
+
+def scan_by_repo_url(project_id, repo_url, branch, engines, tag):
     """
 
     Args:
@@ -337,39 +339,39 @@ def scan_by_repo_url(project_id, repo_url, branch, engines, tag):
     Returns:
         HTTP 201 Created
     """
-    
-    relative_url = f"/api/scans"  
-
-    scan_data = {  
-        "type": "git",  
-        "handler": {  
-            "repoUrl": repo_url,  
-            "branch": branch,  
+
+    relative_url = f"/api/scans"
+
+    scan_data = {
+        "type": "git",
+        "handler": {
+            "repoUrl": repo_url,
+            "branch": branch,
             # "skipSubModules": False  
-        },  
-        "project": {  
-            "id": project_id,  
-            "tags": {}  
-        },  
-        "config": [],  
+        },
+        "project": {
+            "id": project_id,
+            "tags": {}
+        },
+        "config": [],
         "tags": tag
-    }  
-      
-    engine_configs = {  
-        "sast": {"incremental": "false"},  
-        "sca": {},  
-        "kics": {},  
-        "apisec": {}  
-    }  
-      
-    for engine in engines:  
-        if engine in engine_configs:  
-            scan_data["config"].append({  
-                "type": engine,  
-                "value": engine_configs[engine]  
-            })  
-        else:  
-            print(f"Warning: Engine '{engine}' is not supported and will be ignored.")  
-    
+    }
+
+    engine_configs = {
+        "sast": {"incremental": "false"},
+        "sca": {},
+        "kics": {},
+        "apisec": {}
+    }
+
+    for engine in engines:
+        if engine in engine_configs:
+            scan_data["config"].append({
+                "type": engine,
+                "value": engine_configs[engine]
+            })
+        else:
+            print(f"Warning: Engine '{engine}' is not supported and will be ignored.")
+
     response = post_request(relative_url=relative_url, data=json.dumps((scan_data)))
-    return response 
+    return response

{checkmarxpythonsdk-1.0.6 → checkmarxpythonsdk-1.0.7}/CheckmarxPythonSDK/CxScaApiSDK/__init__.py

@@ -69,6 +69,8 @@ from .api import (
     get_container_vulnerabilities_by_scan_id,
     get_package_licenses_by_scan_id,
     get_down_stream_remediation_by_scan_id,
+    get_scan_info_by_scan_id,
+    get_scan_progress_by_scan_id,
 )
 
 from .AccessControlAPI import AccessControlAPI

{checkmarxpythonsdk-1.0.6 → checkmarxpythonsdk-1.0.7}/CheckmarxPythonSDK/CxScaApiSDK/api.py

@@ -2312,6 +2312,97 @@ class Sca(object):
         response = self.gql_request(relative_url=self.gql_relative_url, data=query)
         return response
 
+    def get_scan_info_by_scan_id(self, scan_id):
+        """
+            This is a GraphQL API
+        Args:
+            scan_id (str):
+
+        Returns:
+            example:
+            {
+                "scanInfo": {
+                    "hasWarnings": false,
+                    "totalManifestsCount": 1,
+                    "totalPackagesCount": 245,
+                    "identifiedBy": [
+                        {
+                            "matchType": "Filename",
+                            "count": 240
+                        },
+                        {
+                            "matchType": "Sha1",
+                            "count": 5
+                        }
+                    ],
+                    "manifests": [
+                        {
+                            "dependenciesCount": 309,
+                            "dependencyResolverStatus": "FullResults",
+                            "manifestPath": "pom.xml",
+                            "message": "",
+                            "resolvingModuleType": "Maven"
+                        }
+                    ],
+                    "deltaScan": false
+                }
+            }
+        """
+        query = ("query { "
+                 "scanInfo     ("
+                 f"scanId: \"{scan_id}\" "
+                 ")"
+                 "{hasWarnings, totalManifestsCount, totalPackagesCount, identifiedBy { matchType, count }, "
+                 "manifests { dependenciesCount, dependencyResolverStatus, manifestPath, message, resolvingModuleType},"
+                 "deltaScan }"
+                 "}")
+        response = self.gql_request(relative_url=self.gql_relative_url, data=query)
+        return response
+
+    def get_scan_progress_by_scan_id(self, scan_id):
+        """
+            This is a GraphQL API
+        Args:
+            scan_id (str):
+
+        Returns:
+            example:
+                {'scanProgress': {'totalDuration': 35847.367, 'data': [
+        {'name': 'Generating download link', 'startTime': '2024-11-22T01:54:01.129Z', 'duration': 0.253,
+        'status': 'Done'},
+        {'name': 'Download Project Code', 'startTime': '2024-11-22T01:54:01.145Z', 'duration': 69.031,
+        'status': 'Done'},
+        {'name': 'CollectEvidencesScanPipelineStep', 'startTime': '2024-11-22T01:54:01.227Z', 'duration': 0.001,
+        'status': 'Done'},
+         {'name': 'Collecting Evidence', 'startTime': '2024-11-22T01:54:01.237Z', 'duration': 5241.963,
+         'status': 'Done'},
+          {'name': 'Store Ignored Vulnerabilities in Scan Results', 'startTime': '2024-11-22T01:54:06.547Z',
+          'duration': 7.692, 'status': 'Done'},
+          {'name': 'Generate Risk Report', 'startTime': '2024-11-22T01:54:06.565Z', 'duration': 15284.921,
+          'status': 'Done'},
+          {'name': 'Find Private Packages', 'startTime': '2024-11-22T01:54:36.900Z', 'duration': 0.815,
+          'status': 'Done'},
+          {'name': 'Global Inventory Publisher', 'startTime': '2024-11-22T01:54:36.918Z', 'duration': 0.769,
+          'status': 'Done'},
+          {'name': 'Correlating container vulnerabilities', 'startTime': '2024-11-22T01:54:06.498Z',
+          'duration': 27.277, 'status': 'Done'},
+          {'name': 'Handle Container Evidences', 'startTime': '2024-11-22T01:54:06.490Z', 'duration': 47.252,
+          'status': 'Done'},
+          {'name': 'Generate Risk Management Report', 'startTime': '2024-11-22T01:54:21.862Z', 'duration': 0.777,
+          'status': 'Done'},
+           {'name': 'Fetch Generate Risk Management Report Result', 'startTime': '2024-11-22T01:54:36.888Z',
+           'duration': 0.958, 'status': 'Done'}
+        ]}}
+        """
+        query = ("query { "
+                 "scanProgress  ("
+                 f"scanId: \"{scan_id}\" "
+                 ")"
+                 "{ totalDuration, data { name, startTime, duration, status } }"
+                 "}")
+        response = self.gql_request(relative_url=self.gql_relative_url, data=query)
+        return response
+
 
 def get_all_projects(project_name=None):
     return Sca().get_all_projects(project_name=project_name)
@@ -2634,3 +2725,11 @@ def get_package_licenses_by_scan_id(scan_id, take=0, skip=0):
 def get_down_stream_remediation_by_scan_id(scan_id, include_broken_methods=True, take=10, skip=0):
     return Sca().get_down_stream_remediation_by_scan_id(scan_id, include_broken_methods=include_broken_methods,
                                                         take=take, skip=skip)
+
+
+def get_scan_info_by_scan_id(scan_id):
+    return Sca().get_scan_info_by_scan_id(scan_id)
+
+
+def get_scan_progress_by_scan_id(scan_id):
+    return Sca().get_scan_progress_by_scan_id(scan_id)

checkmarxpythonsdk-1.0.7/CheckmarxPythonSDK/__version__.py

@@ -0,0 +1 @@
+__version__ = '1.0.7'

{checkmarxpythonsdk-1.0.6 → checkmarxpythonsdk-1.0.7}/CheckmarxPythonSDK.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CheckmarxPythonSDK
-Version: 1.0.6
+Version: 1.0.7
 Summary: Checkmarx Python SDK
 Home-page: https://github.com/checkmarx-ts/checkmarx-python-sdk
 Author: Happy Yang

{checkmarxpythonsdk-1.0.6 → checkmarxpythonsdk-1.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: CheckmarxPythonSDK
-Version: 1.0.6
+Version: 1.0.7
 Summary: Checkmarx Python SDK
 Home-page: https://github.com/checkmarx-ts/checkmarx-python-sdk
 Author: Happy Yang

checkmarxpythonsdk-1.0.6/CheckmarxPythonSDK/__version__.py

@@ -1 +0,0 @@
-__version__ = '1.0.6'