CheckmarxPythonSDK 0.9.2__tar.gz → 0.9.4__tar.gz

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxOne/__init__.py

@@ -103,6 +103,10 @@ from .repoStoreServiceAPI import (
     get_the_list_of_branches_inside_a_git_repository,
 )
 
+from .resultsSummaryAPI import (
+    get_summary_for_many_scans,
+)
+
 from .sastBestFixLocationAPI import (
     get_bfl_graph_by_scan_id,
 )
@@ -145,11 +149,11 @@ from .sastResultsAPI import (
     get_sast_results_by_scan_id,
 )
 
-from .resultsSummaryAPI import (
-    get_summary_for_many_scans,
+from .sastResultsSummaryAPI import (
     get_sast_aggregate_results,
 )
 
+
 from .sastScanMetadataServiceAPI import (
     get_metadata_of_scans,
     get_metadata_of_scan,
@@ -186,6 +190,7 @@ from .scansAPI import (
     get_the_list_of_available_config_as_code_template_files,
     get_the_config_as_code_template_file,
     get_scan_by_id,
+    get_a_scan_by_id,
     cancel_scan,
     delete_scan,
     get_a_detailed_workflow_of_a_scan,

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxOne/config.py

@@ -16,6 +16,7 @@ config_default = {
     "timeout": 60,
     "verify": False,
     "cert": None,
+    "proxy": None,
 }
 
 config = get_config(config_default=config_default, section="CxOne", prefix="cxone_")

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxOne/httpRequests.py

@@ -24,15 +24,19 @@ def get_data_from_config():
             "client_id": "ast-app",
             "refresh_token": config.get("refresh_token"),
         }
-    return server_url, token_url, timeout, verify_ssl_cert, cert, token_req_data
+    proxies = {
+        "http": config.get("proxy"),
+        "https": config.get("proxy"),
+    }
+    return server_url, token_url, timeout, verify_ssl_cert, cert, token_req_data, proxies
 
 
 get, post, put, patch, delete, head = build_request_funcs(get_data_from_config)
 
 headers = {
-    "user-agent":
-        "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) "
-        "Chrome/106.0.0.0 Safari/537.36"
+    # "user-agent":
+    #     "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) "
+    #     "Chrome/106.0.0.0 Safari/537.36"
 }
 
 

checkmarxpythonsdk-0.9.4/CheckmarxPythonSDK/CxOne/resultsSummaryAPI.py

@@ -0,0 +1,68 @@
+from .httpRequests import get_request
+from .utilities import get_url_param, type_check, list_member_type_check
+from .dto import (
+    ResultsSummary,
+    KicsCounters,
+    SastCounters,
+    ScaCounters,
+    ScaPackageCounters,
+    ScaContainersCounters,
+    ApiSecCounters,
+)
+
+api_url = "/api/scan-summary"
+
+
+def get_summary_for_many_scans(scan_ids, include_severity_status=True, include_queries=False, include_files=False,
+                               apply_predicates=True, language=None):
+    """
+
+    Args:
+        scan_ids (list of str): Scan IDs to find. Each scan id will have his own object.
+        include_severity_status (bool): if true returns the severityStatus field, otherwise will omit the field.
+                            Default value : true
+        include_queries (bool): if true returns the queries field, otherwise will omit the field.
+                            Default value : false
+        include_files (bool): if true returns the source code file and sink code file fields, otherwise will omit the fields.
+                            Default value : false
+        apply_predicates (bool): if true will apply changes from predicates, otherwise will return the raw results summary.
+                            Default value : true
+        language (str): get scan summary for specific source code language.
+
+    Returns:
+        dict
+    """
+    type_check(scan_ids, (list, tuple))
+    type_check(include_severity_status, bool)
+    type_check(include_queries, bool)
+    type_check(include_files, bool)
+    type_check(apply_predicates, bool)
+    type_check(language, str)
+
+    list_member_type_check(scan_ids, str)
+
+    relative_url = api_url + "?"
+    relative_url += get_url_param("scan-ids", scan_ids)
+    relative_url += get_url_param("include-severity-status", include_severity_status)
+    relative_url += get_url_param("include-queries", include_queries)
+    relative_url += get_url_param("include-files", include_files)
+    relative_url += get_url_param("apply-predicates", apply_predicates)
+    relative_url += get_url_param("language", language)
+
+    response = get_request(relative_url=relative_url)
+    response = response.json()
+    return {
+        "scansSummaries": [
+            ResultsSummary(
+                scan_id=summary.get("scanId"),
+                sast_counters=summary.get("sastCounters"),
+                kics_counters=summary.get("kicsCounters"),
+                sca_counters=summary.get("scaCounters"),
+                sca_packages_counters=summary.get('scaPackagesCounters'),
+                sca_containers_counters=summary.get('scaContainersCounters'),
+                api_sec_counters=summary.get('apiSecCounters')
+            ) for summary in response.get("scansSummaries") or []
+        ],
+        "totalCount": response.get("totalCount")
+    }
+

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/resultsSummaryAPI.py → checkmarxpythonsdk-0.9.4/CheckmarxPythonSDK/CxOne/sastResultsSummaryAPI.py

@@ -10,61 +10,7 @@ from .dto import (
     ApiSecCounters,
 )
 
-api_url = "/api/scan-summary"
-
-
-def get_summary_for_many_scans(scan_ids, include_severity_status=True, include_queries=False, include_files=False,
-                               apply_predicates=True, language=None):
-    """
-
-    Args:
-        scan_ids (list of str): Scan IDs to find. Each scan id will have his own object.
-        include_severity_status (bool): if true returns the severityStatus field, otherwise will omit the field.
-                            Default value : true
-        include_queries (bool): if true returns the queries field, otherwise will omit the field.
-                            Default value : false
-        include_files (bool): if true returns the source code file and sink code file fields, otherwise will omit the fields.
-                            Default value : false
-        apply_predicates (bool): if true will apply changes from predicates, otherwise will return the raw results summary.
-                            Default value : true
-        language (str): get scan summary for specific source code language.
-
-    Returns:
-        dict
-    """
-    type_check(scan_ids, (list, tuple))
-    type_check(include_severity_status, bool)
-    type_check(include_queries, bool)
-    type_check(include_files, bool)
-    type_check(apply_predicates, bool)
-    type_check(language, str)
-
-    list_member_type_check(scan_ids, str)
-
-    relative_url = api_url + "?"
-    relative_url += get_url_param("scan-ids", scan_ids)
-    relative_url += get_url_param("include-severity-status", include_severity_status)
-    relative_url += get_url_param("include-queries", include_queries)
-    relative_url += get_url_param("include-files", include_files)
-    relative_url += get_url_param("apply-predicates", apply_predicates)
-    relative_url += get_url_param("language", language)
-
-    response = get_request(relative_url=relative_url)
-    response = response.json()
-    return {
-        "scansSummaries": [
-            ResultsSummary(
-                scan_id=summary.get("scanId"),
-                sast_counters=summary.get("sastCounters"),
-                kics_counters=summary.get("kicsCounters"),
-                sca_counters=summary.get("scaCounters"),
-                sca_packages_counters=summary.get('scaPackagesCounters'),
-                sca_containers_counters=summary.get('scaContainersCounters'),
-                api_sec_counters=summary.get('apiSecCounters')
-            ) for summary in response.get("scansSummaries") or []
-        ],
-        "totalCount": response.get("totalCount")
-    }
+api_url = "/api/sast-scan-summary"
 
 
 def get_sast_aggregate_results(scan_id, group_by_field, language=None, status=None, severity=None, source_file=None,
@@ -127,7 +73,7 @@ def get_sast_aggregate_results(scan_id, group_by_field, language=None, status=No
     list_member_type_check(severity, str)
     list_member_type_check(query_ids, int)
 
-    relative_url = api_url + "?scan-id={scan_id}"
+    relative_url = api_url + "/aggregate?scan-id={scan_id}"
     relative_url += get_url_param("group-by-field", group_by_field)
     relative_url += get_url_param("language", language)
     relative_url += get_url_param("status", status)

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxPortalSoapApiSDK/authHeaders.py

@@ -5,7 +5,7 @@ auth_headers = {}
 
 
 def get_token():
-    _, token_url, timeout, verify_ssl_cert, cert, token_req_data = get_data_from_config()
+    _, token_url, timeout, verify_ssl_cert, cert, token_req_data, proxies = get_data_from_config()
     token_req_data.update(
         {
             "grant_type": "password",
@@ -14,7 +14,8 @@ def get_token():
             "client_secret": "014DF517-39D1-4453-B7B3-9930C563627C",
         }
     )
-    return get_new_token(token_url, token_req_data, timeout=timeout, verify_ssl_cert=verify_ssl_cert, cert=cert)
+    return get_new_token(token_url, token_req_data, timeout=timeout, verify_ssl_cert=verify_ssl_cert, cert=cert,
+                         proxies=proxies)
 
 
 def update_auth_headers():

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxPortalSoapApiSDK/zeepClient.py

@@ -26,7 +26,10 @@ def get_client_and_factory(relative_web_interface_url):
     )
 
     client.transport.session.verify = False
-
+    client.transport.session.proxies = {
+        'http': config.get("proxy"),
+        'https': config.get("proxy"),
+    }
     factory = client.type_factory("ns0")
 
     return client, factory

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxReporting/config.py

@@ -14,6 +14,7 @@ config_default = {
     "timeout": 60,
     "verify": False,
     "cert": None,
+    "proxy": None,
 }
 
 config = get_config(config_default=config_default, section="CxReporting", prefix="cxreporting_")

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxReporting/httpRequests.py

@@ -23,7 +23,11 @@ def get_data_from_config():
         "client_id": client_id,
         "client_secret": client_secret,
     }
-    return server_url, token_url, timeout, verify_ssl_cert, cert, token_req_data
+    proxies = {
+        "http": config.get("proxy"),
+        "https": config.get("proxy"),
+    }
+    return server_url, token_url, timeout, verify_ssl_cert, cert, token_req_data, proxies
 
 
 get_request, post_request, _, _, _, _ = build_request_funcs(get_data_from_config)

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxRestAPISDK/config.py

@@ -18,6 +18,7 @@ config_default = {
     "timeout": 60,
     "verify": False,
     "cert": None,
+    "proxy": None,
 }
 
 config = get_config(config_default=config_default, section="checkmarx", prefix="cxsast_")

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxRestAPISDK/httpRequests.py

@@ -34,7 +34,11 @@ def get_data_from_config():
         "client_id": client_id,
         "client_secret": client_secret,
     }
-    return server_url, token_url, timeout, verify_ssl_cert, cert, token_req_data
+    proxies = {
+        "http": config.get("proxy"),
+        "https": config.get("proxy"),
+    }
+    return server_url, token_url, timeout, verify_ssl_cert, cert, token_req_data, proxies
 
 
 get, post, put, patch, delete, _ = build_request_funcs(get_data_from_config)

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxScaApiSDK/config.py

@@ -12,6 +12,7 @@ config_default = {
     "timeout": 60,
     "verify": False,
     "cert": None,
+    "proxy": None,
 }
 
 config = get_config(config_default=config_default, section="CxSCA", prefix="cxsca_")

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/CxScaApiSDK/httpRequests.py

@@ -20,7 +20,11 @@ def get_data_from_config():
         "scope": scope,
         "client_id": "sca_resource_owner",
     }
-    return server_url, token_url, timeout, verify_ssl_cert, cert, token_req_data
+    proxies = {
+        "http": config.get("proxy"),
+        "https": config.get("proxy"),
+    }
+    return server_url, token_url, timeout, verify_ssl_cert, cert, token_req_data, proxies
 
 
 get, post, put, _, delete, _ = build_request_funcs(get_data_from_config)

checkmarxpythonsdk-0.9.4/CheckmarxPythonSDK/__version__.py

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

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK/utilities/httpRequests.py

@@ -15,7 +15,7 @@ logger = logging.getLogger("CheckmarxPythonSDK")
 
 
 def request(method, url, params=None, data=None, json=None, files=None, auth=None, timeout=None, headers=None,
-            verify=False, cert=None):
+            verify=False, cert=None, proxies=None):
     """
     https://requests.readthedocs.io/en/latest/api/#requests.request
     Args:
@@ -46,10 +46,10 @@ def request(method, url, params=None, data=None, json=None, files=None, auth=Non
 
     """
     return requests.request(method=method, url=url, params=params, data=data, json=json, files=files, auth=auth,
-                            timeout=timeout, headers=headers, verify=verify, cert=cert)
+                            timeout=timeout, headers=headers, verify=verify, cert=cert, proxies=proxies)
 
 
-def head(url, files=None, data=None, auth=None, timeout=None, headers=None, verify=False, cert=None):
+def head(url, files=None, data=None, auth=None, timeout=None, headers=None, verify=False, cert=None, proxies=None):
     """
 
     Args:
@@ -61,15 +61,16 @@ def head(url, files=None, data=None, auth=None, timeout=None, headers=None, veri
         headers (dict):
         verify (bool, str, optional):
         cert (str, tuple, optional):
+        proxies (dict, optional)
 
     Returns:
 
     """
     return request("HEAD", url, files=files, data=data, auth=auth, timeout=timeout, headers=headers,
-                   verify=verify, cert=cert)
+                   verify=verify, cert=cert, proxies=proxies)
 
 
-def get(url, files=None, data=None, auth=None, timeout=None, headers=None, verify=False, cert=None):
+def get(url, files=None, data=None, auth=None, timeout=None, headers=None, verify=False, cert=None, proxies=None):
     """
 
     Args:
@@ -81,15 +82,16 @@ def get(url, files=None, data=None, auth=None, timeout=None, headers=None, verif
         headers (dict):
         verify (bool, str, optional):
         cert (str, tuple, optional):
+         proxies (dict, optional):
 
     Returns:
 
     """
     return request("GET", url, files=files, data=data, auth=auth, timeout=timeout, headers=headers,
-                   verify=verify, cert=cert)
+                   verify=verify, cert=cert, proxies=proxies)
 
 
-def post(url, data, files=None, auth=None, timeout=None, headers=None, verify=False, cert=None):
+def post(url, data, files=None, auth=None, timeout=None, headers=None, verify=False, cert=None, proxies=None):
     """
 
     Args:
@@ -101,14 +103,15 @@ def post(url, data, files=None, auth=None, timeout=None, headers=None, verify=Fa
         headers (dict):
         verify (bool, str, optional):
         cert (str, tuple, optional):
+         proxies (dict, optional):
 
     Returns:
     """
     return request("POST", url, data=data, files=files, auth=auth, timeout=timeout, headers=headers,
-                   verify=verify, cert=cert)
+                   verify=verify, cert=cert, proxies=proxies)
 
 
-def put(url, data, files=None, auth=None, timeout=None, headers=None, verify=False, cert=None):
+def put(url, data, files=None, auth=None, timeout=None, headers=None, verify=False, cert=None, proxies=None):
     """
 
     Args:
@@ -120,14 +123,15 @@ def put(url, data, files=None, auth=None, timeout=None, headers=None, verify=Fal
         headers (dict):
         verify (bool, str, optional):
         cert (str, tuple, optional):
+        proxies (dict, optional):
 
     Returns:
     """
     return request("PUT", url, data=data, files=files, auth=auth, timeout=timeout, headers=headers,
-                   verify=verify, cert=cert)
+                   verify=verify, cert=cert, proxies=proxies)
 
 
-def patch(url, data, files=None, auth=None, timeout=None, headers=None, verify=False, cert=None):
+def patch(url, data, files=None, auth=None, timeout=None, headers=None, verify=False, cert=None, proxies=None):
     """
 
     Args:
@@ -139,14 +143,15 @@ def patch(url, data, files=None, auth=None, timeout=None, headers=None, verify=F
         headers (dict):
         verify (bool, str, optional):
         cert (str, tuple, optional):
+        proxies (dict, optional):
 
     Returns:
     """
     return request("PATCH", url, files=files, auth=auth, data=data, timeout=timeout, headers=headers,
-                   verify=verify, cert=cert)
+                   verify=verify, cert=cert, proxies=proxies)
 
 
-def delete(url, data=None, files=None, auth=None, timeout=None, headers=None, verify=False, cert=None):
+def delete(url, data=None, files=None, auth=None, timeout=None, headers=None, verify=False, cert=None, proxies=None):
     """
 
     Args:
@@ -158,15 +163,16 @@ def delete(url, data=None, files=None, auth=None, timeout=None, headers=None, ve
         headers (dict):
         verify (bool, str, optional):
         cert (str, tuple, optional):
+        proxies (dict, optional)
 
     Returns:
 
     """
     return request("DELETE", url, files=files, data=data, auth=auth, timeout=timeout, headers=headers,
-                   verify=verify, cert=cert)
+                   verify=verify, cert=cert, proxies=proxies)
 
 
-def get_new_token(token_url, request_data, timeout=None, verify_ssl_cert=False, cert=None):
+def get_new_token(token_url, request_data, timeout=None, verify_ssl_cert=False, cert=None, proxies=None):
     """
 
     Args:
@@ -175,12 +181,14 @@ def get_new_token(token_url, request_data, timeout=None, verify_ssl_cert=False,
         timeout (float, tuple, optional):
         verify_ssl_cert (bool, str):
         cert:
+        proxies (dict, optional):
 
     Returns:
         Bear Token (str)
     """
 
-    response = post(url=token_url, data=request_data, timeout=timeout, verify=verify_ssl_cert, cert=cert)
+    response = post(url=token_url, data=request_data, timeout=timeout, verify=verify_ssl_cert, cert=cert,
+                    proxies=proxies)
 
     if response.status_code != OK:
         raise ValueError(response.text, response.status_code)
@@ -189,7 +197,7 @@ def get_new_token(token_url, request_data, timeout=None, verify_ssl_cert=False,
     return content.get("token_type") + " " + content.get("access_token")
 
 
-def update_header(token_url, req_data, timeout=None, verify_ssl_cert=False, cert=None):
+def update_header(token_url, req_data, timeout=None, verify_ssl_cert=False, cert=None, proxies=None):
     """
 
     Args:
@@ -198,6 +206,7 @@ def update_header(token_url, req_data, timeout=None, verify_ssl_cert=False, cert
         timeout (float, tuple, optional):
         verify_ssl_cert (bool, str):
         cert:
+        proxies (dict, optional)
 
     Returns:
 
@@ -207,7 +216,8 @@ def update_header(token_url, req_data, timeout=None, verify_ssl_cert=False, cert
         request_data=req_data,
         timeout=timeout,
         verify_ssl_cert=verify_ssl_cert,
-        cert=cert
+        cert=cert,
+        proxies=proxies,
     )
     auth_header.update({"Authorization": new_token})
 
@@ -220,7 +230,7 @@ auth_header = {
 
 def retry_when_unauthorized(function_to_send_request, data, get_data_from_config, relative_url, files=None, auth=None,
                             headers=(), is_iam=False):
-    server_url, token_url, timeout, verify, cert, token_req_data = get_data_from_config()
+    server_url, token_url, timeout, verify, cert, token_req_data, proxies = get_data_from_config()
     url = server_url + relative_url
     # is_iam is used for Access Control API
     if is_iam:
@@ -234,13 +244,13 @@ def retry_when_unauthorized(function_to_send_request, data, get_data_from_config
     logger.debug(
         "first http request:"
         "method: {method}, url: {url}, data: {data}, auth: {auth}, timeout: {timeout}, "
-        "origin_headers: {origin_headers}, verify: {verify}, cert: {cert}".format(
+        "origin_headers: {origin_headers}, verify: {verify}, cert: {cert}, proxies: {proxies}".format(
             method=function_to_send_request.__name__, url=url, data=data, auth=auth, timeout=timeout,
-            origin_headers=temp_header, verify=verify, cert=cert
+            origin_headers=temp_header, verify=verify, cert=cert, proxies=proxies
         )
     )
     response = function_to_send_request(url=url, data=data, auth=auth, timeout=timeout, headers=temp_header,
-                                        files=files, verify=verify, cert=cert)
+                                        files=files, verify=verify, cert=cert, proxies=proxies)
     if UNAUTHORIZED == response.status_code:
         update_header(token_url, token_req_data, timeout, verify, cert)
         temp_header.update(auth_header)
@@ -251,11 +261,11 @@ def retry_when_unauthorized(function_to_send_request, data, get_data_from_config
             "new_auth_header: {new_auth_header}, verify: {verify}, cert: {cert}".format(
                 method=function_to_send_request.__name__, url=url, data=data, auth=auth, timeout=timeout,
                 new_auth_header=temp_header, verify=verify,
-                cert=cert
+                cert=cert, proxies=proxies,
             )
         )
         response = function_to_send_request(url=url, data=data, auth=auth, timeout=timeout, headers=temp_header,
-                                            files=files, verify=verify, cert=cert)
+                                            files=files, verify=verify, cert=cert, proxies=proxies)
     return response
 
 

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK.egg-info/PKG-INFO

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

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/CheckmarxPythonSDK.egg-info/SOURCES.txt

@@ -64,6 +64,7 @@ CheckmarxPythonSDK/CxOne/sastQueriesAuditAPI.py
 CheckmarxPythonSDK/CxOne/sastQueriesAuditPresetsAPI.py
 CheckmarxPythonSDK/CxOne/sastResourceManagementServiceAPI.py
 CheckmarxPythonSDK/CxOne/sastResultsAPI.py
+CheckmarxPythonSDK/CxOne/sastResultsSummaryAPI.py
 CheckmarxPythonSDK/CxOne/sastScanMetadataServiceAPI.py
 CheckmarxPythonSDK/CxOne/scanConfigurationAPI.py
 CheckmarxPythonSDK/CxOne/scannersResultsAPI.py

{checkmarxpythonsdk-0.9.2 → checkmarxpythonsdk-0.9.4}/PKG-INFO

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

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/__version__.py

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