catocli 2.0.3__tar.gz → 2.0.4__tar.gz

{catocli-2.0.3/catocli.egg-info → catocli-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: catocli
-Version: 2.0.3
+Version: 2.0.4
 Summary: Cato Networks cli wrapper for the GraphQL API.
 Home-page: https://github.com/Cato-Networks/cato-cli
 Author: Cato Networks

{catocli-2.0.3 → catocli-2.0.4}/catocli/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "2.0.3"
+__version__ = "2.0.4"
 __cato_host__ = "https://api.catonetworks.com/api/v1/graphql2"

{catocli-2.0.3 → catocli-2.0.4}/catocli/parsers/custom/export_rules/__init__.py

@@ -20,6 +20,7 @@ def export_rules_parse(subparsers):
     
     if_rules_parser.add_argument('-accountID', help='Account ID to export rules from (uses CATO_ACCOUNT_ID environment variable if not specified)', required=False)
     if_rules_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')
+    if_rules_parser.add_argument('--append-timestamp', action='store_true', help='Append timestamp to the filename after account ID (format: YYYY-MM-DD_HH-MM-SS)')
     if_rules_parser.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
     
     if_rules_parser.set_defaults(func=export_rules.export_if_rules_to_json)
@@ -33,6 +34,7 @@ def export_rules_parse(subparsers):
     
     wf_rules_parser.add_argument('-accountID', help='Account ID to export rules from (uses CATO_ACCOUNT_ID environment variable if not specified)', required=False)
     wf_rules_parser.add_argument('--output-file-path', help='Full path including filename and extension for output file. If not specified, uses default: config_data/all_wf_rules_and_sections_{account_id}.json')
+    wf_rules_parser.add_argument('--append-timestamp', action='store_true', help='Append timestamp to the filename after account ID (format: YYYY-MM-DD_HH-MM-SS)')
     wf_rules_parser.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
     
     wf_rules_parser.set_defaults(func=export_rules.export_wf_rules_to_json)

{catocli-2.0.3 → catocli-2.0.4}/catocli/parsers/custom/export_rules/export_rules.py

@@ -1,6 +1,7 @@
 import os
 import json
 import sys
+from datetime import datetime
 from graphql_client.api.call_api import ApiClient, CallApi
 from graphql_client.api_client import ApiException
 from ..customLib import writeDataToFile, makeCall, getAccountID
@@ -64,10 +65,15 @@ def export_if_rules_to_json(args, configuration):
         processed_data['data']['policy']['internetFirewall']['policy']['rules'] = filtered_rules
         
         # Add index_in_section to each rule
-        # Group rules by section and add index_in_section
+        # Handle empty section names by assigning a default section name
         section_counters = {}
         for rule_data in processed_data['data']['policy']['internetFirewall']['policy']['rules']:
             section_name = rule_data['rule']['section']['name']
+            # If section name is empty, use "Default Section" as the section name
+            if not section_name or section_name.strip() == "":
+                section_name = "Default Section"
+                rule_data['rule']['section']['name'] = section_name
+            
             if section_name not in section_counters:
                 section_counters[section_name] = 0
             section_counters[section_name] += 1
@@ -104,12 +110,18 @@ def export_if_rules_to_json(args, configuration):
         
         # Replace the original sections array with the reformatted one
         processed_data['data']['policy']['internetFirewall']['policy']['sections'] = processed_sections
+        
+        # Handle timestamp in filename if requested
+        filename_template = "all_ifw_rules_and_sections_{account_id}.json"
+        if hasattr(args, 'append_timestamp') and args.append_timestamp:
+            timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+            filename_template = "all_ifw_rules_and_sections_{account_id}_" + timestamp + ".json"
             
         output_file = writeDataToFile(
             data=processed_data,
             args=args,
             account_id=account_id,
-            default_filename_template="all_ifw_rules_and_sections_{account_id}.json",
+            default_filename_template=filename_template,
             default_directory="config_data"
         )
 
@@ -157,9 +169,15 @@ def export_wf_rules_to_json(args, configuration):
         processed_data['data']['policy']['wanFirewall']['policy']['rules'] = filtered_rules
         
         # Add index_in_section to each rule
+        # Handle empty section names by assigning a default section name
         section_counters = {}
         for rule_data in processed_data['data']['policy']['wanFirewall']['policy']['rules']:
             section_name = rule_data['rule']['section']['name']
+            # If section name is empty, use "Default Section" as the section name
+            if not section_name or section_name.strip() == "":
+                section_name = "Default Section"
+                rule_data['rule']['section']['name'] = section_name
+            
             if section_name not in section_counters:
                 section_counters[section_name] = 0
             section_counters[section_name] += 1
@@ -174,8 +192,8 @@ def export_wf_rules_to_json(args, configuration):
                 "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.pop("index_in_section", None)
+            rule_info.pop("index", None)
             # rule_info["enabled"] = True
 
         # Add rules_in_sections to the policy structure
@@ -194,12 +212,18 @@ def export_wf_rules_to_json(args, configuration):
         
         # Replace the original sections array with the reformatted one
         processed_data['data']['policy']['wanFirewall']['policy']['sections'] = processed_sections
+        
+        # Handle timestamp in filename if requested
+        filename_template = "all_wf_rules_and_sections_{account_id}.json"
+        if hasattr(args, 'append_timestamp') and args.append_timestamp:
+            timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+            filename_template = "all_wf_rules_and_sections_{account_id}_" + timestamp + ".json"
             
         output_file = writeDataToFile(
             data=processed_data,
             args=args,
             account_id=account_id,
-            default_filename_template="all_wf_rules_and_sections_{account_id}.json",
+            default_filename_template=filename_template,
             default_directory="config_data"
         )
         

{catocli-2.0.3 → catocli-2.0.4}/catocli/parsers/custom/export_sites/__init__.py

@@ -13,6 +13,7 @@ def export_sites_parse(subparsers):
     socket_sites_parser.add_argument('-accountID', help='Account ID to export data from (uses CATO_ACCOUNT_ID environment variable if not specified)', required=False)
     socket_sites_parser.add_argument('-siteIDs', help='Comma-separated list of site IDs to export (e.g., "132606,132964,133511")', required=False)
     socket_sites_parser.add_argument('--output-file-path', help='Full path including filename and extension for output file. If not specified, uses default: config_data/socket_site_data_{account_id}.json')
+    socket_sites_parser.add_argument('--append-timestamp', action='store_true', help='Append timestamp to the filename after account ID (format: YYYY-MM-DD_HH-MM-SS)')
     socket_sites_parser.add_argument('-v', '--verbose', action='store_true', help='Verbose output')
     
     socket_sites_parser.set_defaults(func=export_sites.export_socket_site_to_json)

{catocli-2.0.3 → catocli-2.0.4}/catocli/parsers/custom/export_sites/export_sites.py

@@ -2,6 +2,7 @@ import os
 import json
 import traceback
 import sys
+from datetime import datetime
 from graphql_client.api.call_api import ApiClient, CallApi
 from graphql_client.api_client import ApiException
 from ..customLib import writeDataToFile, makeCall, getAccountID
@@ -200,12 +201,18 @@ def export_socket_site_to_json(args, configuration):
             print(f"This is usually caused by data inconsistencies and can be safely ignored if the export completes successfully.")
             print(f"=========================\n")
         
+        # Handle timestamp in filename if requested
+        filename_template = "socket_sites_{account_id}.json"
+        if hasattr(args, 'append_timestamp') and args.append_timestamp:
+            timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+            filename_template = "socket_sites_{account_id}_" + timestamp + ".json"
+            
         # Write the processed data to file using the general-purpose function
         output_file = writeDataToFile(
             data=processed_data,
             args=args,
             account_id=account_id,
-            default_filename_template="socket_sites_{account_id}.json",
+            default_filename_template=filename_template,
             default_directory="config_data"
         )
         

{catocli-2.0.3 → catocli-2.0.4}/catocli/parsers/parserApiClient.py

@@ -6,6 +6,8 @@ from graphql_client import ApiClient, CallApi
 from graphql_client.api_client import ApiException
 import logging
 import pprint
+import uuid
+from urllib3.filepost import encode_multipart_formdata
 
 def createRequest(args, configuration):
 	params = vars(args)
@@ -134,6 +136,11 @@ def createRawRequest(args, configuration):
 	# Handle endpoint override
 	if hasattr(args, 'endpoint') and args.endpoint:
 		configuration.host = args.endpoint
+	
+	# Check if binary/multipart mode is enabled
+	if hasattr(args, 'binary') and args.binary:
+		return createRawBinaryRequest(args, configuration)
+		
 	instance = CallApi(ApiClient(configuration))
 	isOk = False
 	try:
@@ -334,4 +341,159 @@ def renderArgsAndFields(responseArgStr, variablesObj, curOperation, definition,
 					responseArgStr += indent + "	}\n"
 			responseArgStr += indent + "}\n"
 		responseArgStr += "\n"
-	return responseArgStr
+		return responseArgStr
+
+def createRawBinaryRequest(args, configuration):
+	"""Handle multipart/form-data requests for file uploads and binary content"""
+	params = vars(args)
+	
+	
+	# Parse the JSON body
+	try:
+		body = json.loads(params["json"])
+	except ValueError as e:
+		print("ERROR: JSON argument must be valid json. ", e)
+		return
+	except Exception as e:
+		print("ERROR: ", e)
+		return
+	
+	# Build form data
+	form_fields = {}
+	files = []
+	
+	# Add the operations field containing the GraphQL payload
+	form_fields['operations'] = json.dumps(body)
+	
+	# Handle file mappings if files are specified
+	if hasattr(args, 'files') and args.files:
+		# Build the map object for file uploads
+		file_map = {}
+		for i, (field_name, file_path) in enumerate(args.files):
+			file_index = str(i + 1)
+			file_map[file_index] = [field_name]
+			
+			# Read file content
+			try:
+				with open(file_path, 'rb') as f:
+					file_content = f.read()
+				files.append((file_index, (os.path.basename(file_path), file_content, 'application/octet-stream')))
+			except IOError as e:
+				print(f"ERROR: Could not read file {file_path}: {e}")
+				return
+				
+		# Add the map field
+		form_fields['map'] = json.dumps(file_map)
+	
+	# Test mode - just print the request structure
+	if params.get("t") == True:
+		print("Multipart form data request:")
+		if params.get("p") == True:
+			print(f"Operations: {json.dumps(json.loads(form_fields.get('operations')), indent=2)}")
+		else:
+			print(f"Operations: {form_fields.get('operations')}")
+		if 'map' in form_fields:
+			print(f"Map: {form_fields.get('map')}")
+		if files:
+			print(f"Files: {[f[0] + ': ' + f[1][0] for f in files]}")
+		return None
+	
+	# Perform the multipart request
+	try:
+		return sendMultipartRequest(configuration, form_fields, files, params)
+	except Exception as e:
+		# Safely handle exception string conversion
+		try:
+			error_str = str(e)
+		except Exception:
+			error_str = f"Exception of type {type(e).__name__}"
+		
+		if params.get("v") == True:
+			import traceback
+			print(f"ERROR: Failed to send multipart request: {error_str}")
+			traceback.print_exc()
+		else:
+			print(f"ERROR: Failed to send multipart request: {error_str}")
+		return None
+
+def sendMultipartRequest(configuration, form_fields, files, params):
+	"""Send a multipart/form-data request directly using urllib3"""
+	import urllib3
+	
+	# Create pool manager
+	pool_manager = urllib3.PoolManager(
+		cert_reqs='CERT_NONE' if not getattr(configuration, 'verify_ssl', False) else 'CERT_REQUIRED'
+	)
+	
+	# Prepare form data
+	fields = []
+	for key, value in form_fields.items():
+		fields.append((key, value))
+	
+	for file_key, (filename, content, content_type) in files:
+		fields.append((file_key, (filename, content, content_type)))
+	
+	# Encode multipart data
+	body_data, content_type = encode_multipart_formdata(fields)
+	
+	# Prepare headers
+	headers = {
+		'Content-Type': content_type,
+		'User-Agent': f"Cato-CLI-v{getattr(configuration, 'version', 'unknown')}"
+	}
+	
+	# Add API key if not using headers file
+	if hasattr(configuration, 'api_key') and hasattr(configuration, 'api_key') and configuration.api_key and 'x-api-key' in configuration.api_key:
+		headers['x-api-key'] = configuration.api_key['x-api-key']
+	
+	# Add custom headers
+	if hasattr(configuration, 'custom_headers') and configuration.custom_headers:
+		headers.update(configuration.custom_headers)
+	
+	# Verbose output
+	if params.get("v") == True:
+		print(f"Host: {getattr(configuration, 'host', 'unknown')}")
+		masked_headers = headers.copy()
+		if 'x-api-key' in masked_headers:
+			masked_headers['x-api-key'] = '***MASKED***'
+		print(f"Request Headers: {json.dumps(masked_headers, indent=4, sort_keys=True)}")
+		print(f"Content-Type: {content_type}")
+		print(f"Form fields: {list(form_fields.keys())}")
+		print(f"Files: {[f[0] for f in files]}\n")
+	
+	try:
+		# Make the request
+		resp = pool_manager.request(
+			'POST',
+			getattr(configuration, 'host', 'https://api.catonetworks.com/api/v1/graphql'),
+			body=body_data,
+			headers=headers
+		)
+		
+		# Parse response
+		if resp.status < 200 or resp.status >= 300:
+			reason = resp.reason if resp.reason is not None else "Unknown Error"
+			error_msg = f"HTTP {resp.status}: {reason}"
+			if resp.data:
+				try:
+					error_msg += f"\n{resp.data.decode('utf-8')}"
+				except Exception:
+					error_msg += f"\n{resp.data}"
+			print(f"ERROR: {error_msg}")
+			return None
+		
+		try:
+			response_data = json.loads(resp.data.decode('utf-8'))
+		except json.JSONDecodeError:
+			response_data = resp.data.decode('utf-8')
+		
+		return [response_data]
+		
+	except Exception as e:
+		# Safely handle exception string conversion
+		try:
+			error_str = str(e)
+		except Exception:
+			error_str = f"Exception of type {type(e).__name__}"
+		print(f"ERROR: Network/request error: {error_str}")
+		return None

catocli-2.0.4/catocli/parsers/raw/README.md

@@ -0,0 +1,33 @@
+
+## CATO-CLI - raw.graphql
+[Click here](https://api.catonetworks.com/documentation/) for documentation on this operation.
+
+### Usage for raw.graphql
+
+`catocli raw -h`
+
+`catocli raw <json>`
+
+`catocli raw "$(cat < rawGraphqQL.json)"`
+
+`catocli raw '{ "query": "query operationNameHere($yourArgument:String!) { field1 field2 }", "variables": { "yourArgument": "string", "accountID": "10949" }, "operationName": "operationNameHere" } '`
+
+`catocli raw '{ "query": "mutation operationNameHere($yourArgument:String!) { field1 field2 }", "variables": { "yourArgument": "string", "accountID": "10949" }, "operationName": "operationNameHere" } '`
+
+#### Override API endpoint
+
+`catocli raw --endpoint https://custom-api.example.com/graphql '<json>'`
+
+#### Binary content and file uploads
+
+Use `--binary` flag for multipart/form-data requests with file uploads:
+
+`catocli raw --binary --file privateKey /path/to/file.pem '{ "operationName": "accountUpdate", "variables": { "update": { "cloudAccessConfiguration": { "cloudApplications": { "items": [{ "privateKey": null }] } } } }, "query": "mutation accountUpdate($update: AccountInput!) { accountUpdate(update: $update) { id } }" }'`
+
+`catocli raw --binary --file 1 /path/to/file.pem '{ "operationName": "accountUpdate", "variables": { "update": { "version": "1234" } }, "query": "mutation { accountUpdate { id } }" }'`
+
+The `--binary` flag enables multipart/form-data mode which is required for file uploads. Files are specified using `--file field_name file_path` where:
+- `field_name` is the GraphQL variable path where the file should be mapped
+- `file_path` is the local path to the file to upload
+
+Multiple files can be uploaded by using multiple `--file` arguments.

{catocli-2.0.3 → catocli-2.0.4}/catocli/parsers/raw/__init__.py

@@ -9,4 +9,6 @@ def raw_parse(raw_parser):
 	raw_parser.add_argument('-H', '--header', action='append', dest='headers', help='Add custom headers in "Key: Value" format. Can be used multiple times.')
 	raw_parser.add_argument('--headers-file', dest='headers_file', help='Load headers from a file. Each line should contain a header in "Key: Value" format.')
 	raw_parser.add_argument('--endpoint', dest='endpoint', help='Override the API endpoint URL (e.g., https://api.catonetworks.com/api/v1/graphql2)')
+	raw_parser.add_argument('--binary', action='store_true', help='Send multipart/form-data request for file uploads and binary content')
+	raw_parser.add_argument('--file', action='append', nargs=2, metavar=('FIELD', 'PATH'), dest='files', help='Add file for multipart upload. Format: --file field_name file_path')
 	raw_parser.set_defaults(func=createRawRequest,operation_name='raw')

{catocli-2.0.3 → catocli-2.0.4/catocli.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: catocli
-Version: 2.0.3
+Version: 2.0.4
 Summary: Cato Networks cli wrapper for the GraphQL API.
 Home-page: https://github.com/Cato-Networks/cato-cli
 Author: Cato Networks

catocli-2.0.3/catocli/parsers/raw/README.md

@@ -1,19 +0,0 @@
-
-## CATO-CLI - raw.graphql
-[Click here](https://api.catonetworks.com/documentation/) for documentation on this operation.
-
-### Usage for raw.graphql
-
-`catocli raw -h`
-
-`catocli raw <json>`
-
-`catocli raw "$(cat < rawGraphqQL.json)"`
-
-`catocli raw '{ "query": "query operationNameHere($yourArgument:String!) { field1 field2 }", "variables": { "yourArgument": "string", "accountID": "10949" }, "operationName": "operationNameHere" } '`
-
-`catocli raw '{ "query": "mutation operationNameHere($yourArgument:String!) { field1 field2 }", "variables": { "yourArgument": "string", "accountID": "10949" }, "operationName": "operationNameHere" } '`
-
-#### Override API endpoint
-
-`catocli raw --endpoint https://custom-api.example.com/graphql '<json>'`