deploy: 355762e

genindex.html

@@ -402,10 +402,12 @@ <h2 id="F">F</h2>
 </li>
       <li><a href="modules/objects.file.html#objects.file.FileObject.files_included">files_included (objects.file.FileObject attribute)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="modules/helperFunctions.web_interface.html#helperFunctions.web_interface.filter_out_illegal_characters">filter_out_illegal_characters() (in module helperFunctions.web_interface)</a>
 </li>
+      <li><a href="modules/helperFunctions.virtual_file_path.html#helperFunctions.virtual_file_path.filter_vpf_dict">filter_vpf_dict() (in module helperFunctions.virtual_file_path)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="modules/objects.firmware.html#objects.firmware.Firmware">Firmware (class in objects.firmware)</a>
 </li>
       <li><a href="modules/config.html#config.Backend.firmware_file_storage_directory">firmware_file_storage_directory (config.Backend attribute)</a>
@@ -414,6 +416,12 @@ <h2 id="F">F</h2>
 </li>
       <li><a href="modules/helperFunctions.web_interface.html#helperFunctions.web_interface.format_time">format_time() (in module helperFunctions.web_interface)</a>
 </li>
+      <li><a href="modules/objects.file.html#objects.file.FileObject.from_json">from_json() (objects.file.FileObject class method)</a>
+
+      <ul>
+        <li><a href="modules/objects.firmware.html#objects.firmware.Firmware.from_json">(objects.firmware.Firmware class method)</a>
+</li>
+      </ul></li>
       <li><a href="modules/config.html#config.Frontend">Frontend (class in config)</a>
 </li>
       <li><a href="modules/config.html#config.frontend">frontend() (in module config)</a>
@@ -1173,6 +1181,12 @@ <h2 id="T">T</h2>
         <li><a href="modules/scheduler.analysis.plugin.html#scheduler.analysis.plugin.PluginRunner.Config.timeout">(scheduler.analysis.plugin.PluginRunner.Config attribute)</a>
 </li>
         <li><a href="modules/scheduler.analysis.plugin.html#scheduler.analysis.plugin.Worker.Config.timeout">(scheduler.analysis.plugin.Worker.Config attribute)</a>
+</li>
+      </ul></li>
+      <li><a href="modules/objects.file.html#objects.file.FileObject.to_json">to_json() (objects.file.FileObject method)</a>
+
+      <ul>
+        <li><a href="modules/objects.firmware.html#objects.firmware.Firmware.to_json">(objects.firmware.Firmware method)</a>
 </li>
       </ul></li>
   </ul></td>

modules/helperFunctions.html

@@ -275,6 +275,7 @@ <h1>helperFunctions<a class="headerlink" href="#helperfunctions" title="Permalin
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="helperFunctions.virtual_file_path.html">helperFunctions.virtual_file_path module</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="helperFunctions.virtual_file_path.html#helperFunctions.virtual_file_path.filter_vpf_dict"><code class="docutils literal notranslate"><span class="pre">filter_vpf_dict()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="helperFunctions.virtual_file_path.html#helperFunctions.virtual_file_path.get_paths_for_all_parents"><code class="docutils literal notranslate"><span class="pre">get_paths_for_all_parents()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="helperFunctions.virtual_file_path.html#helperFunctions.virtual_file_path.get_some_vfp"><code class="docutils literal notranslate"><span class="pre">get_some_vfp()</span></code></a></li>
 </ul>

modules/helperFunctions.virtual_file_path.html

@@ -80,6 +80,7 @@
 <li class="toctree-l2"><a class="reference internal" href="helperFunctions.task_conversion.html">helperFunctions.task_conversion module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="helperFunctions.uid.html">helperFunctions.uid module</a></li>
 <li class="toctree-l2 current"><a class="current reference internal" href="#">helperFunctions.virtual_file_path module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#helperFunctions.virtual_file_path.filter_vpf_dict"><code class="docutils literal notranslate"><span class="pre">filter_vpf_dict()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#helperFunctions.virtual_file_path.get_paths_for_all_parents"><code class="docutils literal notranslate"><span class="pre">get_paths_for_all_parents()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#helperFunctions.virtual_file_path.get_some_vfp"><code class="docutils literal notranslate"><span class="pre">get_some_vfp()</span></code></a></li>
 </ul>
@@ -121,6 +122,25 @@
 
   <section id="module-helperFunctions.virtual_file_path">
 <span id="helperfunctions-virtual-file-path-module"></span><h1>helperFunctions.virtual_file_path module<a class="headerlink" href="#module-helperFunctions.virtual_file_path" title="Permalink to this heading"></a></h1>
+<dl class="py function">
+<dt class="sig sig-object py" id="helperFunctions.virtual_file_path.filter_vpf_dict">
+<span class="sig-prename descclassname"><span class="pre">helperFunctions.virtual_file_path.</span></span><span class="sig-name descname"><span class="pre">filter_vpf_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vfp_dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_uids</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#helperFunctions.virtual_file_path.filter_vpf_dict" title="Permalink to this definition"></a></dt>
+<dd><p>Get only VFPs from parent files that are contained in <cite>parent_uids</cite>.
+:param vfp_dict: A virtual file path dict
+:param parent_uids: A set of allowed parent UIDs (VFPs from other parent files are filtered out)</p>
+<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>vfp_dict</strong> (<em>dict</em><em>[</em><em>str</em><em>, </em><em>list</em><em>[</em><em>str</em><em>]</em><em>]</em>) – </p></li>
+<li><p><strong>parent_uids</strong> (<em>set</em><em>[</em><em>str</em><em>]</em>) – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>dict[str, list[str]]</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="helperFunctions.virtual_file_path.get_paths_for_all_parents">
 <span class="sig-prename descclassname"><span class="pre">helperFunctions.virtual_file_path.</span></span><span class="sig-name descname"><span class="pre">get_paths_for_all_parents</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vfp_dict</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#helperFunctions.virtual_file_path.get_paths_for_all_parents" title="Permalink to this definition"></a></dt>

modules/objects.file.html

@@ -75,6 +75,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.file_name"><code class="docutils literal notranslate"><span class="pre">FileObject.file_name</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.file_path"><code class="docutils literal notranslate"><span class="pre">FileObject.file_path</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.files_included"><code class="docutils literal notranslate"><span class="pre">FileObject.files_included</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.from_json"><code class="docutils literal notranslate"><span class="pre">FileObject.from_json()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.get_hid"><code class="docutils literal notranslate"><span class="pre">FileObject.get_hid()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.get_virtual_paths_for_all_uids"><code class="docutils literal notranslate"><span class="pre">FileObject.get_virtual_paths_for_all_uids()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.list_of_all_included_files"><code class="docutils literal notranslate"><span class="pre">FileObject.list_of_all_included_files</span></code></a></li>
@@ -87,6 +88,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.sha256"><code class="docutils literal notranslate"><span class="pre">FileObject.sha256</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.size"><code class="docutils literal notranslate"><span class="pre">FileObject.size</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.temporary_data"><code class="docutils literal notranslate"><span class="pre">FileObject.temporary_data</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.to_json"><code class="docutils literal notranslate"><span class="pre">FileObject.to_json()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.uid"><code class="docutils literal notranslate"><span class="pre">FileObject.uid</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.file.FileObject.virtual_file_path"><code class="docutils literal notranslate"><span class="pre">FileObject.virtual_file_path</span></code></a></li>
 </ul>
@@ -235,6 +237,22 @@
 Only lists the next layer, not recursively included files on lower extraction layers.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="objects.file.FileObject.from_json">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json_dict</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_uid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#objects.file.FileObject.from_json" 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"><ul class="simple">
+<li><p><strong>json_dict</strong> (<em>dict</em>) – </p></li>
+<li><p><strong>root_uid</strong> (<em>str</em><em> | </em><em>None</em>) – </p></li>
+</ul>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p><a class="reference internal" href="#objects.file.FileObject" title="objects.file.FileObject">FileObject</a></p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="objects.file.FileObject.get_hid">
 <span class="sig-name descname"><span class="pre">get_hid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#objects.file.FileObject.get_hid" title="Permalink to this definition"></a></dt>
@@ -349,6 +367,20 @@
 It will not be persisted to the database, so it dies after the analysis cycle.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="objects.file.FileObject.to_json">
+<span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vfp_parent_filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#objects.file.FileObject.to_json" title="Permalink to this definition"></a></dt>
+<dd><p>Get a FileObject as JSON. <cite>vfp_parent_filter</cite> can be used to filter the entries with a UID whitelist.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>vfp_parent_filter</strong> (<em>set</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em>) – </p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>dict</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py property">
 <dt class="sig sig-object py" id="objects.file.FileObject.uid">
 <em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#objects.file.FileObject.uid" title="Permalink to this definition"></a></dt>

modules/objects.firmware.html

@@ -68,13 +68,15 @@
 <li class="toctree-l3"><a class="reference internal" href="#objects.firmware.Firmware"><code class="docutils literal notranslate"><span class="pre">Firmware</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.device_class"><code class="docutils literal notranslate"><span class="pre">Firmware.device_class</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.device_name"><code class="docutils literal notranslate"><span class="pre">Firmware.device_name</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.from_json"><code class="docutils literal notranslate"><span class="pre">Firmware.from_json()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.get_hid"><code class="docutils literal notranslate"><span class="pre">Firmware.get_hid()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.part"><code class="docutils literal notranslate"><span class="pre">Firmware.part</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.release_date"><code class="docutils literal notranslate"><span class="pre">Firmware.release_date</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.set_binary"><code class="docutils literal notranslate"><span class="pre">Firmware.set_binary()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.set_part_name"><code class="docutils literal notranslate"><span class="pre">Firmware.set_part_name()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.set_tag"><code class="docutils literal notranslate"><span class="pre">Firmware.set_tag()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.tags"><code class="docutils literal notranslate"><span class="pre">Firmware.tags</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.to_json"><code class="docutils literal notranslate"><span class="pre">Firmware.to_json()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.vendor"><code class="docutils literal notranslate"><span class="pre">Firmware.vendor</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#objects.firmware.Firmware.version"><code class="docutils literal notranslate"><span class="pre">Firmware.version</span></code></a></li>
 </ul>
@@ -173,6 +175,19 @@
 <p>This attribute is <strong>mandatory</strong> and shall never be <cite>None</cite>.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="objects.firmware.Firmware.from_json">
+<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">json</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">root_uid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#objects.firmware.Firmware.from_json" 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"><ul class="simple">
+<li><p><strong>json</strong> (<em>dict</em>) – </p></li>
+<li><p><strong>root_uid</strong> (<em>str</em><em> | </em><em>None</em>) – </p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="objects.firmware.Firmware.get_hid">
 <span class="sig-name descname"><span class="pre">get_hid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#objects.firmware.Firmware.get_hid" title="Permalink to this definition"></a></dt>
@@ -241,6 +256,20 @@
 <p>This attribute is <strong>optional</strong>, the dict may be empty.</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="objects.firmware.Firmware.to_json">
+<span class="sig-name descname"><span class="pre">to_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vfp_parent_filter</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#objects.firmware.Firmware.to_json" title="Permalink to this definition"></a></dt>
+<dd><p>Get a FileObject as JSON. <cite>vfp_parent_filter</cite> can be used to filter the entries with a UID whitelist.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>vfp_parent_filter</strong> (<em>set</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em>) – </p>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>dict</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="objects.firmware.Firmware.vendor">
 <span class="sig-name descname"><span class="pre">vendor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#objects.firmware.Firmware.vendor" title="Permalink to this definition"></a></dt>