<!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.util.tor_tools — 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.util.tor_tools</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.util.tor_tools</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">Miscellaneous utility functions for working with tor.</span>
<span class="sd">**These functions are not being vended to stem users. They may change in the</span>
<span class="sd">future, use them at your own risk.**</span>
<span class="sd">**Module Overview:**</span>
<span class="sd">::</span>
<span class="sd"> is_valid_fingerprint - checks if a string is a valid tor relay fingerprint</span>
<span class="sd"> is_valid_nickname - checks if a string is a valid tor relay nickname</span>
<span class="sd"> is_valid_circuit_id - checks if a string is a valid tor circuit id</span>
<span class="sd"> is_valid_stream_id - checks if a string is a valid tor stream id</span>
<span class="sd"> is_hex_digits - checks if a string is only made up of hex digits</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">re</span>
<span class="c"># The control-spec defines the following as...</span>
<span class="c">#</span>
<span class="c"># Fingerprint = "$" 40*HEXDIG</span>
<span class="c"># NicknameChar = "a"-"z" / "A"-"Z" / "0" - "9"</span>
<span class="c"># Nickname = 1*19 NicknameChar</span>
<span class="c">#</span>
<span class="c"># CircuitID = 1*16 IDChar</span>
<span class="c"># IDChar = ALPHA / DIGIT</span>
<span class="c">#</span>
<span class="c"># HEXDIG is defined in RFC 5234 as being uppercase and used in RFC 5987 as</span>
<span class="c"># case insensitive. Tor doesn't define this in the spec so flipping a coin</span>
<span class="c"># and going with case insensitive.</span>
<span class="n">HEX_DIGIT</span> <span class="o">=</span> <span class="s">"[0-9a-fA-F]"</span>
<span class="n">FINGERPRINT_PATTERN</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">"^</span><span class="si">%s</span><span class="s">{40}$"</span> <span class="o">%</span> <span class="n">HEX_DIGIT</span><span class="p">)</span>
<span class="n">NICKNAME_PATTERN</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">"^[a-zA-Z0-9]{1,19}$"</span><span class="p">)</span>
<span class="n">CIRC_ID_PATTERN</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">"^[a-zA-Z0-9]{1,16}$"</span><span class="p">)</span>
<div class="viewcode-block" id="is_valid_fingerprint"><a class="viewcode-back" href="../../../api/util/tor_tools.html#stem.util.tor_tools.is_valid_fingerprint">[docs]</a><span class="k">def</span> <span class="nf">is_valid_fingerprint</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">check_prefix</span> <span class="o">=</span> <span class="bp">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Checks if a string is a properly formatted relay fingerprint. This checks for</span>
<span class="sd"> a '$' prefix if check_prefix is true, otherwise this only validates the hex</span>
<span class="sd"> digits.</span>
<span class="sd"> :param str entry: string to be checked</span>
<span class="sd"> :param bool check_prefix: checks for a '$' prefix</span>
<span class="sd"> :returns: **True** if the string could be a relay fingerprint, **False** otherwise</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">)):</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">elif</span> <span class="n">check_prefix</span><span class="p">:</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">entry</span> <span class="ow">or</span> <span class="n">entry</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s">"$"</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="n">entry</span> <span class="o">=</span> <span class="n">entry</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">FINGERPRINT_PATTERN</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">entry</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="is_valid_nickname"><a class="viewcode-back" href="../../../api/util/tor_tools.html#stem.util.tor_tools.is_valid_nickname">[docs]</a><span class="k">def</span> <span class="nf">is_valid_nickname</span><span class="p">(</span><span class="n">entry</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Checks if a string is a valid format for being a nickname.</span>
<span class="sd"> :param str entry: string to be checked</span>
<span class="sd"> :returns: **True** if the string could be a nickname, **False** otherwise</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">)):</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">NICKNAME_PATTERN</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">entry</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="is_valid_circuit_id"><a class="viewcode-back" href="../../../api/util/tor_tools.html#stem.util.tor_tools.is_valid_circuit_id">[docs]</a><span class="k">def</span> <span class="nf">is_valid_circuit_id</span><span class="p">(</span><span class="n">entry</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Checks if a string is a valid format for being a circuit identifier.</span>
<span class="sd"> :returns: **True** if the string could be a circuit id, **False** otherwise</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="nb">unicode</span><span class="p">)):</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">CIRC_ID_PATTERN</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">entry</span><span class="p">))</span>
</div>
<div class="viewcode-block" id="is_valid_stream_id"><a class="viewcode-back" href="../../../api/util/tor_tools.html#stem.util.tor_tools.is_valid_stream_id">[docs]</a><span class="k">def</span> <span class="nf">is_valid_stream_id</span><span class="p">(</span><span class="n">entry</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Checks if a string is a valid format for being a stream identifier.</span>
<span class="sd"> Currently, this is just an alias to :func:`~stem.util.tor_tools.is_valid_circuit_id`.</span>
<span class="sd"> :returns: **True** if the string could be a stream id, **False** otherwise</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">is_valid_circuit_id</span><span class="p">(</span><span class="n">entry</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="is_hex_digits"><a class="viewcode-back" href="../../../api/util/tor_tools.html#stem.util.tor_tools.is_hex_digits">[docs]</a><span class="k">def</span> <span class="nf">is_hex_digits</span><span class="p">(</span><span class="n">entry</span><span class="p">,</span> <span class="n">count</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Checks if a string is the given number of hex digits. Digits represented by</span>
<span class="sd"> letters are case insensitive.</span>
<span class="sd"> :param str entry: string to be checked</span>
<span class="sd"> :param int count: number of hex digits to be checked for</span>
<span class="sd"> :returns: **True** if the string matches this number</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">"^</span><span class="si">%s</span><span class="s">{</span><span class="si">%i</span><span class="s">}$"</span> <span class="o">%</span> <span class="p">(</span><span class="n">HEX_DIGIT</span><span class="p">,</span> <span class="n">count</span><span class="p">),</span> <span class="n">entry</span><span class="p">))</span></div>
</pre></div>
</div>
<div class="bottomnav">
</div>
<div class="footer">
</div>
</body>
</html>
