praetorian-cli 2.6.1__tar.gz → 2.6.2__tar.gz

{praetorian_cli-2.6.1/praetorian_cli.egg-info → praetorian_cli-2.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: praetorian-cli
-Version: 2.6.1
+Version: 2.6.2
 Summary: For interacting with the Guard API
 Home-page: https://github.com/praetorian-inc/praetorian-cli
 Author: Praetorian

{praetorian_cli-2.6.1 → praetorian_cli-2.6.2}/praetorian_cli/handlers/delete.py

@@ -103,8 +103,9 @@ def seed(chariot, key):
 
 @delete.command()
 @click.argument('filepath', required=True)
+@click.option('--praetorian', is_flag=True, default=False, help='Delete from the praetorian partition')
 @cli_handler
-def file(chariot, filepath):
+def file(chariot, filepath, praetorian):
     """ Delete a file
 
     \b
@@ -114,8 +115,9 @@ def file(chariot, filepath):
     \b
     Example usage:
         - guard delete file "home/report-dec-2024.pdf"
+        - guard delete file "home/internal/repo.zip" --praetorian
     """
-    chariot.files.delete(filepath)
+    chariot.files.delete(filepath, praetorian=praetorian)
 
 
 @delete.command()

{praetorian_cli-2.6.1 → praetorian_cli-2.6.2}/praetorian_cli/handlers/get.py

@@ -131,7 +131,8 @@ def job(chariot, key):
 @cli_handler
 @click.argument('name')
 @click.option('-p', '--path', default=os.getcwd(), help='Download path. Default: save to current directory')
-def file(chariot, name, path):
+@click.option('--praetorian', is_flag=True, default=False, help='Download from the praetorian partition')
+def file(chariot, name, path, praetorian):
     """ Download a file using key or name
 
     \b
@@ -143,11 +144,11 @@ def file(chariot, name, path):
         - guard get file "#file#proofs/example.azurewebsites.net/jira-unauthenticated-user-picker"
         - guard get file "proofs/example.azurewebsites.net/jira-unauthenticated-user-picker"
         - guard get file "proofs/example.azurewebsites.net/jira-unauthenticated-user-picker" --path ~/Downloads
+        - guard get file "home/internal/repo.zip" --praetorian
     """
     if name.startswith('#'):
-        downloaded_filepath = chariot.files.save(name.split('#')[-1], path)
-    else:
-        downloaded_filepath = chariot.files.save(name, path)
+        name = name.split('#')[-1]
+    downloaded_filepath = chariot.files.save(name, path, praetorian=praetorian)
     click.echo(f'Saved file at {downloaded_filepath}')
 
 

{praetorian_cli-2.6.1 → praetorian_cli-2.6.2}/praetorian_cli/handlers/list.py

@@ -141,7 +141,8 @@ def jobs(chariot, capability, status, target, summary, filter, details, offset,
 
 @list.command()
 @list_params('file path')
-def files(chariot, filter, details, offset, page):
+@click.option('--praetorian', is_flag=True, default=False, help='List the praetorian partition')
+def files(chariot, praetorian, filter, details, offset, page):
     """ List files
 
     Retrieve and display a list of files in the Guard file system.
@@ -152,8 +153,9 @@ def files(chariot, filter, details, offset, page):
         - guard list files --filter "home/reports/cloud-assessment-2024-"
         - guard list files --details
         - guard list files --page all
+        - guard list files --praetorian --filter "home/internal/"
      """
-    render_list_results(chariot.files.list(filter, offset, pagination_size(page)), details)
+    render_list_results(chariot.files.list(filter, offset, pagination_size(page), praetorian=praetorian), details)
 
 
 @list.command()

{praetorian_cli-2.6.1 → praetorian_cli-2.6.2}/praetorian_cli/sdk/chariot.py

@@ -250,7 +250,7 @@ class Chariot:
         process_failure(resp)
         return resp
 
-    def download(self, name: str, global_=False) -> bytes:
+    def download(self, name: str, global_=False, praetorian=False) -> bytes:
         params = dict(name=name)
         # Encrypted files have _encrypted/ prefix in the path. Encrypted files do not use presigned URLs.
         # Instead, they use the /encrypted-file endpoint that directly gets and puts content.
@@ -263,6 +263,8 @@ class Chariot:
         # Regular files, use presigned URLs
         if global_:
             params |= GLOBAL_FLAG
+        if praetorian:
+            params['praetorian'] = 'true'
 
         resp = self.chariot_request('GET', self.url('/file'), params=params)
         process_failure(resp)

{praetorian_cli-2.6.1 → praetorian_cli-2.6.2}/praetorian_cli/sdk/entities/files.py

@@ -29,7 +29,7 @@ class Files:
         """
         return self.api.upload(local_filepath, chariot_filepath, praetorian=praetorian)
 
-    def save(self, chariot_filepath, download_directory=os.getcwd()):
+    def save(self, chariot_filepath, download_directory=os.getcwd(), praetorian=False):
         """
         Download a file from Chariot storage to the local filesystem.
 
@@ -37,11 +37,13 @@ class Files:
         :type chariot_filepath: str
         :param download_directory: Local directory to save the file (defaults to current working directory)
         :type download_directory: str
+        :param praetorian: If True, download from the praetorian partition
+        :type praetorian: bool
         :return: The local path where the file was saved
         :rtype: str
         :raises Exception: If the file does not exist in Chariot storage
         """
-        content = self.get(chariot_filepath)
+        content = self.get(chariot_filepath, praetorian=praetorian)
 
         local_filename = self.sanitize_filename(chariot_filepath)
         directory = os.path.expanduser(download_directory)
@@ -125,7 +127,7 @@ class Files:
             raise
         return destination
 
-    def get(self, chariot_filepath, _global=False) -> bytes:
+    def get(self, chariot_filepath, _global=False, praetorian=False) -> bytes:
         """
         Download a file from Chariot storage into memory as bytes.
 
@@ -133,15 +135,17 @@ class Files:
         :type chariot_filepath: str
         :param _global: If True, fetch from global storage instead of user-specific
         :type _global: bool
+        :param praetorian: If True, fetch from the praetorian partition
+        :type praetorian: bool
         :return: The file content as bytes
         :rtype: bytes
         :raises Exception: If the file does not exist in Chariot storage
         """
         if not _global:
-            self.raise_if_missing(chariot_filepath)
-        return self.api.download(chariot_filepath, global_=_global)
+            self.raise_if_missing(chariot_filepath, praetorian=praetorian)
+        return self.api.download(chariot_filepath, global_=_global, praetorian=praetorian)
 
-    def get_utf8(self, chariot_filepath, _global=False) -> str:
+    def get_utf8(self, chariot_filepath, _global=False, praetorian=False) -> str:
         """
         Download a file from Chariot storage into memory as a UTF-8 string.
 
@@ -149,13 +153,15 @@ class Files:
         :type chariot_filepath: str
         :param _global: If True, fetch from global storage instead of user-specific
         :type _global: bool
+        :param praetorian: If True, fetch from the praetorian partition
+        :type praetorian: bool
         :return: The file content as a UTF-8 decoded string
         :rtype: str
         :raises Exception: If the file does not exist in Chariot storage
         """
-        return self.get(chariot_filepath, _global=_global).decode('utf-8')
+        return self.get(chariot_filepath, _global=_global, praetorian=praetorian).decode('utf-8')
 
-    def list(self, prefix_filter='', offset=None, pages=100000) -> tuple:
+    def list(self, prefix_filter='', offset=None, pages=100000, praetorian=False) -> tuple:
         """
         List files in Chariot storage, optionally filtered by filepath prefix.
 
@@ -168,23 +174,30 @@ class Files:
         :type offset: str or None
         :param pages: The number of pages of results to retrieve. <mcp>Start with one page of results unless specifically requested.</mcp>
         :type pages: int
+        :param praetorian: If True, list the praetorian partition
+        :type praetorian: bool
         :return: A tuple containing (list of matching file entities, next page offset)
         :rtype: tuple
         """
-        return self.api.search.by_key_prefix(f'#file#{prefix_filter}', offset, pages)
+        return self.api.search.by_key_prefix(f'#file#{prefix_filter}', offset, pages, praetorian=praetorian)
 
-    def delete(self, chariot_filepath):
+    def delete(self, chariot_filepath, praetorian=False):
         """
         Delete a file from Chariot storage.
 
         :param chariot_filepath: Path of the file in Chariot storage to delete
         :type chariot_filepath: str
+        :param praetorian: If True, delete from the praetorian partition
+        :type praetorian: bool
         :return: The deleted file entity
         :rtype: dict
         :raises Exception: If the file does not exist in Chariot storage
         """
-        self.raise_if_missing(chariot_filepath)
-        return self.api.delete('file', params=dict(name=chariot_filepath), body={})
+        self.raise_if_missing(chariot_filepath, praetorian=praetorian)
+        params = dict(name=chariot_filepath)
+        if praetorian:
+            params['praetorian'] = 'true'
+        return self.api.delete('file', params=params, body={})
 
     def sanitize_filename(self, filename: str) -> str:
         """
@@ -203,7 +216,7 @@ class Files:
             filename = filename.replace(char, '_')
         return filename
 
-    def raise_if_missing(self, chariot_filepath):
+    def raise_if_missing(self, chariot_filepath, praetorian=False):
         """
         Check if a file exists in Chariot storage and raise an exception if not found.
 
@@ -212,10 +225,12 @@ class Files:
 
         :param chariot_filepath: Path of the file in Chariot storage to check
         :type chariot_filepath: str
+        :param praetorian: If True, look in the praetorian partition
+        :type praetorian: bool
         :return: None
         :rtype: None
         :raises Exception: If the file does not exist in Chariot storage with message 'File {chariot_filepath} not found.'
         """
-        file = self.api.search.by_exact_key(f'#file#{chariot_filepath}')
+        file = self.api.search.by_exact_key(f'#file#{chariot_filepath}', praetorian=praetorian)
         if not file:
             raise Exception(f'File {chariot_filepath} not found.')

{praetorian_cli-2.6.1 → praetorian_cli-2.6.2}/praetorian_cli/sdk/entities/search.py

@@ -3,7 +3,7 @@ import time
 
 from praetorian_cli.sdk.model.query import (Filter, Query, Node, Relationship, KIND_TO_LABEL, node_of_key,
                                              ttl_blockers_query)
-from praetorian_cli.sdk.model.globals import ALL_TENANTS_FLAG, EXACT_FLAG, DESCENDING_FLAG, GLOBAL_FLAG, USER_FLAG, Kind
+from praetorian_cli.sdk.model.globals import ALL_TENANTS_FLAG, EXACT_FLAG, DESCENDING_FLAG, GLOBAL_FLAG, PRAETORIAN_FLAG, USER_FLAG, Kind
 
 # Common asset/risk/web edges followed when the caller doesn't name any. The
 # backend has no wildcard, so we OR a small core set instead of every label
@@ -35,7 +35,7 @@ class Search:
         """
         return self.api.count(dict(key=search_term))
 
-    def by_key_prefix(self, key_prefix, offset=None, pages=100000, user=False) -> tuple:
+    def by_key_prefix(self, key_prefix, offset=None, pages=100000, user=False, praetorian=False) -> tuple:
         """
         Search for entities by key prefix. <mcp>If the response is too large, make your query more specific.<mcp>
 
@@ -48,9 +48,9 @@ class Search:
         :return: A tuple containing (list of matching entities, next page offset)
         :rtype: tuple
         """
-        return self.by_term(key_prefix, None, offset, pages, user=user)
+        return self.by_term(key_prefix, None, offset, pages, user=user, praetorian=praetorian)
 
-    def by_exact_key(self, key, get_attributes=False) -> {}:
+    def by_exact_key(self, key, get_attributes=False, praetorian=False) -> {}:
         """
         Get an entity by its exact key.
 
@@ -58,10 +58,12 @@ class Search:
         :type key: str
         :param get_attributes: Whether to also retrieve associated attributes
         :type get_attributes: bool
+        :param praetorian: Whether to search the praetorian partition
+        :type praetorian: bool
         :return: The matching entity or None if not found
         :rtype: dict or None
         """
-        hits, _ = self.by_term(key, exact=True)
+        hits, _ = self.by_term(key, exact=True, praetorian=praetorian)
         hit = hits[0] if hits else None
         if get_attributes and hit:
             attributes, _ = self.by_source(key, Kind.ATTRIBUTE.value)
@@ -137,7 +139,7 @@ class Search:
         return self.by_term(f'dns:{dns_prefix}', kind, offset, pages)
 
     def by_term(self, search_term, kind=None, offset=None, pages=100000, exact=False, descending=False,
-                global_=False, user=False, all_tenants=False) -> tuple:
+                global_=False, user=False, all_tenants=False, praetorian=False) -> tuple:
         """
         Search for a given kind by term.
 
@@ -169,6 +171,8 @@ class Search:
             params |= DESCENDING_FLAG
         if global_:
             params |= GLOBAL_FLAG
+        if praetorian:
+            params |= PRAETORIAN_FLAG
         if user:
             params |= USER_FLAG
         if all_tenants:

{praetorian_cli-2.6.1 → praetorian_cli-2.6.2}/praetorian_cli/sdk/model/globals.py

@@ -148,6 +148,7 @@ class Kind(Enum):
 EXACT_FLAG = {'exact': 'true'}
 DESCENDING_FLAG = {'desc': 'true'}
 GLOBAL_FLAG = {'global': 'true'}
+PRAETORIAN_FLAG = {'praetorian': 'true'}
 USER_FLAG = {'user': 'true'}
 ALL_TENANTS_FLAG = {'allTenants': 'true'}
 

{praetorian_cli-2.6.1 → praetorian_cli-2.6.2/praetorian_cli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: praetorian-cli
-Version: 2.6.1
+Version: 2.6.2
 Summary: For interacting with the Guard API
 Home-page: https://github.com/praetorian-inc/praetorian-cli
 Author: Praetorian

{praetorian_cli-2.6.1 → praetorian_cli-2.6.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = praetorian-cli
-version = 2.6.1
+version = 2.6.2
 author = Praetorian
 author_email = support@praetorian.com
 description = For interacting with the Guard API