From f075c2db3722439eecaefa9efee524c273c32041 Mon Sep 17 00:00:00 2001 From: Prateek Thakare Date: Thu, 7 Dec 2023 20:14:08 +0530 Subject: [PATCH] Fixed broken links in docs --- src/basics-mantis-code/basics.md | 8 ++++---- src/configuration/config-file.md | 8 ++++---- src/configuration/configuration.md | 4 ++-- src/features/advanced_alerting.md | 2 +- src/features/distributed_scanning.md | 2 +- src/features/new_scanner.md | 2 +- src/features/workflow_customisation.md | 2 +- src/new-scanner-integrations/command-line-class.md | 8 ++++---- .../new-scanner-integration-api.md | 4 ++-- 9 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/basics-mantis-code/basics.md b/src/basics-mantis-code/basics.md index 7e58b8f..d0b3729 100644 --- a/src/basics-mantis-code/basics.md +++ b/src/basics-mantis-code/basics.md @@ -5,10 +5,10 @@ Before you add a new module or scanner to Mantis yourself, it is important to un In this walkthrough, we shall mainly focus on: -- [Mantis folder structure](/./basics-mantis-code/folder-structure.md) - This will help you understand exactly where you need to make changes for new integrations -- [Base scanner class](/./basics-mantis-code/scanner-base-class.md) - Based on the scanner that you want to integrate, this will help you choose the base class that you need to inherit -- [Important utility functions](/./basics-mantis-code/important-utils.md) - If your new scanner only accepts IP addresses, TLDs, or sometimes both, you don't have to write any queries or functions to validate the inputs. Mantis has built-in utility functions that can provide you with this input directly. -- [DB models](/./basics-mantis-code/db-models.md) - After your new scanner completes its scan, you'll need to insert the results into MongoDB. To do so, you'll need to understand the schema that is in place. This will help you do that. +- [Mantis folder structure](/./mantis/basics-mantis-code/folder-structure.md) - This will help you understand exactly where you need to make changes for new integrations +- [Base scanner class](/./mantis/basics-mantis-code/scanner-base-class.md) - Based on the scanner that you want to integrate, this will help you choose the base class that you need to inherit +- [Important utility functions](/./mantis/basics-mantis-code/important-utils.md) - If your new scanner only accepts IP addresses, TLDs, or sometimes both, you don't have to write any queries or functions to validate the inputs. Mantis has built-in utility functions that can provide you with this input directly. +- [DB models](/./mantis/basics-mantis-code/db-models.md) - After your new scanner completes its scan, you'll need to insert the results into MongoDB. To do so, you'll need to understand the schema that is in place. This will help you do that. A basic understanding of the above will simplify any new integrations with Mantis. diff --git a/src/configuration/config-file.md b/src/configuration/config-file.md index 3bf4360..4c57fff 100644 --- a/src/configuration/config-file.md +++ b/src/configuration/config-file.md @@ -2,7 +2,7 @@ --- Mantis Config file provides multiple customisations including: -- [**Workflow Customisation**](/./configuration/workflow-config.md) -- [**Scheduler Customisation**](/./configuration/scheduler-config.md) -- [**Setting App Context**](/./configuration/app-context-config.md) -- [**Slack Alerting**](/./configuration/slack-config.md) +- [**Workflow Customisation**](/./mantis/configuration/workflow-config.md) +- [**Scheduler Customisation**](/./mantis/configuration/scheduler-config.md) +- [**Setting App Context**](/./mantis/configuration/app-context-config.md) +- [**Slack Alerting**](/./mantis/configuration/slack-config.md) diff --git a/src/configuration/configuration.md b/src/configuration/configuration.md index 1461d5d..fb53960 100644 --- a/src/configuration/configuration.md +++ b/src/configuration/configuration.md @@ -2,8 +2,8 @@ Once you have setup Mantis, you can now look at customising your scan requirements. Scan customisations are available via: -- [Config File](/./mantis/configuration/config-file.md) - contains customisations related to scan workflow, scheduling, notifications etc. -- [Command Line](/./mantis/configuration/command-line.md) - contains basic options to onboard your assets and scan +- [Config File](/./mantis/mantis/configuration/config-file.md) - contains customisations related to scan workflow, scheduling, notifications etc. +- [Command Line](/./mantis/mantis/configuration/command-line.md) - contains basic options to onboard your assets and scan > INFO💡- Config File Path: /mantis/config/local.yml diff --git a/src/features/advanced_alerting.md b/src/features/advanced_alerting.md index 6634742..41cf950 100644 --- a/src/features/advanced_alerting.md +++ b/src/features/advanced_alerting.md @@ -27,4 +27,4 @@ Currently, we support notifications via **slack** Slack Tag ### Understanding config.yml -> INFO💡: For more details on config.yml and how to edit it, [Click here](/./configuration/configuration.md) +> INFO💡: For more details on config.yml and how to edit it, [Click here](/./mantis/configuration/configuration.md) diff --git a/src/features/distributed_scanning.md b/src/features/distributed_scanning.md index bdf5dd9..dd6c93b 100644 --- a/src/features/distributed_scanning.md +++ b/src/features/distributed_scanning.md @@ -16,7 +16,7 @@ Mantis is one of the first recon automation framework that that allows you to ** Mantis uses [Ray](https://www.ray.io) framework to scale. [Ray Core](https://docs.ray.io/en/latest/ray-core/walkthrough.html) provides a small number of core primitives (i.e., tasks, actors, objects) for building and scaling distributed applications. -> Please Note - A short infrastructure setup is required before utilising this feature as [described here](/./installation/installation-multiple.md) +> Please Note - A short infrastructure setup is required before utilising this feature as [described here](/./mantis/installation/installation-multiple.md) Mantis diff --git a/src/features/new_scanner.md b/src/features/new_scanner.md index 1bc754c..8b0d797 100644 --- a/src/features/new_scanner.md +++ b/src/features/new_scanner.md @@ -25,5 +25,5 @@ To add a new tool, this is what you need to do: - **db_operations()**, insert the information to database and this is where its simple, we have built-in functions that takes care of everything - Add the install instructions in **DockerFile** -> INFO💡: For a more detailed understanding on how to integrate a new scanner, [Click here](/./new-scanner-integrations/new-scanner-integration.md) +> INFO💡: For a more detailed understanding on how to integrate a new scanner, [Click here](/./mantis/new-scanner-integrations/new-scanner-integration.md) diff --git a/src/features/workflow_customisation.md b/src/features/workflow_customisation.md index 4e287ea..1c0b626 100644 --- a/src/features/workflow_customisation.md +++ b/src/features/workflow_customisation.md @@ -75,4 +75,4 @@ workflow: order: 1 ``` ## Understanding config.yml -> INFO💡: For more details on config.yml and how to edit it, [Click here](/./configuration/configuration.md) \ No newline at end of file +> INFO💡: For more details on config.yml and how to edit it, [Click here](/./mantis/configuration/configuration.md) \ No newline at end of file diff --git a/src/new-scanner-integrations/command-line-class.md b/src/new-scanner-integrations/command-line-class.md index c998750..9103d79 100644 --- a/src/new-scanner-integrations/command-line-class.md +++ b/src/new-scanner-integrations/command-line-class.md @@ -16,7 +16,7 @@ As a first step to integrate a new scanner, answer the below questions: - **What is the input that the tool takes, meaning, TLDs, subdomains, IPs etc.?** - Amass takes TLDs as an input -Now that we have a clear understanding of the expected input and output from the tool, let's begin the process of creating the scanner class. As previously indicated [here](/./basics-mantis-code/scanner-base-class.md), we are required to implement three functions: +Now that we have a clear understanding of the expected input and output from the tool, let's begin the process of creating the scanner class. As previously indicated [here](/./mantis/basics-mantis-code/scanner-base-class.md), we are required to implement three functions: - base_get_commands() or get_commands() - parse_report() @@ -45,14 +45,14 @@ def get_commands(self, assets): - **self.outfile_extension** indicates the output file extension - **self.assets** exclusively extract TLDs from the database, which are then supplied as input to Amass -> Info💡- As mentioned [here](/./basics-mantis-code/important-utils.md), Mantis incorporates a range of pre-existing utility functions to facilitate the seamless integration of new tools +> Info💡- As mentioned [here](/./mantis/basics-mantis-code/important-utils.md), Mantis incorporates a range of pre-existing utility functions to facilitate the seamless integration of new tools ## Implementing parse_report() This function is required to parse what the scanner outputs and insert it into the database. In this context, a list of subdomains need to be extrated and inserted into the database. -> Info💡- To understand the DB schema, click [here](/./basics-mantis-code/db-models.md) +> Info💡- To understand the DB schema, click [here](/./mantis/basics-mantis-code/db-models.md) ```python def parse_report(self, outfile): @@ -86,7 +86,7 @@ async def db_operations(self, tool_output_dict, asset=None): This is straight forward, call the corresponding util function to insert the data into mongoDB. -> Info💡- Depending on whether you are inserting an asset, or updating an asset for recon information, or adding a new finding, you can use the corresponding util functions as described [here](/./basics-mantis-code/important-utils.md) +> Info💡- Depending on whether you are inserting an asset, or updating an asset for recon information, or adding a new finding, you can use the corresponding util functions as described [here](/./mantis/basics-mantis-code/important-utils.md) > ⏭️ In a similar fashion let's try to add a new API scanner. diff --git a/src/new-scanner-integrations/new-scanner-integration-api.md b/src/new-scanner-integrations/new-scanner-integration-api.md index 8935894..88d196d 100644 --- a/src/new-scanner-integrations/new-scanner-integration-api.md +++ b/src/new-scanner-integrations/new-scanner-integration-api.md @@ -16,7 +16,7 @@ As a first step to integrate a new scanner, answer the below questions: - **What is the input that the tool takes, meaning, TLDs, subdomains, IPs etc.?** - SSLMate takes TLDs as an input -Now that we have a clear understanding of the expected input and output from the tool, let's begin the process of creating the scanner class. As previously indicated [here](/./basics-mantis-code/scanner-base-class.md), we are required to implement three functions: +Now that we have a clear understanding of the expected input and output from the tool, let's begin the process of creating the scanner class. As previously indicated [here](/./mantis/basics-mantis-code/scanner-base-class.md), we are required to implement three functions: - get_api_calls() - parse_reponse() @@ -99,6 +99,6 @@ The final step is to insert the data into mongoDB ``` This is straight forward, call the corresponding util function to insert the data into mongoDB. -> Info💡- Depending on whether you are inserting an asset, or updating an asset for recon information, or adding a new finding, you can use the corresponding util functions as described [here](/./basics-mantis-code/important-utils.md) +> Info💡- Depending on whether you are inserting an asset, or updating an asset for recon information, or adding a new finding, you can use the corresponding util functions as described [here](/./mantis/basics-mantis-code/important-utils.md) > Let's now look at adding the new scanner to the config file. \ No newline at end of file