Skip to content

Commit

Permalink
website docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@KTZgraph
KTZgraph committed Jan 14, 2021
1 parent 136b73e commit 12b3782
Show file tree
Hide file tree
Showing 115 changed files with 27,081 additions and 3,165 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d7bf9f48fc174e2357d7ba6d6338b1c7
config: 2e9875a0bcae73a590c886c1e55b9605
tags: 645f666f9bcd5a90fca523b33c5a78b7
370 changes: 370 additions & 0 deletions docs/_modules/api_searcher/dns/dns_searcher.html
View file

Large diffs are not rendered by default.

63 changes: 25 additions & 38 deletions docs/rst/code_description/architecture.html → ...modules/api_searcher/input_validator.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Code Architecture &mdash; sarenka 0.0.1 documentation</title>
<title>api_searcher.input_validator &mdash; SARENKA 0.0.1 documentation</title>



<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />



Expand All @@ -35,9 +36,7 @@


<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Code Documentation" href="code.html" />
<link rel="prev" title="For Contributors" href="../for_contributors.html" />
<link rel="search" title="Search" href="../../search.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -51,7 +50,7 @@



<a href="../../index.html" class="icon icon-home" alt="Documentation Home"> sarenka
<a href="../../index.html" class="icon icon-home" alt="Documentation Home"> SARENKA



Expand Down Expand Up @@ -82,20 +81,13 @@



<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../summary.html">Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../how_to_use.html">How to use</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libraries.html">Libraries</a></li>
<li class="toctree-l1"><a class="reference internal" href="../used_tools.html">Used Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../osint_list.html">OSINT tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../wiki.html">Wiki</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cheat_sheet.html">Cheat Sheet</a></li>
<li class="toctree-l1"><a class="reference internal" href="../for_contributors.html">For Contributors</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Code Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="code.html">Code Documentation</a></li>
<p class="caption"><span class="caption-text">Dokumentacja aplikacji:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../backend/common.html">common</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../backend/api_searcher.html">api_searcher</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../backend/api_tools.html">api_tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../backend/api_vulnerabilities.html">api_vulnerabilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../backend/reports.html">reports</a></li>
</ul>


Expand All @@ -111,7 +103,7 @@
<nav class="wy-nav-top" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">sarenka</a>
<a href="../../index.html">SARENKA</a>

</nav>

Expand Down Expand Up @@ -142,15 +134,13 @@

<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>

<li>Code Architecture</li>
<li><a href="../index.html">Module code</a> &raquo;</li>

<li>api_searcher.input_validator</li>


<li class="wy-breadcrumbs-aside">


<a href="../../_sources/rst/code_description/architecture.rst.txt" rel="nofollow"> View page source</a>


</li>

</ul>
Expand All @@ -161,32 +151,29 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<div class="section" id="code-architecture">
<h1>Code Architecture<a class="headerlink" href="#code-architecture" title="Permalink to this headline"></a></h1>
</div>
<h1>Source code for api_searcher.input_validator</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">re</span>

<div class="viewcode-block" id="InputValidator"><a class="viewcode-back" href="../../backend/api_searcher.html#api_searcher.input_validator.InputValidator">[docs]</a><span class="k">class</span> <span class="nc">InputValidator</span><span class="p">:</span>
<div class="viewcode-block" id="InputValidator.is_cve_code"><a class="viewcode-back" href="../../backend/api_searcher.html#api_searcher.input_validator.InputValidator.is_cve_code">[docs]</a> <span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">is_cve_code</span><span class="p">(</span><span class="n">data</span><span class="p">):</span>
<span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s2">&quot;CVE-\d</span><span class="si">{4}</span><span class="s2">-\d+&quot;</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">return</span> <span class="kc">False</span></div></div>
</pre></div>

</div>

</div>
<footer>

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="code.html" class="btn btn-neutral float-right" title="Code Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="../for_contributors.html" class="btn btn-neutral float-left" title="For Contributors" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>


<hr/>

<div role="contentinfo">
<p>

&copy; Copyright 2020, sarenka team
&copy; Copyright 2021, Dominika Pawlaczyk, Michał Pawlaczyk

</p>
</div>
Expand Down
240 changes: 240 additions & 0 deletions docs/_modules/api_searcher/models.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,240 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>api_searcher.models &mdash; SARENKA 0.0.1 documentation</title>



<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />







<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->


<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/underscore.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/language_data.js"></script>

<script type="text/javascript" src="../../_static/js/theme.js"></script>


<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
</head>

<body class="wy-body-for-nav">


<div class="wy-grid-for-nav">

<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../../index.html" class="icon icon-home" alt="Documentation Home"> SARENKA



</a>







<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>


</div>


<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






<p class="caption"><span class="caption-text">Dokumentacja aplikacji:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../backend/common.html">common</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../backend/api_searcher.html">api_searcher</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../backend/api_tools.html">api_tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../backend/api_vulnerabilities.html">api_vulnerabilities</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../backend/reports.html">reports</a></li>
</ul>



</div>

</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


<nav class="wy-nav-top" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">SARENKA</a>

</nav>


<div class="wy-nav-content">

<div class="rst-content">

















<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">

<li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>

<li><a href="../index.html">Module code</a> &raquo;</li>

<li>api_searcher.models</li>


<li class="wy-breadcrumbs-aside">

</li>

</ul>


<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>Source code for api_searcher.models</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">Modul przechowujący dane uwierzytelniające użytkownika do serwisów trzecich, które wymagają kont.</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">from</span> <span class="nn">django.db</span> <span class="kn">import</span> <span class="n">models</span>


<div class="viewcode-block" id="CensysCredentialsModel"><a class="viewcode-back" href="../../backend/api_searcher.html#api_searcher.models.CensysCredentialsModel">[docs]</a><span class="k">class</span> <span class="nc">CensysCredentialsModel</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Model przechowujący informacje o danych uwierzytelniajacych użytkownika do serwisu http://censys.io/</span>
<span class="sd"> Może istnieć tylko jedna instancja przechowująca dane użytkownika&quot;&quot;&quot;</span>
<span class="n">api_id</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">72</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="n">secret</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">64</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="n">base_url</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">36</span><span class="p">,</span> <span class="n">unique</span> <span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;https://censys.io/&quot;</span><span class="p">)</span>
<span class="n">api_url</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">48</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;https://censys.io/api/v1&quot;</span><span class="p">)</span>

<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">object</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_default_manager</span><span class="o">.</span><span class="n">all</span><span class="p">()</span><span class="o">.</span><span class="n">first</span><span class="p">()</span> <span class="c1"># Since only one item</span>

<div class="viewcode-block" id="CensysCredentialsModel.save"><a class="viewcode-back" href="../../backend/api_searcher.html#api_searcher.models.CensysCredentialsModel.save">[docs]</a> <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">id</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div></div>


<div class="viewcode-block" id="ShodanCredentialsModel"><a class="viewcode-back" href="../../backend/api_searcher.html#api_searcher.models.ShodanCredentialsModel">[docs]</a><span class="k">class</span> <span class="nc">ShodanCredentialsModel</span><span class="p">(</span><span class="n">models</span><span class="o">.</span><span class="n">Model</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Model przechowujący informacje o danych uwierzytelniajacych użytkownika do serwisu https://www.shodan.io/</span>
<span class="sd"> Może istnieć tylko jedna instancja przechowująca dane użytkownika&quot;&quot;&quot;</span>
<span class="n">user</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">200</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="n">api_key</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">64</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">)</span>
<span class="n">base_url</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">CharField</span><span class="p">(</span><span class="n">max_length</span><span class="o">=</span><span class="mi">44</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">&quot;https://www.shodan.io/&quot;</span><span class="p">)</span>

<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">object</span><span class="p">(</span><span class="bp">cls</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_default_manager</span><span class="o">.</span><span class="n">all</span><span class="p">()</span><span class="o">.</span><span class="n">first</span><span class="p">()</span> <span class="c1"># Since only one item</span>

<div class="viewcode-block" id="ShodanCredentialsModel.save"><a class="viewcode-back" href="../../backend/api_searcher.html#api_searcher.models.ShodanCredentialsModel.save">[docs]</a> <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">id</span> <span class="o">=</span> <span class="mi">1</span>
<span class="k">return</span> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div></div>
</pre></div>

</div>

</div>
<footer>


<hr/>

<div role="contentinfo">
<p>

&copy; Copyright 2021, Dominika Pawlaczyk, Michał Pawlaczyk

</p>
</div>



Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a

<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>

provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>
</div>

</section>

</div>


<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>






</body>
</html>
Loading

0 comments on commit 12b3782

Please sign in to comment.