<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>stem.descriptor.extrainfo_descriptor — Stem 1.1.0 documentation</title>
<link rel="stylesheet" href="../../../_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/theme_extras.js"></script>
<link rel="shortcut icon" href="../../../_static/favicon.png"/>
<link rel="top" title="Stem 1.1.0 documentation" href="../../../index.html" />
<link rel="up" title="stem" href="../../stem.html" />
</head>
<body>
<div class="header"><img class="rightlogo" src="../../../_static/logo.png" alt="Logo"/><h1 class="heading"><a href="../../../index.html">
<span>Stem Docs</span></a></h1>
<h2 class="heading"><span>stem.descriptor.extrainfo_descriptor</span></h2>
</div>
<div class="topnav">
<p>
<ul id="navbar">
<li><a href="../../../index.html">Home</a></li>
<li><a href="../../../tutorials.html">Tutorials</a>
<ul>
<li><a href="../../../tutorials/the_little_relay_that_could.html">Hello World</a></li>
<li><a href="../../../tutorials/to_russia_with_love.html">Client Usage</a></li>
<li><a href="../../../tutorials/tortoise_and_the_hare.html">Event Listening</a></li>
<li><a href="../../../tutorials/mirror_mirror_on_the_wall.html">Tor Descriptors</a></li>
<li><a href="../../../tutorials/east_of_the_sun.html">Utilities</a></li>
<li><a href="../../../tutorials/double_double_toil_and_trouble.html">Examples</a></li>
</ul>
</li>
<li><a href="../../../api.html">API</a>
<ul>
<li><a href="../../../api/control.html">stem.control</a></li>
<li><a href="../../../api/connection.html">stem.connection</a></li>
<li><a href="../../../api/socket.html">stem.socket</a></li>
<li><a href="../../../api/process.html">stem.process</a></li>
<li><a href="../../../api/response.html">stem.response</a></li>
<li><a href="../../../api/exit_policy.html">stem.exit_policy</a></li>
<li><a href="../../../api/version.html">stem.version</a></li>
<li><a href="../../../api.html#descriptors">Descriptors</a></li>
<li><a href="../../../api.html#utilities">Utilities</a></li>
</ul>
</li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem">Development</a>
<ul>
<li><a href="../../../faq.html">FAQ</a></li>
<li><a href="../../../change_log.html">Change Log</a></li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs">Bug Tracker</a></li>
<li><a href="../../../download.html">Download</a></li>
</ul>
</li>
</ul>
</p>
</div>
<div class="content">
<h1>Source code for stem.descriptor.extrainfo_descriptor</h1><div class="highlight"><pre>
<span class="c"># Copyright 2012-2013, Damian Johnson and The Tor Project</span>
<span class="c"># See LICENSE for licensing information</span>
<span class="sd">"""</span>
<span class="sd">Parsing for Tor extra-info descriptors. These are published by relays whenever</span>
<span class="sd">their server descriptor is published and have a similar format. However, unlike</span>
<span class="sd">server descriptors these don't contain information that Tor clients require to</span>
<span class="sd">function and as such aren't fetched by default.</span>
<span class="sd">Defined in section 2.2 of the `dir-spec</span>
<span class="sd"><https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt>`_,</span>
<span class="sd">extra-info descriptors contain interesting but non-vital information such as</span>
<span class="sd">usage statistics. Tor clients cannot request these documents for bridges.</span>
<span class="sd">Extra-info descriptors are available from a few sources...</span>
<span class="sd">* if you have 'DownloadExtraInfo 1' in your torrc...</span>
<span class="sd"> * control port via 'GETINFO extra-info/digest/\*' queries</span>
<span class="sd"> * the 'cached-extrainfo' file in tor's data directory</span>
<span class="sd">* tor metrics, at https://metrics.torproject.org/data.html</span>
<span class="sd">* directory authorities and mirrors via their DirPort</span>
<span class="sd">**Module Overview:**</span>
<span class="sd">::</span>
<span class="sd"> ExtraInfoDescriptor - Tor extra-info descriptor.</span>
<span class="sd"> | |- RelayExtraInfoDescriptor - Extra-info descriptor for a relay.</span>
<span class="sd"> | +- BridgeExtraInfoDescriptor - Extra-info descriptor for a bridge.</span>
<span class="sd"> |</span>
<span class="sd"> |- digest - calculates the upper-case hex digest value for our content</span>
<span class="sd"> +- get_unrecognized_lines - lines with unrecognized content</span>
<span class="sd">.. data:: DirResponse (enum)</span>
<span class="sd"> Enumeration for known statuses for ExtraInfoDescriptor's dir_*_responses.</span>
<span class="sd"> =================== ===========</span>
<span class="sd"> DirResponse Description</span>
<span class="sd"> =================== ===========</span>
<span class="sd"> **OK** network status requests that were answered</span>
<span class="sd"> **NOT_ENOUGH_SIGS** network status wasn't signed by enough authorities</span>
<span class="sd"> **UNAVAILABLE** requested network status was unavailable</span>
<span class="sd"> **NOT_FOUND** requested network status was not found</span>
<span class="sd"> **NOT_MODIFIED** network status unmodified since If-Modified-Since time</span>
<span class="sd"> **BUSY** directory was busy</span>
<span class="sd"> =================== ===========</span>
<span class="sd">.. data:: DirStat (enum)</span>
<span class="sd"> Enumeration for known stats for ExtraInfoDescriptor's dir_*_direct_dl and</span>
<span class="sd"> dir_*_tunneled_dl.</span>
<span class="sd"> ===================== ===========</span>
<span class="sd"> DirStat Description</span>
<span class="sd"> ===================== ===========</span>
<span class="sd"> **COMPLETE** requests that completed successfully</span>
<span class="sd"> **TIMEOUT** requests that didn't complete within a ten minute timeout</span>
<span class="sd"> **RUNNING** requests still in process when measurement's taken</span>
<span class="sd"> **MIN** smallest rate at which a descriptor was downloaded in B/s</span>
<span class="sd"> **MAX** largest rate at which a descriptor was downloaded in B/s</span>
<span class="sd"> **D1-4** and **D6-9** rate of the slowest x/10 download rates in B/s</span>
<span class="sd"> **Q1** and **Q3** rate of the slowest and fastest quarter download rates in B/s</span>
<span class="sd"> **MD** median download rate in B/s</span>
<span class="sd"> ===================== ===========</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">datetime</span>
<span class="kn">import</span> <span class="nn">hashlib</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="kn">import</span> <span class="nn">stem.util.connection</span>
<span class="kn">import</span> <span class="nn">stem.util.enum</span>
<span class="kn">import</span> <span class="nn">stem.util.str_tools</span>
<span class="kn">from</span> <span class="nn">stem.descriptor</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">PGP_BLOCK_END</span><span class="p">,</span>
<span class="n">Descriptor</span><span class="p">,</span>
<span class="n">_read_until_keywords</span><span class="p">,</span>
<span class="n">_get_descriptor_components</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="c"># added in python 3.2</span>
<span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="n">lru_cache</span>
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
<span class="kn">from</span> <span class="nn">stem.util.lru_cache</span> <span class="kn">import</span> <span class="n">lru_cache</span>
<span class="c"># known statuses for dirreq-v2-resp and dirreq-v3-resp...</span>
<span class="n">DirResponse</span> <span class="o">=</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">(</span>
<span class="p">(</span><span class="s">"OK"</span><span class="p">,</span> <span class="s">"ok"</span><span class="p">),</span>
<span class="p">(</span><span class="s">"NOT_ENOUGH_SIGS"</span><span class="p">,</span> <span class="s">"not-enough-sigs"</span><span class="p">),</span>
<span class="p">(</span><span class="s">"UNAVAILABLE"</span><span class="p">,</span> <span class="s">"unavailable"</span><span class="p">),</span>
<span class="p">(</span><span class="s">"NOT_FOUND"</span><span class="p">,</span> <span class="s">"not-found"</span><span class="p">),</span>
<span class="p">(</span><span class="s">"NOT_MODIFIED"</span><span class="p">,</span> <span class="s">"not-modified"</span><span class="p">),</span>
<span class="p">(</span><span class="s">"BUSY"</span><span class="p">,</span> <span class="s">"busy"</span><span class="p">),</span>
<span class="p">)</span>
<span class="c"># known stats for dirreq-v2/3-direct-dl and dirreq-v2/3-tunneled-dl...</span>
<span class="n">dir_stats</span> <span class="o">=</span> <span class="p">[</span><span class="s">'complete'</span><span class="p">,</span> <span class="s">'timeout'</span><span class="p">,</span> <span class="s">'running'</span><span class="p">,</span> <span class="s">'min'</span><span class="p">,</span> <span class="s">'max'</span><span class="p">,</span> <span class="s">'q1'</span><span class="p">,</span> <span class="s">'q3'</span><span class="p">,</span> <span class="s">'md'</span><span class="p">]</span>
<span class="n">dir_stats</span> <span class="o">+=</span> <span class="p">[</span><span class="s">'d</span><span class="si">%i</span><span class="s">'</span> <span class="o">%</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">)]</span>
<span class="n">dir_stats</span> <span class="o">+=</span> <span class="p">[</span><span class="s">'d</span><span class="si">%i</span><span class="s">'</span> <span class="o">%</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">6</span><span class="p">,</span> <span class="mi">10</span><span class="p">)]</span>
<span class="n">DirStat</span> <span class="o">=</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">(</span><span class="o">*</span><span class="p">[(</span><span class="n">stat</span><span class="o">.</span><span class="n">upper</span><span class="p">(),</span> <span class="n">stat</span><span class="p">)</span> <span class="k">for</span> <span class="n">stat</span> <span class="ow">in</span> <span class="n">dir_stats</span><span class="p">])</span>
<span class="c"># relay descriptors must have exactly one of the following</span>
<span class="n">REQUIRED_FIELDS</span> <span class="o">=</span> <span class="p">(</span>
<span class="s">"extra-info"</span><span class="p">,</span>
<span class="s">"published"</span><span class="p">,</span>
<span class="s">"router-signature"</span><span class="p">,</span>
<span class="p">)</span>
<span class="c"># optional entries that can appear at most once</span>
<span class="n">SINGLE_FIELDS</span> <span class="o">=</span> <span class="p">(</span>
<span class="s">"read-history"</span><span class="p">,</span>
<span class="s">"write-history"</span><span class="p">,</span>
<span class="s">"geoip-db-digest"</span><span class="p">,</span>
<span class="s">"geoip6-db-digest"</span><span class="p">,</span>
<span class="s">"bridge-stats-end"</span><span class="p">,</span>
<span class="s">"bridge-ips"</span><span class="p">,</span>
<span class="s">"dirreq-stats-end"</span><span class="p">,</span>
<span class="s">"dirreq-v2-ips"</span><span class="p">,</span>
<span class="s">"dirreq-v3-ips"</span><span class="p">,</span>
<span class="s">"dirreq-v2-reqs"</span><span class="p">,</span>
<span class="s">"dirreq-v3-reqs"</span><span class="p">,</span>
<span class="s">"dirreq-v2-share"</span><span class="p">,</span>
<span class="s">"dirreq-v3-share"</span><span class="p">,</span>
<span class="s">"dirreq-v2-resp"</span><span class="p">,</span>
<span class="s">"dirreq-v3-resp"</span><span class="p">,</span>
<span class="s">"dirreq-v2-direct-dl"</span><span class="p">,</span>
<span class="s">"dirreq-v3-direct-dl"</span><span class="p">,</span>
<span class="s">"dirreq-v2-tunneled-dl"</span><span class="p">,</span>
<span class="s">"dirreq-v3-tunneled-dl"</span><span class="p">,</span>
<span class="s">"dirreq-read-history"</span><span class="p">,</span>
<span class="s">"dirreq-write-history"</span><span class="p">,</span>
<span class="s">"entry-stats-end"</span><span class="p">,</span>
<span class="s">"entry-ips"</span><span class="p">,</span>
<span class="s">"cell-stats-end"</span><span class="p">,</span>
<span class="s">"cell-processed-cells"</span><span class="p">,</span>
<span class="s">"cell-queued-cells"</span><span class="p">,</span>
<span class="s">"cell-time-in-queue"</span><span class="p">,</span>
<span class="s">"cell-circuits-per-decile"</span><span class="p">,</span>
<span class="s">"conn-bi-direct"</span><span class="p">,</span>
<span class="s">"exit-stats-end"</span><span class="p">,</span>
<span class="s">"exit-kibibytes-written"</span><span class="p">,</span>
<span class="s">"exit-kibibytes-read"</span><span class="p">,</span>
<span class="s">"exit-streams-opened"</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">def</span> <span class="nf">_parse_file</span><span class="p">(</span><span class="n">descriptor_file</span><span class="p">,</span> <span class="n">is_bridge</span> <span class="o">=</span> <span class="bp">False</span><span class="p">,</span> <span class="n">validate</span> <span class="o">=</span> <span class="bp">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Iterates over the extra-info descriptors in a file.</span>
<span class="sd"> :param file descriptor_file: file with descriptor content</span>
<span class="sd"> :param bool is_bridge: parses the file as being a bridge descriptor</span>
<span class="sd"> :param bool validate: checks the validity of the descriptor's content if</span>
<span class="sd"> **True**, skips these checks otherwise</span>
<span class="sd"> :param dict kwargs: additional arguments for the descriptor constructor</span>
<span class="sd"> :returns: iterator for :class:`~stem.descriptor.extrainfo_descriptor.ExtraInfoDescriptor`</span>
<span class="sd"> instances in the file</span>
<span class="sd"> :raises:</span>
<span class="sd"> * **ValueError** if the contents is malformed and validate is **True**</span>
<span class="sd"> * **IOError** if the file can't be read</span>
<span class="sd"> """</span>
<span class="k">while</span> <span class="bp">True</span><span class="p">:</span>
<span class="n">extrainfo_content</span> <span class="o">=</span> <span class="n">_read_until_keywords</span><span class="p">(</span><span class="s">"router-signature"</span><span class="p">,</span> <span class="n">descriptor_file</span><span class="p">)</span>
<span class="c"># we've reached the 'router-signature', now include the pgp style block</span>
<span class="n">block_end_prefix</span> <span class="o">=</span> <span class="n">PGP_BLOCK_END</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">' '</span><span class="p">,</span> <span class="mi">1</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">extrainfo_content</span> <span class="o">+=</span> <span class="n">_read_until_keywords</span><span class="p">(</span><span class="n">block_end_prefix</span><span class="p">,</span> <span class="n">descriptor_file</span><span class="p">,</span> <span class="bp">True</span><span class="p">)</span>
<span class="k">if</span> <span class="n">extrainfo_content</span><span class="p">:</span>
<span class="k">if</span> <span class="n">is_bridge</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">BridgeExtraInfoDescriptor</span><span class="p">(</span><span class="nb">bytes</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">b</span><span class="s">""</span><span class="p">,</span> <span class="n">extrainfo_content</span><span class="p">),</span> <span class="n">validate</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">RelayExtraInfoDescriptor</span><span class="p">(</span><span class="nb">bytes</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">b</span><span class="s">""</span><span class="p">,</span> <span class="n">extrainfo_content</span><span class="p">),</span> <span class="n">validate</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">break</span> <span class="c"># done parsing file</span>
<span class="k">def</span> <span class="nf">_parse_timestamp_and_interval</span><span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">content</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parses a 'YYYY-MM-DD HH:MM:SS (NSEC s) *' entry.</span>
<span class="sd"> :param str keyword: line's keyword</span>
<span class="sd"> :param str content: line content to be parsed</span>
<span class="sd"> :returns: **tuple** of the form (timestamp (**datetime**), interval</span>
<span class="sd"> (**int**), remaining content (**str**))</span>
<span class="sd"> :raises: **ValueError** if the content is malformed</span>
<span class="sd"> """</span>
<span class="n">line</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">content</span><span class="p">)</span>
<span class="n">content_match</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">"^(.*) \(([0-9]+) s\)( .*)?$"</span><span class="p">,</span> <span class="n">content</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">content_match</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Malformed </span><span class="si">%s</span><span class="s"> line: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">line</span><span class="p">))</span>
<span class="n">timestamp_str</span><span class="p">,</span> <span class="n">interval</span><span class="p">,</span> <span class="n">remainder</span> <span class="o">=</span> <span class="n">content_match</span><span class="o">.</span><span class="n">groups</span><span class="p">()</span>
<span class="k">if</span> <span class="n">remainder</span><span class="p">:</span>
<span class="n">remainder</span> <span class="o">=</span> <span class="n">remainder</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span> <span class="c"># remove leading space</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">interval</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s"> line's interval wasn't a number: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">line</span><span class="p">))</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">timestamp</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">timestamp_str</span><span class="p">,</span> <span class="s">"%Y-%m-</span><span class="si">%d</span><span class="s"> %H:%M:%S"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">timestamp</span><span class="p">,</span> <span class="nb">int</span><span class="p">(</span><span class="n">interval</span><span class="p">),</span> <span class="n">remainder</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s"> line's timestamp wasn't parsable: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">line</span><span class="p">))</span>
<div class="viewcode-block" id="ExtraInfoDescriptor"><a class="viewcode-back" href="../../../api/descriptor/extrainfo_descriptor.html#stem.descriptor.extrainfo_descriptor.ExtraInfoDescriptor">[docs]</a><span class="k">class</span> <span class="nc">ExtraInfoDescriptor</span><span class="p">(</span><span class="n">Descriptor</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Extra-info descriptor document.</span>
<span class="sd"> :var str nickname: **\*** relay's nickname</span>
<span class="sd"> :var str fingerprint: **\*** identity key fingerprint</span>
<span class="sd"> :var datetime published: **\*** time in UTC when this descriptor was made</span>
<span class="sd"> :var str geoip_db_digest: sha1 of the geoIP database file for IPv4 addresses</span>
<span class="sd"> :var str geoip6_db_digest: sha1 of the geoIP database file for IPv6 addresses</span>
<span class="sd"> :var dict transport: **\*** mapping of transport methods to their (address,</span>
<span class="sd"> port, args) tuple, these usually appear on bridges in which case all of</span>
<span class="sd"> those are **None**</span>
<span class="sd"> **Bi-directional connection usage:**</span>
<span class="sd"> :var datetime conn_bi_direct_end: end of the sampling interval</span>
<span class="sd"> :var int conn_bi_direct_interval: seconds per interval</span>
<span class="sd"> :var int conn_bi_direct_below: connections that read/wrote less than 20 KiB</span>
<span class="sd"> :var int conn_bi_direct_read: connections that read at least 10x more than wrote</span>
<span class="sd"> :var int conn_bi_direct_write: connections that wrote at least 10x more than read</span>
<span class="sd"> :var int conn_bi_direct_both: remaining connections</span>
<span class="sd"> **Bytes read/written for relayed traffic:**</span>
<span class="sd"> :var datetime read_history_end: end of the sampling interval</span>
<span class="sd"> :var int read_history_interval: seconds per interval</span>
<span class="sd"> :var list read_history_values: bytes read during each interval</span>
<span class="sd"> :var datetime write_history_end: end of the sampling interval</span>
<span class="sd"> :var int write_history_interval: seconds per interval</span>
<span class="sd"> :var list write_history_values: bytes written during each interval</span>
<span class="sd"> **Cell relaying statistics:**</span>
<span class="sd"> :var datetime cell_stats_end: end of the period when stats were gathered</span>
<span class="sd"> :var int cell_stats_interval: length in seconds of the interval</span>
<span class="sd"> :var list cell_processed_cells: measurement of processed cells per circuit</span>
<span class="sd"> :var list cell_queued_cells: measurement of queued cells per circuit</span>
<span class="sd"> :var list cell_time_in_queue: mean enqueued time in milliseconds for cells</span>
<span class="sd"> :var int cell_circuits_per_decile: mean number of circuits in a decile</span>
<span class="sd"> **Directory Mirror Attributes:**</span>
<span class="sd"> :var datetime dir_stats_end: end of the period when stats were gathered</span>
<span class="sd"> :var int dir_stats_interval: length in seconds of the interval</span>
<span class="sd"> :var dict dir_v2_ips: mapping of locales to rounded count of requester ips</span>
<span class="sd"> :var dict dir_v3_ips: mapping of locales to rounded count of requester ips</span>
<span class="sd"> :var float dir_v2_share: percent of total directory traffic it expects to serve</span>
<span class="sd"> :var float dir_v3_share: percent of total directory traffic it expects to serve</span>
<span class="sd"> :var dict dir_v2_requests: mapping of locales to rounded count of requests</span>
<span class="sd"> :var dict dir_v3_requests: mapping of locales to rounded count of requests</span>
<span class="sd"> :var dict dir_v2_responses: mapping of :data:`~stem.descriptor.extrainfo_descriptor.DirResponse` to their rounded count</span>
<span class="sd"> :var dict dir_v3_responses: mapping of :data:`~stem.descriptor.extrainfo_descriptor.DirResponse` to their rounded count</span>
<span class="sd"> :var dict dir_v2_responses_unknown: mapping of unrecognized statuses to their count</span>
<span class="sd"> :var dict dir_v3_responses_unknown: mapping of unrecognized statuses to their count</span>
<span class="sd"> :var dict dir_v2_direct_dl: mapping of :data:`~stem.descriptor.extrainfo_descriptor.DirStat` to measurement over DirPort</span>
<span class="sd"> :var dict dir_v3_direct_dl: mapping of :data:`~stem.descriptor.extrainfo_descriptor.DirStat` to measurement over DirPort</span>
<span class="sd"> :var dict dir_v2_direct_dl_unknown: mapping of unrecognized stats to their measurement</span>
<span class="sd"> :var dict dir_v3_direct_dl_unknown: mapping of unrecognized stats to their measurement</span>
<span class="sd"> :var dict dir_v2_tunneled_dl: mapping of :data:`~stem.descriptor.extrainfo_descriptor.DirStat` to measurement over ORPort</span>
<span class="sd"> :var dict dir_v3_tunneled_dl: mapping of :data:`~stem.descriptor.extrainfo_descriptor.DirStat` to measurement over ORPort</span>
<span class="sd"> :var dict dir_v2_tunneled_dl_unknown: mapping of unrecognized stats to their measurement</span>
<span class="sd"> :var dict dir_v3_tunneled_dl_unknown: mapping of unrecognized stats to their measurement</span>
<span class="sd"> **Bytes read/written for directory mirroring:**</span>
<span class="sd"> :var datetime dir_read_history_end: end of the sampling interval</span>
<span class="sd"> :var int dir_read_history_interval: seconds per interval</span>
<span class="sd"> :var list dir_read_history_values: bytes read during each interval</span>
<span class="sd"> :var datetime dir_write_history_end: end of the sampling interval</span>
<span class="sd"> :var int dir_write_history_interval: seconds per interval</span>
<span class="sd"> :var list dir_write_history_values: bytes read during each interval</span>
<span class="sd"> **Guard Attributes:**</span>
<span class="sd"> :var datetime entry_stats_end: end of the period when stats were gathered</span>
<span class="sd"> :var int entry_stats_interval: length in seconds of the interval</span>
<span class="sd"> :var dict entry_ips: mapping of locales to rounded count of unique user ips</span>
<span class="sd"> **Exit Attributes:**</span>
<span class="sd"> :var datetime exit_stats_end: end of the period when stats were gathered</span>
<span class="sd"> :var int exit_stats_interval: length in seconds of the interval</span>
<span class="sd"> :var dict exit_kibibytes_written: traffic per port (keys are ints or 'other')</span>
<span class="sd"> :var dict exit_kibibytes_read: traffic per port (keys are ints or 'other')</span>
<span class="sd"> :var dict exit_streams_opened: streams per port (keys are ints or 'other')</span>
<span class="sd"> **Bridge Attributes:**</span>
<span class="sd"> :var datetime bridge_stats_end: end of the period when stats were gathered</span>
<span class="sd"> :var int bridge_stats_interval: length in seconds of the interval</span>
<span class="sd"> :var dict bridge_ips: mapping of locales to rounded count of unique user ips</span>
<span class="sd"> :var datetime geoip_start_time: replaced by bridge_stats_end (deprecated)</span>
<span class="sd"> :var dict geoip_client_origins: replaced by bridge_ips (deprecated)</span>
<span class="sd"> :var dict ip_versions: mapping of ip protocols to a rounded count for the number of users</span>
<span class="sd"> :var dict ip_versions: mapping of ip transports to a count for the number of users</span>
<span class="sd"> **\*** attribute is either required when we're parsed with validation or has</span>
<span class="sd"> a default value, others are left as **None** if undefined</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">raw_contents</span><span class="p">,</span> <span class="n">validate</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Extra-info descriptor constructor. By default this validates the</span>
<span class="sd"> descriptor's content as it's parsed. This validation can be disabled to</span>
<span class="sd"> either improve performance or be accepting of malformed data.</span>
<span class="sd"> :param str raw_contents: extra-info content provided by the relay</span>
<span class="sd"> :param bool validate: checks the validity of the extra-info descriptor if</span>
<span class="sd"> **True**, skips these checks otherwise</span>
<span class="sd"> :raises: **ValueError** if the contents is malformed and validate is True</span>
<span class="sd"> """</span>
<span class="nb">super</span><span class="p">(</span><span class="n">ExtraInfoDescriptor</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">raw_contents</span><span class="p">)</span>
<span class="n">raw_contents</span> <span class="o">=</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">str_tools</span><span class="o">.</span><span class="n">_to_unicode</span><span class="p">(</span><span class="n">raw_contents</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nickname</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fingerprint</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">published</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">geoip_db_digest</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">geoip6_db_digest</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">transport</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_end</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_interval</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_below</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_read</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_write</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_both</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">read_history_end</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">read_history_interval</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">read_history_values</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_history_end</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_history_interval</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_history_values</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_stats_end</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_stats_interval</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_processed_cells</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_queued_cells</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_time_in_queue</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_circuits_per_decile</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_stats_end</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_stats_interval</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_ips</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_ips</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_share</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_share</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_requests</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_requests</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_responses</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_responses</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_responses_unknown</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_responses_unknown</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_direct_dl</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_direct_dl</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_direct_dl_unknown</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_direct_dl_unknown</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_tunneled_dl</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_tunneled_dl</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_tunneled_dl_unknown</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_tunneled_dl_unknown</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_read_history_end</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_read_history_interval</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_read_history_values</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_write_history_end</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_write_history_interval</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_write_history_values</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry_stats_end</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry_stats_interval</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry_ips</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exit_stats_end</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exit_stats_interval</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exit_kibibytes_written</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exit_kibibytes_read</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exit_streams_opened</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bridge_stats_end</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bridge_stats_interval</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bridge_ips</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">geoip_start_time</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">geoip_client_origins</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ip_versions</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ip_transports</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_unrecognized_lines</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">entries</span> <span class="o">=</span> <span class="n">_get_descriptor_components</span><span class="p">(</span><span class="n">raw_contents</span><span class="p">,</span> <span class="n">validate</span><span class="p">)</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">for</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_required_fields</span><span class="p">():</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="n">entries</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Extra-info descriptor must have a '</span><span class="si">%s</span><span class="s">' entry"</span> <span class="o">%</span> <span class="n">keyword</span><span class="p">)</span>
<span class="k">for</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_required_fields</span><span class="p">()</span> <span class="o">+</span> <span class="n">SINGLE_FIELDS</span><span class="p">:</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="n">entries</span> <span class="ow">and</span> <span class="nb">len</span><span class="p">(</span><span class="n">entries</span><span class="p">[</span><span class="n">keyword</span><span class="p">])</span> <span class="o">></span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"The '</span><span class="si">%s</span><span class="s">' entry can only appear once in an extra-info descriptor"</span> <span class="o">%</span> <span class="n">keyword</span><span class="p">)</span>
<span class="n">expected_first_keyword</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_first_keyword</span><span class="p">()</span>
<span class="k">if</span> <span class="n">expected_first_keyword</span> <span class="ow">and</span> <span class="n">expected_first_keyword</span> <span class="o">!=</span> <span class="n">entries</span><span class="o">.</span><span class="n">keys</span><span class="p">()[</span><span class="mi">0</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Extra-info descriptor must start with a '</span><span class="si">%s</span><span class="s">' entry"</span> <span class="o">%</span> <span class="n">expected_first_keyword</span><span class="p">)</span>
<span class="n">expected_last_keyword</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_last_keyword</span><span class="p">()</span>
<span class="k">if</span> <span class="n">expected_last_keyword</span> <span class="ow">and</span> <span class="n">expected_last_keyword</span> <span class="o">!=</span> <span class="n">entries</span><span class="o">.</span><span class="n">keys</span><span class="p">()[</span><span class="o">-</span><span class="mi">1</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Descriptor must end with a '</span><span class="si">%s</span><span class="s">' entry"</span> <span class="o">%</span> <span class="n">expected_last_keyword</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_parse</span><span class="p">(</span><span class="n">entries</span><span class="p">,</span> <span class="n">validate</span><span class="p">)</span>
<div class="viewcode-block" id="ExtraInfoDescriptor.get_unrecognized_lines"><a class="viewcode-back" href="../../../api/descriptor/extrainfo_descriptor.html#stem.descriptor.extrainfo_descriptor.ExtraInfoDescriptor.get_unrecognized_lines">[docs]</a> <span class="k">def</span> <span class="nf">get_unrecognized_lines</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_unrecognized_lines</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_parse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entries</span><span class="p">,</span> <span class="n">validate</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Parses a series of 'keyword => (value, pgp block)' mappings and applies</span>
<span class="sd"> them as attributes.</span>
<span class="sd"> :param dict entries: descriptor contents to be applied</span>
<span class="sd"> :param bool validate: checks the validity of descriptor content if True</span>
<span class="sd"> :raises: **ValueError** if an error occurs in validation</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">keyword</span><span class="p">,</span> <span class="n">values</span> <span class="ow">in</span> <span class="n">entries</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="c"># most just work with the first (and only) value</span>
<span class="n">value</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">values</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">line</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="c"># original line</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"extra-info"</span><span class="p">:</span>
<span class="c"># "extra-info" Nickname Fingerprint</span>
<span class="n">extra_info_comp</span> <span class="o">=</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">extra_info_comp</span><span class="p">)</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Extra-info line must have two values: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">tor_tools</span><span class="o">.</span><span class="n">is_valid_nickname</span><span class="p">(</span><span class="n">extra_info_comp</span><span class="p">[</span><span class="mi">0</span><span class="p">]):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Extra-info line entry isn't a valid nickname: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">extra_info_comp</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">tor_tools</span><span class="o">.</span><span class="n">is_valid_fingerprint</span><span class="p">(</span><span class="n">extra_info_comp</span><span class="p">[</span><span class="mi">1</span><span class="p">]):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Tor relay fingerprints consist of forty hex digits: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">extra_info_comp</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">nickname</span> <span class="o">=</span> <span class="n">extra_info_comp</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">fingerprint</span> <span class="o">=</span> <span class="n">extra_info_comp</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"geoip-db-digest"</span><span class="p">:</span>
<span class="c"># "geoip-db-digest" Digest</span>
<span class="k">if</span> <span class="n">validate</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">tor_tools</span><span class="o">.</span><span class="n">is_hex_digits</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="mi">40</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Geoip digest line had an invalid sha1 digest: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">geoip_db_digest</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"geoip6-db-digest"</span><span class="p">:</span>
<span class="c"># "geoip6-db-digest" Digest</span>
<span class="k">if</span> <span class="n">validate</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">tor_tools</span><span class="o">.</span><span class="n">is_hex_digits</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="mi">40</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Geoip v6 digest line had an invalid sha1 digest: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">geoip6_db_digest</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"transport"</span><span class="p">:</span>
<span class="c"># "transport" transportname address:port [arglist]</span>
<span class="c"># Everything after the transportname is scrubbed in published bridge</span>
<span class="c"># descriptors, so we'll never see it in practice.</span>
<span class="c">#</span>
<span class="c"># These entries really only make sense for bridges, but have been seen</span>
<span class="c"># on non-bridges in the wild when the relay operator configured it this</span>
<span class="c"># way.</span>
<span class="k">for</span> <span class="n">transport_value</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="n">values</span><span class="p">:</span>
<span class="n">name</span><span class="p">,</span> <span class="n">address</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">args</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span>
<span class="k">if</span> <span class="ow">not</span> <span class="s">' '</span> <span class="ow">in</span> <span class="n">transport_value</span><span class="p">:</span>
<span class="c"># scrubbed</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">transport_value</span>
<span class="k">else</span><span class="p">:</span>
<span class="c"># not scrubbed</span>
<span class="n">value_comp</span> <span class="o">=</span> <span class="n">transport_value</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">value_comp</span><span class="p">)</span> <span class="o"><</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Transport line is missing its transport name: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">value_comp</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">value_comp</span><span class="p">)</span> <span class="o"><</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Transport line is missing its address:port value: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="s">":"</span> <span class="ow">in</span> <span class="n">value_comp</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Transport line's address:port entry is missing a colon: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">address</span><span class="p">,</span> <span class="n">port_str</span> <span class="o">=</span> <span class="n">value_comp</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">':'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">is_valid_ipv4_address</span><span class="p">(</span><span class="n">address</span><span class="p">)</span> <span class="ow">or</span> \
<span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">is_valid_ipv6_address</span><span class="p">(</span><span class="n">address</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Transport line has a malformed address: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">is_valid_port</span><span class="p">(</span><span class="n">port_str</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Transport line has a malformed port: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="n">port</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">port_str</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">value_comp</span><span class="p">)</span> <span class="o">>=</span> <span class="mi">3</span><span class="p">:</span>
<span class="n">args</span> <span class="o">=</span> <span class="n">value_comp</span><span class="p">[</span><span class="mi">2</span><span class="p">:]</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">[]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">transport</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">address</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">args</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"cell-circuits-per-decile"</span><span class="p">:</span>
<span class="c"># "cell-circuits-per-decile" num</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">value</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Non-numeric cell-circuits-per-decile value: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">stat</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="n">validate</span> <span class="ow">and</span> <span class="n">stat</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Negative cell-circuits-per-decile value: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_circuits_per_decile</span> <span class="o">=</span> <span class="n">stat</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"dirreq-v2-resp"</span><span class="p">,</span> <span class="s">"dirreq-v3-resp"</span><span class="p">,</span> <span class="s">"dirreq-v2-direct-dl"</span><span class="p">,</span> <span class="s">"dirreq-v3-direct-dl"</span><span class="p">,</span> <span class="s">"dirreq-v2-tunneled-dl"</span><span class="p">,</span> <span class="s">"dirreq-v3-tunneled-dl"</span><span class="p">):</span>
<span class="n">recognized_counts</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">unrecognized_counts</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">is_response_stats</span> <span class="o">=</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"dirreq-v2-resp"</span><span class="p">,</span> <span class="s">"dirreq-v3-resp"</span><span class="p">)</span>
<span class="n">key_set</span> <span class="o">=</span> <span class="n">DirResponse</span> <span class="k">if</span> <span class="n">is_response_stats</span> <span class="k">else</span> <span class="n">DirStat</span>
<span class="n">key_type</span> <span class="o">=</span> <span class="s">"STATUS"</span> <span class="k">if</span> <span class="n">is_response_stats</span> <span class="k">else</span> <span class="s">"STAT"</span>
<span class="n">error_msg</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s"> lines should contain </span><span class="si">%s</span><span class="s">=COUNT mappings: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">key_type</span><span class="p">,</span> <span class="n">line</span><span class="p">)</span>
<span class="k">if</span> <span class="n">value</span><span class="p">:</span>
<span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">","</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="s">"="</span> <span class="ow">in</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">status</span><span class="p">,</span> <span class="n">count</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"="</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="n">count</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
<span class="k">if</span> <span class="n">status</span> <span class="ow">in</span> <span class="n">key_set</span><span class="p">:</span>
<span class="n">recognized_counts</span><span class="p">[</span><span class="n">status</span><span class="p">]</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">count</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">unrecognized_counts</span><span class="p">[</span><span class="n">status</span><span class="p">]</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">count</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v2-resp"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_responses</span> <span class="o">=</span> <span class="n">recognized_counts</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_responses_unknown</span> <span class="o">=</span> <span class="n">unrecognized_counts</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v3-resp"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_responses</span> <span class="o">=</span> <span class="n">recognized_counts</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_responses_unknown</span> <span class="o">=</span> <span class="n">unrecognized_counts</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v2-direct-dl"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_direct_dl</span> <span class="o">=</span> <span class="n">recognized_counts</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_direct_dl_unknown</span> <span class="o">=</span> <span class="n">unrecognized_counts</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v3-direct-dl"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_direct_dl</span> <span class="o">=</span> <span class="n">recognized_counts</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_direct_dl_unknown</span> <span class="o">=</span> <span class="n">unrecognized_counts</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v2-tunneled-dl"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_tunneled_dl</span> <span class="o">=</span> <span class="n">recognized_counts</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_tunneled_dl_unknown</span> <span class="o">=</span> <span class="n">unrecognized_counts</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v3-tunneled-dl"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_tunneled_dl</span> <span class="o">=</span> <span class="n">recognized_counts</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_tunneled_dl_unknown</span> <span class="o">=</span> <span class="n">unrecognized_counts</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"dirreq-v2-share"</span><span class="p">,</span> <span class="s">"dirreq-v3-share"</span><span class="p">):</span>
<span class="c"># "<keyword>" num%</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">value</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s">"%"</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">()</span>
<span class="n">percentage</span> <span class="o">=</span> <span class="nb">float</span><span class="p">(</span><span class="n">value</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span> <span class="o">/</span> <span class="mi">100</span>
<span class="c"># Bug lets these be above 100%, however they're soon going away...</span>
<span class="c"># https://lists.torproject.org/pipermail/tor-dev/2012-June/003679.html</span>
<span class="k">if</span> <span class="n">validate</span> <span class="ow">and</span> <span class="n">percentage</span> <span class="o"><</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Negative percentage value: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v2-share"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_share</span> <span class="o">=</span> <span class="n">percentage</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v3-share"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_share</span> <span class="o">=</span> <span class="n">percentage</span>
<span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Value can't be parsed as a percentage: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"cell-processed-cells"</span><span class="p">,</span> <span class="s">"cell-queued-cells"</span><span class="p">,</span> <span class="s">"cell-time-in-queue"</span><span class="p">):</span>
<span class="c"># "<keyword>" num,...,num</span>
<span class="n">entries</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">value</span><span class="p">:</span>
<span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">","</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="c"># Values should be positive but as discussed in ticket #5849</span>
<span class="c"># there was a bug around this. It was fixed in tor 0.2.2.1.</span>
<span class="n">entries</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">float</span><span class="p">(</span><span class="n">entry</span><span class="p">))</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Non-numeric entry in </span><span class="si">%s</span><span class="s"> listing: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">line</span><span class="p">))</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"cell-processed-cells"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_processed_cells</span> <span class="o">=</span> <span class="n">entries</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"cell-queued-cells"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_queued_cells</span> <span class="o">=</span> <span class="n">entries</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"cell-time-in-queue"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_time_in_queue</span> <span class="o">=</span> <span class="n">entries</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"published"</span><span class="p">,</span> <span class="s">"geoip-start-time"</span><span class="p">):</span>
<span class="c"># "<keyword>" YYYY-MM-DD HH:MM:SS</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">timestamp</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s">"%Y-%m-</span><span class="si">%d</span><span class="s"> %H:%M:%S"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"published"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">published</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"geoip-start-time"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">geoip_start_time</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Timestamp on </span><span class="si">%s</span><span class="s"> line wasn't parsable: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">line</span><span class="p">))</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"cell-stats-end"</span><span class="p">,</span> <span class="s">"entry-stats-end"</span><span class="p">,</span> <span class="s">"exit-stats-end"</span><span class="p">,</span> <span class="s">"bridge-stats-end"</span><span class="p">,</span> <span class="s">"dirreq-stats-end"</span><span class="p">):</span>
<span class="c"># "<keyword>" YYYY-MM-DD HH:MM:SS (NSEC s)</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">timestamp</span><span class="p">,</span> <span class="n">interval</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">_parse_timestamp_and_interval</span><span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"cell-stats-end"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_stats_end</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">cell_stats_interval</span> <span class="o">=</span> <span class="n">interval</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"entry-stats-end"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry_stats_end</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry_stats_interval</span> <span class="o">=</span> <span class="n">interval</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"exit-stats-end"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exit_stats_end</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exit_stats_interval</span> <span class="o">=</span> <span class="n">interval</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"bridge-stats-end"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bridge_stats_end</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bridge_stats_interval</span> <span class="o">=</span> <span class="n">interval</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-stats-end"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_stats_end</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_stats_interval</span> <span class="o">=</span> <span class="n">interval</span>
<span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">exc</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"conn-bi-direct"</span><span class="p">:</span>
<span class="c"># "conn-bi-direct" YYYY-MM-DD HH:MM:SS (NSEC s) BELOW,READ,WRITE,BOTH</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">timestamp</span><span class="p">,</span> <span class="n">interval</span><span class="p">,</span> <span class="n">remainder</span> <span class="o">=</span> <span class="n">_parse_timestamp_and_interval</span><span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="n">stats</span> <span class="o">=</span> <span class="n">remainder</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">","</span><span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">stats</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">4</span> <span class="ow">or</span> <span class="ow">not</span> \
<span class="p">(</span><span class="n">stats</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">isdigit</span><span class="p">()</span> <span class="ow">and</span> <span class="n">stats</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">isdigit</span><span class="p">()</span> <span class="ow">and</span> <span class="n">stats</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span><span class="o">.</span><span class="n">isdigit</span><span class="p">()</span> <span class="ow">and</span> <span class="n">stats</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span><span class="o">.</span><span class="n">isdigit</span><span class="p">()):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"conn-bi-direct line should end with four numeric values: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_end</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_interval</span> <span class="o">=</span> <span class="n">interval</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_below</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">stats</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_read</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">stats</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_write</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">stats</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span>
<span class="bp">self</span><span class="o">.</span><span class="n">conn_bi_direct_both</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">stats</span><span class="p">[</span><span class="mi">3</span><span class="p">])</span>
<span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">exc</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"read-history"</span><span class="p">,</span> <span class="s">"write-history"</span><span class="p">,</span> <span class="s">"dirreq-read-history"</span><span class="p">,</span> <span class="s">"dirreq-write-history"</span><span class="p">):</span>
<span class="c"># "<keyword>" YYYY-MM-DD HH:MM:SS (NSEC s) NUM,NUM,NUM,NUM,NUM...</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">timestamp</span><span class="p">,</span> <span class="n">interval</span><span class="p">,</span> <span class="n">remainder</span> <span class="o">=</span> <span class="n">_parse_timestamp_and_interval</span><span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
<span class="n">history_values</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="n">remainder</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">history_values</span> <span class="o">=</span> <span class="p">[</span><span class="nb">int</span><span class="p">(</span><span class="n">entry</span><span class="p">)</span> <span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">remainder</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">","</span><span class="p">)]</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s"> line has non-numeric values: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">line</span><span class="p">))</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"read-history"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">read_history_end</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">read_history_interval</span> <span class="o">=</span> <span class="n">interval</span>
<span class="bp">self</span><span class="o">.</span><span class="n">read_history_values</span> <span class="o">=</span> <span class="n">history_values</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"write-history"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_history_end</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_history_interval</span> <span class="o">=</span> <span class="n">interval</span>
<span class="bp">self</span><span class="o">.</span><span class="n">write_history_values</span> <span class="o">=</span> <span class="n">history_values</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-read-history"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_read_history_end</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_read_history_interval</span> <span class="o">=</span> <span class="n">interval</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_read_history_values</span> <span class="o">=</span> <span class="n">history_values</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-write-history"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_write_history_end</span> <span class="o">=</span> <span class="n">timestamp</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_write_history_interval</span> <span class="o">=</span> <span class="n">interval</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_write_history_values</span> <span class="o">=</span> <span class="n">history_values</span>
<span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">exc</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"exit-kibibytes-written"</span><span class="p">,</span> <span class="s">"exit-kibibytes-read"</span><span class="p">,</span> <span class="s">"exit-streams-opened"</span><span class="p">):</span>
<span class="c"># "<keyword>" port=N,port=N,...</span>
<span class="n">port_mappings</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">error_msg</span> <span class="o">=</span> <span class="s">"Entries in </span><span class="si">%s</span><span class="s"> line should only be PORT=N entries: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">line</span><span class="p">)</span>
<span class="k">if</span> <span class="n">value</span><span class="p">:</span>
<span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">","</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="s">"="</span> <span class="ow">in</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">port</span><span class="p">,</span> <span class="n">stat</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"="</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="p">(</span><span class="n">port</span> <span class="o">==</span> <span class="s">'other'</span> <span class="ow">or</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">is_valid_port</span><span class="p">(</span><span class="n">port</span><span class="p">))</span> <span class="ow">and</span> <span class="n">stat</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
<span class="k">if</span> <span class="n">port</span> <span class="o">!=</span> <span class="s">'other'</span><span class="p">:</span>
<span class="n">port</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">port</span><span class="p">)</span>
<span class="n">port_mappings</span><span class="p">[</span><span class="n">port</span><span class="p">]</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">stat</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"exit-kibibytes-written"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exit_kibibytes_written</span> <span class="o">=</span> <span class="n">port_mappings</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"exit-kibibytes-read"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exit_kibibytes_read</span> <span class="o">=</span> <span class="n">port_mappings</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"exit-streams-opened"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">exit_streams_opened</span> <span class="o">=</span> <span class="n">port_mappings</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="ow">in</span> <span class="p">(</span><span class="s">"dirreq-v2-ips"</span><span class="p">,</span> <span class="s">"dirreq-v3-ips"</span><span class="p">,</span> <span class="s">"dirreq-v2-reqs"</span><span class="p">,</span> <span class="s">"dirreq-v3-reqs"</span><span class="p">,</span> <span class="s">"geoip-client-origins"</span><span class="p">,</span> <span class="s">"entry-ips"</span><span class="p">,</span> <span class="s">"bridge-ips"</span><span class="p">):</span>
<span class="c"># "<keyword>" CC=N,CC=N,...</span>
<span class="c">#</span>
<span class="c"># The maxmind geoip (https://www.maxmind.com/app/iso3166) has numeric</span>
<span class="c"># locale codes for some special values, for instance...</span>
<span class="c"># A1,"Anonymous Proxy"</span>
<span class="c"># A2,"Satellite Provider"</span>
<span class="c"># ??,"Unknown"</span>
<span class="n">locale_usage</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">error_msg</span> <span class="o">=</span> <span class="s">"Entries in </span><span class="si">%s</span><span class="s"> line should only be CC=N entries: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">line</span><span class="p">)</span>
<span class="k">if</span> <span class="n">value</span><span class="p">:</span>
<span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">","</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="s">"="</span> <span class="ow">in</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">locale</span><span class="p">,</span> <span class="n">count</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"="</span><span class="p">,</span> <span class="mi">1</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="s">"^[a-zA-Z0-9\?]{2}$"</span><span class="p">,</span> <span class="n">locale</span><span class="p">)</span> <span class="ow">and</span> <span class="n">count</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
<span class="n">locale_usage</span><span class="p">[</span><span class="n">locale</span><span class="p">]</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">count</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">validate</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="n">error_msg</span><span class="p">)</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v2-ips"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_ips</span> <span class="o">=</span> <span class="n">locale_usage</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v3-ips"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_ips</span> <span class="o">=</span> <span class="n">locale_usage</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v2-reqs"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v2_requests</span> <span class="o">=</span> <span class="n">locale_usage</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"dirreq-v3-reqs"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dir_v3_requests</span> <span class="o">=</span> <span class="n">locale_usage</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"geoip-client-origins"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">geoip_client_origins</span> <span class="o">=</span> <span class="n">locale_usage</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"entry-ips"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">entry_ips</span> <span class="o">=</span> <span class="n">locale_usage</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"bridge-ips"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bridge_ips</span> <span class="o">=</span> <span class="n">locale_usage</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"bridge-ip-versions"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ip_versions</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="n">value</span><span class="p">:</span>
<span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">','</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="s">'='</span> <span class="ow">in</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">stem</span><span class="o">.</span><span class="n">ProtocolError</span><span class="p">(</span><span class="s">"The bridge-ip-versions should be a comma separated listing of '<protocol>=<count>' mappings: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="n">protocol</span><span class="p">,</span> <span class="n">count</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'='</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">count</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">stem</span><span class="o">.</span><span class="n">ProtocolError</span><span class="p">(</span><span class="s">"IP protocol count was non-numeric (</span><span class="si">%s</span><span class="s">): </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">count</span><span class="p">,</span> <span class="n">line</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ip_versions</span><span class="p">[</span><span class="n">protocol</span><span class="p">]</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">count</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"bridge-ip-transports"</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ip_transports</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="n">value</span><span class="p">:</span>
<span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">','</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="s">'='</span> <span class="ow">in</span> <span class="n">entry</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">stem</span><span class="o">.</span><span class="n">ProtocolError</span><span class="p">(</span><span class="s">"The bridge-ip-transports should be a comma separated listing of '<protocol>=<count>' mappings: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="n">protocol</span><span class="p">,</span> <span class="n">count</span> <span class="o">=</span> <span class="n">entry</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'='</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">count</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span>
<span class="k">raise</span> <span class="n">stem</span><span class="o">.</span><span class="n">ProtocolError</span><span class="p">(</span><span class="s">"Transport count was non-numeric (</span><span class="si">%s</span><span class="s">): </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">count</span><span class="p">,</span> <span class="n">line</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ip_transports</span><span class="p">[</span><span class="n">protocol</span><span class="p">]</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">count</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_unrecognized_lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<div class="viewcode-block" id="ExtraInfoDescriptor.digest"><a class="viewcode-back" href="../../../api/descriptor/extrainfo_descriptor.html#stem.descriptor.extrainfo_descriptor.ExtraInfoDescriptor.digest">[docs]</a> <span class="k">def</span> <span class="nf">digest</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Provides the upper-case hex encoded sha1 of our content. This value is part</span>
<span class="sd"> of the server descriptor entry for this relay.</span>
<span class="sd"> :returns: **str** with the upper-case hex digest value for this server</span>
<span class="sd"> descriptor</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s">"Unsupported Operation: this should be implemented by the ExtraInfoDescriptor subclass"</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_required_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="n">REQUIRED_FIELDS</span>
<span class="k">def</span> <span class="nf">_first_keyword</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">"extra-info"</span>
<span class="k">def</span> <span class="nf">_last_keyword</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">"router-signature"</span>
</div>
<div class="viewcode-block" id="RelayExtraInfoDescriptor"><a class="viewcode-back" href="../../../api/descriptor/extrainfo_descriptor.html#stem.descriptor.extrainfo_descriptor.RelayExtraInfoDescriptor">[docs]</a><span class="k">class</span> <span class="nc">RelayExtraInfoDescriptor</span><span class="p">(</span><span class="n">ExtraInfoDescriptor</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Relay extra-info descriptor, constructed from data such as that provided by</span>
<span class="sd"> "GETINFO extra-info/digest/\*", cached descriptors, and metrics</span>
<span class="sd"> (`specification <https://gitweb.torproject.org/torspec.git/blob/HEAD:/dir-spec.txt>`_).</span>
<span class="sd"> :var str signature: **\*** signature for this extrainfo descriptor</span>
<span class="sd"> **\*** attribute is required when we're parsed with validation</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">raw_contents</span><span class="p">,</span> <span class="n">validate</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">signature</span> <span class="o">=</span> <span class="bp">None</span>
<span class="nb">super</span><span class="p">(</span><span class="n">RelayExtraInfoDescriptor</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">raw_contents</span><span class="p">,</span> <span class="n">validate</span><span class="p">)</span>
<span class="nd">@lru_cache</span><span class="p">()</span>
<div class="viewcode-block" id="RelayExtraInfoDescriptor.digest"><a class="viewcode-back" href="../../../api/descriptor/extrainfo_descriptor.html#stem.descriptor.extrainfo_descriptor.RelayExtraInfoDescriptor.digest">[docs]</a> <span class="k">def</span> <span class="nf">digest</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c"># our digest is calculated from everything except our signature</span>
<span class="n">raw_content</span><span class="p">,</span> <span class="n">ending</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span> <span class="s">"</span><span class="se">\n</span><span class="s">router-signature</span><span class="se">\n</span><span class="s">"</span>
<span class="n">raw_content</span> <span class="o">=</span> <span class="n">raw_content</span><span class="p">[:</span><span class="n">raw_content</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">ending</span><span class="p">)</span> <span class="o">+</span> <span class="nb">len</span><span class="p">(</span><span class="n">ending</span><span class="p">)]</span>
<span class="k">return</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">sha1</span><span class="p">(</span><span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">str_tools</span><span class="o">.</span><span class="n">_to_bytes</span><span class="p">(</span><span class="n">raw_content</span><span class="p">))</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span>
</div>
<span class="k">def</span> <span class="nf">_parse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entries</span><span class="p">,</span> <span class="n">validate</span><span class="p">):</span>
<span class="n">entries</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">entries</span><span class="p">)</span> <span class="c"># shallow copy since we're destructive</span>
<span class="c"># handles fields only in server descriptors</span>
<span class="k">for</span> <span class="n">keyword</span><span class="p">,</span> <span class="n">values</span> <span class="ow">in</span> <span class="n">entries</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">value</span><span class="p">,</span> <span class="n">block_contents</span> <span class="o">=</span> <span class="n">values</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">line</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="c"># original line</span>
<span class="k">if</span> <span class="n">block_contents</span><span class="p">:</span>
<span class="n">line</span> <span class="o">+=</span> <span class="s">"</span><span class="se">\n</span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">block_contents</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"router-signature"</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">block_contents</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Router signature line must be followed by a signature block: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">signature</span> <span class="o">=</span> <span class="n">block_contents</span>
<span class="k">del</span> <span class="n">entries</span><span class="p">[</span><span class="s">"router-signature"</span><span class="p">]</span>
<span class="n">ExtraInfoDescriptor</span><span class="o">.</span><span class="n">_parse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entries</span><span class="p">,</span> <span class="n">validate</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="BridgeExtraInfoDescriptor"><a class="viewcode-back" href="../../../api/descriptor/extrainfo_descriptor.html#stem.descriptor.extrainfo_descriptor.BridgeExtraInfoDescriptor">[docs]</a><span class="k">class</span> <span class="nc">BridgeExtraInfoDescriptor</span><span class="p">(</span><span class="n">ExtraInfoDescriptor</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Bridge extra-info descriptor (`bridge descriptor specification</span>
<span class="sd"> <https://metrics.torproject.org/formats.html#bridgedesc>`_)</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">raw_contents</span><span class="p">,</span> <span class="n">validate</span> <span class="o">=</span> <span class="bp">True</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_digest</span> <span class="o">=</span> <span class="bp">None</span>
<span class="nb">super</span><span class="p">(</span><span class="n">BridgeExtraInfoDescriptor</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">raw_contents</span><span class="p">,</span> <span class="n">validate</span><span class="p">)</span>
<div class="viewcode-block" id="BridgeExtraInfoDescriptor.digest"><a class="viewcode-back" href="../../../api/descriptor/extrainfo_descriptor.html#stem.descriptor.extrainfo_descriptor.BridgeExtraInfoDescriptor.digest">[docs]</a> <span class="k">def</span> <span class="nf">digest</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_digest</span>
</div>
<span class="k">def</span> <span class="nf">_parse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entries</span><span class="p">,</span> <span class="n">validate</span><span class="p">):</span>
<span class="n">entries</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">entries</span><span class="p">)</span> <span class="c"># shallow copy since we're destructive</span>
<span class="c"># handles fields only in server descriptors</span>
<span class="k">for</span> <span class="n">keyword</span><span class="p">,</span> <span class="n">values</span> <span class="ow">in</span> <span class="n">entries</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">value</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">values</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
<span class="n">line</span> <span class="o">=</span> <span class="s">"</span><span class="si">%s</span><span class="s"> </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">keyword</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> <span class="c"># original line</span>
<span class="k">if</span> <span class="n">keyword</span> <span class="o">==</span> <span class="s">"router-digest"</span><span class="p">:</span>
<span class="k">if</span> <span class="n">validate</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">stem</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">tor_tools</span><span class="o">.</span><span class="n">is_hex_digits</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="mi">40</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"Router digest line had an invalid sha1 digest: </span><span class="si">%s</span><span class="s">"</span> <span class="o">%</span> <span class="n">line</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_digest</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">del</span> <span class="n">entries</span><span class="p">[</span><span class="s">"router-digest"</span><span class="p">]</span>
<span class="n">ExtraInfoDescriptor</span><span class="o">.</span><span class="n">_parse</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entries</span><span class="p">,</span> <span class="n">validate</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_required_fields</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">excluded_fields</span> <span class="o">=</span> <span class="p">[</span>
<span class="s">"router-signature"</span><span class="p">,</span>
<span class="p">]</span>
<span class="n">included_fields</span> <span class="o">=</span> <span class="p">[</span>
<span class="s">"router-digest"</span><span class="p">,</span>
<span class="p">]</span>
<span class="k">return</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">included_fields</span> <span class="o">+</span> <span class="p">[</span><span class="n">f</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">REQUIRED_FIELDS</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">excluded_fields</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">_last_keyword</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">None</span></div>
</pre></div>
</div>
<div class="bottomnav">
</div>
<div class="footer">
</div>
</body>
</html>
