CheckmarxPythonSDK 1.3.6__tar.gz → 1.3.7__tar.gz

{checkmarxpythonsdk-1.3.6 → checkmarxpythonsdk-1.3.7}/CheckmarxPythonSDK/CxOne/__init__.py

@@ -41,6 +41,12 @@ from .contributorsAPI import (
     get_contributors_details_for_current_tenant_exported_in_csv,
 )
 
+from .customStateAPI import (
+    get_all_custom_states,
+    create_a_custom_state,
+    delete_a_custom_state,
+)
+
 from .flagsAPI import (
     get_all_feature_flags,
     get_feature_flag,

{checkmarxpythonsdk-1.3.6 → checkmarxpythonsdk-1.3.7}/CheckmarxPythonSDK/CxOne/auditTrailAPI.py

@@ -32,10 +32,14 @@ def __construct_audit_events(audit_events):
     )
 
 
-def get_audit_events_for_tenant(offset=0, limit=200):
+def get_audit_events_for_tenant(date_from=None, date_to=None, offset=0, limit=200):
     """
-
+    returns a list of audit events for the specified date range. - If no date range is specified, events from the last
+    365 days are returned. - The from date cannot be more than 365 days in the past. - Events for the current day are
+    returned inline. - Events for earlier dates are returned as downloadable links to daily JSON files.
     Args:
+        date_from (str): Start date for the event filter in YYYY-MM-DD format. Cannot be more than 365 days in the past.
+        date_to (str): End date for the event filter in YYYY-MM-DD format. Must be the same or later than the from date.
         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
@@ -46,7 +50,9 @@ def get_audit_events_for_tenant(offset=0, limit=200):
     """
     type_check(offset, int)
     type_check(limit, int)
-    relative_url = api_url + "?offset={offset}&limit={limit}".format(offset=offset, limit=limit)
+    relative_url = api_url + f"?offset={offset}&limit={limit}"
+    if date_from and date_to:
+        relative_url += f"from={date_from}&to={date_to}"
     response = get_request(relative_url=relative_url)
     item = response.json()
     return __construct_audit_events(audit_events=item)

checkmarxpythonsdk-1.3.7/CheckmarxPythonSDK/CxOne/customStateAPI.py

@@ -0,0 +1,43 @@
+# encoding: utf-8
+from .httpRequests import get_request, post_request, delete_request
+
+api_url = "/api/custom-states"
+
+
+def get_all_custom_states(include_deleted: bool = False):
+    """
+
+    Args:
+        include_deleted:
+
+    Returns:
+        [
+          {
+            "id": 391,
+            "name": "demo1",
+            "type": "INFO",
+            "isAllowed": true
+          },
+          {
+            "id": 390,
+            "name": "demo2",
+            "type": "INFO",
+            "isAllowed": false
+          }
+        ]
+    """
+    relative_url = api_url + f"?include-deleted={include_deleted}"
+    response = get_request(relative_url=relative_url)
+    item = response.json()
+    return item
+
+
+def create_a_custom_state(name: str):
+    response = post_request(relative_url=api_url, json={"name": name})
+    return response
+
+
+def delete_a_custom_state(id: str):
+    relative_url = api_url + f"/{id}"
+    response = delete_request(relative_url=relative_url)
+    return response

{checkmarxpythonsdk-1.3.6 → checkmarxpythonsdk-1.3.7}/CheckmarxPythonSDK/CxOne/scanConfigurationAPI.py

@@ -45,7 +45,7 @@ def define_parameters_in_the_input_list_for_the_current_tenant(scan_parameters):
     relative_url = api_url + "/tenant"
     data = json.dumps([scan_parameter.to_dict() for scan_parameter in scan_parameters])
     response = patch_request(relative_url=relative_url, data=data)
-    if response.status == NO_CONTENT:
+    if response.status_code == NO_CONTENT:
         result = True
     return result
 
@@ -62,7 +62,7 @@ def delete_parameters_for_a_tenant(config_keys):
     result = False
     relative_url = api_url + "/tenant?config-keys={}".format(config_keys)
     response = delete_request(relative_url=relative_url)
-    if response.status == NO_CONTENT:
+    if response.status_code == NO_CONTENT:
         result = True
     return result
 

{checkmarxpythonsdk-1.3.6 → checkmarxpythonsdk-1.3.7}/CheckmarxPythonSDK/CxRestAPISDK/ScansAPI.py

@@ -15,7 +15,8 @@ from .sast.scans.dto import CxScanState, CxPolicyFindingsStatus, \
     CxCreateScanSettingsResponse, CxEmailNotification, CxLanguage, \
     CxScanResultAttackVectorByBFL, construct_attack_vector, construct_scan_result_node, CxScanResultLabelsFields, \
     CxScanStatistics, CxScanFileCountOfLanguage, CxLanguageStatistic, CxScanParsedFiles, CxScanParsedFilesMetric, \
-    CxScanFailedQueries, CxScanFailedGeneralQueries, CxScanSucceededGeneralQueries, CxPostScanActionConditions
+    CxScanFailedQueries, CxScanFailedGeneralQueries, CxScanSucceededGeneralQueries, CxPostScanActionConditions, \
+    CxScanResultsPage
 
 
 class ScansAPI(object):
@@ -1611,3 +1612,33 @@ class ScansAPI(object):
         if response.status_code == OK:
             result = response.json()
         return result
+
+    @staticmethod
+    def get_scan_results_in_paged_mode(scan_id, offset, limit, lcid=None):
+        """
+        Args:
+            scan_id (int): Unique ID of a scan
+            offset  (int): Page offset
+            limit   (int): Page size
+            lcid    (int): Language Id
+
+        Returns:
+            :obj:CxScnResultsResponse
+
+        Raises:
+        """
+        result = None
+        relative_url = "/cxrestapi/sast/results" \
+            "?scanId={scanId}&offset={offset}&limit={limit}".format(
+                scanId=scan_id,
+                offset=offset,
+                limit=limit
+            )
+        if lcid is not None:
+            relative_url = relative_url + "&LCID={lcid}".format(lcid=lcid)
+        response = get_request(relative_url=relative_url)
+        if response.status_code == OK:
+            data = response.json()
+            result = CxScanResultsPage.from_dict(data)
+
+        return result

checkmarxpythonsdk-1.3.7/CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanResult.py

@@ -0,0 +1,269 @@
+# encoding: utf-8
+
+class CxScanResult:
+
+    class Node:
+
+        def __init__(self, node_id, full_name, short_name, file_name, line,
+                     column, length, remarks, method_line):
+            """
+            Args:
+                node_id (int):
+                full_name (str):
+                short_name (str):
+                file_name (str):
+                line (int):
+                column (int):
+                length (int):
+                remarks (str):
+                method_line (int):
+            """
+            self.node_id = node_id
+            self.full_name = full_name
+            self.short_name = short_name
+            self.file_name = file_name
+            self.line = line
+            self.column = column
+            self.length = length
+            self.remarks = remarks
+            self.method_line = method_line
+
+        @staticmethod
+        def from_dict(d):
+            """
+            Args:
+                d (dict): a dict containing the node data
+            """
+            return CxScanResult.Node(
+                node_id=d.get('nodeId'),
+                full_name=d.get('fullName'),
+                short_name=d.get('shortName'),
+                file_name=d.get('fileName'),
+                line=d.get('line'),
+                column=d.get('column'),
+                length=d.get('length'),
+                remarks=d.get('remarks'),
+                method_line=d.get('methodLine')
+            )
+
+        def __str__(self):
+            return """CxScanResult.Node(node_id={}, full_name={},
+            short_name={}, file_name={}, line={}, column={}, length={},
+            remarks={}, method_line={})""".format(self.node_id,
+                                                  self.full_name,
+                                                  self.short_name,
+                                                  self.file_name,
+                                                  self.line,
+                                                  self.column,
+                                                  self.length,
+                                                  self.remarks,
+                                                  self.method_line)
+
+    class Query:
+
+        def __init__(self, query_version_id, query_id, name, severity,
+                     categories, cwe):
+            """
+            Args:
+                query_version_id (int):
+                query_id (int):
+                name (str):
+                severity (int):
+                categories (str):
+                cwe (int):
+            """
+            self.query_version_id = query_version_id
+            self.query_id = query_id
+            self.name = name
+            self.severity = severity
+            self.categories = categories
+            self.cwe = cwe
+
+        @staticmethod
+        def from_dict(d):
+            """
+            Args:
+                d (dict): a dict containing the query data
+            """
+            return CxScanResult.Query(
+                query_version_id=d.get('queryVersionId'),
+                query_id=d.get('queryId'),
+                name=d.get('name'),
+                severity=d.get('severity'),
+                categories=d.get('categories'),
+                cwe=d.get('cwe')
+            )
+
+        def __str__(self):
+            return """CxScanResult.Query(query_version_id={}, query_id={}, name={},
+            severity={}, categories={}, cwe={})""".format(
+                self.query_version_id, self.query_id, self.name, self.severity,
+                self.categories, self.cwe
+            )
+
+    class Snippet:
+
+        def __init__(self, file_name, line, code):
+            """
+            Args:
+                file_name (str):
+                line (int):
+                code (str):
+            """
+            self.file_name = file_name
+            self.line = line
+            self.code = code
+
+        @staticmethod
+        def from_dict(d):
+            """
+            Args:
+                d (dict): dict containing the snippet data
+            """
+            return CxScanResult.Snippet(
+                file_name=d.get('fileName'),
+                line=d.get('line'),
+                code=d.get('code')
+            )
+
+        def __str__(self):
+            return "CxScanResult.Snippet(file_name={}, line={}, code={})".format(
+                self.file_name, self.line, self.code
+            )
+
+    def __init__(self, index, path_id, similarity_hash, date, detection_date,
+                 confidence_level, cx_rank, bfl_node_short_name, bfl_node_id,
+                 severity, state, status, assigned_to_user_id, assigned_to,
+                 comment, deep_link, query, source_snippet, sink_snippet,
+                 nodes, lcid, cx_description_id, result_description,
+                 best_fix_location, risk, cause, general_recommendations):
+        """
+        Args:
+            index (int):
+            path_id (int):
+            similarity_hash (int)
+            date (str):
+            detection_date (str):
+            confidence_level (int):
+            cx_rank (float):
+            bfl_node_short_name (str):
+            bfl_node_id (int):
+            severity (int):
+            status (int):
+            assigned_to_user_id (int):
+            assigned_to_user (str):
+            comment (str):
+            deep_link (str):
+            query (:obj:`CxQuery`)
+            source_snippet (:obj:`CxSnippet`):
+            sink_snippet (:obj:`CxSnippet`)
+            nodes: (list of `CxScanResultNode`)
+            lcid (int):
+            cx_description_id (int):
+            result_description (str):
+            best_fix_location (str):
+            risk (str):
+            cause (str):
+            general_recommendations (str):
+        """
+        self.index = index
+        self.path_id = path_id
+        self.similarity_hash = similarity_hash
+        self.date = date
+        self.detection_date = detection_date
+        self.confidence_level = confidence_level
+        self.cx_rank = cx_rank
+        self.bfl_node_short_name = bfl_node_short_name
+        self.bfl_node_id = bfl_node_id
+        self.severity = severity
+        self.state = state
+        self.status = status
+        self.assigned_to_user_id = assigned_to_user_id
+        self.assigned_to = assigned_to
+        self.comment = comment
+        self.deep_link = deep_link
+        self.query = query
+        self.source_snippet = source_snippet
+        self.sink_snippet = sink_snippet
+        self.nodes = nodes
+        self.lcid = lcid
+        self.cx_description_id = cx_description_id
+        self.result_description = result_description
+        self.best_fix_location = best_fix_location
+        self.risk = risk
+        self.cause = cause
+        self.general_recommendations = general_recommendations
+
+    @staticmethod
+    def from_dict(d):
+        """
+        Args:
+            d (`dict` of :obj:): a dictionary containin the result data
+        """
+        nodes = [CxScanResult.Node.from_dict(d2) for d2 in d.get('nodes')]
+        return CxScanResult(index=d.get('index'),
+                        path_id=d.get('pathId'),
+                        similarity_hash=d.get('similarityHash'),
+                        date=d.get('date'),
+                        detection_date=d.get('detectionDate'),
+                        confidence_level=d.get('confidenceLevel'),
+                        cx_rank=d.get('cxRank'),
+                        bfl_node_short_name=d.get('bflNodeShortName'),
+                        bfl_node_id=d.get('bflNodeId'),
+                        severity=d.get('severity'),
+                        state=d.get('state'),
+                        status=d.get('status'),
+                        assigned_to_user_id=d.get('assignedToUserId'),
+                        assigned_to=d.get('assignedTo'),
+                        comment=d.get('comment'),
+                        deep_link=d.get('deepLink'),
+                        query=CxScanResult.Query.from_dict(d.get('query')),
+                        source_snippet=CxScanResult.Snippet.from_dict(
+                            d.get('sourceSnippet')),
+                        sink_snippet=CxScanResult.Snippet.from_dict(
+                            d.get('sinkSnippet')),
+                        nodes=nodes,
+                        lcid=d.get('lcid'),
+                        cx_description_id=d.get('cxDescriptionID'),
+                        result_description=d.get('resultDescription'),
+                        best_fix_location=d.get('bestFixLocation'),
+                        risk=d.get('risk'),
+                        cause=d.get('cause'),
+                        general_recommendations=d.get('generalRecommendations')
+                        )
+
+    def __str__(self):
+        return """CxScanResult(index={}, path_id={}, similarity_hash={},
+        date={}, detection_date={}, confidence_level={}, cx_rank={},
+        bfl_node_short_name={}, bfl_node_id={}, severity={}, state={},
+        status={}, assigned_to_user_id={}, assigned_to={}, comment={},
+        deep_link={}, query={}, source_snippet={}, sink_snippet={}, nodes={},
+        lcid={}, cx_description_id={}, result_description={},
+        best_fix_location={}, risk={}, cause={},
+        general_recommendations={}""".format(self.index,
+                                             self.path_id,
+                                             self.similarity_hash,
+                                             self.date,
+                                             self.detection_date,
+                                             self.confidence_level,
+                                             self.cx_rank,
+                                             self.bfl_node_short_name,
+                                             self.bfl_node_id,
+                                             self.severity,
+                                             self.state,
+                                             self.status,
+                                             self.assigned_to_user_id,
+                                             self.assigned_to,
+                                             self.comment,
+                                             self.deep_link,
+                                             self.query,
+                                             self.source_snippet,
+                                             self.sink_snippet,
+                                             self.nodes,
+                                             self.lcid,
+                                             self.cx_description_id,
+                                             self.result_description,
+                                             self.best_fix_location,
+                                             self.risk,
+                                             self.cause,
+                                             self.general_recommendations)

checkmarxpythonsdk-1.3.7/CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanResultsPage.py

@@ -0,0 +1,41 @@
+#encoding: utf-8
+
+from .CxScanResult import CxScanResult
+
+class CxScanResultsPage:
+
+    def __init__(self, scan_id, offset, limit, total_count, results):
+        """
+        Args:
+            scan_id (int): the unique id of the scan
+            offset (int): the page offset
+            limit (int): the page size
+            total_count (int): the total number of results
+            results (`list` of `CxResult`)
+        """
+        self.scan_id = scan_id
+        self.offset = offset
+        self.limit = limit
+        self.total_count = total_count
+        self.results = results
+
+    @staticmethod
+    def from_dict(d):
+        """
+        Args:
+            d (dict): a dict containing the scan results page data
+        """
+        results = [CxScanResult.from_dict(d2) for d2 in d['results']]
+        return CxScanResultsPage(scan_id=d['scanId'],
+                                   offset=d['offset'],
+                                   limit=d['limit'],
+                                   total_count=d['totalCount'],
+                                   results = results)
+
+    def __str__(self):
+        return """CxScanResultsPage(scan_id={}, offset={}, limit={},
+               total_count={}, results={})""".format(self.scan_id,
+                                                     self.offset,
+                                                     self.limit,
+                                                     self.total_count,
+                                                     self.results)

{checkmarxpythonsdk-1.3.6 → checkmarxpythonsdk-1.3.7}/CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/__init__.py

@@ -22,10 +22,12 @@ from .CxScanParsedFilesMetric import CxScanParsedFilesMetric
 from .CxScanQueueDetail import CxScanQueueDetail
 from .CxScanReportStatus import CxScanReportStatus
 from .CxScanReportXmlContent import CxScanReportXmlContent
+from .CxScanResult import CxScanResult
 from .CxScanResultAttackVector import CxScanResultAttackVector
 from .CxScanResultAttackVectorByBFL import CxScanResultAttackVectorByBFL
 from .CxScanResultLabelsFields import CxScanResultLabelsFields
 from .CxScanResultNode import CxScanResultNode
+from .CxScanResultsPage import CxScanResultsPage
 from .CxScanStage import CxScanStage
 from .CxScanState import CxScanState
 from .CxScanStatistics import CxScanStatistics

checkmarxpythonsdk-1.3.7/CheckmarxPythonSDK/__version__.py

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

{checkmarxpythonsdk-1.3.6 → checkmarxpythonsdk-1.3.7}/CheckmarxPythonSDK.egg-info/PKG-INFO

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

{checkmarxpythonsdk-1.3.6 → checkmarxpythonsdk-1.3.7}/CheckmarxPythonSDK.egg-info/SOURCES.txt

@@ -49,6 +49,7 @@ CheckmarxPythonSDK/CxOne/cloudInsightsServiceAPI.py
 CheckmarxPythonSDK/CxOne/codeRepositoryProjectAPI.py
 CheckmarxPythonSDK/CxOne/config.py
 CheckmarxPythonSDK/CxOne/contributorsAPI.py
+CheckmarxPythonSDK/CxOne/customStateAPI.py
 CheckmarxPythonSDK/CxOne/flagsAPI.py
 CheckmarxPythonSDK/CxOne/healthCheckServiceAPI.py
 CheckmarxPythonSDK/CxOne/httpRequests.py
@@ -439,10 +440,12 @@ CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanParsedFilesMetric.py
 CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanQueueDetail.py
 CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanReportStatus.py
 CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanReportXmlContent.py
+CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanResult.py
 CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanResultAttackVector.py
 CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanResultAttackVectorByBFL.py
 CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanResultLabelsFields.py
 CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanResultNode.py
+CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanResultsPage.py
 CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanStage.py
 CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanState.py
 CheckmarxPythonSDK/CxRestAPISDK/sast/scans/dto/CxScanStatistics.py

{checkmarxpythonsdk-1.3.6 → checkmarxpythonsdk-1.3.7}/PKG-INFO

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

checkmarxpythonsdk-1.3.6/CheckmarxPythonSDK/__version__.py

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