Skip to content

Commit

Permalink
deploy: f075c2d
Browse files Browse the repository at this point in the history
  • Loading branch information
Prateek-Thakare committed Dec 7, 2023
1 parent 51a594b commit e795741
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 40 deletions.
8 changes: 4 additions & 4 deletions basics-mantis-code/basics.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,10 +149,10 @@ <h1 id="-mantis-code---getting-started"><a class="header" href="#-mantis-code---
<p>Before you add a new module or scanner to Mantis yourself, it is important to understand the parts of the code that you'll be editing and certain functions that will come in handy.</p>
<p>In this walkthrough, we shall mainly focus on:</p>
<ul>
<li><a href="/./basics-mantis-code/folder-structure.html">Mantis folder structure</a> - This will help you understand exactly where you need to make changes for new integrations</li>
<li><a href="/./basics-mantis-code/scanner-base-class.html">Base scanner class</a> - Based on the scanner that you want to integrate, this will help you choose the base class that you need to inherit</li>
<li><a href="/./basics-mantis-code/important-utils.html">Important utility functions</a> - 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. </li>
<li><a href="/./basics-mantis-code/db-models.html">DB models</a> - 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.</li>
<li><a href="/./mantis/basics-mantis-code/folder-structure.html">Mantis folder structure</a> - This will help you understand exactly where you need to make changes for new integrations</li>
<li><a href="/./mantis/basics-mantis-code/scanner-base-class.html">Base scanner class</a> - Based on the scanner that you want to integrate, this will help you choose the base class that you need to inherit</li>
<li><a href="/./mantis/basics-mantis-code/important-utils.html">Important utility functions</a> - 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. </li>
<li><a href="/./mantis/basics-mantis-code/db-models.html">DB models</a> - 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.</li>
</ul>
<p>A basic understanding of the above will simplify any new integrations with Mantis.</p>
<blockquote>
Expand Down
8 changes: 4 additions & 4 deletions configuration/config-file.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,10 @@ <h1 id="-config-file"><a class="header" href="#-config-file">📋 Config File</a
<hr />
<p>Mantis Config file provides multiple customisations including:</p>
<ul>
<li><a href="/./configuration/workflow-config.html"><strong>Workflow Customisation</strong></a></li>
<li><a href="/./configuration/scheduler-config.html"><strong>Scheduler Customisation</strong></a></li>
<li><a href="/./configuration/app-context-config.html"><strong>Setting App Context</strong></a></li>
<li><a href="/./configuration/slack-config.html"><strong>Slack Alerting</strong></a></li>
<li><a href="/./mantis/configuration/workflow-config.html"><strong>Workflow Customisation</strong></a></li>
<li><a href="/./mantis/configuration/scheduler-config.html"><strong>Scheduler Customisation</strong></a></li>
<li><a href="/./mantis/configuration/app-context-config.html"><strong>Setting App Context</strong></a></li>
<li><a href="/./mantis/configuration/slack-config.html"><strong>Slack Alerting</strong></a></li>
</ul>

</main>
Expand Down
4 changes: 2 additions & 2 deletions configuration/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,8 @@ <h1 class="menu-title">Mantis - Documentation</h1>
<h1 id="-configuration"><a class="header" href="#-configuration">🛠️ Configuration</a></h1>
<p>Once you have setup Mantis, you can now look at customising your scan requirements. Scan customisations are available via:</p>
<ul>
<li><a href="/./mantis/configuration/config-file.html">Config File</a> - contains customisations related to scan workflow, scheduling, notifications etc.</li>
<li><a href="/./mantis/configuration/command-line.html">Command Line</a> - contains basic options to onboard your assets and scan</li>
<li><a href="/./mantis/mantis/configuration/config-file.html">Config File</a> - contains customisations related to scan workflow, scheduling, notifications etc.</li>
<li><a href="/./mantis/mantis/configuration/command-line.html">Command Line</a> - contains basic options to onboard your assets and scan</li>
</ul>
<blockquote>
<p>INFO💡- Config File Path: /mantis/config/local.yml</p>
Expand Down
2 changes: 1 addition & 1 deletion features/advanced_alerting.html
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ <h3 id="new-assets-alert"><a class="header" href="#new-assets-alert">New Assets
<img src="slack-tag.png" class="img-rounded" alt="Slack Tag">
<h3 id="understanding-configyml"><a class="header" href="#understanding-configyml">Understanding config.yml</a></h3>
<blockquote>
<p>INFO💡: For more details on config.yml and how to edit it, <a href="/./configuration/configuration.html">Click here</a></p>
<p>INFO💡: For more details on config.yml and how to edit it, <a href="/./mantis/configuration/configuration.html">Click here</a></p>
</blockquote>

</main>
Expand Down
2 changes: 1 addition & 1 deletion features/distributed_scanning.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h2 id="-feature"><a class="header" href="#-feature">😃 Feature</a></h2>
<h2 id="how-does-mantis-distribute-your-scan-"><a class="header" href="#how-does-mantis-distribute-your-scan-">How does Mantis distribute your scan ?</a></h2>
<p>Mantis uses <a href="https://www.ray.io">Ray</a> framework to scale. <a href="https://docs.ray.io/en/latest/ray-core/walkthrough.html">Ray Core</a> provides a small number of core primitives (i.e., tasks, actors, objects) for building and scaling distributed applications.</p>
<blockquote>
<p>Please Note - A short infrastructure setup is required before utilising this feature as <a href="/./installation/installation-multiple.html">described here</a></p>
<p>Please Note - A short infrastructure setup is required before utilising this feature as <a href="/./mantis/installation/installation-multiple.html">described here</a></p>
</blockquote>
<img src="ray.png" class="img-rounded" alt="Mantis">
<p>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:</p>
Expand Down
2 changes: 1 addition & 1 deletion features/new_scanner.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h2 id="-feature"><a class="header" href="#-feature">😃 Feature</a></h2>
<li>Add the install instructions in <strong>DockerFile</strong></li>
</ul>
<blockquote>
<p>INFO💡: For a more detailed understanding on how to integrate a new scanner, <a href="/./new-scanner-integrations/new-scanner-integration.html">Click here</a></p>
<p>INFO💡: For a more detailed understanding on how to integrate a new scanner, <a href="/./mantis/new-scanner-integrations/new-scanner-integration.html">Click here</a></p>
</blockquote>

</main>
Expand Down
2 changes: 1 addition & 1 deletion features/workflow_customisation.html
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ <h3 id="example-2"><a class="header" href="#example-2">Example 2</a></h3>
</code></pre>
<h2 id="understanding-configyml"><a class="header" href="#understanding-configyml">Understanding config.yml</a></h2>
<blockquote>
<p>INFO💡: For more details on config.yml and how to edit it, <a href="/./configuration/configuration.html">Click here</a></p>
<p>INFO💡: For more details on config.yml and how to edit it, <a href="/./mantis/configuration/configuration.html">Click here</a></p>
</blockquote>

</main>
Expand Down
8 changes: 4 additions & 4 deletions new-scanner-integrations/command-line-class.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ <h1 id="add-a-new-tool-scanner-class"><a class="header" href="#add-a-new-tool-sc
</ul>
</li>
</ul>
<p>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 <a href="/./basics-mantis-code/scanner-base-class.html">here</a>, we are required to implement three functions:</p>
<p>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 <a href="/./mantis/basics-mantis-code/scanner-base-class.html">here</a>, we are required to implement three functions:</p>
<ul>
<li>base_get_commands() or get_commands() </li>
<li>parse_report()</li>
Expand All @@ -205,13 +205,13 @@ <h2 id="implementing-get_commands"><a class="header" href="#implementing-get_com
<li><strong>self.assets</strong> exclusively extract TLDs from the database, which are then supplied as input to Amass</li>
</ul>
<blockquote>
<p>Info💡- As mentioned <a href="/./basics-mantis-code/important-utils.html">here</a>, Mantis incorporates a range of pre-existing utility functions to facilitate the seamless integration of new tools</p>
<p>Info💡- As mentioned <a href="/./mantis/basics-mantis-code/important-utils.html">here</a>, Mantis incorporates a range of pre-existing utility functions to facilitate the seamless integration of new tools</p>
</blockquote>
<h2 id="implementing-parse_report"><a class="header" href="#implementing-parse_report">Implementing parse_report()</a></h2>
<p>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.</p>
<blockquote>
<p>Info💡- To understand the DB schema, click <a href="/./basics-mantis-code/db-models.html">here</a></p>
<p>Info💡- To understand the DB schema, click <a href="/./mantis/basics-mantis-code/db-models.html">here</a></p>
</blockquote>
<pre><code class="language-python">def parse_report(self, outfile):
output_dict_list = []
Expand Down Expand Up @@ -241,7 +241,7 @@ <h2 id="implementing-db_operations"><a class="header" href="#implementing-db_ope
</code></pre>
<p>This is straight forward, call the corresponding util function to insert the data into mongoDB.</p>
<blockquote>
<p>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 <a href="/./basics-mantis-code/important-utils.html">here</a></p>
<p>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 <a href="/./mantis/basics-mantis-code/important-utils.html">here</a></p>
</blockquote>
<blockquote>
<p>⏭️ In a similar fashion let's try to add a new API scanner. </p>
Expand Down
4 changes: 2 additions & 2 deletions new-scanner-integrations/new-scanner-integration-api.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h1 id="add-a-new-api-scanner-class"><a class="header" href="#add-a-new-api-scan
</ul>
</li>
</ul>
<p>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 <a href="/./basics-mantis-code/scanner-base-class.html">here</a>, we are required to implement three functions:</p>
<p>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 <a href="/./mantis/basics-mantis-code/scanner-base-class.html">here</a>, we are required to implement three functions:</p>
<ul>
<li>get_api_calls()</li>
<li>parse_reponse()</li>
Expand Down Expand Up @@ -248,7 +248,7 @@ <h2 id="implementing-db_operations"><a class="header" href="#implementing-db_ope
</code></pre>
<p>This is straight forward, call the corresponding util function to insert the data into mongoDB.</p>
<blockquote>
<p>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 <a href="/./basics-mantis-code/important-utils.html">here</a></p>
<p>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 <a href="/./mantis/basics-mantis-code/important-utils.html">here</a></p>
</blockquote>
<blockquote>
<p>Let's now look at adding the new scanner to the config file. </p>
Expand Down
Loading

0 comments on commit e795741

Please sign in to comment.