praetorian-cli 2.2.2__tar.gz → 2.2.4__tar.gz

{praetorian_cli-2.2.2/praetorian_cli.egg-info → praetorian_cli-2.2.4}/PKG-INFO

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

{praetorian_cli-2.2.2 → praetorian_cli-2.2.4}/praetorian_cli/handlers/add.py

@@ -29,6 +29,9 @@ def asset(sdk, name, dns, asset_type, status, surface):
     Add an asset to the Chariot database. This command requires a DNS name for the asset.
     Optionally, a name can be provided to give the asset more specific information,
     such as IP address. If no name is provided, the DNS name will be used as the name.
+    The DNS is the group and the name is the specific identifier. This is for legacy reasons.
+
+    The type can be one of the following: asset, addomain, repository, webapplication.
 
     \b
     Example assets:
@@ -41,6 +44,7 @@ def asset(sdk, name, dns, asset_type, status, surface):
         - praetorian chariot add asset --dns example.com
         - praetorian chariot add asset --dns example.com --name 1.2.3.4
         - praetorian chariot add asset --dns internal.example.com --name 10.2.3.4 --surface internal
+        - praetorian chariot add asset --dns https://example.com --name 'Example Web Application' --type webapplication
     """
     if not name:
         name = dns
@@ -196,21 +200,39 @@ def attribute(sdk, key, name, value):
 
 @add.command()
 @cli_handler
-@click.option('-d', '--dns', required=True, help='The DNS of the asset')
+@click.option('-t', '--type', 'seed_type', default='asset', help='Asset type (e.g., asset, addomain)')
 @click.option('-s', '--status', type=click.Choice([s.value for s in Seed]),
               default=Seed.PENDING.value, help='The status of the seed', show_default=True)
-def seed(sdk, dns, status):
+@click.option('-f', '--field', 'field_list', multiple=True, 
+              help='Field in format name:value (can be specified multiple times)')
+def seed(sdk, seed_type, status, field_list):
     """ Add a seed
 
-    Add a seed to the Chariot database. This command requires DNS of the seed to be
-    specified. When status is not specified, the seed is added as PENDING.
+    Add a seed to the Chariot database. Seeds are now assets with special labeling.
+    You can specify the asset type and provide dynamic fields using --fields.
 
     \b
     Example usages:
-        - praetorian chariot add seed --dns example.com
-        - praetorian chariot add seed --dns example.com --status A
+        - praetorian chariot add seed --type asset --field dns:example.com
+        - praetorian chariot add seed --type asset --field dns:example.com --status A
+        - praetorian chariot add seed --type asset --field dns:example.com --field name:1.2.3.4
+        - praetorian chariot add seed --type addomain --field domain:corp.local --field objectid:S-1-5-21-2701466056-1043032755-2418290285
     """
-    sdk.seeds.add(dns, status)
+    # Collect dynamic fields from the --fields option
+    dynamic_fields = {}
+    
+    # Parse field_list entries (name:value format)
+    for field in field_list:
+        if ':' in field:
+            # Split only once to allow colons in the value
+            name, value = field.split(':', 1)
+            dynamic_fields[name] = value
+        else:
+            error(f"Field '{field}' is not in the format name:value")
+            return
+    
+    # Call the updated add method with type and dynamic fields
+    sdk.seeds.add(status=status, seed_type=seed_type, **dynamic_fields)
 
 
 @add.command()
@@ -310,3 +332,21 @@ def key(sdk, name, expires):
         return
     click.echo(f'API key created: {result.get("key", "N/A")}')
     click.echo(f'Secret (save this, it will not be shown again): {result["secret"]}')
+
+
+@add.command()
+@cli_handler
+@click.option('-u', '--url', required=True, help='The full URL of the page')
+@click.option('-p', '--parent', required=False, help='Optional key of the parent WebApplication')
+def webpage(sdk, url, parent):
+    """ Add a Webpage
+    
+    Add a web page to the Chariot database. Webpages can optionally be associated
+    with a parent WebApplication or exist independently.
+    
+    \b
+    Example usages:
+        - praetorian chariot add webpage --url https://app.example.com/login
+        - praetorian chariot add webpage --url https://app.example.com/admin --parent "#webapplication#https://app.example.com"
+    """
+    sdk.webpage.add(url, parent)

{praetorian_cli-2.2.2 → praetorian_cli-2.2.4}/praetorian_cli/handlers/cli_decorators.py

@@ -68,7 +68,7 @@ def list_params(filter_by, has_details=True, has_filter=True, has_type=False):
 
 
 def pagination(func):
-    func = click.option('-o', '--offset', default='', help='List results from an offset')(func)
+    func = click.option('-o', '--offset', default=0, help='List results from an offset')(func)
     func = click.option('-p', '--page', type=click.Choice(('first', 'all')), default='first',
                         help='Pagination mode. "all" pages up to 10,000 pages.', show_default=True)(func)
     return func

{praetorian_cli-2.2.2 → praetorian_cli-2.2.4}/praetorian_cli/handlers/delete.py

@@ -88,11 +88,12 @@ def seed(chariot, key):
 
     \b
     Arguments:
-        - KEY: the key of an existing seed
+        - KEY: the key of an existing seed (now uses asset key format)
 
     \b
     Example usage:
-        - praetorian chariot delete seed "#seed#domain#example.com"
+        - praetorian chariot delete seed "#asset#example.com#example.com"
+        - praetorian chariot delete seed "#addomain#corp.local#corp.local"
     """
     chariot.seeds.delete(key)
 
@@ -181,3 +182,15 @@ def key(chariot, key):
         - praetorian chariot delete key "#key#550e8400-e29b-41d4-a716-446655440000"
     """
     chariot.keys.delete(key)
+
+@delete.command()
+@cli_handler
+@click.argument('key', required=True)
+def webpage(chariot, key):
+    """ Delete a webpage
+
+    \b
+    Arguments:
+        - KEY: the key of an existing webpage
+    """
+    chariot.webpage.delete(key)

{praetorian_cli-2.2.2 → praetorian_cli-2.2.4}/praetorian_cli/handlers/get.py

@@ -186,11 +186,12 @@ def seed(chariot, key):
 
     \b
     Argument:
-        - KEY: the key of an existing pre-seed
+        - KEY: the key of an existing seed (now uses asset key format)
 
     \b
     Example usages:
-        - praetorian chariot get preseed "#preseed#domain#example.com"
+        - praetorian chariot get seed "#asset#example.com#example.com"
+        - praetorian chariot get seed "#addomain#corp.local#corp.local"
     """
     print_json(chariot.seeds.get(key))
 
@@ -295,3 +296,48 @@ def scanner(chariot, key):
         - praetorian chariot get scanner "#scanner#127.0.0.1"
     """
     print_json(chariot.scanners.get(key))
+
+
+@get.command()
+@cli_handler
+@click.argument('key', required=True)
+def webpage(chariot, key):
+    """ Get Webpage details
+
+    Retrieve detailed information about a specific web page, including
+    its URL, method, authentication requirements, and other metadata.
+
+    \b
+    Argument:
+        - KEY: the key of an existing Webpage
+
+    \b
+    Example usages:
+        - praetorian chariot get webpage "#webpage#https://app.example.com/dashboard"
+    """
+    print_json(chariot.webpage.get(key))
+        
+@click.option('-t', '--type', help='Optional specific entity type (e.g., asset, risk, attribute)')
+@click.option('-d', '--details', is_flag=True, help='Further retrieve the details of the schema')
+def schema(chariot, type, details):
+    """ Get Chariot entity schema
+
+    \b
+    Returns the JSON schema for Chariot entities. Optionally filter for a
+    specific entity type.
+
+    \b
+    Example usages:
+        - praetorian chariot get schema
+        - praetorian chariot get schema --type asset
+        - praetorian chariot get schema --type asset --details
+    """
+    data = chariot.schema.get(type)
+    if type:
+        data = {type: data[type]}
+
+    if details:
+        print_json(data)
+    else:
+        for hit in data:
+            click.echo(hit)

praetorian_cli-2.2.4/praetorian_cli/handlers/link.py

@@ -0,0 +1,60 @@
+import click
+
+from praetorian_cli.handlers.chariot import chariot
+from praetorian_cli.handlers.cli_decorators import cli_handler
+
+
+@chariot.group()
+def link():
+    """  Link resources to other entities """
+    pass
+
+
+@link.command()
+@cli_handler
+@click.argument('username')
+def account(chariot, username):
+    """ Add a collaborator account to your account
+
+    This allows them to assume access into your account
+    and perform actions on your behalf.
+
+    \b
+    Arguments:
+        - NAME: their email address
+
+
+
+    \b
+    Example usages:
+        - praetorian chariot link account john@praetorian.com
+    """
+    chariot.accounts.add_collaborator(username)
+
+
+@link.command('webpage-source')
+@cli_handler
+@click.argument('webpage_key')
+@click.argument('entity_key')
+def webpage_source(chariot, webpage_key, entity_key):
+    """ Link a file or repository to a webpage as source code
+
+    This associates source code files or repositories with webpages
+    to track where webpage content originates from.
+
+    \b
+    Arguments:
+        - WEBPAGE_KEY: The webpage key in format #webpage#{url}
+        - ENTITY_KEY: The file or repository key to link
+                     Format: #file#{path} or #repository#{url}#{name}
+
+    \b
+    Example usages:
+        - praetorian chariot link webpage-source "#webpage#https://example.com" "#file#proofs/scan.txt"
+        - praetorian chariot link webpage-source "#webpage#https://example.com/login" "#repository#https://github.com/org/repo.git#repo.git"
+    """
+    result = chariot.webpage.link_source(webpage_key, entity_key)
+    if result:
+        click.echo(f"Successfully linked {entity_key} to {webpage_key}")
+        if 'artifacts' in result:
+            click.echo(f"Webpage now has {len(result['artifacts'])} linked artifacts")

{praetorian_cli-2.2.2 → praetorian_cli-2.2.4}/praetorian_cli/handlers/list.py

@@ -26,7 +26,7 @@ def assets(chariot, filter, model_type, details, offset, page):
         - praetorian chariot list assets --page all
         - praetorian chariot list assets --type repository
     """
-    render_list_results(chariot.assets.list(filter, model_type, offset, pagination_size(page)), details)
+    render_list_results(chariot.assets.list(filter, model_type, pagination_size(page)), details)
 
 
 @list.command()
@@ -178,24 +178,23 @@ def attributes(chariot, filter, key, details, offset, page):
 
 @list.command()
 @list_params('DNS')
-@click.option('-t', '--type', type=click.Choice(['ip', 'domain']), help=f'Filter by type of the seeds')
+@click.option('-t', '--type', help='Filter by seed type (e.g., asset, addomain)')
 def seeds(chariot, type, filter, details, offset, page):
     """ List seeds
 
-   	Retrieve and display a list of seeds.
+   	Retrieve and display a list of seeds. Seeds are now assets with the 'Seed' label.
 
     \b
     Example usages:
         - praetorian chariot list seeds
-        - praetorian chariot list seeds --type ip
-        - praetorian chariot list seeds --type domain --filter example.com
+        - praetorian chariot list seeds --type asset
+        - praetorian chariot list seeds --type addomain
+        - praetorian chariot list seeds --type asset --filter example.com
         - praetorian chariot list seeds --details
         - praetorian chariot list seeds --page all
     """
-    if filter and not type:
-        error('When the DNS filter is specified, you also need to specify the type of the filter: ip or domain.')
-
-    render_list_results(chariot.seeds.list(type, filter, offset, pagination_size(page)), details)
+    # Note: filter restriction removed since we're using different key format now
+    render_list_results(chariot.seeds.list(type, filter, pagination_size(page)), details)
 
 
 @list.command()
@@ -369,3 +368,25 @@ def scanners(chariot, filter, details, offset, page):
         - praetorian chariot list scanners --page all
     """
     render_list_results(chariot.scanners.list(filter, offset, pagination_size(page)), details)
+
+
+@list.command()
+@click.option('--parent', required=False, help='Optional WebApp key to filter pages')
+@click.option('-f', '--filter', required=False, help='Optional URL to filter pages')
+@click.option('-d', '--details', is_flag=True, default=False, help='Show detailed information')
+@pagination
+@cli_handler
+def webpages(chariot, parent, filter, details, offset, page):
+    """ List WebPages
+
+    Retrieve and display a list of pages/URLs. Can optionally filter by specific WebApplication.
+
+    \b
+    Example usages:
+        - praetorian chariot list webpages
+        - praetorian chariot list webpages --parent "#webapplication#https://app.example.com"
+        - praetorian chariot list webpages --filter /login
+        - praetorian chariot list webpages --parent "#webapplication#https://app.example.com" --details
+        - praetorian chariot list webpages --page all
+    """
+    render_list_results(chariot.webpage.list(parent, filter, offset, pagination_size(page)), details)

praetorian_cli-2.2.4/praetorian_cli/handlers/unlink.py

@@ -0,0 +1,55 @@
+import click
+
+from praetorian_cli.handlers.chariot import chariot
+from praetorian_cli.handlers.cli_decorators import cli_handler
+
+
+@chariot.group()
+def unlink():
+    """ Remove links between resources """
+    pass
+
+
+@unlink.command()
+@cli_handler
+@click.argument('username')
+def account(chariot, username):
+    """ Remove a collaborator account from your account. This will
+    revoke their access to your account.
+
+    Arguments:
+        - NAME: Their email address.
+
+    \b
+    Example usages:
+        - praetorian chariot unlink account john@praetorian.com
+    """
+    chariot.accounts.delete_collaborator(username)
+
+
+@unlink.command('webpage-source')
+@cli_handler
+@click.argument('webpage_key')
+@click.argument('entity_key')
+def webpage_source(chariot, webpage_key, entity_key):
+    """ Unlink a file or repository from a webpage's source code
+
+    This removes the association between source code files or 
+    repositories and webpages.
+
+    \b
+    Arguments:
+        - WEBPAGE_KEY: The webpage key in format #webpage#{url}
+        - ENTITY_KEY: The file or repository key to unlink
+                     Format: #file#{path} or #repository#{url}#{name}
+
+    \b
+    Example usages:
+        - praetorian chariot unlink webpage-source "#webpage#https://example.com" "#file#proofs/scan.txt"
+        - praetorian chariot unlink webpage-source "#webpage#https://example.com/login" "#repository#https://github.com/org/repo.git#repo.git"
+    """
+    result = chariot.webpage.unlink_source(webpage_key, entity_key)
+    if result:
+        click.echo(f"Successfully unlinked {entity_key} from {webpage_key}")
+        if 'artifacts' in result:
+            click.echo(f"Webpage now has {len(result['artifacts'])} linked artifacts")

{praetorian_cli-2.2.2 → praetorian_cli-2.2.4}/praetorian_cli/handlers/update.py

@@ -65,12 +65,12 @@ def seed(chariot, key, status):
 
     \b
     Example usages:
-        - praetorian chariot update seed "#seed#domain#example.com" -s A
-        - praetorian chariot update seed "#seed#ip#1.1.1.0/24" -s F
+        - praetorian chariot update seed "#asset#example.com#example.com" -s A
+        - praetorian chariot update seed "#asset#1.1.1.0/24#1.1.1.0/24" -s F
     """
+    
     chariot.seeds.update(key, status)
 
-
 @update.command()
 @cli_handler
 @click.argument('key', required=True)

{praetorian_cli-2.2.2 → praetorian_cli-2.2.4}/praetorian_cli/sdk/chariot.py

@@ -16,10 +16,12 @@ from praetorian_cli.sdk.entities.keys import Keys
 from praetorian_cli.sdk.entities.preseeds import Preseeds
 from praetorian_cli.sdk.entities.risks import Risks
 from praetorian_cli.sdk.entities.scanners import Scanners
+from praetorian_cli.sdk.entities.schema import Schema
 from praetorian_cli.sdk.entities.search import Search
 from praetorian_cli.sdk.entities.seeds import Seeds
 from praetorian_cli.sdk.entities.settings import Settings
 from praetorian_cli.sdk.entities.statistics import Statistics
+from praetorian_cli.sdk.entities.webpage import Webpage
 from praetorian_cli.sdk.entities.webhook import Webhook
 from praetorian_cli.sdk.keychain import Keychain
 from praetorian_cli.sdk.model.globals import GLOBAL_FLAG
@@ -51,6 +53,8 @@ class Chariot:
         self.keys = Keys(self)
         self.capabilities = Capabilities(self)
         self.credentials = Credentials(self)
+        self.webpage = Webpage(self)
+        self.schema = Schema(self)
         self.proxy = proxy
 
         if self.proxy == '' and os.environ.get('CHARIOT_PROXY'):
@@ -70,26 +74,16 @@ class Chariot:
             kwargs['proxies'] = {'http': self.proxy, 'https': self.proxy}
             kwargs['verify'] = False
         
-        self._add_beta_filter(method, kwargs)
+        self.add_beta_url_param(kwargs)
 
         return requests.request(method, url, headers=self.keychain.headers(), **kwargs)
 
-    def _add_beta_filter(self, method: str, kwargs: dict):
-        if method == 'GET' or method == 'DELETE':
-            self._add_beta_url_param(kwargs)
-        else:
-            self._add_beta_json_param(kwargs)
-
-    def _add_beta_url_param(self, kwargs: dict):
+    def add_beta_url_param(self, kwargs: dict):
         if 'params' in kwargs:
             kwargs['params']['beta'] = 'true'
         else:
             kwargs['params'] = {'beta': 'true'}
 
-    def _add_beta_json_param(self, kwargs: dict):
-        if 'json' in kwargs:
-            kwargs['json']['beta'] = True
-
     def my(self, params: dict, pages=1) -> dict:
         final_resp = dict()
 

{praetorian_cli-2.2.2 → praetorian_cli-2.2.4}/praetorian_cli/sdk/entities/assets.py

@@ -1,5 +1,6 @@
+from praetorian_cli.handlers.utils import error
 from praetorian_cli.sdk.model.globals import Asset, Kind
-from praetorian_cli.sdk.model.query import Relationship, Node, Query, asset_of_key, RISK_NODE, ATTRIBUTE_NODE
+from praetorian_cli.sdk.model.query import Relationship, Node, Query, Filter, KIND_TO_LABEL, asset_of_key, RISK_NODE, ATTRIBUTE_NODE
 
 
 class Assets:
@@ -76,27 +77,44 @@ class Assets:
         """
         return self.api.delete_by_key('asset', key)
 
-    def list(self, prefix_filter='', asset_type='', offset=None, pages=100000) -> tuple:
+    def list(self, key_prefix='', asset_type='', pages=100000) -> tuple:
         """
         List assets.
 
-        :param prefix_filter: Supply this to perform prefix-filtering of the asset keys after the "#asset#" portion of the asset key. Asset keys read '#asset#{dns}#{name}'
-        :type prefix_filter: str
+        :param key_prefix: Supply this to perform prefix-filtering of the asset key. E.g., '#asset#example.com' or '#addomain#sevenkingdoms'
+        :type key_prefix: str
         :param asset_type: The type of asset to filter by
         :type asset_type: str
-        :param offset: The offset of the page you want to retrieve results. If this is not supplied, this function retrieves from the first page
-        :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
         :return: A tuple containing (list of assets, next page offset)
         :rtype: tuple
         """
-        dns_prefix = ''
-        if prefix_filter:
-            dns_prefix = f'group:{prefix_filter}'
-        if asset_type == '':
-            asset_type = Kind.ASSET.value
-        return self.api.search.by_term(dns_prefix, asset_type, offset, pages)
+
+        if asset_type in KIND_TO_LABEL:
+            asset_type = KIND_TO_LABEL[asset_type]
+        elif not asset_type:
+            asset_type = Node.Label.ASSET
+        else:
+            raise ValueError(f'Invalid asset type: {asset_type}')
+
+        node = Node(
+            labels=[asset_type],
+            filters=[]
+        )
+
+        key_filter = Filter(
+            field=Filter.Field.KEY,
+            operator=Filter.Operator.STARTS_WITH,
+            value=key_prefix
+        )
+
+        if key_prefix:
+            node.filters.append(key_filter)
+
+        query = Query(node=node)
+
+        return self.api.search.by_query(query, pages)
 
     def attributes(self, key):
         """

praetorian_cli-2.2.4/praetorian_cli/sdk/entities/schema.py

@@ -0,0 +1,27 @@
+class Schema:
+    """Access Chariot entity schemas via the SDK.
+
+    Methods in this class are accessed from `sdk.schema`, where `sdk` is an
+    instance of `Chariot`.
+    """
+
+    def __init__(self, api):
+        self.api = api
+
+    def get(self, entity_type: str | None = None) -> dict:
+        """Get schema information for entity types.
+
+        Args:
+            entity_type: Optional specific entity type. If provided and it exists,
+                only that schema is returned. If not provided, all schemas are returned.
+
+        Returns:
+            dict: Schema information.
+        """
+        result = self.api.get('schema', )
+        if entity_type:
+            if entity_type not in result:
+                return {}
+            return {entity_type: result[entity_type]}
+        return result
+