[tor-commits] [stem/master] lsof support for ipv6 addresses

[atagar at torproject.org]

commit b0ad83ab827c8e6cf4d2f333a58b4fe1b457eead
Author: Damian Johnson <atagar at torproject.org>
Date:   Sat Jan 23 15:47:57 2016 -0800

    lsof support for ipv6 addresses
    
    Needed to recognize brackets but that's about it. Added thanks to toralf on...
    
      https://trac.torproject.org/projects/tor/ticket/18079#comment:3
---
 stem/util/connection.py      |    8 ++++----
 test/unit/util/connection.py |   33 ++++++++++++++++++++++++---------
 2 files changed, 28 insertions(+), 13 deletions(-)

diff --git a/stem/util/connection.py b/stem/util/connection.py
index 37839cb..09a1fff 100644
--- a/stem/util/connection.py
+++ b/stem/util/connection.py
@@ -203,8 +203,8 @@ def get_connections(resolver, process_pid = None, process_name = None):
 
   resolver_regex_str = RESOLVER_FILTER[resolver].format(
     protocol = '(?P<protocol>\S+)',
-    local = '(?P<local>[0-9a-f.:]+)',
-    remote = '(?P<remote>[0-9a-f.:]+)',
+    local = '(?P<local>[\[\]0-9a-f.:]+)',
+    remote = '(?P<remote>[\[\]0-9a-f.:]+)',
     pid = process_pid if process_pid else '[0-9]*',
     name = process_name if process_name else '\S*',
   )
@@ -218,7 +218,7 @@ def get_connections(resolver, process_pid = None, process_name = None):
   def _parse_address_str(addr_type, addr_str, line):
     addr, port = addr_str.rsplit(':', 1)
 
-    if not is_valid_ipv4_address(addr) and not is_valid_ipv6_address(addr):
+    if not is_valid_ipv4_address(addr) and not is_valid_ipv6_address(addr, allow_brackets = True):
       _log('Invalid %s address (%s): %s' % (addr_type, addr, line))
       return None, None
     elif not is_valid_port(port):
@@ -226,7 +226,7 @@ def get_connections(resolver, process_pid = None, process_name = None):
       return None, None
     else:
       _log('Valid %s:%s: %s' % (addr, port, line))
-      return addr, int(port)
+      return addr.lstrip('[').rstrip(']'), int(port)
 
   for line in results:
     match = resolver_regex.match(line)
diff --git a/test/unit/util/connection.py b/test/unit/util/connection.py
index 793bcc6..3442326 100644
--- a/test/unit/util/connection.py
+++ b/test/unit/util/connection.py
@@ -11,9 +11,9 @@ from stem.util.connection import Resolver, Connection
 
 try:
   # added in python 3.3
-  from unittest.mock import patch
+  from unittest.mock import Mock, patch
 except ImportError:
-  from mock import patch
+  from mock import Mock, patch
 
 NETSTAT_OUTPUT = """\
 Active Internet connections (w/o servers)
@@ -75,6 +75,15 @@ firefox   20586 atagar   66u  IPv4  5765353      0t0  TCP 192.168.0.1:47486->62.
 firefox   20586 atagar   71u  IPv4 13094989      0t0  TCP 192.168.0.1:43762->182.3.10.42:443 (CLOSE_WAIT)
 """
 
+LSOF_IPV6_OUTPUT = """\
+COMMAND  PID     USER   FD   TYPE   DEVICE SIZE/OFF NODE NAME
+ntpd    1818     root   20u  IPv6      530      0t0  UDP [::1]:123
+ntpd    1818     root   21u  IPv6      532      0t0  UDP [2a01:4f8:190:514a::2]:123
+ntpd    1818     root   22u  IPv6      534      0t0  UDP [fe80::3285:a9ff:feed:1cb]:123
+tor     1904      tor   10u  IPv6     4372      0t0  TCP [2a01:4f8:190:514a::2]:443 (LISTEN)
+tor     1904      tor 3228u  IPv6 10303350      0t0  TCP [2a01:4f8:190:514a::2]:443->[2001:858:2:2:aabb:0:563b:1526]:44811 (ESTABLISHED)
+"""
+
 LSOF_OUTPUT_OSX = """\
 tor       129 atagar    4u  IPv4 0xffffff3527af0500      0t0  TCP 127.0.0.1:9051 (LISTEN)
 tor       129 atagar    5u  IPv4 0xffffff363af9de40      0t0  TCP 192.168.1.10:9090 (LISTEN)
@@ -240,8 +249,8 @@ class TestConnection(unittest.TestCase):
     call_mock.side_effect = OSError('Unable to call ss')
     self.assertRaises(IOError, stem.util.connection.get_connections, Resolver.SS, process_pid = 1111)
 
-  @patch('stem.util.system.call')
-  def test_get_connections_by_ss_ipv6(self, call_mock):
+  @patch('stem.util.system.call', Mock(return_value = SS_IPV6_OUTPUT.split('\n')))
+  def test_get_connections_by_ss_ipv6(self):
     """
     Checks the get_connections function with the ss resolver results on IPv6
     conections. This also checks with the output from a hardened Gentoo system
@@ -250,7 +259,6 @@ class TestConnection(unittest.TestCase):
       https://trac.torproject.org/projects/tor/ticket/18079
     """
 
-    call_mock.return_value = SS_IPV6_OUTPUT.split('\n')
     expected = [
       Connection('5.9.158.75', 443, '107.170.93.13', 56159, 'tcp'),
       Connection('5.9.158.75', 443, '159.203.97.91', 37802, 'tcp'),
@@ -279,15 +287,22 @@ class TestConnection(unittest.TestCase):
     call_mock.side_effect = OSError('Unable to call lsof')
     self.assertRaises(IOError, stem.util.connection.get_connections, Resolver.LSOF, process_pid = 1111)
 
-  @patch('stem.util.system.call')
-  def test_get_connections_by_lsof_osx(self, call_mock):
+  @patch('stem.util.system.call', Mock(return_value = LSOF_IPV6_OUTPUT.split('\n')))
+  def test_get_connections_by_lsof_ipv6(self):
+    """
+    Checks the get_connections function with the lsof resolver for IPv6.
+    """
+
+    expected = [Connection('2a01:4f8:190:514a::2', 443, '2001:858:2:2:aabb:0:563b:1526', 44811, 'tcp')]
+    self.assertEqual(expected, stem.util.connection.get_connections(Resolver.LSOF, process_pid = 1904, process_name = 'tor'))
+
+  @patch('stem.util.system.call', Mock(return_value = LSOF_OUTPUT_OSX.split('\n')))
+  def test_get_connections_by_lsof_osx(self):
     """
     Checks the get_connections function with the lsof resolver on OSX. This
     only includes entries for the tor process.
     """
 
-    call_mock.return_value = LSOF_OUTPUT_OSX.split('\n')
-
     expected = [
       Connection('192.168.1.20', 9090, '38.229.79.2', 14010, 'tcp'),
       Connection('192.168.1.20', 9090, '68.169.35.102', 14815, 'tcp'),