catocli 3.0.18__py3-none-any.whl → 3.0.24__py3-none-any.whl

catocli-3.0.18.dist-info/METADATA

@@ -1,124 +0,0 @@
-Metadata-Version: 2.4
-Name: catocli
-Version: 3.0.18
-Summary: Cato Networks cli wrapper for the GraphQL API.
-Home-page: https://github.com/Cato-Networks/cato-cli
-Author: Cato Networks
-Author-email: [email protected]
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: urllib3
-Requires-Dist: certifi
-Requires-Dist: six
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# Cato Networks GraphQL API CLI
-
-The package provides a simple to use CLI that reflects industry standards (such as the AWS cli), and enables customers to manage Cato Networks configurations and processes via the [Cato Networks GraphQL API](https://api.catonetworks.com/api/v1/graphql2) easily integrating into configurations management, orchestration or automation frameworks to support the DevOps model.
-
-## Installation
-    pip3 install catocli
-
-## Authentication
-
-The Cato CLI uses a profile-based authentication system similar to AWS CLI. You can configure multiple profiles for different environments or accounts.
-
-### Quick Setup
-
-```bash
-# Configure your first profile (interactive)
-catocli configure set
-
-# Or configure non-interactively
-catocli configure set --cato-token "your-api-token" --account-id "12345"
-```
-
-### Profile Management
-
-```bash
-# List profiles
-catocli configure list
-
-# Switch profiles
-catocli configure use prod
-
-# Show current profile
-catocli configure show
-```
-
-### Legacy Environment Variables (deprecated)
-
-For backward compatibility, you can still use environment variables:
-
-```bash
-export CATO_TOKEN="12345-abcde-12345-abcde"
-export CATO_ACCOUNT_ID="12345"
-export CATO_DEBUG=True  # Optional for debug logs
-```
-
-The CLI will automatically migrate these to a default profile on first run.
-
-### Documentation
-
-For detailed information about profile management, see [PROFILES.md](PROFILES.md).
-
-[CLICK HERE](https://support.catonetworks.com/hc/en-us/articles/4413280536081-Generating-API-Keys-for-the-Cato-API) to see how create an API key to authenticate.
-
-## Running the CLI
-	catocli -h
-	catocli query -h
-	catocli query entityLookup -h
-	catocli query entityLookup '{"type":"country"}`
-    
-    // Override the accountID value as a cli argument
-	catocli query entityLookup -accountID=12345 '{"type":"country"}`
-
-## Check out run locally not as pip package
-	git clone git@github.com:Cato-Networks/cato-cli.git
-	cd cato-cli
-	python3 -m catocli -h
-
-This CLI is a Python 3 application and has been tested with Python 3.6 -> 3.8
-## Requirements:
-    python 3.6 or higher
-    
-## Confirm your version of python if installed:
-    Open a terminal
-    Enter: python -V or python3 -V
-
-## Usage:
-    usage: catocli <resource> <command> [options]
-
-    CLI for query, and mutation operations via API.
-
-    Positional arguments:
-      {entityLookup}
-		entityLookup         entityLookup reference.
-
-    Optional arguments:
-      -h, --help            show this help message and exit
-      --version             show program's version number and exit
-
-## Installing the correct version for environment:
-https://www.python.org/downloads/
-

scripts/catolib.py

@@ -1,62 +0,0 @@
-#!/usr/bin/env python3
-import json
-import os
-import sys
-import subprocess
-from typing import Any, Dict, List, Union
-
-def should_strip_id(obj: Dict[str, Any]) -> bool:
-    if not isinstance(obj, dict):
-        return False
-    
-    keys = set(obj.keys())
-    return keys == {'name', 'id'}
-
-def strip_ids_recursive(obj: Union[Dict, List, Any]) -> Union[Dict, List, Any, None]:
-    if isinstance(obj, dict):
-        new_obj = {}
-        for key, value in obj.items():
-            ## Ignoring sections to retain id and name pair
-            if key == 'sections':
-                new_obj[key] = value
-            else:
-                processed_value = strip_ids_recursive(value)
-                # Skip keys where the value is an empty list
-                if processed_value != []:
-                    new_obj[key] = processed_value
-            # Check if this object should have its id stripped
-            if should_strip_id(new_obj):
-                return {'name': new_obj['name']}
-        return new_obj
-
-    elif isinstance(obj, list):
-        # Recursively process all items in the list
-        processed_list = [strip_ids_recursive(item) for item in obj]
-        # Remove None values from the list (if any were removed)
-        processed_list = [item for item in processed_list if item is not None]
-        return processed_list
-    
-    else:
-        # For primitive types (str, int, bool, None), return as-is
-        return obj
-
-## General purpose functions
-def exec_cli(command):
-    result = None
-    try:
-        response = subprocess.run(command, shell=True, text=True, capture_output=True)
-        if response.returncode != 0:
-            print(f"Command failed with return code {response.returncode}")
-            print(f"stderr: {response.stderr}")
-            return None
-        result = json.loads(response.stdout)
-    except json.JSONDecodeError as e:
-        print(f"Failed to parse JSON response: {e}")
-        print(f"stdout: {response.stdout}")
-        print(f"stderr: {response.stderr}")
-        return None
-    except Exception as e:
-        print(f"Failed to execute command: {e}")
-        return None
-    return result
-

scripts/export_if_rules_to_json.py

@@ -1,188 +0,0 @@
-import sys
-import csv
-import subprocess
-import json
-import os
-import argparse
-sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
-from graphql_client.api.call_api import ApiClient, CallApi
-from graphql_client import Configuration
-from graphql_client.api_client import ApiException
-import catocli
-
-# Configuration variables
-DESTINATION_DIR = "config_data"
-
-def strip_ids_recursive(data):
-    """Recursively strip id attributes from data structure"""
-    if isinstance(data, dict):
-        return {k: strip_ids_recursive(v) for k, v in data.items() if k != 'id'}
-    elif isinstance(data, list):
-        return [strip_ids_recursive(item) for item in data]
-    else:
-        return data
-
-def main():
-    # Parse command line arguments
-    parser = argparse.ArgumentParser(description='Export IFW rules to JSON')
-    parser.add_argument('-accountID', help='Account ID to export rules from', required=True)
-    parser.add_argument('--output-file-path', help='Full path including filename and extension for output file. If not specified, uses default: config_data/all_ifw_rules_and_sections_{account_id}.json')
-    parser.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
-    args = parser.parse_args()
-    
-    ACCOUNT_ID = args.accountID
-    
-    # Setup API client configuration
-    if "CATO_TOKEN" not in os.environ:
-        print("Missing authentication, please set the CATO_TOKEN environment variable with your api key.")
-        sys.exit(1)
-    
-    configuration = Configuration()
-    configuration.verify_ssl = False
-    configuration.api_key["x-api-key"] = os.getenv("CATO_TOKEN")
-    configuration.host = "{}".format(catocli.__cato_host__)
-    configuration.accountID = ACCOUNT_ID
-    
-    # Set up output file path
-    if args.output_file_path:
-        # Use output file path if provided
-        output_file = args.output_file_path
-        destination_dir = os.path.dirname(output_file)
-        if args.verbose:
-            print(f"Using output file path: {output_file}")
-    else:
-        # Use default path and filename
-        destination_dir = 'config_data'
-        json_output_file = f"all_ifw_rules_and_sections_{ACCOUNT_ID}.json"
-        output_file = os.path.join(destination_dir, json_output_file)
-        if args.verbose:
-            print(f"Using default path: {output_file}")
-    
-    # Create destination directory if it doesn't exist
-    if destination_dir and not os.path.exists(destination_dir):
-        if args.verbose:
-            print(f"Creating directory: {destination_dir}")
-        os.makedirs(destination_dir)
-    policyQuery = {
-        "query": "query policy ( $accountId:ID! ) { policy ( accountId:$accountId ) { internetFirewall { policy { enabled rules { audit { updatedTime updatedBy } rule { id name description index section { id name } enabled source { ip host { id name } site { id name } subnet ipRange { from to } globalIpRange { id name } networkInterface { id name } siteNetworkSubnet { id name } floatingSubnet { id name } user { id name } usersGroup { id name } group { id name } systemGroup { id name } } connectionOrigin country { id name } device { id name } deviceOS deviceAttributes { category type model manufacturer os osVersion } destination { application { id name } customApp { id name } appCategory { id name } customCategory { id name } sanctionedAppsCategory { id name } country { id name } domain fqdn ip subnet ipRange { from to } globalIpRange { id name } remoteAsn containers { fqdnContainer { id name } ipAddressRangeContainer { id name } } } service { standard { id name } custom { port portRange { from to } protocol } } action tracking { event { enabled } alert { enabled frequency subscriptionGroup { id name } webhook { id name } mailingList { id name } } } schedule { activeOn customTimeframePolicySchedule: customTimeframe { from to } customRecurringPolicySchedule: customRecurring { from to days } } exceptions { name source { ip host { id name } site { id name } subnet ipRange { from to } globalIpRange { id name } networkInterface { id name } siteNetworkSubnet { id name } floatingSubnet { id name } user { id name } usersGroup { id name } group { id name } systemGroup { id name } } deviceOS country { id name } device { id name } deviceAttributes { category type model manufacturer os osVersion } destination { application { id name } customApp { id name } appCategory { id name } customCategory { id name } sanctionedAppsCategory { id name } country { id name } domain fqdn ip subnet ipRange { from to } globalIpRange { id name } remoteAsn containers { fqdnContainer { id name } ipAddressRangeContainer { id name } } } service { standard { id name } custom { port portRangeCustomService: portRange { from to } protocol } } connectionOrigin } } properties } sections { audit { updatedTime updatedBy } section { id name } properties } audit { publishedTime publishedBy } revision { id name description changes createdTime updatedTime } } } } }",
-        "variables": {
-            "accountId": ACCOUNT_ID
-        },
-        "operationName": "policy"
-    }
-    print(f"Retrieving all IFW rules and sections for account {ACCOUNT_ID}...")
-    
-    # Create API client instance
-    instance = CallApi(ApiClient(configuration))
-    
-    # Create params object for the API call
-    params = {
-        'v': False,  # verbose mode
-        'f': 'json',  # format
-        'p': False,  # pretty print
-        't': False   # test mode
-    }
-    
-    try:
-        # Call the API directly
-        response = instance.call_api(policyQuery, params)
-        allIfwRules = response[0] if response else {}
-        
-        if not allIfwRules or 'data' not in allIfwRules:
-            print("ERROR: Failed to retrieve data from API")
-            sys.exit(1)
-            
-    except ApiException as e:
-        print(f"ERROR: API call failed - {e}")
-        sys.exit(1)
-    except Exception as e:
-        print(f"ERROR: Unexpected error - {e}")
-        sys.exit(1)
-    
-    # First, preserve section IDs before stripping them
-    section_id_map = {}
-    sections_with_ids = allIfwRules['data']['policy']['internetFirewall']['policy']['sections']
-    for section_data in sections_with_ids:
-        section_id_map[section_data['section']['name']] = section_data['section']['id']
-    
-    # Get the first section ID for section_to_start_after_id
-    section_to_start_after_id = None
-    if len(sections_with_ids) > 0:
-        section_to_start_after_id = sections_with_ids[0]['section']['id']
-        print(f"Excluding first section with system rule: {sections_with_ids[0]['section']['name']}")
-    
-    ## Processing data to strip id attributes
-    processed_data = strip_ids_recursive(allIfwRules)
-    
-    ## Filter out rules with properties[0]=="SYSTEM"
-    filtered_rules = []
-    for rule_data in processed_data['data']['policy']['internetFirewall']['policy']['rules']:
-        rule_properties = rule_data.get('properties', [])
-        # Skip rules where the first property is "SYSTEM"
-        if rule_properties and rule_properties[0] == "SYSTEM":
-            print(f"Excluding SYSTEM rule: {rule_data['rule']['name']}")
-        else:
-            filtered_rules.append(rule_data)
-    processed_data['data']['policy']['internetFirewall']['policy']['rules'] = filtered_rules
-    # rules = filtered_rules
-    
-    # Add index_in_section to each rule
-    # Group rules by section and add index_in_section
-    section_counters = {}
-    for rule_data in processed_data['data']['policy']['internetFirewall']['policy']['rules']:
-        section_name = rule_data['rule']['section']['name']
-        if section_name not in section_counters:
-            section_counters[section_name] = 0
-        section_counters[section_name] += 1
-        rule_data['rule']['index_in_section'] = section_counters[section_name]
-    
-    # Create rules_in_sections array
-    rules_in_sections = []
-    for rule_data in processed_data['data']['policy']['internetFirewall']['policy']['rules']:
-        rule_info = rule_data['rule']
-        rules_in_sections.append({
-            "index_in_section": rule_info['index_in_section'],
-            "section_name": rule_info['section']['name'],
-            "rule_name": rule_info['name']
-        })
-        rule_info.pop("index_in_section", None)
-        rule_info.pop("index", None)
-        rule_info["enabled"] = True
-
-    # Add rules_in_sections to the policy structure
-    processed_data['data']['policy']['internetFirewall']['policy']['rules_in_sections'] = rules_in_sections
-    
-    # Reformat sections array to have index, section_id and section_name structure
-    # Exclude the first section from export
-    processed_sections = [] 
-    # Add first section containing reserved SYSTEM rules as section_to_start_after_id
-    for index, section_data in enumerate(processed_data['data']['policy']['internetFirewall']['policy']['sections']):
-        if index == 0:
-            # Skip the first section which contains reserved SYSTEM rules
-            continue
-        else:
-            processed_sections.append({
-                "section_index": index,
-                "section_name": section_data['section']['name']
-            })
-    
-    # Add preserved section IDs and section_to_start_after_id
-    processed_data['data']['policy']['internetFirewall']['policy']['section_ids'] = section_id_map
-    if section_to_start_after_id:
-        processed_data['data']['policy']['internetFirewall']['policy']['section_to_start_after_id'] = section_to_start_after_id
-
-    if len(sections_with_ids) > 0:
-        print(f"Excluded first section: {sections_with_ids[0]['section']['name']} containing reserved SYSTEM rules")
-    
-    # Replace the original sections array with the reformatted one
-    processed_data['data']['policy']['internetFirewall']['policy']['sections'] = processed_sections
-        
-    # Write the processed data to the new file
-    with open(output_file, 'w', encoding='utf-8') as f:
-        json.dump(processed_data, f, indent=4, ensure_ascii=False)    
-    print(f"Successfully created {output_file}")
-    
-
-if __name__ == "__main__":
-    main()
-

scripts/export_wf_rules_to_json.py

@@ -1,111 +0,0 @@
-import sys
-import csv
-import subprocess
-import json
-import os
-import argparse
-import catolib
-
-# Configuration variables
-DESTINATION_DIR = "config_data"
-
-def main():
-    # Parse command line arguments
-    parser = argparse.ArgumentParser(description='Export WAN rules to JSON')
-    parser.add_argument('account_id', help='Account ID to export rules from')
-    args = parser.parse_args()
-    
-    ACCOUNT_ID = args.account_id
-    JSON_OUTPUT_FILE = f"all_wf_rules_and_sections_{ACCOUNT_ID}.json"
-    # Create destination directory if it doesn't exist
-    if not os.path.exists(DESTINATION_DIR):
-        print(f"Creating directory: {DESTINATION_DIR}")
-        os.makedirs(DESTINATION_DIR)
-    
-    # Set full file paths
-    output_file = os.path.join(DESTINATION_DIR, JSON_OUTPUT_FILE)
-    policyQuery = {
-        "query": "query policy ( $accountId:ID! ) { policy ( accountId:$accountId ) { wanFirewall { policy { enabled rules { audit { updatedTime updatedBy } rule { id name description index section { id name } enabled source { host { id name } site { id name } subnet ip ipRange { from to } globalIpRange { id name } networkInterface { id name } siteNetworkSubnet { id name } floatingSubnet { id name } user { id name } usersGroup { id name } group { id name } systemGroup { id name } } connectionOrigin country { id name } device { id name } deviceOS deviceAttributes { category type model manufacturer os osVersion } destination { host { id name } site { id name } subnet ip ipRange { from to } globalIpRange { id name } networkInterface { id name } siteNetworkSubnet { id name } floatingSubnet { id name } user { id name } usersGroup { id name } group { id name } systemGroup { id name } } application { application { id name } appCategory { id name } customApp { id name } customCategory { id name } sanctionedAppsCategory { id name } domain fqdn ip subnet ipRange { from to } globalIpRange { id name } } service { standard { id name } custom { port portRange { from to } protocol } } action tracking { event { enabled } alert { enabled frequency subscriptionGroup { id name } webhook { id name } mailingList { id name } } } schedule { activeOn customTimeframePolicySchedule: customTimeframe { from to } customRecurringPolicySchedule: customRecurring { from to days } } direction exceptions { name source { host { id name } site { id name } subnet ip ipRange { from to } globalIpRange { id name } networkInterface { id name } siteNetworkSubnet { id name } floatingSubnet { id name } user { id name } usersGroup { id name } group { id name } systemGroup { id name } } deviceOS destination { host { id name } site { id name } subnet ip ipRange { from to } globalIpRange { id name } networkInterface { id name } siteNetworkSubnet { id name } floatingSubnet { id name } user { id name } usersGroup { id name } group { id name } systemGroup { id name } } country { id name } device { id name } deviceAttributes { category type model manufacturer os osVersion } application { application { id name } appCategory { id name } customApp { id name } customCategory { id name } sanctionedAppsCategory { id name } domain fqdn ip subnet ipRange { from to } globalIpRange { id name } } service { standard { id name } custom { port portRangeCustomService: portRange { from to } protocol } } connectionOrigin direction } } properties } sections { audit { updatedTime updatedBy } section { id name } properties } audit { publishedTime publishedBy } revision { id name description changes createdTime updatedTime } } } } }",
-        "variables": {
-            "accountId": ACCOUNT_ID
-        },
-        "operationName": "policy"
-    }
-    catocliCommand = "catocli raw '"+json.dumps(policyQuery)+"'"
-    print(f"Retrieving all WAN rules and sections for account {ACCOUNT_ID}...")
-    allWanRules = catolib.exec_cli(catocliCommand)
-    
-    ## Processing data to strip id attributes
-    processed_data = catolib.strip_ids_recursive(allWanRules)
-
-    ## Preserving section IDs index by section name
-    section_id_map = {}
-    if 'data' in allWanRules and 'policy' in allWanRules['data'] and 'wanFirewall' in allWanRules['data']['policy']:
-        for section_data in allWanRules['data']['policy']['wanFirewall']['policy']['sections']:
-            section_id_map[section_data['section']['name']] = section_data['section']['id']
-    processed_data['data']['policy']['wanFirewall']['policy']['section_ids'] = section_id_map
-    
-    ## Filter out rules with properties[0]=="SYSTEM"
-    filtered_rules = []
-    for rule_data in processed_data['data']['policy']['wanFirewall']['policy']['rules']:
-        rule_properties = rule_data.get('properties', [])
-        # Skip rules where the first property is "SYSTEM"
-        if rule_properties and rule_properties[0] == "SYSTEM":
-            print(f"Excluding SYSTEM rule: {rule_data['rule']['name']}")
-        else:
-            filtered_rules.append(rule_data)
-    processed_data['data']['policy']['wanFirewall']['policy']['rules'] = filtered_rules
-    # rules = filtered_rules
-    
-    # Add index_in_section to each rule
-    # Group rules by section and add index_in_section
-    section_counters = {}
-    for rule_data in processed_data['data']['policy']['wanFirewall']['policy']['rules']:
-        section_name = rule_data['rule']['section']['name']
-        if section_name not in section_counters:
-            section_counters[section_name] = 0
-        section_counters[section_name] += 1
-        rule_data['rule']['index_in_section'] = section_counters[section_name]
-    
-    # Create rules_in_sections array
-    rules_in_sections = []
-    for rule_data in processed_data['data']['policy']['wanFirewall']['policy']['rules']:
-        rule_info = rule_data['rule']
-        rules_in_sections.append({
-            "index_in_section": rule_info['index_in_section'],
-            "section_name": rule_info['section']['name'],
-            "rule_name": rule_info['name']
-        })
-        rule_info.pop("index_in_section", None)
-        rule_info.pop("index", None)
-        rule_info["enabled"] = True
-
-    # Add rules_in_sections to the policy structure
-    processed_data['data']['policy']['wanFirewall']['policy']['rules_in_sections'] = rules_in_sections
-    
-    # Reformat sections array to have index, section_id and section_name structure
-    # Exclude the first section from export, excluding first section
-    
-    processed_sections = []
-    # Add first section containing reserved SYSTEM rules as section_to_start_after_id
-    for index, section_data in enumerate(processed_data['data']['policy']['wanFirewall']['policy']['sections']):
-        processed_sections.append({
-            "section_index": index,
-            "section_name": section_data['section']['name']
-        })
-
-    if len(processed_data['data']['policy']['wanFirewall']['policy']['sections']) > 0:
-        print(f"Excluded first section: {processed_data['data']['policy']['wanFirewall']['policy']['sections'][0]['section']['name']} containing reserved SYSTEM rules")
-    
-    # Replace the original sections array with the reformatted one
-    processed_data['data']['policy']['wanFirewall']['policy']['sections'] = processed_sections
-        
-    # Write the processed data to the new file
-    with open(output_file, 'w', encoding='utf-8') as f:
-        json.dump(processed_data, f, indent=4, ensure_ascii=False)    
-    print(f"Successfully created {output_file}")
-    
-
-if __name__ == "__main__":
-    main()
-