CheckmarxPythonSDK 0.8.4__tar.gz → 0.8.6__tar.gz

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxOne/__init__.py

@@ -14,6 +14,11 @@ from .applicationsAPI import (
     delete_an_application_rule,
 )
 
+from .flagsAPI import (
+    get_all_feature_flags,
+    get_feature_flag,
+)
+
 from .healthCheckServiceAPI import (
     get_health_of_the_database,
     get_health_of_the_in_memory_db,
@@ -88,6 +93,9 @@ from .scanConfigurationAPI import (
     get_sast_default_config_by_id,
     update_default_config_for_the_sast_engine,
     delete_a_sast_default_config,
+    update_project_repo_url,
+    update_project_token
+
 )
 
 from .scannersResultsAPI import (

checkmarxpythonsdk-0.8.6/CheckmarxPythonSDK/CxOne/dto/Flag.py

@@ -0,0 +1,18 @@
+# encoding utf-8
+class Flag(object):
+    def __init__(self, name, status, payload):
+        """
+
+        Args:
+            name (str)
+            status (boolean)
+            payload (dict)
+        """
+        self.name = name
+        self.status = status
+        self.payload = payload
+
+    def __str__(self):
+        return """Flag(name={name}, status={status}, payload={payload}""".format(
+            name=self.name, status=self.status, payload=self.payload
+        )

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxOne/dto/__init__.py

@@ -9,6 +9,7 @@ from .DefaultConfig import DefaultConfig
 from .DefaultConfigOut import DefaultConfigOut
 from .Error import Error
 from .FileInfo import FileInfo
+from .Flag import Flag
 from .Git import Git
 from .Group import Group
 from .KicsResult import KicsResult

checkmarxpythonsdk-0.8.6/CheckmarxPythonSDK/CxOne/flagsAPI.py

@@ -0,0 +1,49 @@
+# encoding: utf-8
+import json
+import requests
+import time
+import os
+from CheckmarxPythonSDK.CxOne.httpRequests import get_request, post_request
+from CheckmarxPythonSDK.CxOne.config import config
+from .dto import (
+    Flag,
+)
+
+base_url = config.get("server")
+
+def __construct_flag(flag):
+    return Flag(
+        name=flag.get("name"),
+        status=flag.get("status"),
+        payload=flag.get("payload")
+    )
+
+def get_all_feature_flags():
+    """
+
+    Returns:
+        `list` of `Flag`
+    """
+    relative_url = f"/api/flags/"
+
+    response = get_request(relative_url=relative_url)
+
+    flags = response.json()
+    return [__construct_flag(flag) for flag in flags]
+
+
+def get_feature_flag(name):
+    """
+
+    Args:
+        name (`str`)
+
+    Returns:
+        `Flag`
+    """
+    relative_url = f"/api/flags/{name}"
+
+    response = get_request(relative_url=relative_url)
+
+    flag = response.json()
+    return __construct_flag(flag)

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxOne/httpRequests.py

@@ -52,34 +52,36 @@ def get_request(relative_url, is_iam=False):
     return response
 
 
-def post_request(relative_url, data, is_iam=False):
+def post_request(relative_url, data, files=None, is_iam=False):
     """
 
     Args:
         relative_url (str):
         data (str):
+        files:
         is_iam (bool): True if the endpoint is for Identity And Management
 
     Returns:
 
     """
-    response = post(relative_url, data, is_iam=is_iam, headers=headers)
+    response = post(relative_url, data, files=files, is_iam=is_iam, headers=headers)
     check_response(response)
     return response
 
 
-def put_request(relative_url, data, is_iam=False):
+def put_request(relative_url, data, files=None, is_iam=False):
     """
 
     Args:
         relative_url (str):
         data (str):
+        files:
         is_iam (bool): True if the endpoint is for Identity And Management
 
     Returns:
 
     """
-    response = put(relative_url, data, is_iam=is_iam, headers=headers)
+    response = put(relative_url, data, files=files, is_iam=is_iam, headers=headers)
     check_response(response)
     return response
 

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxOne/reportAPI.py

@@ -3,7 +3,7 @@ import requests
 import time
 import os
 from CheckmarxPythonSDK.CxOne.httpRequests import get_request, post_request
-from CheckmarxPythonSDK.CxOne import authHeaders
+from CheckmarxPythonSDK.utilities.httpRequests import auth_header
 from CheckmarxPythonSDK.CxOne.config import config
 
 base_url = config.get("server")
@@ -34,7 +34,7 @@ def create_scan_report(file_format, scan_id, project_id):
         }
     })
 
-    headers = authHeaders.auth_headers.copy()
+    headers = auth_header.copy()
 
     response = requests.post(report_url, headers=headers, data=post_data, verify=False)
     report_json = response.json()
@@ -61,3 +61,10 @@ def get_scan_report(report_id):
 
     response = get_request(relative_url=relative_url)
     return response.content
+
+
+def get_risk_scan_report(scan_id, report_type):
+    relative_url = f"/api/sca/risk-management/risk-reports/{scan_id}/export?format={report_type}"
+
+    response = get_request(relative_url=relative_url)
+    return response.content

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxOne/scanConfigurationAPI.py

@@ -190,13 +190,13 @@ def get_sast_default_config_by_id(config_id):
     response = get_request(relative_url=relative_url)
     item = response.json()
     return DefaultConfigOut(
-            default_config_out_id=item.get("id"),
-            name=item.get("name"),
-            description=item.get("description"),
-            url=item.get("url"),
-            is_tenant_default=item.get("isTenantDefault"),
-            associated_projects=item.get("associatedProjects")
-        )
+        default_config_out_id=item.get("id"),
+        name=item.get("name"),
+        description=item.get("description"),
+        url=item.get("url"),
+        is_tenant_default=item.get("isTenantDefault"),
+        associated_projects=item.get("associatedProjects")
+    )
 
 
 def update_default_config_for_the_sast_engine(config_id, default_config):
@@ -236,3 +236,65 @@ def delete_a_sast_default_config(config_id):
     if response.status_code == NO_CONTENT:
         result = True
     return result
+
+
+def update_project_repo_url(project_id, repo_url):
+    """
+
+    Args:
+        project_id (str):
+        repo_url (str):
+
+    Returns:
+
+    """
+    type_check(project_id, str)
+    type_check(repo_url, str)
+    relative_url = api_url + "/project?project-id=" + project_id
+    data = [{
+        "key": "scan.handler.git.repository",
+        "name": "repository",
+        "category": "git",
+        "originLevel": "Project",
+        "value": repo_url,
+        "valuetype": "String",
+        "allowOverride": True
+    }]
+
+    data_json = json.dumps(data)
+    response = patch_request(relative_url=relative_url, data=data_json)
+
+    if response.status_code == NO_CONTENT:
+        result = True
+    return result
+
+
+def update_project_token(project_id, token):
+    """
+
+    Args:
+        project_id (str):
+        token (str):
+
+    Returns:
+
+    """
+    type_check(project_id, str)
+    type_check(token, str)
+    relative_url = api_url + "/project?project-id=" + project_id
+    data = [{
+        "key": "scan.handler.git.token",
+        "name": "token",
+        "category": "git",
+        "originLevel": "Project",
+        "value": token,
+        "valuetype": "Secret",
+        "allowOverride": True
+    }, ]
+
+    data_json = json.dumps(data)
+    response = patch_request(relative_url=relative_url, data=data_json)
+
+    if response.status_code == NO_CONTENT:
+        result = True
+    return result

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxOne/uploadsAPI.py

@@ -4,7 +4,7 @@ import requests
 from .httpRequests import post_request
 from CheckmarxPythonSDK.utilities.compat import OK
 from os.path import exists
-from . import authHeaders
+from CheckmarxPythonSDK.utilities.httpRequests import auth_header
 
 
 def create_a_pre_signed_url_to_upload_files():
@@ -41,7 +41,7 @@ def upload_zip_content_for_scanning(upload_link, zip_file_path):
 
     url = "{uploadLink}".format(uploadLink=upload_link)
 
-    headers = authHeaders.auth_headers.copy()
+    headers = auth_header.copy()
     headers.update(
         {"Content-Type": "application/x-www-form-urlencoded"}
     )

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxReporting/api.py

@@ -6,6 +6,8 @@ from .dto import (
     CreateReportDTO,
 )
 
+headers = {"Content-Type": "application/json; v=1.0"}
+
 
 def retrieve_the_file_of_a_specific_report(report_id):
     """
@@ -18,7 +20,7 @@ def retrieve_the_file_of_a_specific_report(report_id):
     """
     report_content = None
     relative_url = "/api/reports/{id}".format(id=report_id)
-    response = get_request(relative_url=relative_url)
+    response = get_request(relative_url=relative_url, headers=headers)
     if response.status_code == OK:
         report_content = response.content
     return report_content
@@ -40,7 +42,7 @@ def create_a_new_report_request(report_request):
 
     relative_url = "/api/reports"
     data = report_request.get_post_data()
-    response = post_request(relative_url=relative_url, data=data)
+    response = post_request(relative_url=relative_url, data=data, headers=headers)
     if response.status_code == CREATED:
         item = response.json()
         report_id = item.get("reportId")
@@ -61,7 +63,7 @@ def retrieve_the_status_of_a_specific_report(report_id):
     """
     report_status = None
     relative_url = "/api/reports/{id}/status".format(id=report_id)
-    response = get_request(relative_url=relative_url)
+    response = get_request(relative_url=relative_url, headers=headers)
     if response.status_code == OK:
         item = response.json()
         report_status = item.get("reportStatus")

checkmarxpythonsdk-0.8.6/CheckmarxPythonSDK/CxRestAPISDK/GeneralAPI.py

@@ -0,0 +1,43 @@
+# encoding: utf-8
+from .httpRequests import get_request, get_headers
+from CheckmarxPythonSDK.utilities.compat import OK
+from .sast.general.dto import CxServerLicenseData, CxSupportedLanguage
+
+
+class GeneralAPI:
+    """
+    CxSAST general API
+    """
+
+    @staticmethod
+    def get_server_license_data(api_version="4.0"):
+        """
+        Returns the CxSAST server's license data
+        """
+        result = None
+        relative_url = "/cxrestapi/serverLicenseData"
+        response = get_request(relative_url=relative_url, headers=get_headers(api_version))
+        if response.status_code == OK:
+            json = response.json()
+            result = CxServerLicenseData(
+                current_audit_users=json["currentAuditUsers"],
+                current_projects_count=json["currentProjectsCount"],
+                current_users=json["currentUsers"],
+                edition=json["edition"],
+                expiration_date=json["expirationDate"],
+                hid=json["hid"],
+                is_osa_enabled=json["isOsaEnabled"],
+                max_audit_users=json["maxAuditUsers"],
+                max_concurrent_scans=json["maxConcurrentScans"],
+                max_loc=json["maxLOC"],
+                max_users=json["maxUsers"],
+                osa_expiration_date=json["osaExpirationDate"],
+                projects_allowed=json["projectsAllowed"],
+                supported_languages=[
+                    CxSupportedLanguage(
+                        is_supported=item["isSupported"],
+                        language=item["language"])
+                    for item in json["supportedLanguages"]
+                ]
+            )
+        return result

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxRestAPISDK/ProjectsAPI.py

@@ -1053,7 +1053,7 @@ class ProjectsAPI(object):
         return result
 
     @staticmethod
-    def upload_source_code_zip_file(project_id, zip_file_path, api_version="1.0"):
+    def upload_source_code_zip_file(project_id, zip_file_path, api_version="4.0"):
         """
         Upload a zip file that contains the source code for scanning.
 

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxRestAPISDK/ScansAPI.py

@@ -1247,7 +1247,7 @@ class ScansAPI(object):
                                                                       {}).get("scannedSuccessfullyLOCPercentage"),
                         count_of_dom_objects=value.get("countOfDomObjects")
                     )
-                    for key, value in item.get("languageStatistics").items()
+                    for key, value in item.get("languageStatistics", {}).items()
                 ],
                 exclusion_folders_pattern=item.get("exclusionFoldersPattern"),
                 exclusion_files_pattern=item.get("exclusionFilesPattern"),
@@ -1285,7 +1285,7 @@ class ScansAPI(object):
                         parsed_unsuccessfully=value.get("parsedUnsuccessfully"),
                         parsed_partially=value.get("parsedPartially")
                     )
-                    for key, value in item.get("scannedFilesPerLanguage").items()
+                    for key, value in item.get("scannedFilesPerLanguage", {}).items()
                 ]
             )
         return result

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxRestAPISDK/httpRequests.py

@@ -46,14 +46,14 @@ def get_request(relative_url, headers=(), is_iam=False):
     return response
 
 
-def post_request(relative_url, data, headers=(), is_iam=False):
-    response = post(relative_url, data=data, headers=headers, is_iam=is_iam)
+def post_request(relative_url, data, files=None, headers=(), is_iam=False):
+    response = post(relative_url, data=data, files=files, headers=headers, is_iam=is_iam)
     check_response_status_code(response)
     return response
 
 
-def put_request(relative_url, data, headers=(), is_iam=False):
-    response = put(relative_url, data=data, headers=headers, is_iam=is_iam)
+def put_request(relative_url, data, files=None, headers=(), is_iam=False):
+    response = put(relative_url, data=data, files=files, headers=headers, is_iam=is_iam)
     check_response_status_code(response)
     return response
 

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxRestAPISDK/sast/projects/dto/__init__.py

@@ -56,13 +56,13 @@ def construct_cx_project(item):
                 custom_field_id=custom_field.get("id"),
                 value=custom_field.get("value"),
                 name=custom_field.get("name")
-            ) for custom_field in item.get("customFields")
+            ) for custom_field in item.get("customFields") or []
         ],
         links=[
             CxLink(
                 rel=link.get("rel"),
                 uri=link.get("uri"),
-            ) for link in item.get("links")
+            ) for link in item.get("links") or []
         ],
         project_queue_settings=CxProjectQueueSetting(
             queue_keep_mode=item.get("projectQueueSettings", {}).get("queueKeepMode"),

{CheckmarxPythonSDK-0.8.4 → checkmarxpythonsdk-0.8.6}/CheckmarxPythonSDK/CxScaApiSDK/__init__.py

@@ -44,6 +44,14 @@ from .api import (
     execute_actions_on_package_license,
     evaluate_package_licenses,
     search_entity_profiles_of_package_licenses,
+    generate_upload_link,
+    upload_zip_file,
+    scan_zip_file_or_github_file,
+    create_sbom_report,
+    get_sbom_report_creation_status,
+    get_sbom_supported_file_formats,
+    run_file_analysis,
+    retrieve_analysis_result,
 )
 
 from .AccessControlAPI import AccessControlAPI