secator 0.22.0__py3-none-any.whl

secator/rich.py

@@ -0,0 +1,130 @@
+import operator
+from pathlib import Path
+
+import yaml
+from rich.console import Console
+from rich.table import Table
+
+console = Console(stderr=True, record=True)
+console_stdout = Console(record=True)
+# handler = RichHandler(rich_tracebacks=True)  # TODO: add logging handler
+
+
+def criticity_to_color(value):
+	if value == 'critical':
+		value = f'[bold red3]{value.upper()}[/]'
+	elif value == 'high':
+		value = f'[bold orange_red1]{value.upper()}[/]'
+	elif value == 'medium':
+		value = f'[bold dark_orange]{value.upper()}[/]'
+	elif value == 'low':
+		value = f'[bold yellow1]{value.upper()}[/]'
+	elif value == 'info':
+		value = f'[bold green]{value.upper()}[/]'
+	return value
+
+
+def status_to_color(value):
+	value = int(value) if value else None
+	if value is None:
+		return value
+	if value < 400:
+		value = f'[bold green]{value}[/]'
+	elif value in [400, 499]:
+		value = f'[bold dark_orange]{value}[/]'
+	elif value >= 500:
+		value = f'[bold red3]{value}[/]'
+	return value
+
+
+FORMATTERS = {
+	'confidence': lambda x: f'[dim]{x.upper()}[/]',
+	'severity': criticity_to_color,
+	'cvss_score': lambda score: '' if score == -1 else f'[bold cyan]{score}[/]',
+	'port': lambda port: f'[bold cyan]{port}[/]',
+	'url': lambda host: f'[bold underline blue link={host}]{host}[/]',
+	'stored_response_path': lambda path: f'[link=file://{path}]:pencil:[/]' if path and Path(path).exists() else '',
+	'screenshot_path': lambda path: f'[link=file://{path}]:camera:[/]' if path and Path(path).exists() else '',
+	'ip': lambda ip: f'[bold yellow]{ip}[/]',
+	'status_code': status_to_color,
+	'reference': lambda reference: f'[link={reference}]{reference}[/]' if reference else '',
+	'matched_at': lambda matched_at: f'[link={matched_at}]{matched_at}[/]' if matched_at and matched_at.startswith('http') else '',  # noqa: E501
+	'match': lambda match: f'[link={match}]{match}[/]' if match else '',
+	'_source': lambda source: f'[bold gold3]{source}[/]'
+}
+
+
+def build_table(items, output_fields=[], exclude_fields=[], sort_by=None):
+	"""Build rich table.
+
+	Args:
+		items (list): List of items.
+		output_fields (list, Optional): List of fields to add.
+		exclude_fields (list, Optional): List of fields to exclude.
+		sort_by (tuple, Optional): Tuple of sort_by keys.
+
+	Returns:
+		rich.table.Table: rich table.
+	"""
+	# Sort items by one or multiple fields
+	if sort_by and all(sort_by):
+		items = sorted(items, key=operator.attrgetter(*sort_by))
+
+	# Create rich table
+	table = Table(show_lines=True)
+
+	# Get table schema if any, default to first item keys
+	keys = []
+	if output_fields:
+		keys = [k for k in output_fields if k not in exclude_fields]
+		# Remove meta fields not needed in output
+		if '_cls' in keys:
+			keys.remove('_cls')
+		if '_type' in keys:
+			keys.remove('_type')
+		if '_uuid' in keys:
+			keys.remove('_uuid')
+
+		# Add _source field
+		if '_source' not in keys:
+			keys.append('_source')
+
+		# Create table columns
+		for key in keys:
+			key_str = key
+			if not key.startswith('_'):
+				key_str = ' '.join(key.split('_')).title()
+			# TODO: remove this as it's not needed anymore
+			# no_wrap = key in ['url', 'reference', 'references', 'matched_at']
+			# overflow = None if no_wrap else 'fold'
+			# print('key: ', key_str, 'overflow: ', overflow, 'no_wrap: ', no_wrap)
+			# table.add_column(
+			# 	key_str,
+			# 	overflow=overflow,
+			# 	min_width=10,
+			# 	no_wrap=no_wrap)
+			table.add_column(key_str)
+
+	if not keys:
+		table.add_column(
+			'Extracted values',
+			overflow=False,
+			min_width=10,
+			no_wrap=False)
+
+	# Create table rows
+	for item in items:
+		values = []
+		if keys:
+			for key in keys:
+				value = getattr(item, key) if keys else item
+				value = FORMATTERS.get(key, lambda x: x)(value) if keys else item
+				if isinstance(value, dict) or isinstance(value, list):
+					value = yaml.dump(value)
+				elif isinstance(value, int) or isinstance(value, float):
+					value = str(value)
+				values.append(value)
+		else:
+			values = [item]
+		table.add_row(*values)
+	return table

secator/runners/__init__.py

@@ -0,0 +1,14 @@
+__all__ = [
+    'Runner',
+    'Command',
+    'Task',
+    'Workflow',
+    'Scan',
+    'PythonRunner',
+]
+from secator.runners._base import Runner
+from secator.runners.command import Command
+from secator.runners.task import Task
+from secator.runners.scan import Scan
+from secator.runners.workflow import Workflow
+from secator.runners.python import PythonRunner