pyattackforge 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

pyattackforge/client.py

@@ -11,6 +11,7 @@ from .transport import AttackForgeTransport
 from .resources import (
     AssetsResource,
     ProjectsResource,
+    GroupsResource,
     FindingsResource,
     WriteupsResource,
     TestcasesResource,
@@ -51,6 +52,7 @@ class AttackForgeClient:
 
         self.assets = AssetsResource(self._transport)
         self.projects = ProjectsResource(self._transport)
+        self.groups = GroupsResource(self._transport)
         self.findings = FindingsResource(self._transport)
         self.writeups = WriteupsResource(self._transport)
         self.testcases = TestcasesResource(self._transport)

pyattackforge/config.py

@@ -16,7 +16,7 @@ class ClientConfig:
     timeout: float = 30.0
     max_retries: int = 3
     backoff_factor: float = 0.5
-    user_agent: str = "pyattackforge/0.2.1"
+    user_agent: str = "pyattackforge/0.2.3"
     http2: bool = True
     # Default visibility for newly created findings. False = pending/hidden.
     default_findings_visible: bool = False

pyattackforge/resources/__init__.py

@@ -2,6 +2,7 @@
 
 from .assets import AssetsResource
 from .projects import ProjectsResource
+from .groups import GroupsResource
 from .findings import FindingsResource
 from .writeups import WriteupsResource
 from .testcases import TestcasesResource
@@ -13,6 +14,7 @@ from .reports import ReportsResource
 __all__ = [
     "AssetsResource",
     "ProjectsResource",
+    "GroupsResource",
     "FindingsResource",
     "WriteupsResource",
     "TestcasesResource",

pyattackforge/resources/findings.py

@@ -36,6 +36,9 @@ class FindingsResource(BaseResource):
     def get_vulnerability(self, vulnerability_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
         return self._get(f"/api/ss/vulnerability/{vulnerability_id}", params=params)
 
+    def get_vulnerabilities_by_group(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get(f"/api/ss/groups/{group_id}/vulnerabilities", params=params)
+
     def get_project_vulnerabilities(self, project_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
         return self._get(f"/api/ss/project/{project_id}/vulnerabilities", params=params)
 

pyattackforge/resources/groups.py

@@ -0,0 +1,35 @@
+"""Resource: groups."""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from .base import BaseResource
+
+
+class GroupsResource(BaseResource):
+    """Groups API resource wrapper."""
+
+    def create_group(self, payload: Dict[str, Any]) -> Any:
+        return self._post("/api/ss/group", json=payload)
+
+    def get_groups(self, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get("/api/ss/groups", params=params)
+
+    def get_group(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get(f"/api/ss/group/{group_id}", params=params)
+
+    def update_group(self, group_id: str, payload: Dict[str, Any]) -> Any:
+        return self._put(f"/api/ss/group/{group_id}", json=payload)
+
+    def archive_group(self, group_id: str) -> Any:
+        return self._put(f"/api/ss/group/{group_id}/archive")
+
+    def restore_group(self, group_id: str) -> Any:
+        return self._put(f"/api/ss/group/{group_id}/restore")
+
+    def get_group_projects(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get(f"/api/ss/groups/{group_id}/projects", params=params)
+
+    def get_group_vulnerabilities(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get(f"/api/ss/groups/{group_id}/vulnerabilities", params=params)

pyattackforge/resources/projects.py

@@ -33,6 +33,9 @@ class ProjectsResource(BaseResource):
     def get_projects(self, params: Optional[Dict[str, Any]] = None) -> Any:
         return self._get("/api/ss/projects", params=params)
 
+    def get_projects_by_group(self, group_id: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        return self._get(f"/api/ss/groups/{group_id}/projects", params=params)
+
     def get_projects_and_vulnerabilities(self, params: Optional[Dict[str, Any]] = None) -> Any:
         return self._get("/api/ss/projects-and-vulnerabilities", params=params)
 
@@ -130,6 +133,48 @@ class ProjectsResource(BaseResource):
     def update_user_access_on_project(self, project_id: str, user_id: str, payload: Dict[str, Any]) -> Any:
         return self._put(f"/api/ss/project/{project_id}/access/{user_id}", json=payload)
 
+    def add_project_to_group(
+        self,
+        project_id: str,
+        group_id: str,
+        *,
+        project_data: Optional[Dict[str, Any]] = None,
+    ) -> Any:
+        """
+        Convenience helper to add a project to a group by updating the project's groups list.
+        """
+        if not group_id:
+            raise ValueError("group_id is required")
+        data = project_data if project_data is not None else self.get_project(project_id)
+        project = data
+        if isinstance(project, dict) and isinstance(project.get("data"), dict):
+            project = project["data"]
+        if isinstance(project, dict) and isinstance(project.get("project"), dict):
+            project = project["project"]
+        if not isinstance(project, dict):
+            raise ValueError("Project response is not a dict; cannot resolve groups")
+        groups = project.get("groups") or project.get("project_groups") or []
+        group_ids: List[str] = []
+        if isinstance(groups, list):
+            for entry in groups:
+                if isinstance(entry, str) and entry:
+                    group_ids.append(entry)
+                    continue
+                if isinstance(entry, dict):
+                    candidate = entry.get("id") or entry.get("group_id") or entry.get("_id")
+                    if isinstance(candidate, str) and candidate:
+                        group_ids.append(candidate)
+        seen: set = set()
+        deduped: List[str] = []
+        for value in group_ids:
+            if value in seen:
+                continue
+            seen.add(value)
+            deduped.append(value)
+        if group_id not in seen:
+            deduped.append(group_id)
+        return self.update_project(project_id, {"groups": deduped})
+
     def extract_projects_list(self, projects_data: Any) -> List[Dict[str, Any]]:
         if not isinstance(projects_data, dict):
             return []

{pyattackforge-0.2.1.dist-info → pyattackforge-0.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyattackforge
-Version: 0.2.1
+Version: 0.2.3
 Summary: Python SDK for the AttackForge SSAPI
 Author: hackman238
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -812,6 +812,25 @@ with AttackForgeClient() as client:
     client.link_vulnerability_to_testcases("project_id", "vuln_id", ["testcase_id"])
 ```
 
+Group management (examples):
+
+```python
+from pyattackforge import AttackForgeClient
+
+with AttackForgeClient() as client:
+    group = client.groups.create_group({
+        "name": "SDK Group",
+        "group_owner": "Owner Name",
+        "primary_contact_name": "Owner Name",
+        "primary_contact_email": "owner@example.com",
+        "primary_contact_number": "0000000000",
+    })
+    group_id = group.get("group_id") or group.get("id")
+    client.projects.add_project_to_group("project_id", group_id)
+    client.groups.get_group_projects(group_id)
+    client.groups.get_group_vulnerabilities(group_id)
+```
+
 ## Testing
 
 Unit tests:

{pyattackforge-0.2.1.dist-info → pyattackforge-0.2.3.dist-info}/RECORD

@@ -1,20 +1,21 @@
 pyattackforge/__init__.py,sha256=ebRH36uyrbMl6C4H9JejeW0cA6S9xTTzScyD69I0Jso,97
 pyattackforge/cache.py,sha256=zTGWzL4F6n4u6opCNCi0CYkkSWPx5ShZMVmDagMpPQ0,933
-pyattackforge/client.py,sha256=E99KuD71q_geRiwMLdcJMUi_hdRJJUu8lPyC6Q-hVAk,5590
-pyattackforge/config.py,sha256=tqiE_ZtbpanWRLUcTh0TRprHXSdySAFP-24h6GlIsi8,2240
+pyattackforge/client.py,sha256=C_nCWuQByRr3GwZVIVUjdsrNA5j-Gv0ttkqig1GkwFg,5664
+pyattackforge/config.py,sha256=m6Fpqj8JUGbeWG5SXLIXZR-yO0YYvYxCd3ahWNiH5TI,2240
 pyattackforge/exceptions.py,sha256=YFzV7VQ3UkOGXKpHhXctuM7fZUtR4LgYuPR_po4pksA,592
 pyattackforge/transport.py,sha256=slYM9zqleyWlTiUpZZfF0CVB95I0u8UMkqsK09Qa9W4,6500
-pyattackforge/resources/__init__.py,sha256=n0C-HZDqBHKfxM7utqKXkGtDES3i-7OzEHcRyUstXHY,589
+pyattackforge/resources/__init__.py,sha256=Tim25zMXM8FoprSyh_r2PJQjouWUq4FxfqMvNT6RI_g,646
 pyattackforge/resources/assets.py,sha256=cVe4PrLp3Afxv52SBekQZaiDvQpV7zCKN6bLkUHl-uA,1420
 pyattackforge/resources/base.py,sha256=x5C8SG2MfwCtOkcRi8plDTF6TkJqXz-b58KS4qkP0Zw,1286
-pyattackforge/resources/findings.py,sha256=krl-IODoUFQ1pfsx4SkTCuKICdSsp1Zc1MWwrF2iYRM,34147
+pyattackforge/resources/findings.py,sha256=KjCKUqdffL8-5j4I0srxNgpjR3gLbfck_WQKyX04FEE,34341
+pyattackforge/resources/groups.py,sha256=RR1kWW0kBPT6QPoV0pD59X-tnu5ViP_cTjLE9p7ghaA,1358
 pyattackforge/resources/notes.py,sha256=r-TR3QuatrhGzwmoR7AQt7wiHXTrvmMvm7rYtkBCOkQ,5741
-pyattackforge/resources/projects.py,sha256=6pDvOp7s81KvzNgONo04rqWzVXGggbdPXvOnEnBEz9A,7262
+pyattackforge/resources/projects.py,sha256=i9IU4yObv4u4hmcmg7aiXrucsLw966ywhpEBILYx2XE,9201
 pyattackforge/resources/reports.py,sha256=43wDK8SB2qqz-tjerjFBOV4G9EcgLk5WL3O8H-On5b0,805
 pyattackforge/resources/users.py,sha256=8SF_3QdNQalsyU-60V_oJtsJbo6nHkI3WPbCBebEkrk,2275
 pyattackforge/resources/writeups.py,sha256=iBShGQFrwYie3Gx8F0ekSOW0rf_ZzziRDsRpdQYUsSg,3001
-pyattackforge-0.2.1.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
-pyattackforge-0.2.1.dist-info/METADATA,sha256=0AaifLGznCHYGlElu6SUJzw-bid2LYmwVjKjn_uKAlU,46131
-pyattackforge-0.2.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-pyattackforge-0.2.1.dist-info/top_level.txt,sha256=1rDeMkWvFWuX3MS8V65no7KuybYyvtfIgbYSt5m_uPU,14
-pyattackforge-0.2.1.dist-info/RECORD,,
+pyattackforge-0.2.3.dist-info/licenses/LICENSE,sha256=hIahDEOTzuHCU5J2nd07LWwkLW7Hko4UFO__ffsvB-8,34523
+pyattackforge-0.2.3.dist-info/METADATA,sha256=xiUYFVZ9dJcefPjZGtK_yx8OCJ-HvjnNP2FqSr3TR40,46741
+pyattackforge-0.2.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+pyattackforge-0.2.3.dist-info/top_level.txt,sha256=1rDeMkWvFWuX3MS8V65no7KuybYyvtfIgbYSt5m_uPU,14
+pyattackforge-0.2.3.dist-info/RECORD,,