Merge branch 'tkt_71_add_soport_for_tags_plugins' into 'dev'

Replace the apply_tag function with plugins parameters

Closes #71

See merge request faradaysec/faraday-cli!70

Author: Nicolas Rebagliati

CHANGELOG/current/add_soport_for_tags_plugins.md

@@ -0,0 +1 @@
+Replace the apply_tag function with plugins parameters

faraday_cli/api_client/faraday_api.py

@@ -300,6 +300,9 @@ def run_executor(
         args,
         ignore_info,
         hostname_resolution,
+        vuln_tag,
+        host_tag,
+        service_tag,
     ):
         body = {
             "executor_data": {
@@ -310,6 +313,9 @@ def run_executor(
             "workspaces_names": workspaces_names,
             "ignore_info": ignore_info,
             "hostname_resolution": hostname_resolution,
+            "vuln_tag": vuln_tag,
+            "host_tag": host_tag,
+            "service_tag": service_tag,
         }
         response = self.faraday_api.agent.run(agent_id, body=body)
         return response.body

faraday_cli/shell/modules/agent.py

@@ -163,13 +163,43 @@ def get_agent(self, args: argparse.Namespace):
         type=str,
         help="Workspace name",
     )
+    run_executor_parser.add_argument(
+        "--vuln-tag",
+        type=str,
+        help="Tag to add to vulnerabilities",
+        required=False,
+        action="append",
+        default=[],
+    )
+    run_executor_parser.add_argument(
+        "--host-tag",
+        type=str,
+        help="Tag to add to hosts",
+        required=False,
+        action="append",
+        default=[],
+    )
+    run_executor_parser.add_argument(
+        "--service-tag",
+        type=str,
+        help="Tag to add to services",
+        required=False,
+        action="append",
+        default=[],
+    )
 
     @cmd2.as_subcommand_to(
         "agent", "run", run_executor_parser, help="run an executor"
     )
     def run_executor(self, args):
         """Run executor"""
         ask_for_parameters = False
+        if isinstance(args.vuln_tag, str):
+            args.vuln_tag = [args.vuln_tag]
+        if isinstance(args.host_tag, str):
+            args.host_tag = [args.host_tag]
+        if isinstance(args.service_tag, str):
+            args.service_tag = [args.service_tag]
         if args.stdin:
             executor_params = sys.stdin.read()
         else:
@@ -278,6 +308,9 @@ def run_executor(self, args):
                             json.loads(executor_params),
                             self._cmd.ignore_info_severity,
                             self._cmd.hostname_resolution,
+                            args.vuln_tag,
+                            args.host_tag,
+                            args.service_tag,
                         )
                     except Exception as e:
                         self._cmd.perror(str(e))

faraday_cli/shell/modules/reports.py

@@ -6,7 +6,6 @@
 import cmd2
 from cmd2 import Fg as COLORS
 from faraday_cli.config import active_config
-from faraday_cli.shell.utils import apply_tags
 
 
 @cmd2.with_default_category("Tools Reports")
@@ -36,21 +35,21 @@ def __init__(self):
         help="Show output in json (dont send to faraday)",
     )
     report_parser.add_argument(
-        "--tag-vuln",
+        "--vuln-tag",
         type=str,
         help="Tag to add to vulnerabilities",
         required=False,
         action="append",
     )
     report_parser.add_argument(
-        "--tag-host",
+        "--host-tag",
         type=str,
         help="Tag to add to hosts",
         required=False,
         action="append",
     )
     report_parser.add_argument(
-        "--tag-service",
+        "--service-tag",
         type=str,
         help="Tag to add to services",
         required=False,
@@ -117,18 +116,18 @@ def process_report(self, args: argparse.Namespace):
                     fg=COLORS.GREEN,
                 )
             )
+        plugin.vuln_tag = args.vuln_tag
+        plugin.host_tag = args.host_tag
+        plugin.service_tag = args.service_tag
         plugin.processReport(
             report_path.absolute().as_posix(), getpass.getuser()
         )
-        report_json = apply_tags(
-            plugin.get_data(), args.tag_host, args.tag_service, args.tag_vuln
-        )
         if args.json_output:
-            self._cmd.poutput(json.dumps(report_json, indent=4))
+            self._cmd.poutput(json.dumps(plugin.get_data(), indent=4))
         else:
             self._cmd.data_queue.put(
                 {
                     "workspace": destination_workspace,
-                    "json_data": report_json,
+                    "json_data": plugin.get_data(),
                 }
             )

faraday_cli/shell/modules/tools.py

@@ -34,21 +34,21 @@ def __init__(self):
         help="Show output in json (dont send it to faraday)",
     )
     tool_parser.add_argument(
-        "--tag-vuln",
+        "--vuln-tag",
         type=str,
         help="Tag to add to vulnerabilities",
         required=False,
         action="append",
     )
     tool_parser.add_argument(
-        "--tag-host",
+        "--host-tag",
         type=str,
         help="Tag to add to hosts",
         required=False,
         action="append",
     )
     tool_parser.add_argument(
-        "--tag-service",
+        "--service-tag",
         type=str,
         help="Tag to add to services",
         required=False,
@@ -108,6 +108,9 @@ def process_tool(self, args):
                         fg=COLORS.GREEN,
                     )
                 )
+            plugin.vuln_tag = args.vuln_tag
+            plugin.host_tag = args.host_tag
+            plugin.service_tag = args.service_tag
             show_command_output = not args.json_output
             command_json = utils.run_tool(
                 plugin,
@@ -120,12 +123,6 @@ def process_tool(self, args):
                     f"{self._cmd.emojis['cross']} Command execution error!!"
                 )
             else:
-                command_json = utils.apply_tags(
-                    command_json,
-                    args.tag_host,
-                    args.tag_service,
-                    args.tag_vuln,
-                )
                 if args.json_output:
                     self._cmd.poutput(json.dumps(command_json, indent=4))
                 else:

faraday_cli/shell/utils.py

@@ -167,25 +167,3 @@ def run_tool(plugin, user, command, show_output=True):
         return plugin.get_data()
     else:
         return None
-
-
-def apply_tags(data, host_tags, service_tags, vuln_tags):
-    if vuln_tags or host_tags or service_tags:
-        for host in data["hosts"]:
-            if host_tags:
-                for tag in host_tags:
-                    host["tags"].append(tag)
-            if vuln_tags:
-                for vuln in host["vulnerabilities"]:
-                    for tag in vuln_tags:
-                        vuln["tags"].append(tag)
-            if vuln_tags or service_tags:
-                for service in host["services"]:
-                    if service_tags:
-                        for tag in service_tags:
-                            service["tags"].append(tag)
-                    if vuln_tags:
-                        for vuln in service["vulnerabilities"]:
-                            for tag in vuln_tags:
-                                vuln["tags"].append(tag)
-    return data