|
|
|
@@ -5,14 +5,14 @@
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
|
|
|
<title>parsedmarc — parsedmarc 9.7.0 documentation</title>
|
|
|
|
|
<title>parsedmarc — parsedmarc 9.7.1 documentation</title>
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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=854825c2"></script>
|
|
|
|
|
<script src="../_static/documentation_options.js?v=2130a1db"></script>
|
|
|
|
|
<script src="../_static/doctools.js?v=9bcbadda"></script>
|
|
|
|
|
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
|
|
|
<script src="../_static/js/theme.js"></script>
|
|
|
|
@@ -119,7 +119,11 @@
|
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">expiringdict</span><span class="w"> </span><span class="kn">import</span> <span class="n">ExpiringDict</span>
|
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">mailsuite.smtp</span><span class="w"> </span><span class="kn">import</span> <span class="n">send_email</span>
|
|
|
|
|
|
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">parsedmarc.constants</span><span class="w"> </span><span class="kn">import</span> <span class="n">__version__</span>
|
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">parsedmarc.constants</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
|
|
|
|
|
<span class="n">DEFAULT_DNS_MAX_RETRIES</span><span class="p">,</span>
|
|
|
|
|
<span class="n">DEFAULT_DNS_TIMEOUT</span><span class="p">,</span>
|
|
|
|
|
<span class="n">__version__</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span>
|
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">parsedmarc.log</span><span class="w"> </span><span class="kn">import</span> <span class="n">logger</span>
|
|
|
|
|
<span class="kn">from</span><span class="w"> </span><span class="nn">parsedmarc.mail</span><span class="w"> </span><span class="kn">import</span> <span class="p">(</span>
|
|
|
|
|
<span class="n">GmailConnection</span><span class="p">,</span>
|
|
|
|
@@ -397,7 +401,8 @@
|
|
|
|
|
<span class="n">reverse_dns_map_url</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">offline</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">2.0</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_TIMEOUT</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_MAX_RETRIES</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span> <span class="o">-></span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
|
|
|
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
|
|
|
<span class="sd"> Converts a record from a DMARC aggregate report into a more consistent</span>
|
|
|
|
@@ -413,6 +418,8 @@
|
|
|
|
|
<span class="sd"> nameservers (list): A list of one or more nameservers to use</span>
|
|
|
|
|
<span class="sd"> (Cloudflare's public DNS resolvers by default)</span>
|
|
|
|
|
<span class="sd"> dns_timeout (float): Sets the DNS timeout in seconds</span>
|
|
|
|
|
<span class="sd"> dns_retries (int): Number of times to retry DNS queries on timeout</span>
|
|
|
|
|
<span class="sd"> or other transient errors</span>
|
|
|
|
|
|
|
|
|
|
<span class="sd"> Returns:</span>
|
|
|
|
|
<span class="sd"> dict: The converted record</span>
|
|
|
|
@@ -432,6 +439,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="o">=</span><span class="n">offline</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span>
|
|
|
|
|
<span class="n">new_record</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_record_source</span>
|
|
|
|
|
<span class="n">new_record</span><span class="p">[</span><span class="s2">"count"</span><span class="p">]</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">record</span><span class="p">[</span><span class="s2">"row"</span><span class="p">][</span><span class="s2">"count"</span><span class="p">])</span>
|
|
|
|
@@ -775,7 +783,8 @@
|
|
|
|
|
<span class="n">reverse_dns_map_url</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">offline</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">2.0</span><span class="p">,</span>
|
|
|
|
|
<span class="n">timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_TIMEOUT</span><span class="p">,</span>
|
|
|
|
|
<span class="n">retries</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_MAX_RETRIES</span><span class="p">,</span>
|
|
|
|
|
<span class="n">keep_alive</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">normalize_timespan_threshold_hours</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">24.0</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">AggregateReport</span><span class="p">:</span>
|
|
|
|
@@ -791,6 +800,8 @@
|
|
|
|
|
<span class="sd"> nameservers (list): A list of one or more nameservers to use</span>
|
|
|
|
|
<span class="sd"> (Cloudflare's public DNS resolvers by default)</span>
|
|
|
|
|
<span class="sd"> timeout (float): Sets the DNS timeout in seconds</span>
|
|
|
|
|
<span class="sd"> retries (int): Number of times to retry DNS queries on timeout or</span>
|
|
|
|
|
<span class="sd"> other transient errors</span>
|
|
|
|
|
<span class="sd"> keep_alive (callable): Keep alive function</span>
|
|
|
|
|
<span class="sd"> normalize_timespan_threshold_hours (float): Normalize timespans beyond this</span>
|
|
|
|
|
|
|
|
|
@@ -935,6 +946,7 @@
|
|
|
|
|
<span class="n">reverse_dns_map_url</span><span class="o">=</span><span class="n">reverse_dns_map_url</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="o">=</span><span class="n">retries</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span>
|
|
|
|
|
<span class="n">_append_parsed_record</span><span class="p">(</span>
|
|
|
|
|
<span class="n">parsed_record</span><span class="o">=</span><span class="n">report_record</span><span class="p">,</span>
|
|
|
|
@@ -956,6 +968,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="o">=</span><span class="n">offline</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="o">=</span><span class="n">retries</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span>
|
|
|
|
|
<span class="n">_append_parsed_record</span><span class="p">(</span>
|
|
|
|
|
<span class="n">parsed_record</span><span class="o">=</span><span class="n">report_record</span><span class="p">,</span>
|
|
|
|
@@ -1098,7 +1111,8 @@
|
|
|
|
|
<span class="n">reverse_dns_map_url</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">ip_db_path</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">2.0</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_TIMEOUT</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_MAX_RETRIES</span><span class="p">,</span>
|
|
|
|
|
<span class="n">keep_alive</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">normalize_timespan_threshold_hours</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">24.0</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">AggregateReport</span><span class="p">:</span>
|
|
|
|
@@ -1115,6 +1129,8 @@
|
|
|
|
|
<span class="sd"> nameservers (list): A list of one or more nameservers to use</span>
|
|
|
|
|
<span class="sd"> (Cloudflare's public DNS resolvers by default)</span>
|
|
|
|
|
<span class="sd"> dns_timeout (float): Sets the DNS timeout in seconds</span>
|
|
|
|
|
<span class="sd"> dns_retries (int): Number of times to retry DNS queries on timeout</span>
|
|
|
|
|
<span class="sd"> or other transient errors</span>
|
|
|
|
|
<span class="sd"> keep_alive (callable): Keep alive function</span>
|
|
|
|
|
<span class="sd"> normalize_timespan_threshold_hours (float): Normalize timespans beyond this</span>
|
|
|
|
|
|
|
|
|
@@ -1136,6 +1152,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="o">=</span><span class="n">offline</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="n">keep_alive</span><span class="o">=</span><span class="n">keep_alive</span><span class="p">,</span>
|
|
|
|
|
<span class="n">normalize_timespan_threshold_hours</span><span class="o">=</span><span class="n">normalize_timespan_threshold_hours</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span></div>
|
|
|
|
@@ -1355,7 +1372,8 @@
|
|
|
|
|
<span class="n">offline</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="n">ip_db_path</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">2.0</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_TIMEOUT</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_MAX_RETRIES</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span> <span class="o">-></span> <span class="n">ForensicReport</span><span class="p">:</span>
|
|
|
|
|
<span class="w"> </span><span class="sd">"""</span>
|
|
|
|
@@ -1373,6 +1391,8 @@
|
|
|
|
|
<span class="sd"> nameservers (list): A list of one or more nameservers to use</span>
|
|
|
|
|
<span class="sd"> (Cloudflare's public DNS resolvers by default)</span>
|
|
|
|
|
<span class="sd"> dns_timeout (float): Sets the DNS timeout in seconds</span>
|
|
|
|
|
<span class="sd"> dns_retries (int): Number of times to retry DNS queries on timeout</span>
|
|
|
|
|
<span class="sd"> or other transient errors</span>
|
|
|
|
|
<span class="sd"> strip_attachment_payloads (bool): Remove attachment payloads from</span>
|
|
|
|
|
<span class="sd"> forensic report results</span>
|
|
|
|
|
|
|
|
|
@@ -1427,6 +1447,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="o">=</span><span class="n">offline</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span>
|
|
|
|
|
<span class="n">parsed_report</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]</span> <span class="o">=</span> <span class="n">parsed_report_source</span>
|
|
|
|
|
<span class="k">del</span> <span class="n">parsed_report</span><span class="p">[</span><span class="s2">"source_ip"</span><span class="p">]</span>
|
|
|
|
@@ -1595,7 +1616,8 @@
|
|
|
|
|
<span class="n">reverse_dns_map_path</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">reverse_dns_map_url</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">2.0</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_TIMEOUT</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_MAX_RETRIES</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="n">keep_alive</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Callable</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">normalize_timespan_threshold_hours</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">24.0</span><span class="p">,</span>
|
|
|
|
@@ -1612,6 +1634,8 @@
|
|
|
|
|
<span class="sd"> offline (bool): Do not query online for geolocation on DNS</span>
|
|
|
|
|
<span class="sd"> nameservers (list): A list of one or more nameservers to use</span>
|
|
|
|
|
<span class="sd"> dns_timeout (float): Sets the DNS timeout in seconds</span>
|
|
|
|
|
<span class="sd"> dns_retries (int): Number of times to retry DNS queries on timeout</span>
|
|
|
|
|
<span class="sd"> or other transient errors</span>
|
|
|
|
|
<span class="sd"> strip_attachment_payloads (bool): Remove attachment payloads from</span>
|
|
|
|
|
<span class="sd"> forensic report results</span>
|
|
|
|
|
<span class="sd"> keep_alive (callable): keep alive function</span>
|
|
|
|
@@ -1738,6 +1762,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="o">=</span><span class="n">offline</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="n">keep_alive</span><span class="o">=</span><span class="n">keep_alive</span><span class="p">,</span>
|
|
|
|
|
<span class="n">normalize_timespan_threshold_hours</span><span class="o">=</span><span class="n">normalize_timespan_threshold_hours</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span>
|
|
|
|
@@ -1773,6 +1798,7 @@
|
|
|
|
|
<span class="n">reverse_dns_map_url</span><span class="o">=</span><span class="n">reverse_dns_map_url</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="o">=</span><span class="n">strip_attachment_payloads</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span>
|
|
|
|
|
<span class="k">except</span> <span class="n">InvalidForensicReport</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
|
|
@@ -1802,7 +1828,8 @@
|
|
|
|
|
<span class="n">input_</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">bytes</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">PathLike</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">os</span><span class="o">.</span><span class="n">PathLike</span><span class="p">[</span><span class="nb">bytes</span><span class="p">],</span> <span class="n">BinaryIO</span><span class="p">],</span>
|
|
|
|
|
<span class="o">*</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">2.0</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_TIMEOUT</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_MAX_RETRIES</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="n">ip_db_path</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">always_use_local_files</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
@@ -1821,6 +1848,8 @@
|
|
|
|
|
<span class="sd"> nameservers (list): A list of one or more nameservers to use</span>
|
|
|
|
|
<span class="sd"> (Cloudflare's public DNS resolvers by default)</span>
|
|
|
|
|
<span class="sd"> dns_timeout (float): Sets the DNS timeout in seconds</span>
|
|
|
|
|
<span class="sd"> dns_retries (int): Number of times to retry DNS queries on timeout</span>
|
|
|
|
|
<span class="sd"> or other transient errors</span>
|
|
|
|
|
<span class="sd"> strip_attachment_payloads (bool): Remove attachment payloads from</span>
|
|
|
|
|
<span class="sd"> forensic report results</span>
|
|
|
|
|
<span class="sd"> ip_db_path (str): Path to a MMDB file from MaxMind or DBIP</span>
|
|
|
|
@@ -1860,6 +1889,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="o">=</span><span class="n">offline</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="n">keep_alive</span><span class="o">=</span><span class="n">keep_alive</span><span class="p">,</span>
|
|
|
|
|
<span class="n">normalize_timespan_threshold_hours</span><span class="o">=</span><span class="n">normalize_timespan_threshold_hours</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span>
|
|
|
|
@@ -1879,6 +1909,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="o">=</span><span class="n">offline</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="o">=</span><span class="n">strip_attachment_payloads</span><span class="p">,</span>
|
|
|
|
|
<span class="n">keep_alive</span><span class="o">=</span><span class="n">keep_alive</span><span class="p">,</span>
|
|
|
|
|
<span class="n">normalize_timespan_threshold_hours</span><span class="o">=</span><span class="n">normalize_timespan_threshold_hours</span><span class="p">,</span>
|
|
|
|
@@ -1898,7 +1929,8 @@
|
|
|
|
|
<span class="n">input_</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
|
|
|
<span class="o">*</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">2.0</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_TIMEOUT</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_MAX_RETRIES</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="n">ip_db_path</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">always_use_local_files</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
@@ -1915,6 +1947,8 @@
|
|
|
|
|
<span class="sd"> nameservers (list): A list of one or more nameservers to use</span>
|
|
|
|
|
<span class="sd"> (Cloudflare's public DNS resolvers by default)</span>
|
|
|
|
|
<span class="sd"> dns_timeout (float): Sets the DNS timeout in seconds</span>
|
|
|
|
|
<span class="sd"> dns_retries (int): Number of times to retry DNS queries on timeout</span>
|
|
|
|
|
<span class="sd"> or other transient errors</span>
|
|
|
|
|
<span class="sd"> strip_attachment_payloads (bool): Remove attachment payloads from</span>
|
|
|
|
|
<span class="sd"> forensic report results</span>
|
|
|
|
|
<span class="sd"> always_use_local_files (bool): Do not download files</span>
|
|
|
|
@@ -1951,6 +1985,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="o">=</span><span class="n">offline</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="o">=</span><span class="n">sa</span><span class="p">,</span>
|
|
|
|
|
<span class="n">normalize_timespan_threshold_hours</span><span class="o">=</span><span class="n">normalize_timespan_threshold_hours</span><span class="p">,</span>
|
|
|
|
|
<span class="p">)</span>
|
|
|
|
@@ -1998,6 +2033,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">6.0</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_MAX_RETRIES</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="n">results</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">ParsingResults</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">batch_size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span>
|
|
|
|
@@ -2021,6 +2057,8 @@
|
|
|
|
|
<span class="sd"> offline (bool): Do not query online for geolocation or DNS</span>
|
|
|
|
|
<span class="sd"> nameservers (list): A list of DNS nameservers to query</span>
|
|
|
|
|
<span class="sd"> dns_timeout (float): Set the DNS query timeout</span>
|
|
|
|
|
<span class="sd"> dns_retries (int): Number of times to retry DNS queries on timeout</span>
|
|
|
|
|
<span class="sd"> or other transient errors</span>
|
|
|
|
|
<span class="sd"> strip_attachment_payloads (bool): Remove attachment payloads from</span>
|
|
|
|
|
<span class="sd"> forensic report results</span>
|
|
|
|
|
<span class="sd"> results (dict): Results from the previous run</span>
|
|
|
|
@@ -2144,6 +2182,7 @@
|
|
|
|
|
<span class="n">msg_content</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="n">ip_db_path</span><span class="o">=</span><span class="n">ip_db_path</span><span class="p">,</span>
|
|
|
|
|
<span class="n">always_use_local_files</span><span class="o">=</span><span class="n">always_use_local_files</span><span class="p">,</span>
|
|
|
|
|
<span class="n">reverse_dns_map_path</span><span class="o">=</span><span class="n">reverse_dns_map_path</span><span class="p">,</span>
|
|
|
|
@@ -2302,6 +2341,7 @@
|
|
|
|
|
<span class="n">test</span><span class="o">=</span><span class="n">test</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="o">=</span><span class="n">strip_attachment_payloads</span><span class="p">,</span>
|
|
|
|
|
<span class="n">results</span><span class="o">=</span><span class="n">results</span><span class="p">,</span>
|
|
|
|
|
<span class="n">ip_db_path</span><span class="o">=</span><span class="n">ip_db_path</span><span class="p">,</span>
|
|
|
|
@@ -2335,6 +2375,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mf">6.0</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEFAULT_DNS_MAX_RETRIES</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
|
|
|
<span class="n">batch_size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">,</span>
|
|
|
|
|
<span class="n">since</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">datetime</span><span class="p">,</span> <span class="n">date</span><span class="p">,</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
|
|
@@ -2362,6 +2403,8 @@
|
|
|
|
|
<span class="sd"> nameservers (list): A list of one or more nameservers to use</span>
|
|
|
|
|
<span class="sd"> (Cloudflare's public DNS resolvers by default)</span>
|
|
|
|
|
<span class="sd"> dns_timeout (float): Set the DNS query timeout</span>
|
|
|
|
|
<span class="sd"> dns_retries (int): Number of times to retry DNS queries on timeout</span>
|
|
|
|
|
<span class="sd"> or other transient errors</span>
|
|
|
|
|
<span class="sd"> strip_attachment_payloads (bool): Replace attachment payloads in</span>
|
|
|
|
|
<span class="sd"> forensic report samples with None</span>
|
|
|
|
|
<span class="sd"> batch_size (int): Number of messages to read and process before saving</span>
|
|
|
|
@@ -2385,6 +2428,7 @@
|
|
|
|
|
<span class="n">offline</span><span class="o">=</span><span class="n">offline</span><span class="p">,</span>
|
|
|
|
|
<span class="n">nameservers</span><span class="o">=</span><span class="n">nameservers</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_timeout</span><span class="o">=</span><span class="n">dns_timeout</span><span class="p">,</span>
|
|
|
|
|
<span class="n">dns_retries</span><span class="o">=</span><span class="n">dns_retries</span><span class="p">,</span>
|
|
|
|
|
<span class="n">strip_attachment_payloads</span><span class="o">=</span><span class="n">strip_attachment_payloads</span><span class="p">,</span>
|
|
|
|
|
<span class="n">batch_size</span><span class="o">=</span><span class="n">batch_size</span><span class="p">,</span>
|
|
|
|
|
<span class="n">since</span><span class="o">=</span><span class="n">since</span><span class="p">,</span>
|
|
|
|
|