From e795741e53fad5d93f6727934d545ba390673f95 Mon Sep 17 00:00:00 2001 From: Prateek-Thakare Date: Thu, 7 Dec 2023 14:44:39 +0000 Subject: [PATCH] deploy: f075c2db3722439eecaefa9efee524c273c32041 --- basics-mantis-code/basics.html | 8 ++-- configuration/config-file.html | 8 ++-- configuration/configuration.html | 4 +- features/advanced_alerting.html | 2 +- features/distributed_scanning.html | 2 +- features/new_scanner.html | 2 +- features/workflow_customisation.html | 2 +- .../command-line-class.html | 8 ++-- .../new-scanner-integration-api.html | 4 +- print.html | 40 +++++++++---------- 10 files changed, 40 insertions(+), 40 deletions(-) diff --git a/basics-mantis-code/basics.html b/basics-mantis-code/basics.html index 30eecc5..9559a9c 100644 --- a/basics-mantis-code/basics.html +++ b/basics-mantis-code/basics.html @@ -149,10 +149,10 @@

Mantis folder structure - This will help you understand exactly where you need to make changes for new integrations -
  • Base scanner class - 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 - 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 - 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 - This will help you understand exactly where you need to make changes for new integrations
  • +
  • Base scanner class - 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 - 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 - 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/configuration/config-file.html b/configuration/config-file.html index 7a4d2e0..f7ae48b 100644 --- a/configuration/config-file.html +++ b/configuration/config-file.html @@ -148,10 +148,10 @@

    📋 Config File

    Mantis Config file provides multiple customisations including:

    diff --git a/configuration/configuration.html b/configuration/configuration.html index 8aaf0b1..668170a 100644 --- a/configuration/configuration.html +++ b/configuration/configuration.html @@ -147,8 +147,8 @@

    Mantis - Documentation

    🛠️ Configuration

    Once you have setup Mantis, you can now look at customising your scan requirements. Scan customisations are available via:

      -
    • Config File - contains customisations related to scan workflow, scheduling, notifications etc.
    • -
    • Command Line - contains basic options to onboard your assets and scan
    • +
    • Config File - contains customisations related to scan workflow, scheduling, notifications etc.
    • +
    • Command Line - contains basic options to onboard your assets and scan

    INFO💡- Config File Path: /mantis/config/local.yml

    diff --git a/features/advanced_alerting.html b/features/advanced_alerting.html index b734a5b..6db3693 100644 --- a/features/advanced_alerting.html +++ b/features/advanced_alerting.html @@ -167,7 +167,7 @@

    New Assets Slack Tag

    Understanding config.yml

    -

    INFO💡: For more details on config.yml and how to edit it, Click here

    +

    INFO💡: For more details on config.yml and how to edit it, Click here

    diff --git a/features/distributed_scanning.html b/features/distributed_scanning.html index 562aa8c..2f926ce 100644 --- a/features/distributed_scanning.html +++ b/features/distributed_scanning.html @@ -157,7 +157,7 @@

    😃 Feature

    How does Mantis distribute your scan ?

    Mantis uses Ray framework to scale. Ray Core 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

    +

    Please Note - A short infrastructure setup is required before utilising this feature as described here

    Mantis

    The Mantis framework is designed to use Ray Core in the most efficient way, breaking down a single scan into the most granular level. To put it simply:

    diff --git a/features/new_scanner.html b/features/new_scanner.html index 3eff187..a612e8b 100644 --- a/features/new_scanner.html +++ b/features/new_scanner.html @@ -175,7 +175,7 @@

    😃 Feature

  • Add the install instructions in DockerFile
  • -

    INFO💡: For a more detailed understanding on how to integrate a new scanner, Click here

    +

    INFO💡: For a more detailed understanding on how to integrate a new scanner, Click here

    diff --git a/features/workflow_customisation.html b/features/workflow_customisation.html index e56b2ce..995d8e1 100644 --- a/features/workflow_customisation.html +++ b/features/workflow_customisation.html @@ -214,7 +214,7 @@

    Example 2

    Understanding config.yml

    -

    INFO💡: For more details on config.yml and how to edit it, Click here

    +

    INFO💡: For more details on config.yml and how to edit it, Click here

    diff --git a/new-scanner-integrations/command-line-class.html b/new-scanner-integrations/command-line-class.html index 066904c..b5ddea0 100644 --- a/new-scanner-integrations/command-line-class.html +++ b/new-scanner-integrations/command-line-class.html @@ -179,7 +179,7 @@

    here, 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, we are required to implement three functions:

    • base_get_commands() or get_commands()
    • parse_report()
    • @@ -205,13 +205,13 @@

      here, Mantis incorporates a range of pre-existing utility functions to facilitate the seamless integration of new tools

      +

      Info💡- As mentioned here, 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

    +

    Info💡- To understand the DB schema, click here

    def parse_report(self, outfile):
             output_dict_list = []
    @@ -241,7 +241,7 @@ 

    here

    +

    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

    ⏭️ In a similar fashion let's try to add a new API scanner.

    diff --git a/new-scanner-integrations/new-scanner-integration-api.html b/new-scanner-integrations/new-scanner-integration-api.html index 2346e44..32a66f3 100644 --- a/new-scanner-integrations/new-scanner-integration-api.html +++ b/new-scanner-integrations/new-scanner-integration-api.html @@ -175,7 +175,7 @@

    here, 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, we are required to implement three functions:

    • get_api_calls()
    • parse_reponse()
    • @@ -248,7 +248,7 @@

      here

      +

      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

    Let's now look at adding the new scanner to the config file.

    diff --git a/print.html b/print.html index 1252c19..aecf344 100644 --- a/print.html +++ b/print.html @@ -216,7 +216,7 @@

    😃 Feature

    How does Mantis distribute your scan ?

    Mantis uses Ray framework to scale. Ray Core 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

    +

    Please Note - A short infrastructure setup is required before utilising this feature as described here

    Mantis

    The Mantis framework is designed to use Ray Core in the most efficient way, breaking down a single scan into the most granular level. To put it simply:

    @@ -323,7 +323,7 @@

    Example 2

    Understanding config.yml

    -

    INFO💡: For more details on config.yml and how to edit it, Click here

    +

    INFO💡: For more details on config.yml and how to edit it, Click here

    Advanced Alerting


    @@ -348,7 +348,7 @@

    New Assets Slack Tag

    Understanding config.yml

    -

    INFO💡: For more details on config.yml and how to edit it, Click here

    +

    INFO💡: For more details on config.yml and how to edit it, Click here

    Understanding Scan Efficiency


    @@ -490,7 +490,7 @@

    😃 Feature

  • Add the install instructions in DockerFile
  • -

    INFO💡: For a more detailed understanding on how to integrate a new scanner, Click here

    +

    INFO💡: For a more detailed understanding on how to integrate a new scanner, Click here

    ⚙️ Installation

    Mantis provides multiple installation methods that includes performing the entire scan in a single system or multiple machines

    @@ -524,8 +524,8 @@

    Setup

    🛠️ Configuration

    Once you have setup Mantis, you can now look at customising your scan requirements. Scan customisations are available via:

      -
    • Config File - contains customisations related to scan workflow, scheduling, notifications etc.
    • -
    • Command Line - contains basic options to onboard your assets and scan
    • +
    • Config File - contains customisations related to scan workflow, scheduling, notifications etc.
    • +
    • Command Line - contains basic options to onboard your assets and scan

    INFO💡- Config File Path: /mantis/config/local.yml

    @@ -534,10 +534,10 @@

    Setup


    Mantis Config file provides multiple customisations including:

    🎛️ Workflow Configuration


    @@ -973,10 +973,10 @@

    Mantis folder structure - This will help you understand exactly where you need to make changes for new integrations -
  • Base scanner class - 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 - 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 - 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 - This will help you understand exactly where you need to make changes for new integrations
  • +
  • Base scanner class - 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 - 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 - 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.

    @@ -1254,7 +1254,7 @@

    -

    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, 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, we are required to implement three functions:

    • base_get_commands() or get_commands()
    • parse_report()
    • @@ -1280,13 +1280,13 @@

      here, Mantis incorporates a range of pre-existing utility functions to facilitate the seamless integration of new tools

      +

      Info💡- As mentioned here, 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

    +

    Info💡- To understand the DB schema, click here

    def parse_report(self, outfile):
             output_dict_list = []
    @@ -1316,7 +1316,7 @@ 

    here

    +

    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

    ⏭️ In a similar fashion let's try to add a new API scanner.

    @@ -1352,7 +1352,7 @@

    here, 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, we are required to implement three functions:

    • get_api_calls()
    • parse_reponse()
    • @@ -1425,7 +1425,7 @@

      here

      +

      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

    Let's now look at adding the new scanner to the config file.