CheckmarxPythonSDK 0.9.0__tar.gz → 0.9.2__tar.gz

{checkmarxpythonsdk-0.9.0 → checkmarxpythonsdk-0.9.2}/CheckmarxPythonSDK/CxODataApiSDK/HttpRequests.py

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

{checkmarxpythonsdk-0.9.0 → checkmarxpythonsdk-0.9.2}/CheckmarxPythonSDK/CxOne/KeycloakAPI/dto/Group.py

@@ -28,5 +28,5 @@ def construct_group(item):
         group_id=item.get("id"),
         name=item.get("name"),
         path=item.get("path"),
-        sub_groups=[construct_group(group) for group in item.get("subGroups")]
+        sub_groups=[construct_group(group) for group in item.get("subGroups") or []]
     )

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

@@ -14,6 +14,28 @@ from .applicationsAPI import (
     delete_an_application_rule,
 )
 
+from .auditTrailAPI import (
+    get_audit_events_for_tenant,
+)
+
+from .byorResultsHandlerAPI import (
+    create_byor_import,
+)
+
+from .cloudInsightsServiceAPI import (
+    create_enrich_account,
+    get_enrich_account_by_external_id,
+    start_enrichment,
+    get_cloud_insight_account,
+    delete_cloud_insight_account,
+    get_all_containers_for_an_account_id,
+)
+
+from .contributorsAPI import (
+    get_allowed_and_current_contributors_for_the_current_tenant,
+    get_contributors_details_for_current_tenant_exported_in_csv,
+)
+
 from .flagsAPI import (
     get_all_feature_flags,
     get_feature_flag,
@@ -57,7 +79,23 @@ from .projectsAPI import (
     delete_a_project,
 )
 
+from .projectsOverviewAPI import (
+    get_tenant_projects_overview,
+    get_project_counters,
+)
+
+from .queryEditorAPI import (
+    create_new_audit_session,
+)
+
+from .reportAPI import (
+    create_scan_report,
+    get_scan_report,
+    get_risk_scan_report,
+)
+
 from .repoStoreServiceAPI import (
+    check_if_scan_has_source_code_available,
     get_commit_content,
     get_folder_content,
     get_code,
@@ -73,6 +111,9 @@ from .sastQueriesAPI import (
     get_list_of_the_existing_query_repos,
     get_sast_queries_presets,
     get_sast_query_description,
+    get_mapping_between_ast_and_sast_query_ids,
+    get_sast_queries_preset_for_a_specific_scan,
+    get_sast_queries_categories,
 )
 
 from .sastQueriesAuditAPI import (
@@ -82,6 +123,40 @@ from .sastQueriesAuditAPI import (
     update_query_source,
 )
 
+from .sastQueriesAuditPresetsAPI import (
+    get_presets,
+    create_new_preset,
+    get_queries,
+    get_preset_by_id,
+    update_a_preset,
+    delete_a_preset_by_id,
+    get_preset_summary_by_id,
+    clone_preset,
+    add_query_to_preset,
+)
+
+from .sastResourceManagementServiceAPI import (
+    get_sast_scan_allocation_info,
+    delete_sast_scan,
+    get_sast_scans,
+)
+
+from .sastResultsAPI import (
+    get_sast_results_by_scan_id,
+)
+
+from .resultsSummaryAPI import (
+    get_summary_for_many_scans,
+    get_sast_aggregate_results,
+)
+
+from .sastScanMetadataServiceAPI import (
+    get_metadata_of_scans,
+    get_metadata_of_scan,
+    get_engine_metrics_of_scan,
+    get_engine_versions_of_scan,
+)
+
 from .scanConfigurationAPI import (
     get_the_list_of_all_the_parameters_defined_for_the_current_tenant,
     define_parameters_in_the_input_list_for_the_current_tenant,
@@ -102,15 +177,6 @@ from .scannersResultsAPI import (
     get_all_scanners_results_by_scan_id,
 )
 
-from .sastResultsSummaryAPI import (
-    get_summary_for_many_scans,
-    get_sast_aggregate_results,
-)
-
-from .sastResultsAPI import (
-    get_sast_results_by_scan_id,
-)
-
 from .scansAPI import (
     create_scan,
     get_a_list_of_scan,

{checkmarxpythonsdk-0.9.0 → checkmarxpythonsdk-0.9.2}/CheckmarxPythonSDK/CxOne/applicationsAPI.py

@@ -11,6 +11,7 @@ from .dto import (
     RuleInput,
 )
 
+api_url = "/api/applications"
 
 def __construct_application_rules(rules):
     rules = rules or []
@@ -48,7 +49,7 @@ def create_an_application(application_input):
     """
     type_check(application_input, ApplicationInput)
 
-    relative_url = "/api/applications"
+    relative_url = api_url
     data = application_input.get_post_data()
     response = post_request(relative_url=relative_url, data=data)
     item = response.json()
@@ -89,7 +90,7 @@ def get_a_list_of_applications(offset=0, limit=20, name=None, tags_keys=None, ta
     list_member_type_check(tags_keys, str)
     list_member_type_check(tags_values, str)
 
-    relative_url = "/api/applications?offset={offset}&limit={limit}".format(offset=offset, limit=limit)
+    relative_url = api_url + "?offset={offset}&limit={limit}".format(offset=offset, limit=limit)
     relative_url += get_url_param("name", name)
     relative_url += get_url_param("tags-keys", tags_keys)
     relative_url += get_url_param("tags-values", tags_values)
@@ -138,7 +139,7 @@ def get_all_application_tags():
           ]
         }
     """
-    relative_url = "/api/applications/tags"
+    relative_url = api_url + "/tags"
     response = get_request(relative_url=relative_url)
     return response.json()
 
@@ -154,7 +155,7 @@ def get_an_application_by_id(application_id):
     """
     type_check(application_id, str)
 
-    relative_url = "/api/applications/{id}".format(id=application_id)
+    relative_url = api_url + "/{id}".format(id=application_id)
     response = get_request(relative_url=relative_url)
     app = response.json()
     return __construct_application(app)
@@ -174,7 +175,7 @@ def update_an_application(application_id, application_input):
     type_check(application_input, ApplicationInput)
 
     is_successful = False
-    relative_url = "/api/applications/{id}".format(id=application_id)
+    relative_url = api_url + "/{id}".format(id=application_id)
     data = application_input.get_post_data()
     response = put_request(relative_url=relative_url, data=data)
     if response.status_code == NO_CONTENT:
@@ -194,7 +195,7 @@ def delete_an_application(application_id):
     type_check(application_id, str)
 
     is_successful = False
-    relative_url = "/api/applications/{id}".format(id=application_id)
+    relative_url = api_url + "/{id}".format(id=application_id)
     response = delete_request(relative_url=relative_url)
     if response.status_code == NO_CONTENT:
         is_successful = True
@@ -214,7 +215,7 @@ def create_an_application_rule(application_id, rule_input):
     type_check(application_id, str)
     type_check(rule_input, RuleInput)
 
-    relative_url = "/api/applications/{id}/project-rules".format(id=application_id)
+    relative_url = api_url + "/{id}/project-rules".format(id=application_id)
     type_check(rule_input, RuleInput)
     data = rule_input.get_post_data()
     response = post_request(relative_url=relative_url, data=data)
@@ -237,7 +238,7 @@ def get_a_list_of_rules_for_a_specific_application(application_id):
     """
     type_check(application_id, str)
 
-    relative_url = "/api/applications/{id}/project-rules".format(id=application_id)
+    relative_url = api_url + "/{id}/project-rules".format(id=application_id)
     response = get_request(relative_url=relative_url)
     rules = response.json()
     return __construct_application_rules(rules)
@@ -256,7 +257,7 @@ def get_an_application_rule(application_id, rule_id):
     type_check(application_id, str)
     type_check(rule_id, str)
 
-    relative_url = "/api/applications/{id}/project-rules/{rule_id}".format(
+    relative_url = api_url + "/{id}/project-rules/{rule_id}".format(
         id=application_id, rule_id=rule_id
     )
     response = get_request(relative_url=relative_url)
@@ -284,7 +285,7 @@ def update_an_application_rule(application_id, rule_id, rule_input):
     type_check(rule_input, RuleInput)
 
     is_successful = False
-    relative_url = "/api/applications/{id}/project-rules/{rule_id}".format(
+    relative_url = api_url + "/{id}/project-rules/{rule_id}".format(
         id=application_id, rule_id=rule_id
     )
     data = rule_input.get_post_data()
@@ -308,7 +309,7 @@ def delete_an_application_rule(application_id, rule_id):
     type_check(rule_id, str)
 
     is_successful = False
-    relative_url = "/api/applications/{id}/project-rules/{rule_id}".format(
+    relative_url = api_url + "/{id}/project-rules/{rule_id}".format(
         id=application_id, rule_id=rule_id
     )
     response = delete_request(relative_url=relative_url)

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/auditTrailAPI.py

@@ -0,0 +1,52 @@
+from .httpRequests import get_request
+from .utilities import type_check
+from .dto import (
+    AuditEvent,
+    AuditEventLink,
+    AuditEvents,
+)
+
+api_url = "/api/audit"
+
+
+def __construct_audit_events(audit_events):
+    return AuditEvents(
+        links=[
+            AuditEventLink(
+                event_date=link.get("eventDate"),
+                url=link.get("url"),
+                crc=link.get("crc"),
+            ) for link in audit_events.get("links", [])
+               ],
+        events=[
+            AuditEvent(
+                event_date=event.get("eventDate"),
+                event_type=event.get("eventType"),
+                audit_resource=event.get("auditResource"),
+                action_type=event.get("actionType"),
+                action_user_id=event.get("actionUserId"),
+                ip_address=event.get("ipAddress"),
+                data=event.get("data")
+            ) for event in audit_events.get("events", [])
+        ],
+    )
+
+
+def get_audit_events_for_tenant(offset=0, limit=200):
+    """
+
+    Args:
+        offset (int): The number of items to skip before starting to collect the result set
+                    Default value : 0
+        limit (int):  The number of items to return
+                    Default value : 20
+
+    Returns:
+        `ApplicationsCollection`
+    """
+    type_check(offset, int)
+    type_check(limit, int)
+    relative_url = api_url + "?offset={offset}&limit={limit}".format(offset=offset, limit=limit)
+    response = get_request(relative_url=relative_url)
+    item = response.json()
+    return __construct_audit_events(audit_events=item)

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/byorResultsHandlerAPI.py

@@ -0,0 +1,26 @@
+# encoding: utf-8
+from .httpRequests import post_request
+from .utilities import type_check
+from .dto import (
+    ImportRequest,
+    ImportResults,
+)
+
+api_url = "/api/byor"
+
+
+def create_byor_import(import_request):
+    """
+
+    Args:
+        import_request (ImportRequest):
+
+    Returns:
+        ImportResults
+    """
+    type_check(import_request, ImportRequest)
+    relative_url = api_url + "/imports"
+    data = import_request.get_post_data()
+    response = post_request(relative_url=relative_url, data=data)
+    item = response.json()
+    return ImportResults(import_id=item.get("importId"))

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/cloudInsightsServiceAPI.py

@@ -0,0 +1,212 @@
+# encoding: utf-8
+from .httpRequests import get_request, post_request, delete_request
+from CheckmarxPythonSDK.utilities.compat import OK, NO_CONTENT, CREATED
+from .utilities import get_url_param, type_check, list_member_type_check
+from .dto import (
+    CreateEnrichAccount,
+    EnrichAccount,
+    Account,
+    StartEnrich,
+    Container,
+)
+
+api_url = "/api/cnas"
+
+
+def create_enrich_account(data):
+    """
+
+    Args:
+        data (CreateEnrichAccount):
+
+    Returns:
+        EnrichAccount
+    """
+    type_check(data, CreateEnrichAccount)
+    relative_url = api_url + "/accounts/enrich"
+    data = data.get_post_data()
+    response = post_request(relative_url=relative_url, data=data)
+    item = response.json()
+    return EnrichAccount(
+        name=item.get("name"),
+        account_id=item.get("accountID"),
+    )
+
+
+def get_enrich_account_by_external_id(external_id, offset=0, limit=100):
+    """
+
+    Args:
+        external_id (str): A unique identifier provided by Checkmarx
+        offset (int): Offset the results Default value : 0
+        limit (int): Limit the number of results
+
+    Returns:
+
+    """
+    type_check(external_id, str)
+    type_check(offset, int)
+    type_check(limit, int)
+    relative_url = api_url + "/accounts/enrich?external-id={}&offset={}&limit={}".format(
+        external_id, offset, limit
+    )
+    response = get_request(relative_url=relative_url)
+    item = response.json()
+    return {
+        "data": [
+            Account(
+                account_id=account.get("id"),
+                name=account.get("name"),
+                credentials=account.get("credentials"),
+                account_type=account.get("accountType"),
+                tenant_id=account.get("tenantId"),
+                created_at=account.get("createdAt"),
+                updated_at=account.get("updatedAt"),
+                last_scan_date=account.get("lastScanDate"),
+            ) for account in item.get("data", []) or []
+        ],
+        "total": item.get("total"),
+        "currentPage": item.get("currentPage"),
+        "lastPage": item.get("lastPage")
+    }
+
+
+def start_enrichment(cloud_insights_account_id, start_enrich):
+    """
+
+    Args:
+        cloud_insights_account_id (str):   uuid4
+        start_enrich (StartEnrich)
+
+    Returns:
+        message (str)
+    """
+    type_check(cloud_insights_account_id, str)
+    type_check(start_enrich, StartEnrich)
+
+    relative_url = api_url + "/accounts/{id}/enrich".format(id=cloud_insights_account_id)
+    post_data = start_enrich.get_post_data()
+    response = post_request(relative_url=relative_url, data=post_data)
+    item = response.json()
+    return item.get("message")
+
+
+def get_cloud_insight_account(account_id):
+    """
+
+    Args:
+        account_id (str): Cloud Insights account ID
+
+    Returns:
+        Account
+    """
+    type_check(account_id, str)
+    relative_url = api_url + "/accounts/{id}".format(id=account_id)
+    response = get_request(relative_url=relative_url)
+    account = response.json()
+    return Account(
+        account_id=account.get("id"),
+        name=account.get("name"),
+        credentials=account.get("credentials"),
+        account_type=account.get("accountType"),
+        tenant_id=account.get("tenantId"),
+        created_at=account.get("createdAt"),
+        updated_at=account.get("updatedAt"),
+        last_scan_date=account.get("lastScanDate"),
+    )
+
+
+def delete_cloud_insight_account(account_id):
+    """
+
+      Args:
+          account_id (str): Cloud Insights account ID
+
+      Returns:
+          bool
+      """
+    is_successful = False
+    relative_url = api_url + "/accounts/{id}".format(id=account_id)
+    response = delete_request(relative_url=relative_url)
+    if response.status_code == OK:
+        is_successful = True
+    return is_successful
+
+
+def get_all_containers_for_an_account_id(account_id, limit=100, offset=0, image_name=None, image_short_name=None,
+                                         project_name=None, repo_url=None, cluster_name=None, public_exposed=None,
+                                         search=None, cluster_id=None, order_column=None, order_direction=None):
+    """
+
+    Args:
+        account_id (str): Cloud Insights account ID
+        limit (int): Limit the number of results
+        offset (int): Offset the results Default value : 0
+        image_name (str):
+        image_short_name (str):
+        project_name (str):
+        repo_url (str):
+        cluster_name (str):
+        public_exposed (str):
+        search (str):
+        cluster_id (str):
+        order_column (str):
+        order_direction (str):
+
+    Returns:
+
+    """
+    type_check(account_id, str)
+    type_check(limit, int)
+    type_check(offset, int)
+    type_check(image_name, str)
+    type_check(image_short_name, str)
+    type_check(project_name, str)
+    type_check(repo_url, str)
+    type_check(cluster_name, str)
+    type_check(public_exposed, str)
+    type_check(search, str)
+    type_check(cluster_id, str)
+    type_check(order_column, str)
+    type_check(order_direction, str)
+    relative_url = api_url + "/accounts/{id}/containers?limit={limit}&offset={offset}".format(
+        id=account_id, limit=limit, offset=offset
+    )
+    if image_name:
+        relative_url += "&image-name={}".format(image_name)
+    if image_short_name:
+        relative_url += "&image-short-name={}".format(image_short_name)
+    if project_name:
+        relative_url += "&project-name={}".format(project_name)
+    if repo_url:
+        relative_url += "&repo-url={}".format(repo_url)
+    if cluster_name:
+        relative_url += "&cluster-name={}".format(cluster_name)
+    if public_exposed:
+        relative_url += "&public-exposed={}".format(public_exposed)
+    if search:
+        relative_url += "&search={}".format(search)
+    if cluster_id:
+        relative_url += "&cluster-id={}".format(cluster_id)
+    if order_column:
+        relative_url += "&order-column={}".format(order_column)
+    if order_direction:
+        relative_url += "&order-direction={}".format(order_direction)
+    response = get_request(relative_url=relative_url)
+    item = response.json()
+    return {
+        "data": [
+            Container(
+                container_id=container.get("containerId"),
+                cluster_name=container.get("clusterName"),
+                container_name=container.get("containerName"),
+                public_exposed=container.get("publicExposed"),
+                image=container.get("image"),
+                image_short_name=container.get("imageShortname"),
+                project=container.get("project")
+            ) for container in item.get("data", []) or []
+        ],
+        "total": item.get("total"),
+        "currentPage": item.get("currentPage"),
+        "lastPage": item.get("lastPage")
+    }

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/contributorsAPI.py

@@ -0,0 +1,35 @@
+# encoding: utf-8
+from .httpRequests import get_request, post_request, delete_request
+from CheckmarxPythonSDK.utilities.compat import OK, NO_CONTENT, CREATED
+from .utilities import get_url_param, type_check, list_member_type_check
+from .dto import (
+    Contributors
+)
+
+api_url = "/api/contributors"
+
+
+def get_allowed_and_current_contributors_for_the_current_tenant():
+    """
+
+    Returns:
+
+    """
+    relative_url = api_url
+    response = get_request(relative_url=relative_url)
+    item = response.json()
+    return Contributors(
+        allowed_contributors=item.get("allowedContributors"),
+        current_contributors=item.get("currentContributors")
+    )
+
+
+def get_contributors_details_for_current_tenant_exported_in_csv():
+    """
+
+    Returns:
+        bytes (data of the csv file)
+    """
+    relative_url = api_url + "/csv"
+    response = get_request(relative_url=relative_url)
+    return response.content

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/dto/Account.py

@@ -0,0 +1,30 @@
+class Account(object):
+
+    def __init__(self, account_id, name, credentials, account_type, tenant_id, created_at, updated_at, last_scan_date):
+        """
+
+        Args:
+            account_id (str): A unique identifier for an account
+            name (str): The account name
+            credentials (dict): The account credentials to connect to the provider
+            account_type (int): The type of account
+            tenant_id (str): The tenantId where the account belongs to
+            created_at (str):
+            updated_at (str):
+            last_scan_date (str):
+        """
+        self.account_id = account_id
+        self.name = name
+        self.credentials = credentials
+        self.account_type = account_type
+        self.tenant_id = tenant_id
+        self.created_at = created_at
+        self.updated_at = updated_at
+        self.last_scan_date = last_scan_date
+
+    def __str__(self):
+        return """Account(account_id={}, name={}, credentials={}, account_type={}, tenant_id={}, created_at={}, 
+        updated_at={}, last_scan_date={})""".format(
+            self.account_id, self.name, self.credentials, self.account_type, self.tenant_id, self.created_at,
+            self.updated_at, self.last_scan_date
+        )

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/dto/AuditEvent.py

@@ -0,0 +1,28 @@
+class AuditEvent(object):
+
+    def __init__(self, event_date, event_type, audit_resource, action_type, action_user_id, ip_address, data):
+        """
+
+        Args:
+            event_date (str):
+            event_type (str):
+            audit_resource (str):
+            action_type (str):
+            action_user_id (str):
+            ip_address (str):
+            data (dict):
+        """
+        self.event_date = event_date
+        self.event_type = event_type
+        self.audit_resource = audit_resource
+        self.action_type = action_type
+        self.action_user_id = action_user_id
+        self.ip_address = ip_address
+        self.data = data
+
+    def __str__(self):
+        return """AuditEvent(event_date={}, event_type={}, audit_resource={}, action_type={}, action_user_id={}, 
+        ip_address={}, data={})""".format(
+            self.event_date, self.event_type, self.audit_resource, self.action_type, self.action_user_id,
+            self.ip_address, self.data
+        )

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/dto/AuditEventLink.py

@@ -0,0 +1,18 @@
+class AuditEventLink(object):
+
+    def __init__(self, event_date, url, crc):
+        """
+
+        Args:
+            event_date (str):
+            url (str):
+            crc (str):
+        """
+        self.event_date = event_date
+        self.url = url
+        self.crc = crc
+
+    def __str__(self):
+        return """AuditEventLink(event_date={}, url={}, crc={})""".format(
+            self.event_date, self.url, self.crc
+        )

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/dto/AuditEvents.py

@@ -0,0 +1,20 @@
+from .AuditEventLink import AuditEventLink
+from .AuditEvent import AuditEvent
+
+
+class AuditEvents(object):
+
+    def __init__(self, links, events):
+        """
+
+        Args:
+            links (list of AuditEventLink):
+            events (list of AuditEvent):
+        """
+        self.links = links
+        self.events = events
+
+    def __str__(self):
+        return """AuditEvents(links={}, events={})""".format(
+            self.links, self.events
+        )

checkmarxpythonsdk-0.9.2/CheckmarxPythonSDK/CxOne/dto/Category.py

@@ -0,0 +1,20 @@
+class Category(object):
+
+    def __init__(self, category_id, name, sast_id):
+        """
+
+        Args:
+            category_id (int):
+            name (str):
+            sast_id (int):
+        """
+        self.category_id = category_id
+        self.name = name
+        self.sast_id = sast_id
+
+    def __str__(self):
+        return """Category(
+        category_id={self.category_id},
+        name={self.name},
+        sast_id={self.sast_id},
+        )"""