CheckmarxPythonSDK 0.9.6__tar.gz → 0.9.7__tar.gz

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/CxOne/AccessControlAPI/__init__.py

@@ -2,4 +2,5 @@ from .api import (
     get_groups,
     get_users,
     get_users_by_groups,
+    get_group_by_name,
 )

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/CxOne/AccessControlAPI/api.py

@@ -42,6 +42,26 @@ def get_groups(realm, group_name=None, limit=None, ids=None) -> List[AstIdWithNa
     return [construct_ast_id_with_name(item) for item in item_list]
 
 
+def get_group_by_name(realm, group_name):
+    """
+
+    Args:
+        realm (str):
+        group_name (str):
+
+    Returns:
+        Group
+    """
+    result = None
+    type_check(realm, str)
+    type_check(group_name, str)
+    groups = get_groups(realm=realm, group_name=group_name)
+    one_group = list(filter(lambda g: g.name == group_name, groups))
+    if len(one_group) == 1:
+        result = one_group[0]
+    return result
+
+
 def get_users(realm, term, limit=100) -> List[AstIdWithName]:
     """
 

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/CxOne/dto/ProjectInput.py

@@ -71,6 +71,6 @@ class ProjectInput(object):
         if self.tags:
             data.update({"tags": self.tags})
         if self.criticality:
-            data.update({"tags": self.criticality})
+            data.update({"criticality": self.criticality})
             
         return json.dumps(data)

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/CxRestAPISDK/CxSastXML/xml_results.py

@@ -104,6 +104,8 @@ def obj_to_dict(obj) -> dict:
     obj_dict = obj.__dict__
     for key, value in obj_dict.items():
         if value is None or isinstance(value, (int, str)):
+            if key == 'schema':
+                key = '$schema'
             result[key] = value
         elif isinstance(value, list):
             result[key] = []
@@ -111,6 +113,7 @@ def obj_to_dict(obj) -> dict:
                 result[key].append(obj_to_dict(item))
         else:
             result[key] = obj_to_dict(value)
+
     return result
 
 

checkmarxpythonsdk-0.9.7/CheckmarxPythonSDK/__version__.py

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

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifArtifactLocation.py

@@ -5,9 +5,9 @@ class SarifArtifactLocation:
         Args:
             uri (str):
         """
-        self.URI = uri
+        self.uri = uri
 
     def __str__(self):
         return f"SarifArtifactLocation(" \
-               f"uri={self.URI}"\
+               f"uri={self.uri}"\
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifDescription.py

@@ -5,9 +5,9 @@ class SarifDescription:
         Args:
             text (str):
         """
-        self.Text = text
+        self.text = text
 
     def __str__(self):
         return f"SarifDescription(" \
-               f"text={self.Text}" \
+               f"text={self.text}" \
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifDriver.py

@@ -13,17 +13,17 @@ class SarifDriver:
             information_uri (str):
             rules (list of SarifDriverRule):
         """
-        self.Name = name
-        self.FullName = full_name
-        self.Version = version
-        self.InformationURI = information_uri
-        self.Rules = rules
+        self.name = name
+        self.fullName = full_name
+        self.version = version
+        self.informationUri = information_uri
+        self.rules = rules
 
     def __str__(self):
         return f"SarifDriver(" \
-               f"name={self.Name}, " \
-               f"full_name={self.FullName}, " \
-               f"version={self.Version}, " \
-               f"information_uri={self.InformationURI}, " \
-               f"rules={self.Rules}"\
+               f"name={self.name}, " \
+               f"full_name={self.fullName}, " \
+               f"version={self.version}, " \
+               f"information_uri={self.informationUri}, " \
+               f"rules={self.rules}"\
                f")"

checkmarxpythonsdk-0.9.7/CheckmarxPythonSDK/external/sarif/dto/SarifDriverRule.py

@@ -0,0 +1,34 @@
+from .SarifDescription import SarifDescription
+
+
+class SarifDriverRule:
+    def __init__(self, rule_id, name, short_description, full_description, help_uri, help, relation_ships):
+        """
+
+        Args:
+            rule_id (str):
+            name (str):
+            short_description (SarifDescription):
+            full_description (SarifDescription):
+            help_uri (str):
+            help (SarifMultiFormatMessageString):
+            relation_ships (SarifTaxaRelationship):
+        """
+        self.id = rule_id
+        self.name = name
+        self.helpUri = help_uri
+        self.help = help
+        self.fullDescription = full_description
+        self.shortDescription = short_description
+        self.relationships = relation_ships
+
+    def __str__(self):
+        return f"SarifDriverRule("\
+               f"rule_id={self.id}, "\
+               f"name={self.name}, "\
+               f"help_uri={self.helpUri}, "\
+               f"help={self.help}, "\
+               f"full_description={self.fullDescription}, "\
+               f"short_description={self.shortDescription}, "\
+               f"relation_ships={self.relationships}"\
+               ")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifLocation.py

@@ -8,9 +8,9 @@ class SarifLocation:
         Args:
             physical_location (SarifPhysicalLocation):
         """
-        self.PhysicalLocation = physical_location
+        self.physicalLocation = physical_location
 
     def __str__(self):
         return f"SarifLocation(" \
-               f"physical_location={self.PhysicalLocation}, " \
+               f"physical_location={self.physicalLocation}, " \
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifMessage.py

@@ -5,9 +5,9 @@ class SarifMessage:
         Args:
             text (str):
         """
-        self.Text = text
+        self.text = text
 
     def __str__(self):
         return f"SarifMessage(" \
-               f"text={self.Text}"\
+               f"text={self.text}"\
                f")"

checkmarxpythonsdk-0.9.7/CheckmarxPythonSDK/external/sarif/dto/SarifMultiFormatMessageString.py

@@ -0,0 +1,20 @@
+class SarifMultiFormatMessageString(object):
+
+    def __init__(self, general, text, markdown):
+        """
+
+        Args:
+            general (str):
+            text (str):
+            markdown (str):
+        """
+        self.general = general
+        self.text = text
+        self.markdown = markdown
+
+    def __str__(self):
+        return f"""SarifMultiFormatMessageString(
+        general={self.general}, 
+        text={self.text}, 
+        markdown={self.markdown})
+        """

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifPhysicalLocation.py

@@ -12,13 +12,13 @@ class SarifPhysicalLocation:
             region (SarifRegion):
             properties (SarifPhysicalLocationPropertyBag):
         """
-        self.ArtifactLocation = artifact_location
-        self.Region = region
-        self.Properties = properties
+        self.artifactLocation = artifact_location
+        self.region = region
+        self.properties = properties
 
     def __str__(self):
         return f"SarifPhysicalLocation(" \
-               f"artifact_location={self.ArtifactLocation}, " \
-               f"region={self.Region}" \
-               f"properties={self.Properties}"\
+               f"artifact_location={self.artifactLocation}, " \
+               f"region={self.region}" \
+               f"properties={self.properties}"\
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifPhysicalLocationPropertyBag.py

@@ -6,11 +6,11 @@ class SarifPhysicalLocationPropertyBag:
             tags (list of str):
             snippet (str):
         """
-        self.Tags = tags
-        self.Snippet = snippet
+        self.tags = tags
+        self.snippet = snippet
 
     def __str__(self):
         return f"SarifPhysicalLocationPropertyBag(" \
-               f"tags={self.Tags}, "\
-               f"snippet={self.Snippet}"\
+               f"tags={self.tags}, "\
+               f"snippet={self.snippet}"\
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifRegion.py

@@ -7,13 +7,13 @@ class SarifRegion:
             start_column (int):
             end_column (int):
         """
-        self.StartLine = start_line
-        self.StartColumn = start_column
-        self.EndColumn = end_column
+        self.startLine = start_line
+        self.startColumn = start_column
+        self.endColumn = end_column
 
     def __str__(self):
         return f"SarifRegion(" \
-               f"start_line={self.StartLine}, "\
-               f"start_column={self.StartColumn}, "\
-               f"end_column={self.EndColumn}" \
+               f"start_line={self.startLine}, "\
+               f"start_column={self.startColumn}, "\
+               f"end_column={self.endColumn}" \
                f")"

checkmarxpythonsdk-0.9.7/CheckmarxPythonSDK/external/sarif/dto/SarifResultPropertyBag.py

@@ -0,0 +1,25 @@
+class SarifResultPropertyBag:
+    def __init__(self, tags, similarity_id, cx_cwe, cx_stig_id, cx_stig_rule_id):
+        """
+
+        Args:
+            tags (list of str):
+            similarity_id (int):
+            cx_cwe (str):
+            cx_stig_id (str):
+            cx_stig_rule_id (str):
+        """
+        self.tags = tags
+        self.similarityId = similarity_id
+        self.cxCwe = cx_cwe
+        self.cxStigID = cx_stig_id
+        self.cxStigRuleID = cx_stig_rule_id
+
+    def __str__(self):
+        return f"SarifResultPropertyBag(" \
+               f"tags={self.tags}, "\
+               f"similarity_id={self.similarityId}, " \
+               f"cx_cwe={self.cxCwe}, " \
+               f"cx_stig_id={self.cxStigID}, "\
+               f"cx_stig_rule_id={self.cxStigRuleID}"\
+               f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifResultsCollection.py

@@ -10,13 +10,13 @@ class SarifResultsCollection:
             version (str):
             runs (list of SarifRun):
         """
-        self.Schema = schema
-        self.Version = version
-        self.Runs = runs
+        self.schema = schema
+        self.version = version
+        self.runs = runs
 
     def __str__(self):
         return f"SarifResultsCollection("\
-               f"schema={self.Schema}, "\
-               f"version={self.Version}, "\
-               f"runs={self.Runs} "\
+               f"schema={self.schema}, "\
+               f"version={self.version}, "\
+               f"runs={self.runs} "\
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifRun.py

@@ -13,13 +13,13 @@ class SarifRun:
             results (list of SarifScanResult):
             taxonomies (list of SarifTaxonomy)
         """
-        self.Tool = tool
-        self.Results = results
-        self.Taxonomies = taxonomies
+        self.tool = tool
+        self.results = results
+        self.taxonomies = taxonomies
 
     def __str__(self):
         return f"SarifRun(" \
-               f"tool={self.Tool}, "\
-               f"results={self.Results}"\
-               f"taxonomies={self.Taxonomies}"\
+               f"tool={self.tool}, "\
+               f"results={self.results}"\
+               f"taxonomies={self.taxonomies}"\
                f")"

checkmarxpythonsdk-0.9.7/CheckmarxPythonSDK/external/sarif/dto/SarifScanResult.py

@@ -0,0 +1,36 @@
+from .SarifMessage import SarifMessage
+from .SarifResultPropertyBag import SarifResultPropertyBag
+from .SarifLocation import SarifLocation
+
+
+class SarifScanResult:
+    def __init__(self, rule_id, kind, level, message, properties, locations, fixes):
+        """
+
+        Args:
+            rule_id (str):
+            kind (str):
+            level (str):
+            message (SarifMessage):
+            properties (SarifResultPropertyBag):
+            locations (list of SarifLocation):
+            fixes ():
+        """
+        self.ruleId = rule_id
+        self.kind = kind
+        self.level = level
+        self.message = message
+        self.properties = properties
+        self.locations = locations
+        self.fixes = fixes
+
+    def __str__(self):
+        return f"SarifScanResult(" \
+               f"rule_id={self.ruleId}, "\
+               f"kind={self.kind}, " \
+               f"level={self.level}, " \
+               f"message={self.message}, " \
+               f"properties={self.properties}, "\
+               f"locations={self.locations}, "\
+               f"fixes={self.fixes}, "\
+               f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifTaxa.py

@@ -13,17 +13,17 @@ class SarifTaxa:
             short_description (SarifDescription):
             properties (SarifTaxaPropertyBag):
         """
-        self.Id = taxa_id
-        self.Name = name
-        self.FullDescription = full_description
-        self.ShortDescription = short_description
-        self.Properties = properties
+        self.id = taxa_id
+        self.name = name
+        self.fullDescription = full_description
+        self.shortDescription = short_description
+        self.properties = properties
 
     def __str__(self):
         return f"SarifTaxa(" \
-               f"taxa_id={self.Id}, "\
-               f"name={self.Name}, "\
-               f"full_description={self.FullDescription}, "\
-               f"short_description={self.ShortDescription}, "\
-               f"properties={self.Properties}"\
+               f"taxa_id={self.id}, "\
+               f"name={self.name}, "\
+               f"full_description={self.fullDescription}, "\
+               f"short_description={self.shortDescription}, "\
+               f"properties={self.properties}"\
                f")"

checkmarxpythonsdk-0.9.7/CheckmarxPythonSDK/external/sarif/dto/SarifTaxaPropertyBag.py

@@ -0,0 +1,41 @@
+from .CxSarifCategory import CxSarifCategory
+
+
+class SarifTaxaPropertyBag:
+    def __init__(self, tags, cx_cwe, cx_severity, cx_category, cx_query_group_name, cx_language_name,
+                 cx_package_type_name, cx_stig_id, cx_stig_rule_id):
+        """
+
+        Args:
+            tags (list of str):
+            cx_cwe (str):
+            cx_severity (str):
+            cx_category (list of CxSarifCategory):
+            cx_query_group_name (str):
+            cx_language_name (str):
+            cx_package_type_name (str):
+            cx_stig_id (str):
+            cx_stig_rule_id (str):
+        """
+        self.tags = tags
+        self.cxCwe = cx_cwe
+        self.cxSeverity = cx_severity
+        self.cxCategory = cx_category
+        self.cxQueryGroupName = cx_query_group_name
+        self.cxLanguageName = cx_language_name
+        self.cxPackageTypeName = cx_package_type_name
+        self.cxStigID = cx_stig_id
+        self.cxStigRuleID = cx_stig_rule_id
+
+    def __str__(self):
+        return f"SarifTaxaPropertyBag(" \
+               f"tags={self.tags}, "\
+               f"cx_cwe={self.cxCwe}, "\
+               f"cx_severity={self.cxSeverity}, "\
+               f"cx_category={self.cxCategory}, " \
+               f"cx_query_group_name={self.cxQueryGroupName}, " \
+               f"cx_language_name={self.cxLanguageName}, " \
+               f"cx_package_type_name={self.cxPackageTypeName}, " \
+               f"cx_stig_id={self.cxStigID}, " \
+               f"cx_stig_rule_id={self.cxStigRuleID}" \
+               f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifTaxaRelationship.py

@@ -5,9 +5,9 @@ class SarifTaxaRelationship:
         Args:
             target (SarifTaxaRelationshipTarget):
         """
-        self.Target = target
+        self.target = target
 
     def __str__(self):
         return f"SarifTaxaRelationship(" \
-               f"target={self.Target}"\
+               f"target={self.target}"\
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifTaxaRelationshipTarget.py

@@ -10,13 +10,13 @@ class SarifTaxaRelationshipTarget:
             index (int):
             tool_component (SarifToolComponent):
         """
-        self.ID = target_id
-        self.Index = index
-        self.ToolComponent = tool_component
+        self.id = target_id
+        self.index = index
+        self.toolComponent = tool_component
 
     def __str__(self):
         return f"SarifTaxaRelationshipTarget(" \
-               f"target_id={self.ID}, "\
-               f"index={self.Index}, "\
-               f"tool_component={self.ToolComponent}"\
+               f"target_id={self.id}, "\
+               f"index={self.index}, "\
+               f"tool_component={self.toolComponent}"\
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifTaxonomy.py

@@ -13,17 +13,17 @@ class SarifTaxonomy:
             short_description (SarifDescription):
             taxa (list of SarifTaxa):
         """
-        self.Guid = guid
-        self.Name = name
-        self.FullDescription = full_description
-        self.ShortDescription = short_description
-        self.Taxa = taxa
+        self.guid = guid
+        self.name = name
+        self.fullDescription = full_description
+        self.shortDescription = short_description
+        self.taxa = taxa
 
     def __str__(self):
         return f"SarifTaxonomy(" \
-               f"guid={self.Guid}, "\
-               f"name={self.Name}, "\
-               f"full_description={self.FullDescription}, "\
-               f"short_description={self.ShortDescription}, "\
-               f"taxa={self.Taxa}"\
+               f"guid={self.guid}, "\
+               f"name={self.name}, "\
+               f"full_description={self.fullDescription}, "\
+               f"short_description={self.shortDescription}, "\
+               f"taxa={self.taxa}"\
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifTool.py

@@ -8,9 +8,9 @@ class SarifTool:
         Args:
             driver (SarifDriver):
         """
-        self.Driver = driver
+        self.driver = driver
 
     def __str__(self):
         return f"SarifDriver(" \
-               f"driver={self.Driver}"\
+               f"driver={self.driver}"\
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/SarifToolComponent.py

@@ -7,13 +7,13 @@ class SarifToolComponent:
             guid (str):
             index (int):
         """
-        self.Name = name
-        self.Guid = guid
-        self.Index = index
+        self.name = name
+        self.guid = guid
+        self.index = index
 
     def __str__(self):
         return f"SarifToolComponent(" \
-               f"name={self.Name}, "\
-               f"guid={self.Guid}, "\
-               f"index={self.Index}"\
+               f"name={self.name}, "\
+               f"guid={self.guid}, "\
+               f"index={self.index}"\
                f")"

{checkmarxpythonsdk-0.9.6 → checkmarxpythonsdk-0.9.7}/CheckmarxPythonSDK/external/sarif/dto/__init__.py

@@ -6,6 +6,7 @@ from .SarifDriver import SarifDriver
 from .SarifDriverRule import SarifDriverRule
 from .SarifLocation import SarifLocation
 from .SarifMessage import SarifMessage
+from .SarifMultiFormatMessageString import SarifMultiFormatMessageString
 from .SarifPhysicalLocation import SarifPhysicalLocation
 from .SarifPhysicalLocationPropertyBag import SarifPhysicalLocationPropertyBag
 from .SarifRegion import SarifRegion