<!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>Connection Summary — Stem 1.8.1-maint 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/style.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../../', VERSION: '1.8.1-maint', 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> <link rel="shortcut icon" href="../../_static/favicon.png"/> <link rel="top" title="Stem 1.8.1-maint documentation" href="../../index.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>Connection Summary</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="../the_little_relay_that_could.html">Hello World</a></li> <li><a href="../to_russia_with_love.html">Client Usage</a></li> <li><a href="../tortoise_and_the_hare.html">Event Listening</a></li> <li><a href="../over_the_river.html">Hidden Services</a></li> <li><a href="../mirror_mirror_on_the_wall.html">Tor Descriptors</a></li> <li><a href="../east_of_the_sun.html">Utilities</a></li> <li><a href="../down_the_rabbit_hole.html">Interpreter</a></li> <li><a href="../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://github.com/torproject/stem/issues/">Bug Tracker</a></li> <li><a href="https://jenkins.torproject.org/job/stem-tor-ci/">Jenkins</a></li> <li><a href="../../download.html">Download</a></li> </ul> </li> <li><a href="../../faq.html#where-can-i-get-help">Contact</a> <ul> <li><a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev">Email List</a></li> <li><a href="https://www.torproject.org/about/contact.html.en#irc">IRC</a></li> <li><a href="https://www.atagar.com/contact/">Author</a></li> </ul> </li> </ul> </p> </div> <div class="content"> <div class="section" id="connection-summary"> <h1>Connection Summary<a class="headerlink" href="#connection-summary" title="Permalink to this headline">ΒΆ</a></h1> <a class="reference external image-reference" href="../double_double_toil_and_trouble.html"><img alt="../../_images/back.png" src="../../_images/back.png" /></a> <p>The following provides a summary of your relay's inbound and outbound connections. Couple important notes...</p> <blockquote> <div><ul> <li><p class="first">To use this you must set <strong>DisableDebuggerAttachment 0</strong> in your torrc. Otherwise connection information will be unavailable.</p> </li> <li><p class="first"><strong>Be careful about the data you look at.</strong> Inspection of client and exit traffic especially is wiretapping and not only unethical but likely illegal.</p> <p>That said, a general overview like this should be fine.</p> </li> </ul> </div></blockquote> <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">argparse</span> <span class="kn">import</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="nn">time</span> <span class="kn">import</span> <span class="nn">stem.connection</span> <span class="kn">import</span> <span class="nn">stem.util.system</span> <span class="kn">import</span> <span class="nn">stem.util.str_tools</span> <span class="kn">from</span> <span class="nn">stem.control</span> <span class="kn">import</span> <span class="n">Listener</span> <span class="kn">from</span> <span class="nn">stem.util.connection</span> <span class="kn">import</span> <span class="n">get_connections</span><span class="p">,</span> <span class="n">port_usage</span><span class="p">,</span> <span class="n">is_valid_ipv4_address</span> <span class="n">HEADER_LINE</span> <span class="o">=</span> <span class="s">" {version} uptime: {uptime} flags: {flags}</span><span class="se">\n</span><span class="s">"</span> <span class="n">DIV</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="si">%s</span><span class="s">+'</span> <span class="o">%</span> <span class="p">(</span><span class="s">'-'</span> <span class="o">*</span> <span class="mi">30</span><span class="p">,</span> <span class="s">'-'</span> <span class="o">*</span> <span class="mi">6</span><span class="p">,</span> <span class="s">'-'</span> <span class="o">*</span> <span class="mi">6</span><span class="p">)</span> <span class="n">COLUMN</span> <span class="o">=</span> <span class="s">'| </span><span class="si">%-28s</span><span class="s"> | </span><span class="si">%4s</span><span class="s"> | </span><span class="si">%4s</span><span class="s"> |'</span> <span class="n">INBOUND_ORPORT</span> <span class="o">=</span> <span class="s">'Inbound to our ORPort'</span> <span class="n">INBOUND_DIRPORT</span> <span class="o">=</span> <span class="s">'Inbound to our DirPort'</span> <span class="n">INBOUND_CONTROLPORT</span> <span class="o">=</span> <span class="s">'Inbound to our ControlPort'</span> <span class="n">OUTBOUND_ORPORT</span> <span class="o">=</span> <span class="s">'Outbound to a relay'</span> <span class="n">OUTBOUND_EXIT</span> <span class="o">=</span> <span class="s">'Outbound exit traffic'</span> <span class="n">OUTBOUND_UNKNOWN</span> <span class="o">=</span> <span class="s">'Outbound uncategorized'</span> <span class="k">def</span> <span class="nf">main</span><span class="p">():</span> <span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">()</span> <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s">"--ctrlport"</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s">"default: 9051 or 9151"</span><span class="p">)</span> <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s">"--resolver"</span><span class="p">,</span> <span class="n">help</span><span class="o">=</span><span class="s">"default: autodetected"</span><span class="p">)</span> <span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span> <span class="n">control_port</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">ctrlport</span><span class="p">)</span> <span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">ctrlport</span> <span class="k">else</span> <span class="s">'default'</span> <span class="n">controller</span> <span class="o">=</span> <span class="n">stem</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">control_port</span> <span class="o">=</span> <span class="p">(</span><span class="s">'127.0.0.1'</span><span class="p">,</span> <span class="n">control_port</span><span class="p">))</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">controller</span><span class="p">:</span> <span class="k">return</span> <span class="n">desc</span> <span class="o">=</span> <span class="n">controller</span><span class="o">.</span><span class="n">get_network_status</span><span class="p">(</span><span class="n">default</span> <span class="o">=</span> <span class="bp">None</span><span class="p">)</span> <span class="n">pid</span> <span class="o">=</span> <span class="n">controller</span><span class="o">.</span><span class="n">get_pid</span><span class="p">()</span> <span class="k">print</span><span class="p">(</span><span class="n">HEADER_LINE</span><span class="o">.</span><span class="n">format</span><span class="p">(</span> <span class="n">version</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">controller</span><span class="o">.</span><span class="n">get_version</span><span class="p">())</span><span class="o">.</span><span class="n">split</span><span class="p">()[</span><span class="mi">0</span><span class="p">],</span> <span class="n">uptime</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">short_time_label</span><span class="p">(</span><span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">()</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">system</span><span class="o">.</span><span class="n">start_time</span><span class="p">(</span><span class="n">pid</span><span class="p">)),</span> <span class="n">flags</span> <span class="o">=</span> <span class="s">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">desc</span><span class="o">.</span><span class="n">flags</span> <span class="k">if</span> <span class="n">desc</span> <span class="k">else</span> <span class="p">[</span><span class="s">'none'</span><span class="p">]),</span> <span class="p">))</span> <span class="n">policy</span> <span class="o">=</span> <span class="n">controller</span><span class="o">.</span><span class="n">get_exit_policy</span><span class="p">()</span> <span class="n">relays</span> <span class="o">=</span> <span class="p">{}</span> <span class="c"># address => [orports...]</span> <span class="k">for</span> <span class="n">desc</span> <span class="ow">in</span> <span class="n">controller</span><span class="o">.</span><span class="n">get_network_statuses</span><span class="p">():</span> <span class="n">relays</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">desc</span><span class="o">.</span><span class="n">address</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">desc</span><span class="o">.</span><span class="n">or_port</span><span class="p">)</span> <span class="c"># categorize our connections</span> <span class="n">categories</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">OrderedDict</span><span class="p">((</span> <span class="p">(</span><span class="n">INBOUND_ORPORT</span><span class="p">,</span> <span class="p">[]),</span> <span class="p">(</span><span class="n">INBOUND_DIRPORT</span><span class="p">,</span> <span class="p">[]),</span> <span class="p">(</span><span class="n">INBOUND_CONTROLPORT</span><span class="p">,</span> <span class="p">[]),</span> <span class="p">(</span><span class="n">OUTBOUND_ORPORT</span><span class="p">,</span> <span class="p">[]),</span> <span class="p">(</span><span class="n">OUTBOUND_EXIT</span><span class="p">,</span> <span class="p">[]),</span> <span class="p">(</span><span class="n">OUTBOUND_UNKNOWN</span><span class="p">,</span> <span class="p">[]),</span> <span class="p">))</span> <span class="n">exit_connections</span> <span class="o">=</span> <span class="p">{}</span> <span class="c"># port => [connections]</span> <span class="k">for</span> <span class="n">conn</span> <span class="ow">in</span> <span class="n">get_connections</span><span class="p">(</span><span class="n">resolver</span> <span class="o">=</span> <span class="n">args</span><span class="o">.</span><span class="n">resolver</span><span class="p">,</span> <span class="n">process_pid</span> <span class="o">=</span> <span class="n">pid</span><span class="p">):</span> <span class="k">if</span> <span class="n">conn</span><span class="o">.</span><span class="n">protocol</span> <span class="o">==</span> <span class="s">'udp'</span><span class="p">:</span> <span class="k">continue</span> <span class="k">if</span> <span class="n">conn</span><span class="o">.</span><span class="n">local_port</span> <span class="ow">in</span> <span class="n">controller</span><span class="o">.</span><span class="n">get_ports</span><span class="p">(</span><span class="n">Listener</span><span class="o">.</span><span class="n">OR</span><span class="p">,</span> <span class="p">[]):</span> <span class="n">categories</span><span class="p">[</span><span class="n">INBOUND_ORPORT</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span> <span class="k">elif</span> <span class="n">conn</span><span class="o">.</span><span class="n">local_port</span> <span class="ow">in</span> <span class="n">controller</span><span class="o">.</span><span class="n">get_ports</span><span class="p">(</span><span class="n">Listener</span><span class="o">.</span><span class="n">DIR</span><span class="p">,</span> <span class="p">[]):</span> <span class="n">categories</span><span class="p">[</span><span class="n">INBOUND_DIRPORT</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span> <span class="k">elif</span> <span class="n">conn</span><span class="o">.</span><span class="n">local_port</span> <span class="ow">in</span> <span class="n">controller</span><span class="o">.</span><span class="n">get_ports</span><span class="p">(</span><span class="n">Listener</span><span class="o">.</span><span class="n">CONTROL</span><span class="p">,</span> <span class="p">[]):</span> <span class="n">categories</span><span class="p">[</span><span class="n">INBOUND_CONTROLPORT</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span> <span class="k">elif</span> <span class="n">conn</span><span class="o">.</span><span class="n">remote_port</span> <span class="ow">in</span> <span class="n">relays</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">remote_address</span><span class="p">,</span> <span class="p">[]):</span> <span class="n">categories</span><span class="p">[</span><span class="n">OUTBOUND_ORPORT</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span> <span class="k">elif</span> <span class="n">policy</span><span class="o">.</span><span class="n">can_exit_to</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">remote_address</span><span class="p">,</span> <span class="n">conn</span><span class="o">.</span><span class="n">remote_port</span><span class="p">):</span> <span class="n">categories</span><span class="p">[</span><span class="n">OUTBOUND_EXIT</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span> <span class="n">exit_connections</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">remote_port</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span> <span class="k">else</span><span class="p">:</span> <span class="n">categories</span><span class="p">[</span><span class="n">OUTBOUND_UNKNOWN</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">conn</span><span class="p">)</span> <span class="k">print</span><span class="p">(</span><span class="n">DIV</span><span class="p">)</span> <span class="k">print</span><span class="p">(</span><span class="n">COLUMN</span> <span class="o">%</span> <span class="p">(</span><span class="s">'Type'</span><span class="p">,</span> <span class="s">'IPv4'</span><span class="p">,</span> <span class="s">'IPv6'</span><span class="p">))</span> <span class="k">print</span><span class="p">(</span><span class="n">DIV</span><span class="p">)</span> <span class="n">total_ipv4</span><span class="p">,</span> <span class="n">total_ipv6</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span> <span class="k">for</span> <span class="n">label</span><span class="p">,</span> <span class="n">connections</span> <span class="ow">in</span> <span class="n">categories</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">connections</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> <span class="k">continue</span> <span class="n">ipv4_count</span> <span class="o">=</span> <span class="nb">len</span><span class="p">([</span><span class="n">conn</span> <span class="k">for</span> <span class="n">conn</span> <span class="ow">in</span> <span class="n">connections</span> <span class="k">if</span> <span class="n">is_valid_ipv4_address</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">remote_address</span><span class="p">)])</span> <span class="n">ipv6_count</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">connections</span><span class="p">)</span> <span class="o">-</span> <span class="n">ipv4_count</span> <span class="n">total_ipv4</span><span class="p">,</span> <span class="n">total_ipv6</span> <span class="o">=</span> <span class="n">total_ipv4</span> <span class="o">+</span> <span class="n">ipv4_count</span><span class="p">,</span> <span class="n">total_ipv6</span> <span class="o">+</span> <span class="n">ipv6_count</span> <span class="k">print</span><span class="p">(</span><span class="n">COLUMN</span> <span class="o">%</span> <span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">ipv4_count</span><span class="p">,</span> <span class="n">ipv6_count</span><span class="p">))</span> <span class="k">print</span><span class="p">(</span><span class="n">DIV</span><span class="p">)</span> <span class="k">print</span><span class="p">(</span><span class="n">COLUMN</span> <span class="o">%</span> <span class="p">(</span><span class="s">'Total'</span><span class="p">,</span> <span class="n">total_ipv4</span><span class="p">,</span> <span class="n">total_ipv6</span><span class="p">))</span> <span class="k">print</span><span class="p">(</span><span class="n">DIV</span><span class="p">)</span> <span class="k">print</span><span class="p">(</span><span class="s">''</span><span class="p">)</span> <span class="k">if</span> <span class="n">exit_connections</span><span class="p">:</span> <span class="k">print</span><span class="p">(</span><span class="n">DIV</span><span class="p">)</span> <span class="k">print</span><span class="p">(</span><span class="n">COLUMN</span> <span class="o">%</span> <span class="p">(</span><span class="s">'Exit Port'</span><span class="p">,</span> <span class="s">'IPv4'</span><span class="p">,</span> <span class="s">'IPv6'</span><span class="p">))</span> <span class="k">print</span><span class="p">(</span><span class="n">DIV</span><span class="p">)</span> <span class="n">total_ipv4</span><span class="p">,</span> <span class="n">total_ipv6</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">0</span> <span class="k">for</span> <span class="n">port</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">exit_connections</span><span class="p">):</span> <span class="n">connections</span> <span class="o">=</span> <span class="n">exit_connections</span><span class="p">[</span><span class="n">port</span><span class="p">]</span> <span class="n">ipv4_count</span> <span class="o">=</span> <span class="nb">len</span><span class="p">([</span><span class="n">conn</span> <span class="k">for</span> <span class="n">conn</span> <span class="ow">in</span> <span class="n">connections</span> <span class="k">if</span> <span class="n">is_valid_ipv4_address</span><span class="p">(</span><span class="n">conn</span><span class="o">.</span><span class="n">remote_address</span><span class="p">)])</span> <span class="n">ipv6_count</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">connections</span><span class="p">)</span> <span class="o">-</span> <span class="n">ipv4_count</span> <span class="n">total_ipv4</span><span class="p">,</span> <span class="n">total_ipv6</span> <span class="o">=</span> <span class="n">total_ipv4</span> <span class="o">+</span> <span class="n">ipv4_count</span><span class="p">,</span> <span class="n">total_ipv6</span> <span class="o">+</span> <span class="n">ipv6_count</span> <span class="n">usage</span> <span class="o">=</span> <span class="n">port_usage</span><span class="p">(</span><span class="n">port</span><span class="p">)</span> <span class="n">label</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">port</span><span class="p">,</span> <span class="n">usage</span><span class="p">)</span> <span class="k">if</span> <span class="n">usage</span> <span class="k">else</span> <span class="n">port</span> <span class="k">print</span><span class="p">(</span><span class="n">COLUMN</span> <span class="o">%</span> <span class="p">(</span><span class="n">label</span><span class="p">,</span> <span class="n">ipv4_count</span><span class="p">,</span> <span class="n">ipv6_count</span><span class="p">))</span> <span class="k">print</span><span class="p">(</span><span class="n">DIV</span><span class="p">)</span> <span class="k">print</span><span class="p">(</span><span class="n">COLUMN</span> <span class="o">%</span> <span class="p">(</span><span class="s">'Total'</span><span class="p">,</span> <span class="n">total_ipv4</span><span class="p">,</span> <span class="n">total_ipv6</span><span class="p">))</span> <span class="k">print</span><span class="p">(</span><span class="n">DIV</span><span class="p">)</span> <span class="k">print</span><span class="p">(</span><span class="s">''</span><span class="p">)</span> <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">'__main__'</span><span class="p">:</span> <span class="n">main</span><span class="p">()</span> </pre></div> </div> <div class="highlight-python"><pre>% relay_connections.py --ctrlport 29051 0.3.2.0-alpha-dev uptime: 01:20:44 flags: none +------------------------------+------+------+ | Type | IPv4 | IPv6 | +------------------------------+------+------+ | Inbound to our ORPort | 2400 | 3 | | Inbound to our DirPort | 12 | 0 | | Inbound to our ControlPort | 2 | 0 | | Outbound to a relay | 324 | 0 | | Outbound exit traffic | 3 | 0 | +------------------------------+------+------+ | Total | 2741 | 3 | +------------------------------+------+------+ +------------------------------+------+------+ | Exit Port | IPv4 | IPv6 | +------------------------------+------+------+ | 443 (HTTPS) | 1 | 0 | | 8443 (PCsync HTTPS) | 1 | 0 | | 54682 | 1 | 0 | +------------------------------+------+------+ | Total | 3 | 0 | +------------------------------+------+------+</pre> </div> </div> </div> <div class="bottomnav"> </div> <div class="footer"> </div> </body> </html>