algosec-appviz 0.0.2__py3-none-any.whl → 0.0.5__py3-none-any.whl

algosec_appviz/__init__.py

@@ -0,0 +1,3 @@
+from .main import AppViz
+
+__all__ = ["AppViz"]

algosec_appviz/main.py

@@ -2,15 +2,28 @@ import requests
 from algosec_appviz import environment
 from mydict import MyDict
 
+regions = {
+    'eu': 'eu.app.algosec.com',
+    'us': 'us.app.algosec.com',
+    'anz': 'anz.app.algosec.com',
+    'me': 'me.app.algosec.com',
+    'uae': 'uae.app.algosec.com',
+    'ind': 'ind.app.algosec.com',
+    'sgp': 'sgp.app.algosec.com'
+}
 
-class AlgoSecAppViz:
-    def __init__(self, tenant_id, client_id, client_secret):
-        self.url = "https://eu.app.algosec.com/api/algosaas/auth/v1/access-keys/login"
+
+class AppViz:
+    def __init__(self, region='eu', tenant_id=None, client_id=None, client_secret=None):
+        if region not in regions.keys():
+            raise ValueError(f"Invalid region, must be one of: {', '.join(regions.keys())}")
+
+        login_url = f"https://{regions[region]}/api/algosaas/auth/v1/access-keys/login"
 
         data = {
-            "tenantId": environment.get_tenant_id(),
-            "clientId": environment.get_client_id(),
-            "clientSecret": environment.get_client_secret()
+            "tenantId": tenant_id or environment.get_tenant_id(),
+            "clientId": client_id or environment.get_client_id(),
+            "clientSecret": client_secret or environment.get_client_secret()
         }
 
         headers = {
@@ -18,41 +31,82 @@ class AlgoSecAppViz:
             "Accept": "application/json"
         }
 
-        response = requests.post(self.url, json=data, headers=headers)
+        response = requests.post(login_url, json=data, headers=headers)
         if response.status_code != 200:
             raise ConnectionError(f"Authentication to AppViz failed: {response.text}")
+        self.url = 'https://' + regions[region]
         self._token_type = response.json()['token_type']
         self._token = response.json()['access_token']
 
-    def get_applications(self):
-        url = 'https://eu.app.algosec.com/BusinessFlow/rest/v1/applications'
-        headers = {
-            'Accept': 'application/json',
-            'Authorization': f'{self._token_type} {self._token}'
+    def create_application(self, name=None, **kwargs):
+        if not name:
+            raise ValueError("Name is required")
+
+        body = {
+            'name': name,
+            **kwargs
         }
 
-        response = requests.get(url, headers=headers)
-        return [MyDict(x) for x in response.json()]
+        result = self._make_api_call('POST',
+                                       '/BusinessFlow/rest/v1/applications/new',
+                                       body=body)
 
-    def get_network_objects(self):
-        url = 'https://eu.app.algosec.com/ObjectFlow/rest/v1/network_objects/name/'
-        headers = {
-            'Accept': 'application/json',
-            'Authorization': f'{self._token_type} {self._token}'
+        return result
+
+    def create_network_object(self, name=None, obj_type=None, content=None, **kwargs):
+        valid_object_types = ['Range', 'Host', 'Group', 'Abstract']
+
+        if not name:
+            raise ValueError("Object name is required")
+        if not obj_type:
+            raise ValueError("Object type is required")
+        if obj_type not in valid_object_types:
+            raise ValueError(f"Object type invalid, allowed values: {', '.join(valid_object_types)}")
+
+        body = {
+            'name': name,
+            'type': obj_type,
+            'content': content,
+            **kwargs
         }
 
-        response = requests.get(url, headers=headers)
-        return [MyDict(x) for x in response.json()]
+        result = self._make_api_call('POST',
+                                     '/BusinessFlow/rest/v1/network_objects/new',
+                                     body=body)
+
+        return result
+
+    def get_applications(self):
+        response = self._make_api_call('GET',
+                                       '/BusinessFlow/rest/v1/applications')
+
+        return [MyDict(x) for x in response]
 
-    def _make_api_call(self, method, url):
+    def list_network_objects(self, page_number=1, page_size=1000):
+        response = self._make_api_call('GET',
+                                       '/BusinessFlow/rest/v1/network_objects/',
+                                       params={'page_number': page_number, 'page_size': page_size})
+
+        return [MyDict(x) for x in response]
+
+    def search_exact_object(self, content):
+        response = self._make_api_call('GET',
+                                       '/BusinessFlow/rest/v1/network_objects/find',
+                                       params={'address': content, 'type': 'EXACT'})
+
+        return [MyDict(x) for x in response]
+
+    def _make_api_call(self, method, url_path, body=None, params=None):
         headers = {
             'Accept': 'application/json',
             'Authorization': f'{self._token_type} {self._token}'
         }
 
         if method.lower() == 'get':
-            response = requests.get(url, headers=headers)
+            response = requests.get(self.url + url_path, headers=headers, json=body, params=params)
         elif method.lower() == 'post':
-            response = requests.get(url, headers=headers)
+            response = requests.post(self.url + url_path, headers=headers, json=body, params=params)
         else:
-            raise AssertionError("Invalid method, must be: 'GET' or 'POST'")
+            raise ValueError("Invalid method, must be: 'GET' or 'POST'")
+
+        return response.json()

{algosec_appviz-0.0.2.dist-info → algosec_appviz-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: algosec_appviz
-Version: 0.0.2
+Version: 0.0.5
 Summary: AlgoSec AppViz Library
 Home-page: https://github.com/bogdan-iot/algosec-appviz
 License: LICENSE
@@ -22,7 +22,12 @@ Description-Content-Type: text/markdown
 
 # AlgoSec AppViz Python Library
 
-Unofficial library to interract with AlgoSec AppViz in Python.
+Unofficial library to interact with AlgoSec AppViz in Python. Official API documentation can be found here:  
+https://api-docs.algosec.com/docs/appvizsaas-api-docs/lr8pw057bsh37-welcome-to-the-app-viz-api-reference
+
+## API Endpoint
+**Important Note:** If not specified, the EU region will be used. If your tenant is provisioned in a different
+region, this needs to be provided when creating the class instance.
 
 ## Installation
 
@@ -30,3 +35,22 @@ Unofficial library to interract with AlgoSec AppViz in Python.
 $ pip install algosec_appviz
 ```
 
+## Environment Variables
+
+The following Environment Variables will be automatically read if set:  
+TENANT_ID  
+CLIENT_ID  
+CLIENT_SECRET
+
+## Usage
+
+```python
+from algosec_appviz import AppViz
+
+# Use automatically loaded environment variables as mentioned above
+appviz_inst = AppViz()
+
+# Provide parameters in code
+appviz_inst = AppViz(region='us', tenant_id='xxx', client_id='xxx', client_secret='xxx')
+```
+

algosec_appviz-0.0.5.dist-info/RECORD

@@ -0,0 +1,7 @@
+algosec_appviz/__init__.py,sha256=epwLWpezNwfYP0Zuqk32rWEvNeloAKzbrRFi9tzlsXo,46
+algosec_appviz/environment.py,sha256=ycrVSpR6oLpj9p54SvDdy0nqwS9IwHAh-1x-zOaTQ5I,1775
+algosec_appviz/main.py,sha256=h96IyEVtELXmmGuvxrQojh9L45c0ssDG7UB2WPZX4J0,4028
+algosec_appviz-0.0.5.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+algosec_appviz-0.0.5.dist-info/METADATA,sha256=aIriv-vJisyeYbnd3K3Qdct_XL_M4GRTyq0ievrAgEo,1798
+algosec_appviz-0.0.5.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+algosec_appviz-0.0.5.dist-info/RECORD,,

algosec_appviz-0.0.2.dist-info/RECORD

@@ -1,7 +0,0 @@
-algosec_appviz/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-algosec_appviz/environment.py,sha256=ycrVSpR6oLpj9p54SvDdy0nqwS9IwHAh-1x-zOaTQ5I,1775
-algosec_appviz/main.py,sha256=qUdqAuaDIPFFul2jLvuZgltp5-oAo_oNryiI9fnO4gM,2057
-algosec_appviz-0.0.2.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-algosec_appviz-0.0.2.dist-info/METADATA,sha256=MjIKPr0aa89icnaNxsRsXXiXZhpOO2hk4mBO8rCUB5s,1042
-algosec_appviz-0.0.2.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-algosec_appviz-0.0.2.dist-info/RECORD,,