deploy: 76f5bb8

genindex.html

@@ -480,18 +480,16 @@ <h2 id="G">G</h2>
         <li><a href="modules/objects.firmware.html#objects.firmware.Firmware.get_hid">(objects.firmware.Firmware method)</a>
 </li>
       </ul></li>
-      <li><a href="modules/helperFunctions.hash.html#helperFunctions.hash.get_imphash">get_imphash() (in module helperFunctions.hash)</a>
-</li>
       <li><a href="modules/helperFunctions.hash.html#helperFunctions.hash.get_md5">get_md5() (in module helperFunctions.hash)</a>
 </li>
       <li><a href="modules/web_interface.rest.helper.html#web_interface.rest.helper.get_paging">get_paging() (in module web_interface.rest.helper)</a>
 </li>
       <li><a href="modules/helperFunctions.virtual_file_path.html#helperFunctions.virtual_file_path.get_paths_for_all_parents">get_paths_for_all_parents() (in module helperFunctions.virtual_file_path)</a>
-</li>
-      <li><a href="modules/scheduler.analysis.scheduler.html#scheduler.analysis.scheduler.AnalysisScheduler.get_plugin_dict">get_plugin_dict() (scheduler.analysis.scheduler.AnalysisScheduler method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="modules/scheduler.analysis.scheduler.html#scheduler.analysis.scheduler.AnalysisScheduler.get_plugin_dict">get_plugin_dict() (scheduler.analysis.scheduler.AnalysisScheduler method)</a>
+</li>
       <li><a href="modules/web_interface.rest.helper.html#web_interface.rest.helper.get_query">get_query() (in module web_interface.rest.helper)</a>
 </li>
       <li><a href="modules/scheduler.analysis.plugin.html#scheduler.analysis.plugin.PluginRunner.get_queue_len">get_queue_len() (scheduler.analysis.plugin.PluginRunner method)</a>
@@ -509,16 +507,12 @@ <h2 id="G">G</h2>
       <li><a href="modules/helperFunctions.virtual_file_path.html#helperFunctions.virtual_file_path.get_some_vfp">get_some_vfp() (in module helperFunctions.virtual_file_path)</a>
 </li>
       <li><a href="modules/helperFunctions.fileSystem.html#helperFunctions.fileSystem.get_src_dir">get_src_dir() (in module helperFunctions.fileSystem)</a>
-</li>
-      <li><a href="modules/helperFunctions.hash.html#helperFunctions.hash.get_ssdeep">get_ssdeep() (in module helperFunctions.hash)</a>
 </li>
       <li><a href="modules/analysis.plugin.plugin.html#analysis.plugin.plugin.AnalysisPluginV0.get_tags">get_tags() (analysis.plugin.plugin.AnalysisPluginV0 method)</a>
 </li>
       <li><a href="modules/helperFunctions.web_interface.html#helperFunctions.web_interface.get_template_as_string">get_template_as_string() (in module helperFunctions.web_interface)</a>
 </li>
       <li><a href="modules/helperFunctions.fileSystem.html#helperFunctions.fileSystem.get_template_dir">get_template_dir() (in module helperFunctions.fileSystem)</a>
-</li>
-      <li><a href="modules/helperFunctions.hash.html#helperFunctions.hash.get_tlsh">get_tlsh() (in module helperFunctions.hash)</a>
 </li>
       <li><a href="modules/helperFunctions.hash.html#helperFunctions.hash.get_tlsh_comparison">get_tlsh_comparison() (in module helperFunctions.hash)</a>
 </li>

modules/analysis.plugin.plugin.html

@@ -196,10 +196,10 @@
 It MUST be a <a class="reference external" href="https://semver.org/">semver</a> version.
 Here is a quick summary how semver relates to plugins.
 * MAJOR: The plugin schema changed.
-* MINOR: The schema din’t change but might contain more data.
+* MINOR: The schema didn’t change but might contain more data.
 * PATCH: A bug was fixed e.g. a crash on some files.</p>
 <p>Note that any version change leads to rescheduling the analysis.
-But backwards compatible results will still be shown in the fronfrontend.</p>
+But backwards compatible results will still be shown in the frontend.</p>
 </dd></dl>
 
 </dd></dl>
@@ -270,8 +270,8 @@
 
 <dl class="py method">
 <dt class="sig sig-object py" id="analysis.plugin.plugin.AnalysisPluginV0.summarize">
-<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">summarize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#analysis.plugin.plugin.AnalysisPluginV0.summarize" title="Permalink to this definition"></a></dt>
-<dd><p>The summary is a list of categories in which the result can be grouped.
+<span class="sig-name descname"><span class="pre">summarize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">result</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#analysis.plugin.plugin.AnalysisPluginV0.summarize" title="Permalink to this definition"></a></dt>
+<dd><p>The summary is an optional list of categories in which the result can be grouped.
 In the FACT_core frontend if you view the analysis of a container the
 summary is used to group files included in it.</p>
 <p>Some examples of summaries are:</p>

modules/helperFunctions.hash.html

@@ -69,11 +69,8 @@
 <li class="toctree-l2"><a class="reference internal" href="helperFunctions.fileSystem.html">helperFunctions.fileSystem module</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">helperFunctions.hash module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#helperFunctions.hash.get_hash"><code class="docutils literal notranslate"><span class="pre">get_hash()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#helperFunctions.hash.get_imphash"><code class="docutils literal notranslate"><span class="pre">get_imphash()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#helperFunctions.hash.get_md5"><code class="docutils literal notranslate"><span class="pre">get_md5()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#helperFunctions.hash.get_sha256"><code class="docutils literal notranslate"><span class="pre">get_sha256()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#helperFunctions.hash.get_ssdeep"><code class="docutils literal notranslate"><span class="pre">get_ssdeep()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#helperFunctions.hash.get_tlsh"><code class="docutils literal notranslate"><span class="pre">get_tlsh()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#helperFunctions.hash.get_tlsh_comparison"><code class="docutils literal notranslate"><span class="pre">get_tlsh_comparison()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#helperFunctions.hash.normalize_lief_items"><code class="docutils literal notranslate"><span class="pre">normalize_lief_items()</span></code></a></li>
 </ul>
@@ -134,50 +131,44 @@
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>hash_function</strong> – The hash function to use. See hashlib for more</p></li>
-<li><p><strong>binary</strong> – The data to hash, either as string or array of Integers</p></li>
+<li><p><strong>hash_function</strong> (<em>str</em>) – The hash function to use. See hashlib for more</p></li>
+<li><p><strong>binary</strong> (<em>bytes</em><em> | </em><em>str</em>) – The data to hash, either as string or array of Integers</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>The hash as hexstring</p>
+<dd class="field-even"><p>The hash as hex string</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>str</p>
 </dd>
 </dl>
 </dd></dl>
 
 <dl class="py function">
-<dt class="sig sig-object py" id="helperFunctions.hash.get_imphash">
-<span class="sig-prename descclassname"><span class="pre">helperFunctions.hash.</span></span><span class="sig-name descname"><span class="pre">get_imphash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#helperFunctions.hash.get_imphash" title="Permalink to this definition"></a></dt>
-<dd><p>Generates and returns the md5 hash of the (sorted) imported functions of an ELF file represented by <cite>file_object</cite>.
-Returns <cite>None</cite> if there are no imports or if an exception occurs.</p>
-<dl class="field-list simple">
+<dt class="sig sig-object py" id="helperFunctions.hash.get_md5">
+<span class="sig-prename descclassname"><span class="pre">helperFunctions.hash.</span></span><span class="sig-name descname"><span class="pre">get_md5</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#helperFunctions.hash.get_md5" title="Permalink to this definition"></a></dt>
+<dd><dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>file_object</strong> (<a class="reference internal" href="objects.file.html#objects.file.FileObject" title="objects.file.FileObject"><em>FileObject</em></a>) – The FileObject of which the imphash shall be computed</p>
+<dd class="field-odd"><p><strong>code</strong> (<em>bytes</em><em> | </em><em>str</em>) – </p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>str | None</p>
+<dd class="field-even"><p>str</p>
 </dd>
 </dl>
 </dd></dl>
 
-<dl class="py function">
-<dt class="sig sig-object py" id="helperFunctions.hash.get_md5">
-<span class="sig-prename descclassname"><span class="pre">helperFunctions.hash.</span></span><span class="sig-name descname"><span class="pre">get_md5</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#helperFunctions.hash.get_md5" title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
-
 <dl class="py function">
 <dt class="sig sig-object py" id="helperFunctions.hash.get_sha256">
 <span class="sig-prename descclassname"><span class="pre">helperFunctions.hash.</span></span><span class="sig-name descname"><span class="pre">get_sha256</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#helperFunctions.hash.get_sha256" title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="helperFunctions.hash.get_ssdeep">
-<span class="sig-prename descclassname"><span class="pre">helperFunctions.hash.</span></span><span class="sig-name descname"><span class="pre">get_ssdeep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#helperFunctions.hash.get_ssdeep" title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
-
-<dl class="py function">
-<dt class="sig sig-object py" id="helperFunctions.hash.get_tlsh">
-<span class="sig-prename descclassname"><span class="pre">helperFunctions.hash.</span></span><span class="sig-name descname"><span class="pre">get_tlsh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">code</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#helperFunctions.hash.get_tlsh" title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
+<dd><dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>code</strong> (<em>bytes</em><em> | </em><em>str</em>) – </p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>str</p>
+</dd>
+</dl>
+</dd></dl>
 
 <dl class="py function">
 <dt class="sig sig-object py" id="helperFunctions.hash.get_tlsh_comparison">

modules/helperFunctions.html

@@ -154,11 +154,8 @@ <h1>helperFunctions<a class="headerlink" href="#helperfunctions" title="Permalin
 </li>
 <li class="toctree-l1"><a class="reference internal" href="helperFunctions.hash.html">helperFunctions.hash module</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="helperFunctions.hash.html#helperFunctions.hash.get_hash"><code class="docutils literal notranslate"><span class="pre">get_hash()</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="helperFunctions.hash.html#helperFunctions.hash.get_imphash"><code class="docutils literal notranslate"><span class="pre">get_imphash()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="helperFunctions.hash.html#helperFunctions.hash.get_md5"><code class="docutils literal notranslate"><span class="pre">get_md5()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="helperFunctions.hash.html#helperFunctions.hash.get_sha256"><code class="docutils literal notranslate"><span class="pre">get_sha256()</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="helperFunctions.hash.html#helperFunctions.hash.get_ssdeep"><code class="docutils literal notranslate"><span class="pre">get_ssdeep()</span></code></a></li>
-<li class="toctree-l2"><a class="reference internal" href="helperFunctions.hash.html#helperFunctions.hash.get_tlsh"><code class="docutils literal notranslate"><span class="pre">get_tlsh()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="helperFunctions.hash.html#helperFunctions.hash.get_tlsh_comparison"><code class="docutils literal notranslate"><span class="pre">get_tlsh_comparison()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="helperFunctions.hash.html#helperFunctions.hash.normalize_lief_items"><code class="docutils literal notranslate"><span class="pre">normalize_lief_items()</span></code></a></li>
 </ul>