prelude-sdk-beta 1402__tar.gz → 1404__tar.gz

{prelude_sdk_beta-1402 → prelude_sdk_beta-1404}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prelude-sdk-beta
-Version: 1402
+Version: 1404
 Summary: For interacting with the Prelude API
 Home-page: https://github.com/preludeorg
 Author: Prelude Research

{prelude_sdk_beta-1402 → prelude_sdk_beta-1404}/prelude_sdk_beta/controllers/build_controller.py

@@ -271,7 +271,10 @@ class BuildController(HttpController):
             headers=self.account.headers,
             timeout=10,
         )
-        return res.json()
+        threat_hunt = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(threat_hunt, [(Control, "control")])
+        return threat_hunt
 
     @verify_credentials
     def update_threat_hunt(
@@ -296,7 +299,10 @@ class BuildController(HttpController):
             headers=self.account.headers,
             timeout=10,
         )
-        return res.json()
+        threat_hunt = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(threat_hunt, [(Control, "control")])
+        return threat_hunt
 
     @verify_credentials
     def delete_threat_hunt(self, threat_hunt_id: str):

{prelude_sdk_beta-1402 → prelude_sdk_beta-1404}/prelude_sdk_beta/controllers/detect_controller.py

@@ -1,5 +1,6 @@
 from prelude_sdk_beta.controllers.http_controller import HttpController
 from prelude_sdk_beta.models.account import verify_credentials
+from prelude_sdk_beta.models.codes import Control, RunCode
 
 
 class DetectController(HttpController):
@@ -59,7 +60,10 @@ class DetectController(HttpController):
             params=params,
             timeout=10,
         )
-        return res.json()
+        endpoints = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(endpoints, [(Control, "control")])
+        return endpoints
 
     @verify_credentials
     def describe_activity(self, filters: dict, view: str = "protected"):
@@ -169,7 +173,10 @@ class DetectController(HttpController):
             params=filters if filters else {},
             timeout=10,
         )
-        return res.json()
+        threat_hunts = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(threat_hunts, [(Control, "control")])
+        return threat_hunts
 
     @verify_credentials
     def get_threat_hunt(self, threat_hunt_id):
@@ -179,7 +186,10 @@ class DetectController(HttpController):
             headers=self.account.headers,
             timeout=10,
         )
-        return res.json()
+        threat_hunt = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(threat_hunt, [(Control, "control")])
+        return threat_hunt
 
     @verify_credentials
     def do_threat_hunt(self, threat_hunt_id):
@@ -214,7 +224,10 @@ class DetectController(HttpController):
             json=dict(items=items),
             timeout=10,
         )
-        return res.json()
+        schedule = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(schedule, [(RunCode, "run_code")])
+        return schedule
 
     @verify_credentials
     def unschedule(self, items: list):

{prelude_sdk_beta-1402 → prelude_sdk_beta-1404}/prelude_sdk_beta/controllers/http_controller.py

@@ -22,6 +22,26 @@ class HttpController(object):
         self._session.mount("http://", HTTPAdapter(max_retries=retry))
         self._session.mount("https://", HTTPAdapter(max_retries=retry))
 
+    def resolve_enums(self, data, enum_params: list[tuple]):
+        for [enum_class, key] in enum_params:
+            self._resolve_enum(data, enum_class, key)
+
+    def _resolve_enum(self, data, enum_class, key):
+        if isinstance(data, list):
+            for item in data:
+                if isinstance(item, dict):
+                    self._resolve_enum(item, enum_class, key)
+        elif isinstance(data, dict):
+            for k, v in data.items():
+                if k == key:
+                    if isinstance(v, list):
+                        for i, item in enumerate(v):
+                            v[i] = enum_class[item].name
+                    elif v is not None:
+                        data[k] = enum_class[v].name
+                elif isinstance(v, dict) or isinstance(v, list):
+                    self._resolve_enum(v, enum_class, key)
+
     def get(self, url, retry=True, **kwargs):
         res = self._session.get(url, **kwargs)
         if res.status_code == 200:

{prelude_sdk_beta-1402 → prelude_sdk_beta-1404}/prelude_sdk_beta/controllers/iam_controller.py

@@ -1,6 +1,6 @@
 from prelude_sdk_beta.controllers.http_controller import HttpController
 from prelude_sdk_beta.models.account import verify_credentials
-from prelude_sdk_beta.models.codes import Mode, Permission
+from prelude_sdk_beta.models.codes import Control, Mode, Permission
 
 
 class IAMAccountController(HttpController):
@@ -14,7 +14,12 @@ class IAMAccountController(HttpController):
         res = self.get(
             f"{self.account.hq}/iam/account", headers=self.account.headers, timeout=10
         )
-        return res.json()
+        account = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(
+                account, [(Mode, "mode"), (Permission, "permission"), (Control, "id")]
+            )
+        return account
 
     @verify_credentials
     def purge_account(self):
@@ -100,7 +105,10 @@ class IAMAccountController(HttpController):
             headers=self.account.headers,
             timeout=10,
         )
-        return res.json()
+        user = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(user, [(Permission, "permission")])
+        return user
 
     @verify_credentials
     def create_service_user(self, name: str):
@@ -173,7 +181,6 @@ class IAMAccountController(HttpController):
         )
         return res.json()
 
-
     def sign_up(self, company, email, name):
         """(NOT AVAIABLE IN PRODUCTION) Create a new user and account"""
         body = dict(company=company, email=email, name=name)

{prelude_sdk_beta-1402 → prelude_sdk_beta-1404}/prelude_sdk_beta/controllers/jobs_controller.py

@@ -1,5 +1,8 @@
+from itertools import chain
+
 from prelude_sdk_beta.controllers.http_controller import HttpController
 from prelude_sdk_beta.models.account import verify_credentials
+from prelude_sdk_beta.models.codes import BackgroundJobTypes, Control
 
 
 class JobsController(HttpController):
@@ -13,7 +16,10 @@ class JobsController(HttpController):
         res = self.get(
             f"{self.account.hq}/jobs/statuses", headers=self.account.headers, timeout=30
         )
-        return res.json()
+        jobs = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(jobs, [(Control, "control")])
+        return jobs
 
     @verify_credentials
     def job_status(self, job_id: str):
@@ -23,4 +29,9 @@ class JobsController(HttpController):
             headers=self.account.headers,
             timeout=30,
         )
-        return res.json()
+        job = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(
+                job, [(Control, "control"), (BackgroundJobTypes, "job_type")]
+            )
+        return job

{prelude_sdk_beta-1402 → prelude_sdk_beta-1404}/prelude_sdk_beta/controllers/scm_controller.py

@@ -4,8 +4,9 @@ from prelude_sdk_beta.models.codes import (
     Control,
     ControlCategory,
     PartnerEvents,
+    PolicyType,
+    NotationType,
     RunCode,
-    SCMCategory,
 )
 
 
@@ -25,7 +26,18 @@ class ScmController(HttpController):
             params=params,
             timeout=30,
         )
-        return res.json()
+        data = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(
+                data,
+                [
+                    (Control, "controls"),
+                    (Control, "control"),
+                    (ControlCategory, "category"),
+                    (PartnerEvents, "event"),
+                ],
+            )
+        return data
 
     @verify_credentials
     def inboxes(self, filter: str = None, orderby: str = None, top: int = None):
@@ -37,7 +49,18 @@ class ScmController(HttpController):
             params=params,
             timeout=30,
         )
-        return res.json()
+        data = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(
+                data,
+                [
+                    (Control, "controls"),
+                    (Control, "control"),
+                    (ControlCategory, "category"),
+                    (PartnerEvents, "event"),
+                ],
+            )
+        return data
 
     @verify_credentials
     def users(self, filter: str = None, orderby: str = None, top: int = None):
@@ -49,7 +72,18 @@ class ScmController(HttpController):
             params=params,
             timeout=30,
         )
-        return res.json()
+        data = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(
+                data,
+                [
+                    (Control, "controls"),
+                    (Control, "control"),
+                    (ControlCategory, "category"),
+                    (PartnerEvents, "event"),
+                ],
+            )
+        return data
 
     @verify_credentials
     def technique_summary(self, techniques: str):
@@ -84,7 +118,12 @@ class ScmController(HttpController):
             headers=self.account.headers,
             timeout=30,
         )
-        return res.json()
+        data = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(
+                data, [(Control, "control"), (ControlCategory, "category")]
+            )
+        return data
 
     @verify_credentials
     def evaluation(
@@ -104,7 +143,10 @@ class ScmController(HttpController):
             headers=self.account.headers,
             timeout=30,
         )
-        return res.json()
+        data = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(data, [(PolicyType, "policy_type")])
+        return data
 
     @verify_credentials
     def update_evaluation(self, partner: Control, instance_id: str):
@@ -126,7 +168,10 @@ class ScmController(HttpController):
             params=params,
             timeout=10,
         )
-        return res.json()
+        groups = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(groups, [(Control, "control")])
+        return groups
 
     @verify_credentials
     def update_partner_groups(
@@ -150,7 +195,10 @@ class ScmController(HttpController):
             headers=self.account.headers,
             timeout=10,
         )
-        return res.json()
+        exceptions = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(exceptions, [(ControlCategory, "category")])
+        return exceptions
 
     @verify_credentials
     def create_object_exception(
@@ -208,7 +256,12 @@ class ScmController(HttpController):
             headers=self.account.headers,
             timeout=10,
         )
-        return res.json()
+        exceptions = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(
+                exceptions, [(Control, "control"), (ControlCategory, "category")]
+            )
+        return exceptions
 
     @verify_credentials
     def create_policy_exception(
@@ -240,13 +293,13 @@ class ScmController(HttpController):
         setting_names=None,
     ):
         """Update policy exceptions"""
-        body = dict(control=partner.name, instance_id=instance_id)
+        body = dict(control=partner.name, instance_id=instance_id, policy_id=policy_id)
         if expires != self.default:
             body["expires"] = expires
         if setting_names:
             body["setting_names"] = setting_names
-        res = self.post(
-            f"{self.account.hq}/scm/exceptions/policies/{policy_id}",
+        res = self.put(
+            f"{self.account.hq}/scm/exceptions/policies",
             json=body,
             headers=self.account.headers,
             timeout=10,
@@ -256,9 +309,9 @@ class ScmController(HttpController):
     @verify_credentials
     def delete_policy_exception(self, instance_id: str, policy_id: str):
         """Delete policy exceptions"""
-        body = dict(instance_id=instance_id)
+        body = dict(instance_id=instance_id, policy_id=policy_id)
         res = self.delete(
-            f"{self.account.hq}/scm/exceptions/policies/{policy_id}",
+            f"{self.account.hq}/scm/exceptions/policies",
             json=body,
             headers=self.account.headers,
             timeout=10,
@@ -273,7 +326,10 @@ class ScmController(HttpController):
             headers=self.account.headers,
             timeout=10,
         )
-        return res.json()
+        views = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(views, [(ControlCategory, "category")])
+        return views
 
     @verify_credentials
     def create_view(self, category: ControlCategory, filter: str, name: str):
@@ -412,7 +468,17 @@ class ScmController(HttpController):
             headers=self.account.headers,
             timeout=10,
         )
-        return res.json()
+        notifications = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(
+                notifications,
+                [
+                    (ControlCategory, "control_category"),
+                    (PartnerEvents, "event"),
+                    (RunCode, "run_code"),
+                ],
+            )
+        return notifications
 
     @verify_credentials
     def delete_notification(self, notification_id: str):
@@ -472,7 +538,10 @@ class ScmController(HttpController):
             headers=self.account.headers,
             timeout=10,
         )
-        return res.json()
+        notations = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(notations, [(NotationType, "event")])
+        return notations
 
     @verify_credentials
     def list_history(
@@ -486,4 +555,14 @@ class ScmController(HttpController):
             params=params,
             timeout=10,
         )
-        return res.json()
+        history = res.json()
+        if self.account.resolve_enums:
+            self.resolve_enums(
+                history,
+                [
+                    (Control, "control"),
+                    (ControlCategory, "category"),
+                    (PartnerEvents, "event"),
+                ],
+            )
+        return history

{prelude_sdk_beta-1402 → prelude_sdk_beta-1404}/prelude_sdk_beta/models/account.py

@@ -83,7 +83,7 @@ def exchange_token(
 class Account:
 
     @staticmethod
-    def from_keychain(profile: str = "default"):
+    def from_keychain(profile: str = "default", resolve_enums: bool = False):
         """
         Create an account object from a pre-configured profile in your keychain file
         """
@@ -100,6 +100,7 @@ class Account:
             oidc=profile_items.get("oidc"),
             profile=profile,
             slug=profile_items.get("slug"),
+            resolve_enums=resolve_enums,
         )
 
     @staticmethod
@@ -111,6 +112,7 @@ class Account:
         hq: str = "https://api.us1.preludesecurity.com",
         oidc: str | None = None,
         slug: str | None = None,
+        resolve_enums: bool = False,
     ):
         """
         Create an account object from an access token or a refresh token
@@ -131,6 +133,7 @@ class Account:
             slug=slug,
             token=token,
             token_location=None,
+            resolve_enums=resolve_enums,
         )
 
 
@@ -151,6 +154,7 @@ class _Account:
         token_location: str | None = os.path.join(
             Path.home(), ".prelude", "tokens.json"
         ),
+        resolve_enums: bool = False,
     ):
         if token is None and token_location is None:
             raise ValueError(
@@ -168,6 +172,7 @@ class _Account:
         self.slug = slug
         self.token = token
         self.token_location = token_location
+        self.resolve_enums = resolve_enums
         if self.token_location and not os.path.exists(self.token_location):
             head, _ = os.path.split(Path(self.token_location))
             Path(head).mkdir(parents=True, exist_ok=True)

{prelude_sdk_beta-1402 → prelude_sdk_beta-1404}/prelude_sdk_beta.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prelude-sdk-beta
-Version: 1402
+Version: 1404
 Summary: For interacting with the Prelude API
 Home-page: https://github.com/preludeorg
 Author: Prelude Research

{prelude_sdk_beta-1402 → prelude_sdk_beta-1404}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = prelude-sdk-beta
-version = 1402
+version = 1404
 author = Prelude Research
 author_email = support@preludesecurity.com
 description = For interacting with the Prelude API