prelude-cli-beta 1396__py3-none-any.whl

prelude_cli/views/scm.py

@@ -0,0 +1,471 @@
+import click
+import requests
+from time import sleep
+
+from prelude_cli.views.shared import Spinner, pretty_print
+from prelude_sdk.controllers.export_controller import ExportController
+from prelude_sdk.controllers.jobs_controller import JobsController
+from prelude_sdk.controllers.scm_controller import ScmController
+from prelude_sdk.models.codes import (
+    Control,
+    ControlCategory,
+    PartnerEvents,
+    RunCode,
+    SCMCategory,
+)
+
+
+@click.group()
+@click.pass_context
+def scm(ctx):
+    """SCM system commands"""
+    ctx.obj = ScmController(account=ctx.obj)
+
+
+@scm.command("endpoints")
+@click.option(
+    "--limit", default=100, help="maximum number of results to return", type=int
+)
+@click.option("--odata_filter", help="OData filter string", default=None)
+@click.option("--odata_orderby", help="OData orderby string", default=None)
+@click.pass_obj
+@pretty_print
+def endpoints(controller, limit, odata_filter, odata_orderby):
+    """List endpoints with SCM data"""
+    with Spinner(description="Fetching endpoints from partner"):
+        return controller.endpoints(
+            filter=odata_filter, orderby=odata_orderby, top=limit
+        )
+
+
+@scm.command("inboxes")
+@click.option(
+    "--limit", default=100, help="maximum number of results to return", type=int
+)
+@click.option("--odata_filter", help="OData filter string", default=None)
+@click.option("--odata_orderby", help="OData orderby string", default=None)
+@click.pass_obj
+@pretty_print
+def endpoints(controller, limit, odata_filter, odata_orderby):
+    """List inboxes with SCM data"""
+    with Spinner(description="Fetching inboxes from partner"):
+        return controller.inboxes(filter=odata_filter, orderby=odata_orderby, top=limit)
+
+
+@scm.command("users")
+@click.option(
+    "--limit", default=100, help="maximum number of results to return", type=int
+)
+@click.option("--odata_filter", help="OData filter string", default=None)
+@click.option("--odata_orderby", help="OData orderby string", default=None)
+@click.pass_obj
+@pretty_print
+def endpoints(controller, limit, odata_filter, odata_orderby):
+    """List users with SCM data"""
+    with Spinner(description="Fetching users from partner"):
+        return controller.users(filter=odata_filter, orderby=odata_orderby, top=limit)
+
+
+@scm.command("technique-summary")
+@click.option(
+    "-q",
+    "--techniques",
+    help="comma-separated list of techniques to filter by",
+    type=str,
+    required=True,
+)
+@click.pass_obj
+@pretty_print
+def technique_summary(controller, techniques):
+    """Get policy summary per technique"""
+    with Spinner(description="Getting policy summary by technique"):
+        return controller.technique_summary(techniques=techniques)
+
+
+@scm.command("evaluation-summary")
+@click.option(
+    "--endpoint_odata_filter", help="OData filter string for endpoints", default=None
+)
+@click.option(
+    "--inbox_odata_filter", help="OData filter string for inboxes", default=None
+)
+@click.option("--user_odata_filter", help="OData filter string for users", default=None)
+@click.option(
+    "-q",
+    "--techniques",
+    help="comma-separated list of techniques to filter by",
+    type=str,
+    default=None,
+)
+@click.pass_obj
+@pretty_print
+def evaluation_summary(
+    controller, endpoint_odata_filter, inbox_odata_filter, user_odata_filter, techniques
+):
+    """Get policy evaluation summary for all partners"""
+    with Spinner(description="Getting policy evaluation summary"):
+        return controller.evaluation_summary(
+            endpoint_filter=endpoint_odata_filter,
+            inbox_filter=inbox_odata_filter,
+            user_filter=user_odata_filter,
+            techniques=techniques,
+        )
+
+
+@scm.command("evaluation")
+@click.argument(
+    "partner",
+    type=click.Choice(
+        [c.name for c in Control if c != Control.INVALID], case_sensitive=False
+    ),
+)
+@click.option("--instance_id", required=True, help="instance ID of the partner")
+@click.option("--odata_filter", help="OData filter string", default=None)
+@click.option(
+    "-q",
+    "--techniques",
+    help="comma-separated list of techniques to filter by",
+    type=str,
+    default=None,
+)
+@click.pass_obj
+@pretty_print
+def evaluation(controller, partner, instance_id, odata_filter, techniques):
+    """Get policy evaluation for given partner"""
+    with Spinner(description="Getting policy evaluation"):
+        return controller.evaluation(
+            partner=Control[partner],
+            instance_id=instance_id,
+            filter=odata_filter,
+            techniques=techniques,
+        )
+
+
+@scm.command("sync")
+@click.argument(
+    "partner",
+    type=click.Choice(
+        [c.name for c in Control if c != Control.INVALID], case_sensitive=False
+    ),
+    required=True,
+)
+@click.option("--instance_id", required=True, help="instance ID of the partner")
+@click.pass_obj
+@pretty_print
+def sync(controller, partner, instance_id):
+    """Update policy evaluation for given partner"""
+    with Spinner(description="Updating policy evaluation"):
+        job_id = controller.update_evaluation(
+            partner=Control[partner], instance_id=instance_id
+        )["job_id"]
+        jobs = JobsController(account=controller.account)
+        while (result := jobs.job_status(job_id))["end_time"] is None:
+            sleep(3)
+        return result
+
+
+@scm.command("export")
+@click.argument(
+    "type",
+    type=click.Choice(
+        [c.name for c in SCMCategory if c.value > 0], case_sensitive=False
+    ),
+)
+@click.option(
+    "-o",
+    "--output_file",
+    help="csv filename to export to",
+    type=click.Path(writable=True),
+    required=True,
+)
+@click.option(
+    "--limit", default=None, help="maximum number of results to return", type=int
+)
+@click.option("--odata_filter", help="OData filter string", default=None)
+@click.option("--odata_orderby", help="OData orderby string", default=None)
+@click.pass_obj
+@pretty_print
+def export(controller, type, output_file, limit, odata_filter, odata_orderby):
+    """Export SCM data"""
+    with Spinner(description="Exporting SCM data"):
+        export = ExportController(account=controller.account)
+        jobs = JobsController(account=controller.account)
+        job_id = export.export_scm(
+            export_type=SCMCategory[type],
+            filter=odata_filter,
+            orderby=odata_orderby,
+            top=limit,
+        )["job_id"]
+        while (result := jobs.job_status(job_id))["end_time"] is None:
+            sleep(3)
+        if result["successful"]:
+            data = requests.get(result["results"]["url"], timeout=10).content
+            with open(output_file, "wb") as f:
+                f.write(data)
+        return result, f"Exported data to {output_file}"
+
+
+@scm.command("groups")
+@click.option("--odata_filter", help="OData filter string", default=None)
+@click.option("--odata_orderby", help="OData orderby string", default=None)
+@click.pass_obj
+@pretty_print
+def list_partner_groups(controller, odata_filter, odata_orderby):
+    """List all partner groups"""
+    with Spinner(description="Fetching partner groups"):
+        return controller.list_partner_groups(filter=odata_filter, orderby=odata_orderby)
+
+
+@scm.command("sync-groups")
+@click.argument(
+    "partner",
+    type=click.Choice(
+        [c.name for c in Control if c != Control.INVALID], case_sensitive=False
+    ),
+    required=True,
+)
+@click.option("--instance_id", required=True, help="instance ID of the partner")
+@click.option("--group_ids", required=True, help="comma-separated list of group IDs")
+@click.pass_obj
+@pretty_print
+def sync_groups(controller, partner, instance_id, group_ids):
+    """Update groups for a partner"""
+    with Spinner(description="Updating groups"):
+        job_id = controller.update_partner_groups(
+            partner=Control[partner],
+            instance_id=instance_id,
+            group_ids=group_ids.split(","),
+        )["job_id"]
+        jobs = JobsController(account=controller.account)
+        while (result := jobs.job_status(job_id))["end_time"] is None:
+            sleep(3)
+        return result
+
+
+@scm.command("create-threat")
+@click.argument("name")
+@click.option(
+    "-d", "--description", help="description of the threat", default=None, type=str
+)
+@click.option("--id", help="uuid for threat", default=None, type=str)
+@click.option(
+    "-g", "--generated", help="was the threat AI generated", default=False, type=bool
+)
+@click.option(
+    "-p", "--published", help="date the threat was published", default=None, type=str
+)
+@click.option(
+    "-s", "--source", help="source of threat (ex. www.cisa.gov)", default=None, type=str
+)
+@click.option(
+    "-i",
+    "--source_id",
+    help="ID of the threat, per the source (ex. aa23-075a)",
+    default=None,
+    type=str,
+)
+@click.option(
+    "-q",
+    "--techniques",
+    help="comma-separated list of techniques (MITRE ATT&CK IDs)",
+    default=None,
+    type=str,
+)
+@click.pass_obj
+@pretty_print
+def create_threat(
+    controller,
+    name,
+    description,
+    id,
+    generated,
+    published,
+    source,
+    source_id,
+    techniques,
+):
+    """Create an scm threat"""
+    with Spinner(description="Creating scm threat"):
+        return controller.create_threat(
+            name=name,
+            description=description,
+            id=id,
+            generated=generated,
+            published=published,
+            source=source,
+            source_id=source_id,
+            techniques=techniques,
+        )
+
+
+@scm.command("delete-threat")
+@click.argument("threat_id")
+@click.confirmation_option(prompt="Are you sure?")
+@click.pass_obj
+@pretty_print
+def delete_threat(controller, threat_id):
+    """Delete an scm threat"""
+    with Spinner(description="Removing scm threat"):
+        return controller.delete_threat(id=threat_id)
+
+
+@scm.command("threats")
+@click.pass_obj
+@pretty_print
+def list_threats(controller):
+    """List all scm threats"""
+    with Spinner(description="Fetching scm threats"):
+        return controller.list_threats()
+
+
+@scm.command("threat")
+@click.argument("threat_id")
+@click.pass_obj
+@pretty_print
+def get_threat(controller, threat_id):
+    """Get specific scm threat"""
+    with Spinner(description="Fetching scm threat"):
+        return controller.get_threat(id=threat_id)
+
+
+@scm.command("threat-intel")
+@click.argument(
+    "threat_pdf",
+    type=click.Path(exists=True, file_okay=True, dir_okay=False, readable=True),
+)
+@click.pass_obj
+@pretty_print
+def parse_threat_intel(controller, threat_pdf):
+    with Spinner("Parsing PDF"):
+        return controller.parse_threat_intel(threat_pdf)
+
+
+@scm.command("from-advisory")
+@click.argument(
+    "partner", type=click.Choice([Control.CROWDSTRIKE.name], case_sensitive=False)
+)
+@click.option(
+    "-a", "--advisory_id", required=True, type=str, help="Partner advisory ID"
+)
+@click.pass_obj
+@pretty_print
+def parse_from_partner_advisory(controller, partner, advisory_id):
+    with Spinner("Uploading"):
+        return controller.parse_from_partner_advisory(
+            partner=Control[partner], advisory_id=advisory_id
+        )
+
+
+@scm.command("list-notifications")
+@click.pass_obj
+@pretty_print
+def list_notifications(controller):
+    with Spinner("Fetching notifications"):
+        return controller.list_notifications()
+
+
+@scm.command("delete-notification")
+@click.argument("notification_id", type=str)
+@click.confirmation_option(prompt="Are you sure?")
+@click.pass_obj
+@pretty_print
+def delete_notification(controller, notification_id):
+    with Spinner("Deleting notification"):
+        return controller.delete_notification(notification_id)
+
+
+@scm.command("upsert-notification")
+@click.argument(
+    "control_category",
+    type=click.Choice([c.name for c in ControlCategory], case_sensitive=False),
+)
+@click.option(
+    "-e",
+    "--emails",
+    help="comma-separated list of emails to notify",
+    default=None,
+    type=str,
+)
+@click.option(
+    "-v",
+    "--event",
+    help="event to trigger notification for",
+    type=click.Choice([e.name for e in PartnerEvents], case_sensitive=False),
+    required=True,
+)
+@click.option("-f", "--filter", help="OData filter string", default=None, type=str)
+@click.option(
+    "-i", "--id", help="ID of the notification to update", default=None, type=str
+)
+@click.option("-m", "--message", help="notification message", default="", type=str)
+@click.option(
+    "-r",
+    "--run_code",
+    help="notification frequency",
+    type=click.Choice([r.name for r in RunCode], case_sensitive=False),
+    required=True,
+)
+@click.option(
+    "-s",
+    "--scheduled_hour",
+    help="scheduled UTC hour to receive notifications",
+    type=int,
+    required=True,
+)
+@click.option(
+    "-u",
+    "--slack_urls",
+    help="comma-separated list of Slack Webhook URLs to notify",
+    default=None,
+    type=str,
+)
+@click.option(
+    "-p",
+    "--suppress_empty",
+    help="suppress notifications with no results",
+    default=True,
+    type=bool,
+)
+@click.option(
+    "-u",
+    "--teams_urls",
+    help="comma-separated list of Teams Webhook URLs to notify",
+    default=None,
+    type=str,
+)
+@click.option(
+    "-t", "--title", help="notification title", default="SCM Notification", type=str
+)
+@click.pass_obj
+@pretty_print
+def upsert_notification(
+    controller,
+    control_category,
+    emails,
+    event,
+    filter,
+    id,
+    message,
+    run_code,
+    scheduled_hour,
+    slack_urls,
+    suppress_empty,
+    teams_urls,
+    title,
+):
+    """Upsert an SCM notification"""
+    with Spinner("Upserting notification"):
+        return controller.upsert_notification(
+            control_category=ControlCategory[control_category],
+            emails=emails.split(",") if emails else None,
+            event=PartnerEvents[event],
+            filter=filter,
+            id=id,
+            message=message,
+            run_code=RunCode[run_code],
+            scheduled_hour=scheduled_hour,
+            slack_urls=slack_urls.split(",") if slack_urls else None,
+            suppress_empty=suppress_empty,
+            teams_urls=teams_urls.split(",") if teams_urls else None,
+            title=title,
+        )

prelude_cli/views/shared.py

@@ -0,0 +1,37 @@
+from functools import wraps
+from rich import print_json
+from rich.progress import Progress, TextColumn, SpinnerColumn
+
+
+def pretty_print(func):
+    @wraps(func)
+    def handler(*args, **kwargs):
+        try:
+            res = func(*args, **kwargs)
+            msg = None
+            if isinstance(res, tuple):
+                res, msg = res
+            if not isinstance(res, list):
+                res = [res]
+            return print_json(data=dict(status="complete", results=res, message=msg))
+        except Exception as e:
+            return print_json(
+                data=dict(
+                    status="error",
+                    results=None,
+                    message=" ".join(str(arg) for arg in e.args),
+                )
+            )
+
+    return handler
+
+
+class Spinner(Progress):
+    def __init__(self, description="Loading"):
+        super().__init__(
+            SpinnerColumn(style="green", spinner_name="line"),
+            TextColumn("[green]{task.description}..."),
+            transient=True,
+            refresh_per_second=10,
+        )
+        self.add_task(description)

prelude_cli_beta-1396.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: prelude-cli-beta
+Version: 1396
+Summary: For interacting with the Prelude SDK
+Home-page: https://github.com/preludeorg
+Author: Prelude Research
+Author-email: support@preludesecurity.com
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: prelude-sdk==2.6.13a1396
+Requires-Dist: click>8
+Requires-Dist: rich
+Requires-Dist: python-dateutil
+Requires-Dist: pyyaml
+Dynamic: license-file
+
+# Prelude CLI
+
+Interact with the full range of features in Prelude Detect, organized by:
+
+- IAM: manage your account 
+- Build: write and maintain your collection of security tests
+- Detect: schedule security tests for your endpoints
+
+## Quick start
+```bash
+pip install prelude-cli
+prelude --help
+prelude --interactive
+```
+
+## Documentation
+
+https://docs.preludesecurity.com/docs/prelude-cli

prelude_cli_beta-1396.dist-info/RECORD

@@ -0,0 +1,22 @@
+prelude_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+prelude_cli/cli.py,sha256=uxX3WkgjEu7gSSFVtcPA-sCPoaS-2L81OfKveM3ia2I,1239
+prelude_cli/templates/README.md,sha256=uSrjMIA4dmO5gNu_KvZHVOL0gdm39nL6OJQQT8L-zhg,1120
+prelude_cli/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+prelude_cli/templates/template.go,sha256=1HAYJmM842MjiH_hnXtYMHYAuqZES4njWa4dtbZ9A_0,319
+prelude_cli/views/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+prelude_cli/views/auth.py,sha256=frbmcuQhVFRLibQBJEDppiRPdDBjGHCycUEaqIIkIhE,1859
+prelude_cli/views/build.py,sha256=casUGNyvBvE8uM9Cw1PjGQUFqLb1Rg29d_ZbZOPmmhw,16488
+prelude_cli/views/configure.py,sha256=saj0kR9mQqBp7cCmq-yfEr3UwZCZIV1vL8WDQLDAO7o,991
+prelude_cli/views/detect.py,sha256=sHc2P4kqZwrnlfxCP6JI1PjWQ3Hzky4xeNWFlZDZNWs,12992
+prelude_cli/views/generate.py,sha256=xSy0TN6wtUV5_rDolPdPPI0dp5wZC9nxhmLG0YVLc70,4664
+prelude_cli/views/iam.py,sha256=Q8Q4vWxpTRWtbXBUMeIDWT69UklihrFdtVpHaJTwGPU,9998
+prelude_cli/views/jobs.py,sha256=8F6BiPoYj3LADHa8gpbbrd2eVLetsI1g-N98i8AyPq8,1440
+prelude_cli/views/partner.py,sha256=MlcqOVDANtwBHUqGD-nROEGmptb6741HPUcFU6RF_as,6364
+prelude_cli/views/scm.py,sha256=4x5EwP0HyuiOe_Lops8qCTX52pj1y7mTGbc11FbWZHM,14000
+prelude_cli/views/shared.py,sha256=ZKvY8N1Vi6RtEbJli5PDzJ9R6L_bX2F27n1tm6Knvgs,1101
+prelude_cli_beta-1396.dist-info/licenses/LICENSE,sha256=ttdT5omfN6LNmtQoIjUhkkFhz6i44SDMRNwKrbfyTf8,1069
+prelude_cli_beta-1396.dist-info/METADATA,sha256=cLFF1BmGd_ItOlnO-9kp_e0q5weQVMjfHohXJFNYAUo,995
+prelude_cli_beta-1396.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+prelude_cli_beta-1396.dist-info/entry_points.txt,sha256=EcHxlP45Wb60ThfVcsNSEAmWdy-chL_1crJKR_9a3uU,48
+prelude_cli_beta-1396.dist-info/top_level.txt,sha256=tPjI9IbMelcZ6RUw_gqloIqK_C2yr7NJ6v6mI88xwHM,12
+prelude_cli_beta-1396.dist-info/RECORD,,

prelude_cli_beta-1396.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

prelude_cli_beta-1396.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+prelude = prelude_cli.cli:cli

prelude_cli_beta-1396.dist-info/licenses/LICENSE

@@ -0,0 +1,9 @@
+MIT LICENSE
+
+Copyright 2022, Prelude Research
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

prelude_cli_beta-1396.dist-info/top_level.txt

@@ -0,0 +1 @@
+prelude_cli