CheckmarxPythonSDK 1.0.4__tar.gz → 1.0.6__tar.gz

{checkmarxpythonsdk-1.0.4 → checkmarxpythonsdk-1.0.6}/CheckmarxPythonSDK/CxODataApiSDK/HttpRequests.py

@@ -34,7 +34,7 @@ def get_data_from_config():
     return server_url, token_url, timeout, verify_ssl_cert, cert, token_req_data, proxies
 
 
-get, _, _, _, _, _ = build_request_funcs(get_data_from_config)
+get, _, _, _, _, _, _ = build_request_funcs(get_data_from_config)
 
 
 def get_value_from_response(func):

checkmarxpythonsdk-1.0.6/CheckmarxPythonSDK/CxOne/KeycloakAPI/AttackDetectionAPI.py

@@ -0,0 +1,8 @@
+import json
+from ...utilities.compat import CREATED, NO_CONTENT
+from ..httpRequests import get_request, post_request, put_request, delete_request
+from typing import List
+from ..utilities import get_url_param, type_check
+from .url import api_url
+
+

{checkmarxpythonsdk-1.0.4 → checkmarxpythonsdk-1.0.6}/CheckmarxPythonSDK/CxOne/config.py

@@ -6,7 +6,6 @@ from CheckmarxPythonSDK.utilities.configUtility import (
 config_default = {
     "access_control_url": "https://iam.checkmarx.net",
     "server": "https://ast.checkmarx.net",
-    "tenant_id": None, # Needed for the feature flags API (see flagsAPI.py)
     "tenant_name": None,
     "grant_type": "refresh_token",
     "client_id": "ast-app",

{checkmarxpythonsdk-1.0.4 → checkmarxpythonsdk-1.0.6}/CheckmarxPythonSDK/CxOne/dto/Flag.py

@@ -12,6 +12,16 @@ class Flag(object):
         self.status = status
         self.payload = payload
 
+    def __eq__(self, other):
+
+        return (self.name == other.name and
+                self.status == other.status and
+                self.payload == other.payload)
+
+    def __lt__(self, other):
+
+        return self.name < other.name
+
     def __str__(self):
         return """Flag(name={name}, status={status}, payload={payload})""".format(
             name=self.name, status=self.status, payload=self.payload

{checkmarxpythonsdk-1.0.4 → checkmarxpythonsdk-1.0.6}/CheckmarxPythonSDK/CxOne/flagsAPI.py

@@ -5,6 +5,7 @@ import time
 import os
 from CheckmarxPythonSDK.CxOne.httpRequests import get_request, post_request
 from CheckmarxPythonSDK.CxOne.config import config
+from .utilities import type_check, list_member_type_check
 from .dto import (
     Flag,
 )
@@ -22,16 +23,23 @@ def __construct_flag(flag):
     )
 
 
-def get_all_feature_flags():
+def get_all_feature_flags(ids=None):
     """
+    Args:
+         ids (`list`)
 
     Returns:
         `list` of `Flag`
     """
-    if not config['tenant_id']:
-        _set_tenant_id()
+    type_check(ids, (list, tuple))
+
+    list_member_type_check(ids, str)
 
-    relative_url = f"{api_url}?filter={config['tenant_id']}"
+    relative_url = f"{api_url}"
+    # We can't use get_url_param() because it assumes that this is not
+    # the first query parameter.
+    if ids:
+        relative_url += f"?ids={','.join(ids)}"
 
     response = get_request(relative_url=relative_url)
 
@@ -48,19 +56,11 @@ def get_feature_flag(name):
     Returns:
         `Flag`
     """
-    if not config['tenant_id']:
-        _set_tenant_id()
+    type_check(name, str)
 
-    relative_url = f"{api_url}{name}?filter={config['tenant_id']}"
+    relative_url = f"{api_url}{name}"
 
     response = get_request(relative_url=relative_url)
 
     flag = response.json()
     return __construct_flag(flag)
-
-
-def _set_tenant_id():
-
-    resp = get_request(f"/auth/admin/realms/{config['tenant_name']}",
-                       is_iam=True)
-    config['tenant_id'] = resp.json()['id']

{checkmarxpythonsdk-1.0.4 → checkmarxpythonsdk-1.0.6}/CheckmarxPythonSDK/CxOne/httpRequests.py

@@ -1,6 +1,7 @@
 # encoding: utf-8
 from .config import config
 from CheckmarxPythonSDK.utilities.httpRequests import build_request_funcs, check_response
+from ..__version__ import __version__
 
 
 def get_data_from_config():
@@ -31,12 +32,10 @@ def get_data_from_config():
     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)
+get, post, put, patch, delete, head, gql = 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": f"Checkmarx Python SDK {__version__}"
 }
 
 
@@ -136,3 +135,8 @@ def head_request(relative_url, is_iam=False):
     response = head(relative_url, is_iam=is_iam, headers=headers)
     check_response(response)
     return response
+
+
+def gql_request(relative_url, data, is_iam=False):
+    response = gql(relative_url, data=data, headers=headers, is_iam=is_iam)
+    return response

{checkmarxpythonsdk-1.0.4 → checkmarxpythonsdk-1.0.6}/CheckmarxPythonSDK/CxOne/scaAPI.py

@@ -6,6 +6,7 @@ from .httpRequests import (
     post_request as post_re,
     put_request as put_re,
     delete_request as delete_re,
+    gql_request as gql_re
 )
 
 url_prefix = "/api/sca"
@@ -27,14 +28,20 @@ def delete(relative_url, data=None):
     return delete_re(relative_url=url_prefix + relative_url, data=data)
 
 
+def gql(relative_url, data):
+    return gql_re(relative_url=url_prefix + relative_url, data=data)
+
+
 class ScaAPI(Sca):
 
-    def __init__(self, get_request=get, post_request=post, put_request=put, delete_request=delete):
+    def __init__(self, get_request=get, post_request=post, put_request=put, delete_request=delete, gql_request=gql):
         Sca.__init__(self, get_request=get, post_request=post, put_request=put, delete_request=delete)
         self.get_request = get_request
         self.post_request = post_request
         self.put_request = put_request
         self.delete_request = delete_request
+        self.gql_request = gql_request
+        self.gql_relative_url = "/graphql/graphql"
 
     def __str__(self):
         return """ScaAPI()"""

{checkmarxpythonsdk-1.0.4 → checkmarxpythonsdk-1.0.6}/CheckmarxPythonSDK/CxPortalSoapApiSDK/CxPortalWebService.py

@@ -15,11 +15,7 @@ def add_license_expiration_notification():
     """
 
     Returns:
-        CxWSBasicRepsonse
-        {
-            'IsSuccesfull': True,
-            'ErrorMessage': None
-        }
+
     """
 
     @retry_when_unauthorized
@@ -29,7 +25,10 @@ def add_license_expiration_notification():
 
     response = execute()
 
-    return response
+    return {
+        "IsSuccesfull": response["IsSuccesfull"],
+        "ErrorMessage": response["ErrorMessage"]
+    }
 
 
 def create_new_preset(query_ids, name):
@@ -40,26 +39,21 @@ def create_new_preset(query_ids, name):
         name (str):
 
     Returns:
-        CxWSResponsePresetDetails
+        dict
 
+        sample return:
         {
-            'IsSuccesfull': True,
-            'ErrorMessage': None,
-            'preset': {
-                'queryIds': {
-                    'long': [
-                        343
-                    ]
-                },
-                'id': 100006,
-                'name': 'ddd10',
-                'owningteam': 1,
-                'isPublic': True,
-                'owner': None,
-                'isUserAllowToUpdate': True,
-                'isUserAllowToDelete': True,
-                'IsDuplicate': False
-            }
+            'queryIds':  [
+                    343
+            ],
+            'id': 110003,
+            'name': 'ddd',
+            'owningteam': 1,
+            'isPublic': True,
+            'owner': None,
+            'isUserAllowToUpdate': True,
+            'isUserAllowToDelete': True,
+            'IsDuplicate': False
         }
     """
 
@@ -76,7 +70,22 @@ def create_new_preset(query_ids, name):
         return client.service.CreateNewPreset(sessionId="0", presrt=cx_preset_detail)
 
     response = execute()
-    return response
+    preset = response.preset
+    return {
+        "IsSuccesfull": response["IsSuccesfull"],
+        "ErrorMessage": response["ErrorMessage"],
+        "preset": {
+            'queryIds': preset["queryIds"]["long"],
+            'id': preset["id"],
+            'name': preset["name"],
+            'owningteam': preset["owningteam"],
+            'isPublic': preset["isPublic"],
+            'owner': preset["owner"],
+            'isUserAllowToUpdate': preset["isUserAllowToUpdate"],
+            'isUserAllowToDelete': preset["isUserAllowToDelete"],
+            'IsDuplicate': preset["IsDuplicate"]
+        } if preset else None
+    }
 
 
 def create_scan_report(scan_id, report_type, queries_all=True, queries_ids=None, results_severity_all=True,
@@ -141,12 +150,7 @@ def create_scan_report(scan_id, report_type, queries_all=True, queries_ids=None,
         results_display_option_snippets_mode (str): "None", "SourceAndDestination", "Full"
 
     Returns:
-        CxWSCreateReportResponse
-        {
-            'IsSuccesfull': True,
-            'ErrorMessage': None,
-            'ID': 336
-        }
+
     """
 
     @retry_when_unauthorized
@@ -243,7 +247,12 @@ def create_scan_report(scan_id, report_type, queries_all=True, queries_ids=None,
         return client.service.CreateScanReport(SessionID="0", Report=filtered_report_request)
 
     response = execute()
-    return response
+
+    return {
+        "IsSuccesfull": response["IsSuccesfull"],
+        "ErrorMessage": response["ErrorMessage"],
+        "ID": response["ID"]
+    }
 
 
 def delete_preset(preset_id):
@@ -253,11 +262,7 @@ def delete_preset(preset_id):
         preset_id (int):
 
     Returns:
-        CxWSBasicRepsonse
-        {
-            'IsSuccesfull': True,
-            'ErrorMessage': None
-        }
+
     """
 
     @retry_when_unauthorized
@@ -266,7 +271,10 @@ def delete_preset(preset_id):
         return client.service.DeletePreset(sessionId="0", id=preset_id)
 
     response = execute()
-    return response
+    return {
+        "IsSuccesfull": response["IsSuccesfull"],
+        "ErrorMessage": response["ErrorMessage"]
+    }
 
 
 def delete_project(project_id):
@@ -276,17 +284,7 @@ def delete_project(project_id):
         project_id (int):
 
     Returns:
-        CxWSResponseDeleteProjects
-        {
-            'IsSuccesfull': True,
-            'ErrorMessage': None,
-            'IsConfirmation': False,
-            'Flags': [
-                'None'
-            ],
-            'UndeletedProjects': None,
-            'NumOfDeletedProjects': 1
-        }
+
     """
 
     @retry_when_unauthorized
@@ -295,7 +293,10 @@ def delete_project(project_id):
         return client.service.DeleteProject(sessionID="0", projectID=project_id)
 
     response = execute()
-    return response
+    return {
+        "IsSuccesfull": response["IsSuccesfull"],
+        "ErrorMessage": response["ErrorMessage"]
+    }
 
 
 def delete_projects(project_ids, flag="None"):

{checkmarxpythonsdk-1.0.4 → checkmarxpythonsdk-1.0.6}/CheckmarxPythonSDK/CxReporting/httpRequests.py

@@ -30,4 +30,4 @@ def get_data_from_config():
     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)
+get_request, post_request, _, _, _, _, _ = build_request_funcs(get_data_from_config)

{checkmarxpythonsdk-1.0.4 → checkmarxpythonsdk-1.0.6}/CheckmarxPythonSDK/CxRestAPISDK/httpRequests.py

@@ -41,7 +41,7 @@ def get_data_from_config():
     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)
+get, post, put, patch, delete, _, _ = build_request_funcs(get_data_from_config)
 
 
 def get_request(relative_url, headers=(), is_iam=False):

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

@@ -52,6 +52,23 @@ from .api import (
     get_sbom_supported_file_formats,
     run_file_analysis,
     retrieve_analysis_result,
+    get_number_of_vulnerabilities_risks_by_scan_id,
+    get_number_of_supply_chain_risks_by_scan_id,
+    get_number_of_outdated_packages_by_scan_id,
+    get_number_of_legal_risks_by_scan_id,
+    get_vulnerabilities_risks_by_scan_id,
+    get_supply_chain_risks_by_scan_id,
+    get_legal_risks_by_scan_id,
+    get_direct_third_party_packages_by_scan_id,
+    get_transitive_third_party_packages_by_scan_id,
+    get_number_of_packages_by_scan_id,
+    get_number_of_direct_third_party_packages_by_scan_id,
+    get_number_of_transitive_third_party_packages_by_scan_id,
+    get_number_of_packages_used_for_accessing_saas_services,
+    get_container_packages_by_scan_id,
+    get_container_vulnerabilities_by_scan_id,
+    get_package_licenses_by_scan_id,
+    get_down_stream_remediation_by_scan_id,
 )
 
 from .AccessControlAPI import AccessControlAPI