CheckmarxPythonSDK 1.0.9__tar.gz → 1.1.1__tar.gz

{checkmarxpythonsdk-1.0.9 → checkmarxpythonsdk-1.1.1}/CheckmarxPythonSDK/CxOne/__init__.py

@@ -31,6 +31,11 @@ from .cloudInsightsServiceAPI import (
     get_all_containers_for_an_account_id,
 )
 
+from .codeRepositoryProjectAPI import (
+    import_code_repository,
+    retrieve_import_status,
+)
+
 from .contributorsAPI import (
     get_allowed_and_current_contributors_for_the_current_tenant,
     get_contributors_details_for_current_tenant_exported_in_csv,

checkmarxpythonsdk-1.1.1/CheckmarxPythonSDK/CxOne/codeRepositoryProjectAPI.py

@@ -0,0 +1,45 @@
+# encoding: utf-
+import json
+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 SCMImportInput
+
+api_url = "/api/repos-manager"
+
+
+def import_code_repository(scm_import_input: SCMImportInput):
+    """
+
+    Args:
+        scm_import_input (SCMImportInput):
+
+    Returns:
+        processId
+            string
+            The unique identifier of this conversion process. You will use this ID with the
+            GET conversion/status/{process_id} API to check the status of the conversion.
+
+        message
+            string
+            A message that includes the url for checking the conversion status.
+    """
+    type_check(scm_import_input, SCMImportInput)
+    relative_url = api_url + "/scm-projects"
+    response = post_request(relative_url=relative_url, data=json.dumps(scm_import_input.to_dict()))
+    return response.json()
+
+
+def retrieve_import_status(process_id: str):
+    """
+
+    Args:
+        process_id: The unique identifier of the import process for which you would like to check the status
+
+    Returns:
+
+    """
+    type_check(process_id, str)
+    relative_url = api_url + f"/scm-projects/import-status?process-id={process_id}"
+    response = get_request(relative_url=relative_url)
+    return response.json()

checkmarxpythonsdk-1.1.1/CheckmarxPythonSDK/CxOne/dto/ProjectSettings.py

@@ -0,0 +1,56 @@
+from .Scanner import Scanner
+from typing import List
+
+
+class ProjectSettings(object):
+
+    def __init__(self,
+                 web_hook_enabled: bool,
+                 decorate_pull_requests: bool,
+                 scanners: List[Scanner],
+                 tags: dict = None,
+                 groups: List[str] = None,
+                 is_private_package: bool = None,
+                 ):
+        """
+
+        Args:
+            web_hook_enabled (bool): If true, a webhook is enabled for each repo.
+            decorate_pull_requests (bool): If true, pull request decorations will be sent to the repo.
+                            Note: This requires webhookEnabled to be set as true.
+            is_private_package (bool): If true the project will be marked as a private package for SCA scans. (Not
+                currently supported)
+            scanners (list of Scanner):
+            tags (dict):
+            groups (list of str):
+        """
+        self.webhookEnabled = web_hook_enabled
+        self.decoratePullRequests = decorate_pull_requests
+        self.isPrivatePackage = is_private_package
+        self.scanners = scanners
+        self.tags = tags
+        self.groups = groups
+
+    def __str__(self):
+        return (f"ProjectSettings("
+                f"webhookEnabled={self.webhookEnabled}, "
+                f"decoratePullRequests={self.decoratePullRequests}, "
+                f"isPrivatePackage={self.isPrivatePackage}, "
+                f"scanners={self.scanners}, "
+                f"tags={self.tags}, "
+                f"groups={self.groups}"
+                f")")
+
+    def to_dict(self):
+        result = {
+            "decoratePullRequests": self.decoratePullRequests,
+            "webhookEnabled": self.webhookEnabled,
+            "scanners": [
+                scanner.to_dict() for scanner in self.scanners
+            ]
+        }
+        if self.tags is not None:
+            result.update({"tags": self.tags})
+        if self.groups is not None:
+            result.update({"groups": self.groups})
+        return result

checkmarxpythonsdk-1.1.1/CheckmarxPythonSDK/CxOne/dto/SCMImportInput.py

@@ -0,0 +1,52 @@
+from .Scm import Scm
+from .ScmOrganization import ScmOrganization
+from .ProjectSettings import ProjectSettings
+from .ScmProject import ScmProject
+from typing import List
+
+
+class SCMImportInput(object):
+
+    def __init__(self,
+                 scm: Scm,
+                 organization: ScmOrganization,
+                 default_project_settings: ProjectSettings,
+                 scan_projects_after_import: bool,
+                 projects: List[ScmProject]
+                 ):
+        """
+
+        Args:
+            scm (Scm):
+            organization (ScmOrganization):
+            default_project_settings (ProjectSettings): By default, these settings will be applied to each
+                project created by this process. You can configure different settings for specific projects, which will
+                override these settings.
+            scan_projects_after_import (bool): If true an initial scan will be run when the import process is completed
+            projects (list of ScmProject): Specify the repos that you would like to import.
+                Each repo needs to be submitted explicitly.
+                Note: You can specify project settings for each specific project. These settings override the
+                defaultProjectSettings
+        """
+        self.scm = scm
+        self.organization = organization
+        self.defaultProjectSettings = default_project_settings
+        self.scanProjectsAfterImport = scan_projects_after_import
+        self.projects = projects
+
+    def __str__(self):
+        return (f"SCMImportInput( scm={self.scm}, "
+                f"organization={self.organization}, "
+                f"defaultProjectSettings={self.defaultProjectSettings}, "
+                f"scanProjectsAfterImport={self.scanProjectsAfterImport}, "
+                f"projects={self.projects}"
+                f")")
+
+    def to_dict(self):
+        return {
+            "scm": self.scm.to_dict(),
+            "organization": self.organization.to_dict(),
+            "defaultProjectSettings": self.defaultProjectSettings.to_dict(),
+            "scanProjectsAfterImport": self.scanProjectsAfterImport,
+            "projects": [project.to_dict() for project in self.projects]
+        }

checkmarxpythonsdk-1.1.1/CheckmarxPythonSDK/CxOne/dto/Scanner.py

@@ -0,0 +1,31 @@
+class Scanner(object):
+
+    def __init__(self,
+                 scanner_type: str,
+                 auto_pr_enabled: bool = None,
+                 incremental: bool = None
+                 ):
+        """
+
+        Args:
+            scanner_type (str): The type of scanner to run.
+                    Allowed values: sast sca kics apisec containers
+            auto_pr_enabled (bool): If true, Checkmarx will automatically send suggested remediation actions.
+                        Note: Relevant only for sca scanner.
+            incremental (bool): If true, an incremental scan will be run by default (unless extensive changes are
+                identified in the project). Note: Relevant only for sast scans.
+        """
+        self.type = scanner_type
+        self.autoPrEnabled = auto_pr_enabled
+        self.incremental = incremental
+
+    def __str__(self):
+        return f"Scanner(type={self.type}, autoPrEnabled={self.autoPrEnabled}, incremental={self.incremental})"
+
+    def to_dict(self):
+        result = {"type": self.type}
+        if self.autoPrEnabled is not None:
+            result.update({"enableAutoPullRequests": self.autoPrEnabled})
+        if self.incremental is not None:
+            result.update({"incrementalScan": self.incremental})
+        return result

checkmarxpythonsdk-1.1.1/CheckmarxPythonSDK/CxOne/dto/Scm.py

@@ -0,0 +1,27 @@
+class Scm(object):
+
+    def __init__(self,
+                 token: str,
+                 scm_type: str = "github",
+                 self_hosted_scm_url: str = None
+                 ):
+        """
+
+        Args:
+            token (str): The token for authentication with your SCM
+            scm_type (str): The type of SCM that you are importing from
+            self_hosted_scm_url (str): The URL of your self-hosted environment. Note: This should be the exact URL that
+                you configured for your code repository in Checkmarx One.
+        """
+        self.type = scm_type
+        self.token = token
+        self.selfHostedScmUrl = self_hosted_scm_url
+
+    def __str__(self):
+        return f"Scm(type={self.type}, token={self.token}, selfHostedScmUrl={self.selfHostedScmUrl}"
+
+    def to_dict(self):
+        return {
+            "type": self.type,
+            "token": self.token
+        }

checkmarxpythonsdk-1.1.1/CheckmarxPythonSDK/CxOne/dto/ScmOrganization.py

@@ -0,0 +1,25 @@
+class ScmOrganization(object):
+
+    def __init__(self,
+                 org_identity: str,
+                 monitor_for_new_projects: bool
+                 ):
+        """
+
+        Args:
+            org_identity (str): The name of the organization that you are importing from. Note: Each API call can only
+                import repos from a single organization.
+            monitor_for_new_projects (bool): If true, then after the initial configuration, whenever a new repo is
+                created in the organization, a corresponding project will be created in Checkmarx.
+        """
+        self.orgIdentity = org_identity
+        self.monitorForNewProjects = monitor_for_new_projects
+
+    def __str__(self):
+        return f"ScmOrganization(orgIdentity={self.orgIdentity}, monitorForNewProjects={self.monitorForNewProjects})"
+
+    def to_dict(self):
+        return {
+            "orgIdentity": self.orgIdentity,
+            "monitorForNewProjects": self.monitorForNewProjects
+        }

checkmarxpythonsdk-1.1.1/CheckmarxPythonSDK/CxOne/dto/ScmProject.py

@@ -0,0 +1,56 @@
+from typing import List
+from .ProjectSettings import ProjectSettings
+
+
+class ScmProject(object):
+
+    def __init__(self,
+                 scm_repository_url: str,
+                 protected_branches: List[str] = None,
+                 branch_to_scan_upon_creation: str = None,
+                 custom_settings: ProjectSettings = None,
+                 ssh_key: str = None
+                 ):
+        """
+
+        Args:
+            scm_repository_url (str): The URL of the repo.
+                        Note: Do not include the .git extension at the end of the URL.
+                        Note: When using an SSH Key, you have the option to specify the repo address using the git@...
+                        format, e.g., git@github:MyOrg/MyRepo.
+            protected_branches (list of str): A list of branches that will be scanned
+                        Note: The max. number of protected branches is 3. If no branch is specified then the default
+                        branch will be used.
+            ssh_key (str): The ssh key for accessing the repo.
+                        Note: Newline characters in an SSH key must follow JSON convention and be escaped with \n in
+                        the request.
+            branch_to_scan_upon_creation (str): Specify the branch that will be scanned after the initial import process
+                        is completed.
+                        Note: This is only relevant if scanProjectsAfterCreation is true.
+            custom_settings (ProjectSettings):
+        """
+        self.scmRepositoryUrl = scm_repository_url
+        self.protectedBranches = protected_branches
+        self.sshKey = ssh_key
+        self.branchToScanUponCreation = branch_to_scan_upon_creation
+        self.customSettings = custom_settings
+
+    def __str__(self):
+        return (f"ScmProject( scmRepositoryUrl={self.scmRepositoryUrl}, "
+                f"protectedBranches={self.protectedBranches}, "
+                f"sshKey={self.sshKey}, "
+                f"branchToScanUponCreation={self.branchToScanUponCreation}, "
+                f"customSettings={self.customSettings}"
+                f")")
+
+    def to_dict(self):
+        result = {"scmRepositoryUrl": self.scmRepositoryUrl}
+        if self.protectedBranches is not None:
+            result.update({"protectedBranches": self.protectedBranches})
+        if self.sshKey is not None:
+            result.update({"sshKey": self.sshKey})
+        if self.branchToScanUponCreation is not None:
+            result.update({"branchToScanUponCreation": self.branchToScanUponCreation})
+        if self.customSettings is not None:
+            result.update({"customSettings": self.customSettings.to_dict()})
+        return result

{checkmarxpythonsdk-1.0.9 → checkmarxpythonsdk-1.1.1}/CheckmarxPythonSDK/CxOne/dto/__init__.py

@@ -44,6 +44,7 @@ from .ProjectCounter import ProjectCounter
 from .ProjectInput import ProjectInput
 from .ProjectResponseModel import ProjectResponseModel
 from .ProjectsCollection import ProjectsCollection
+from .ProjectSettings import ProjectSettings
 from .Property import Property
 from .Queries import Queries
 from .QueriesResponse import QueriesResponse
@@ -67,9 +68,14 @@ from .ScanEngineVersion import ScanEngineVersion
 from .ScanInfo import ScanInfo
 from .ScanInfoCollection import ScanInfoCollection
 from .ScanInput import ScanInput
+from .Scanner import Scanner
 from .ScanParameter import ScanParameter
 from .ScansCollection import ScansCollection
 from .ScaPackageCounters import ScaPackageCounters
+from .Scm import Scm
+from .SCMImportInput import SCMImportInput
+from .ScmOrganization import ScmOrganization
+from .ScmProject import ScmProject
 from .SeverityCounter import SeverityCounter
 from .SeveritySummary import SeveritySummary
 from .SinkFileSummary import SinkFileSummary

{checkmarxpythonsdk-1.0.9 → checkmarxpythonsdk-1.1.1}/CheckmarxPythonSDK/CxOne/sastResultsSummaryAPI.py

@@ -73,7 +73,8 @@ def get_sast_aggregate_results(scan_id, group_by_field, language=None, status=No
     list_member_type_check(severity, str)
     list_member_type_check(query_ids, int)
 
-    relative_url = api_url + "/aggregate?scan-id={scan_id}"
+    relative_url = api_url + "/aggregate?"
+    relative_url += get_url_param("scan-id", scan_id)
     relative_url += get_url_param("group-by-field", group_by_field)
     relative_url += get_url_param("language", language)
     relative_url += get_url_param("status", status)

checkmarxpythonsdk-1.1.1/CheckmarxPythonSDK/__version__.py

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

{checkmarxpythonsdk-1.0.9 → checkmarxpythonsdk-1.1.1}/CheckmarxPythonSDK.egg-info/PKG-INFO

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

{checkmarxpythonsdk-1.0.9 → checkmarxpythonsdk-1.1.1}/CheckmarxPythonSDK.egg-info/SOURCES.txt

@@ -46,6 +46,7 @@ CheckmarxPythonSDK/CxOne/applicationsAPI.py
 CheckmarxPythonSDK/CxOne/auditTrailAPI.py
 CheckmarxPythonSDK/CxOne/byorResultsHandlerAPI.py
 CheckmarxPythonSDK/CxOne/cloudInsightsServiceAPI.py
+CheckmarxPythonSDK/CxOne/codeRepositoryProjectAPI.py
 CheckmarxPythonSDK/CxOne/config.py
 CheckmarxPythonSDK/CxOne/contributorsAPI.py
 CheckmarxPythonSDK/CxOne/flagsAPI.py
@@ -221,6 +222,7 @@ CheckmarxPythonSDK/CxOne/dto/Project.py
 CheckmarxPythonSDK/CxOne/dto/ProjectCounter.py
 CheckmarxPythonSDK/CxOne/dto/ProjectInput.py
 CheckmarxPythonSDK/CxOne/dto/ProjectResponseModel.py
+CheckmarxPythonSDK/CxOne/dto/ProjectSettings.py
 CheckmarxPythonSDK/CxOne/dto/ProjectsCollection.py
 CheckmarxPythonSDK/CxOne/dto/Property.py
 CheckmarxPythonSDK/CxOne/dto/Queries.py
@@ -236,6 +238,7 @@ CheckmarxPythonSDK/CxOne/dto/ResultsSummary.py
 CheckmarxPythonSDK/CxOne/dto/RichProject.py
 CheckmarxPythonSDK/CxOne/dto/Rule.py
 CheckmarxPythonSDK/CxOne/dto/RuleInput.py
+CheckmarxPythonSDK/CxOne/dto/SCMImportInput.py
 CheckmarxPythonSDK/CxOne/dto/SastCounters.py
 CheckmarxPythonSDK/CxOne/dto/SastResult.py
 CheckmarxPythonSDK/CxOne/dto/SastScan.py
@@ -249,7 +252,11 @@ CheckmarxPythonSDK/CxOne/dto/ScanInfo.py
 CheckmarxPythonSDK/CxOne/dto/ScanInfoCollection.py
 CheckmarxPythonSDK/CxOne/dto/ScanInput.py
 CheckmarxPythonSDK/CxOne/dto/ScanParameter.py
+CheckmarxPythonSDK/CxOne/dto/Scanner.py
 CheckmarxPythonSDK/CxOne/dto/ScansCollection.py
+CheckmarxPythonSDK/CxOne/dto/Scm.py
+CheckmarxPythonSDK/CxOne/dto/ScmOrganization.py
+CheckmarxPythonSDK/CxOne/dto/ScmProject.py
 CheckmarxPythonSDK/CxOne/dto/SeverityCounter.py
 CheckmarxPythonSDK/CxOne/dto/SeveritySummary.py
 CheckmarxPythonSDK/CxOne/dto/SinkFileSummary.py

{checkmarxpythonsdk-1.0.9 → checkmarxpythonsdk-1.1.1}/PKG-INFO

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

checkmarxpythonsdk-1.0.9/CheckmarxPythonSDK/__version__.py

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