mirror of
https://github.com/NetherlandsForensicInstitute/hansken-extraction-plugin-sdk-documentation.git
synced 2026-05-08 19:26:35 +00:00
157 lines
8.7 KiB
HTML
157 lines
8.7 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="../../">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Data Transformations — Hansken Extraction Plugins for plugin developers 0.9.16
|
|
documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=d75fae25" />
|
|
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=e59714d7" />
|
|
<link rel="stylesheet" type="text/css" href="../../_static/wider_pages.css?v=32ad70ab" />
|
|
|
|
|
|
<script src="../../_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="../../_static/documentation_options.js?v=433a2a34"></script>
|
|
<script src="../../_static/doctools.js?v=9a2dae69"></script>
|
|
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="../../_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../search.html" />
|
|
<link rel="next" title="Test framework" href="test_framework.html" />
|
|
<link rel="prev" title="HQL-Lite" href="hql_lite.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">
|
|
Hansken Extraction Plugins for plugin developers
|
|
</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" aria-label="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="Navigation menu">
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="../concepts.html">General concepts</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="extraction_plugins.html">Hansken Extraction Plugins</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="anatomy_of_a_plugin.html">Anatomy of a plugin</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="plugin_types.html">Extraction plugin types</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="plugin_naming_convention.html">Plugin naming convention</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="traces.html">Traces & Trace model</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="hql_lite.html">HQL-Lite</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">Data Transformations</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#see-also">See also</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="test_framework.html">Test framework</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="all_in_one_debugging.html">Debugging locally with Hansken All in One (AIO)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="isolation.html">Plugin isolation</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="kubernetes_autoscaling.html">Kubernetes, Autoscaling, Resourcemanagement</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../spec.html">Extraction Plugin specifications</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../java.html">Java</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../python.html">Python</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../contact.html">Contact</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../changes.html">Changelog</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../../index.html">Hansken Extraction Plugins for plugin developers</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item"><a href="../concepts.html">General concepts</a></li>
|
|
<li class="breadcrumb-item active">Data Transformations</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="../../_sources/dev/concepts/data_transformations.md.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="data-transformations">
|
|
<h1>Data Transformations<a class="headerlink" href="#data-transformations" title="Link to this heading"></a></h1>
|
|
<p>Extraction Plugins can create new <a class="reference internal" href="traces.html#datastreams"><span class="std std-ref">data-streams</span></a> on a Trace through data transformations. Data
|
|
transformations describe how data can be obtained from a source. Data transformations are preferred over storing blobs
|
|
because they take less space. This is because they only describe the data instead of specifying the actual data.</p>
|
|
<p>The following figure shows how Hansken visualizes data transformations:</p>
|
|
<a class="reference external image-reference" href="datatransformations.png"><img alt="datatransformations.png" src="../../_images/datatransformations.png" /></a>
|
|
<p>Note that transformations can be applied on transformations. The SDK only supports range transformations at the moment,
|
|
while this image also shows some transformations that are currently available in Hansken but not in the SDK.</p>
|
|
<p>An example case is an extraction plugin that processes an archive file. The plugin creates a child trace per entry in
|
|
the archive file. Each child trace will have a data stream that is a transformation that marks the start and length of
|
|
the entry in the original archive data. By just describing the data instead of specifying the actual data, a lot of
|
|
space is saved.</p>
|
|
<p>Although Hansken supports various transformations, the Extraction Plugins SDK for now only supports ranged data
|
|
transformations. Ranged data transformations define data as a list of ranges, each range with an offset and length in a
|
|
bytearray.</p>
|
|
<section id="see-also">
|
|
<h2>See also<a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
|
|
<ul class="simple">
|
|
<li><p><a class="reference internal" href="../java/snippets.html"><span class="doc">Data Transformations in Java</span></a></p></li>
|
|
<li><p><a class="reference internal" href="../python/snippets.html"><span class="doc">Data Transformations in Python</span></a></p></li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="hql_lite.html" class="btn btn-neutral float-left" title="HQL-Lite" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="test_framework.html" class="btn btn-neutral float-right" title="Test framework" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2020-2026 Netherlands Forensic Institute.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |