graylog-api-client 0.1.4__tar.gz → 0.2.0__tar.gz

{graylog_api_client-0.1.4 → graylog_api_client-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: graylog-api-client
-Version: 0.1.4
+Version: 0.2.0
 Summary: A Python wrapper for the Graylog REST API
 License-Expression: MIT
 License-File: LICENSE
@@ -11,6 +11,7 @@ Requires-Python: >=3.13
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Requires-Dist: requests (>=2.32.5,<3.0.0)
 Project-URL: Repository, https://github.com/Chrxxxxs/graylog_api_client
 Description-Content-Type: text/markdown
@@ -19,7 +20,7 @@ Description-Content-Type: text/markdown
 As there are a lot of endpoints not all of them are implemented by now. I started by implementing the GET requests first.
 Also the API responses all follow very different schemas and an implementation of that into Python is probably not worth the effort which is why the responses from this API are so low-level.
 Feel free to add endpoints or schemas in PRs if you need them :)
-#### Last tested Graylog Version is: 6.3.4
+#### Last tested Graylog Major Version is: 7
 
 ### Example Usage
 

{graylog_api_client-0.1.4 → graylog_api_client-0.2.0}/README.md

@@ -2,7 +2,7 @@
 As there are a lot of endpoints not all of them are implemented by now. I started by implementing the GET requests first.
 Also the API responses all follow very different schemas and an implementation of that into Python is probably not worth the effort which is why the responses from this API are so low-level.
 Feel free to add endpoints or schemas in PRs if you need them :)
-#### Last tested Graylog Version is: 6.3.4
+#### Last tested Graylog Major Version is: 7
 
 ### Example Usage
 

{graylog_api_client-0.1.4 → graylog_api_client-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "graylog-api-client"
-version = "0.1.4"
+version = "0.2.0"
 description = "A Python wrapper for the Graylog REST API"
 authors = [
     {name = "Chrxxxxs",email = "134285960+Chrxxxxs@users.noreply.github.com"}

{graylog_api_client-0.1.4 → graylog_api_client-0.2.0}/src/graylog_api_client/data_structures.py

@@ -23,4 +23,4 @@ class GraylogTimerange:
     def relative(range: int):
         ...
     def absolute(from_time: str, to_time: str):
-        ...
+        ...

graylog_api_client-0.2.0/src/graylog_api_client/endpoints/authz.py

@@ -0,0 +1,27 @@
+from ..data_structures import GraylogApiResult
+from ..rest_adapter import RestAdapter
+from typing import Dict
+
+class Endpoint_AUTH:
+    def __init__(self, rest_adapter: RestAdapter):
+        self._rest_adapter = rest_adapter
+
+    def get_grants_overview(self) -> GraylogApiResult:
+        overview = self._rest_adapter.get("authz/grants-overview")
+        return overview
+
+    def get_roles(self, parameters: Dict = None) -> GraylogApiResult:
+        roles = self._rest_adapter.get("authz/roles", parameters)
+        return roles
+
+    def get_roles_of_user(self, username: str, parameters: Dict = None) -> GraylogApiResult:
+        roles = self._rest_adapter.get(f"authz/roles/user/{username}", parameters)
+        return roles
+
+    def get_role_by_id(self, role_id: str) -> GraylogApiResult:
+        roles = self._rest_adapter.get(f"authz/roles/{role_id}")
+        return roles
+
+    def get_assignees_of_role(self, role_id: str, parameters: Dict = None) -> GraylogApiResult:
+        assignees = self._rest_adapter.get(f"authz/roles/{role_id}/assignees", parameters)
+        return assignees

graylog_api_client-0.2.0/src/graylog_api_client/endpoints/plugins/SecurityApp.py

@@ -0,0 +1,101 @@
+from ...data_structures import GraylogApiResult
+from ...rest_adapter import RestAdapter
+from typing import Union, Dict
+from datetime import datetime
+
+class SecurityApp:
+    def __init__(self, rest_adapter: RestAdapter):
+        self._rest_adapter = rest_adapter
+        self.Assets = Assets(rest_adapter)
+
+class Assets:
+    def __init__(self, rest_adapter: RestAdapter):
+        self._rest_adapter = rest_adapter
+    
+    def get_assets(self, *, sort: str = "name", page: int = 1, per_page: int = 15, query: str = "",\
+                               filters: str = "", direction: str = "asc") -> GraylogApiResult:
+        parameters = {
+            "sort": sort,
+            "page": page,
+            "per_page": per_page,
+            "query": query,
+            "filters": filters,
+            "direction": direction,
+        }
+        result = self._rest_adapter.get("plugins/org.graylog.plugins.securityapp.asset/assets", parameters)
+        return result
+    
+    # The API Browser is very confusing/wrong for creating assets
+    def create_user_asset(
+        self, *, name: str, usernames: list[str], user_ids: list[str] = [], email_addresses: list[str] = [], first_name: str = "", last_name: str = "", category: list[str] = [], priority: int = 1
+    ) -> GraylogApiResult:
+        """Create a user asset."""
+        data = {
+            "category": category,
+            "details": {
+                "type": "user",
+                "usernames": usernames,
+                "user_ids": user_ids,
+                "email_addresses": email_addresses,
+                "first_name": first_name,
+                "last_name": last_name,
+            },
+            "name": name,
+            "priority": priority,
+        }
+        result = self._rest_adapter.post("plugins/org.graylog.plugins.securityapp.asset/assets", data=data)
+        return result
+    
+    def create_machine_asset(
+        self, *, name: str, hostnames: list[str], ip_addresses: list[str] = [], mac_addresses: list[str] = [], category: list[str] = [], custom_fields: dict[str, str] = {},
+        description: str = "", geo_info: dict[str, int|str] = {}, owner: str = "", priority: int = 1
+    ) -> GraylogApiResult:
+        """Create a machine asset."""
+        data = {
+            "category": category,
+            "details": {
+                "type": "machine",
+                "hostnames": hostnames,
+                "ip_addresses": ip_addresses,
+                "mac_addresses": mac_addresses,
+                "custom_fields": custom_fields,
+                "description": description,
+                "geo_info": geo_info,
+                "owner": owner,
+            },
+            "name": name,
+            "priority": priority,
+        }
+        result = self._rest_adapter.post("plugins/org.graylog.plugins.securityapp.asset/assets", data=data)
+        return result
+    
+    def add_categories_to_multiple_assets(self, *, asset_ids: list[str], categories: list[str]) -> GraylogApiResult:
+        # Untested
+        data = {
+            "asset_ids": asset_ids,
+            "categories": categories,
+        }
+        result = self._rest_adapter.put("plugins/org.graylog.plugins.securityapp.asset/assets/bulk/categories_add", data=data)
+        return result
+
+    def get_asset_by_id_detailed(self, asset_id: str) -> GraylogApiResult:
+        result = self._rest_adapter.get(
+            f"plugins/org.graylog.plugins.securityapp.asset/assets/{asset_id}"
+        )
+        return result
+    
+    def edit_asset_by_id(self, asset_id: str, **updates) -> GraylogApiResult:
+        """Edit the asset with the given ID by passing the updates as keyword arguments."""
+        current_state = self.get_asset_by_id_detailed(asset_id)
+        payload = current_state.data
+        payload.update(updates)
+        result = self._rest_adapter.put(
+            f"plugins/org.graylog.plugins.securityapp.asset/assets/{asset_id}", data=payload
+        )
+        return result
+    
+    def delete_asset_by_id(self, asset_id: str) -> GraylogApiResult:
+        result = self._rest_adapter.delete(
+            f"plugins/org.graylog.plugins.securityapp.asset/assets/{asset_id}"
+        )
+        return result

graylog_api_client-0.2.0/src/graylog_api_client/endpoints/plugins/__init__.py

@@ -0,0 +1,7 @@
+from ...rest_adapter import RestAdapter
+from .SecurityApp import SecurityApp
+
+class Plugins:
+    def __init__(self, rest_adapter: RestAdapter):
+        self._rest_adapter = rest_adapter
+        self.SecurityApp = SecurityApp(rest_adapter)

{graylog_api_client-0.1.4 → graylog_api_client-0.2.0}/src/graylog_api_client/graylog_api_client.py

@@ -1,8 +1,11 @@
 import logging
+from datetime import datetime
 from typing import List, Literal, Union, Dict
 
 from .rest_adapter import RestAdapter
 from .data_structures import GraylogApiResult
+from .endpoints.authz import Endpoint_AUTH
+from .endpoints.plugins import Plugins
 
 
 class GraylogAPI:
@@ -15,27 +18,29 @@ class GraylogAPI:
         :param logger: The logger being used by the Adapter, will use a new one if none is given, defaults to None
         """
         self._rest_adapter = RestAdapter(host=host, api_key=api_key, ssl_verify=ssl_verify, logger=logger)
+        self.authz = Endpoint_AUTH(rest_adapter=self._rest_adapter)
+        self.plugins = Plugins(rest_adapter=self._rest_adapter)
 
     # The endpoints grouped like they are in the api-browser
     # /authz Authorization
     def get_auth_grants_overview(self) -> GraylogApiResult:
-        overview = self._rest_adapter.get("authz/grants-overview")
+        overview = self.authz.get_grants_overview()
         return overview
 
     def get_auth_roles(self, parameters: Dict = None) -> GraylogApiResult:
-        roles = self._rest_adapter.get("authz/roles", parameters)
+        roles = self.authz.get_roles(parameters)
         return roles
 
     def get_auth_roles_of_user(self, username: str, parameters: Dict = None) -> GraylogApiResult:
-        roles = self._rest_adapter.get(f"authz/roles/user/{username}", parameters)
+        roles = self.authz.get_roles_of_user(username, parameters)
         return roles
 
     def get_auth_role_by_id(self, role_id: str) -> GraylogApiResult:
-        roles = self._rest_adapter.get(f"authz/roles/{role_id}")
+        roles = self.authz.get_role_by_id(role_id)
         return roles
 
     def get_auth_assignees_of_role(self, role_id: str, parameters: Dict = None) -> GraylogApiResult:
-        assignees = self._rest_adapter.get(f"authz/roles/{role_id}/assignees", parameters)
+        assignees = self.authz.get_assignees_of_role(role_id, parameters)
         return assignees
 
     # /ca

{graylog_api_client-0.1.4 → graylog_api_client-0.2.0}/src/graylog_api_client/rest_adapter.py

@@ -37,7 +37,7 @@ class RestAdapter:
         """
         url = self.host + endpoint
         log_line_pre = f"method={method}, url={url}, parameters={parameters}"
-        log_line_post = ', '.join((log_line_pre, "success={}, status_code={}, message={}"))
+        log_line_post = "{}, success={}, status_code={}, message={}"
         try:
             self._logger.debug(msg=log_line_pre)
             response = self._session.request(method=method, url=url, verify=self._ssl_verify, params=parameters, json=data)
@@ -50,10 +50,10 @@ class RestAdapter:
             else:
                 data_out = None
         except (ValueError, requests.exceptions.JSONDecodeError) as e:
-            self._logger.error(msg=log_line_post.format(False, None, e))
+            self._logger.error(msg=log_line_post.format(log_line_pre, False, None, e))
             raise GraylogApiException("Bad JSON in response") from e
         is_success = 299 >= response.status_code >= 200  # OK
-        log_line = log_line_post.format(is_success, response.status_code, response.reason)
+        log_line = log_line_post.format(log_line_pre, is_success, response.status_code, response.reason)
         if is_success:
             self._logger.debug(msg=log_line)
             return GraylogApiResult(status_code=response.status_code, message=response.reason, data=data_out)