February 2020 - tor-commits - lists.torproject.org

[stem/master] Drop hidden_service_descriptor alias
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit 56b60d504d7d2bbd277aaf247e628574d26730cd Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Jan 31 15:04:54 2020 -0800 Drop hidden_service_descriptor alias Earlier we shortened this module from... stem.descriptor.hidden_service_descriptor ... to... stem.descriptor.hidden_service Dropping the backward compatibility alias. --- stem/descriptor/hidden_service_descriptor.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/stem/descriptor/hidden_service_descriptor.py b/stem/descriptor/hidden_service_descriptor.py deleted file mode 100644 index d77d88aa..00000000 --- a/stem/descriptor/hidden_service_descriptor.py +++ /dev/null @@ -1,4 +0,0 @@ -# TODO: This module (hidden_service_descriptor) is a temporary alias for -# hidden_service. This alias will be removed in Stem 2.x. - -from stem.descriptor.hidden_service import *

1 0

[stem/master] Drop method name aliases
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit f1ff290453a564049ecf69fda2a819e4cc63d0e7 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Jan 31 15:46:18 2020 -0800 Drop method name aliases Removing the backward compatibility alises for renamed methods. --- stem/descriptor/hidden_service.py | 5 ----- stem/descriptor/remote.py | 7 ------- stem/util/connection.py | 7 ------- stem/util/proc.py | 17 ----------------- stem/util/str_tools.py | 14 -------------- stem/util/system.py | 19 ------------------- stem/util/test_tools.py | 10 ---------- 7 files changed, 79 deletions(-) diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py index 7994bffb..6fa43521 100644 --- a/stem/descriptor/hidden_service.py +++ b/stem/descriptor/hidden_service.py @@ -1388,8 +1388,3 @@ def _blinded_sign(msg, identity_key, blinded_key, blinding_nonce): S = (r + ed25519.Hint(ed25519.encodepoint(R) + blinded_key + msg) * a) % ed25519.l return ed25519.encodepoint(R) + ed25519.encodeint(S) - - -# TODO: drop this alias in stem 2.x - -HiddenServiceDescriptor = HiddenServiceDescriptorV2 diff --git a/stem/descriptor/remote.py b/stem/descriptor/remote.py index c7132a38..2632a036 100644 --- a/stem/descriptor/remote.py +++ b/stem/descriptor/remote.py @@ -1156,10 +1156,3 @@ def get_authorities(): """ return DirectoryAuthority.from_cache() - - -# TODO: drop aliases in stem 2.0 - -Directory = stem.directory.Directory -DirectoryAuthority = stem.directory.Authority -FallbackDirectory = stem.directory.Fallback diff --git a/stem/util/connection.py b/stem/util/connection.py index f88b3f85..5480f95a 100644 --- a/stem/util/connection.py +++ b/stem/util/connection.py @@ -783,10 +783,3 @@ def _address_to_binary(address): return ''.join([_get_binary(int(grouping, 16), 16) for grouping in address.split(':')]) else: raise ValueError("'%s' is neither an IPv4 or IPv6 address" % address) - - -# TODO: drop with stem 2.x -# We renamed our methods to drop a redundant 'get_*' prefix, so alias the old -# names for backward compatability. - -get_system_resolvers = system_resolvers diff --git a/stem/util/proc.py b/stem/util/proc.py index ecb7f3f7..0b4c0ab4 100644 --- a/stem/util/proc.py +++ b/stem/util/proc.py @@ -15,10 +15,6 @@ Dave Daeschler, Giampaolo Rodola' and is under the BSD license. **These functions are not being vended to stem users. They may change in the future, use them at your own risk.** -.. versionchanged:: 1.3.0 - Dropped the get_* prefix from several function names. The old names still - work, but are deprecated aliases. - **Module Overview:** :: @@ -579,16 +575,3 @@ def _log_failure(parameter, exc): """ log.debug('proc call failed (%s): %s' % (parameter, exc)) - - -# TODO: drop with stem 2.x -# We renamed our methods to drop a redundant 'get_*' prefix, so alias the old -# names for backward compatability. - -get_system_start_time = system_start_time -get_physical_memory = physical_memory -get_cwd = cwd -get_uid = uid -get_memory_usage = memory_usage -get_stats = stats -get_connections = connections diff --git a/stem/util/str_tools.py b/stem/util/str_tools.py index 6b852f3d..bf582bea 100644 --- a/stem/util/str_tools.py +++ b/stem/util/str_tools.py @@ -4,10 +4,6 @@ """ Toolkit for various string activity. -.. versionchanged:: 1.3.0 - Dropped the get_* prefix from several function names. The old names still - work, but are deprecated aliases. - **Module Overview:** :: @@ -589,13 +585,3 @@ def _get_label(units, count, decimal, is_long, round = False): return count_label + long_label + ('s' if is_plural else '') else: return count_label + short_label - - -# TODO: drop with stem 2.x -# We renamed our methods to drop a redundant 'get_*' prefix, so alias the old -# names for backward compatability. - -get_size_label = size_label -get_time_label = time_label -get_time_labels = time_labels -get_short_time_label = short_time_label diff --git a/stem/util/system.py b/stem/util/system.py index e514c3a4..b9a7ef8d 100644 --- a/stem/util/system.py +++ b/stem/util/system.py @@ -6,10 +6,6 @@ Helper functions for working with the underlying system. These are mostly os dependent, only working on linux, osx, and bsd. In almost all cases they're best-effort, providing **None** if the lookup fails. -.. versionchanged:: 1.3.0 - Dropped the get_* prefix from several function names. The old names still - work, but are deprecated aliases. - .. versionchanged:: 1.5.0 Added the **SYSTEM_CALL_TIME** global, which tracks total time spent making system commands. @@ -1500,18 +1496,3 @@ def _set_proc_title(process_name): # AttributeError: dlsym(0x7fff6a41d1e0, setproctitle): symbol not found pass - - -# TODO: drop with stem 2.x -# We renamed our methods to drop a redundant 'get_*' prefix, so alias the old -# names for backward compatability. - -get_name_by_pid = name_by_pid -get_pid_by_name = pid_by_name -get_pid_by_port = pid_by_port -get_pid_by_open_file = pid_by_open_file -get_cwd = cwd -get_user = user -get_start_time = start_time -get_bsd_jail_id = bsd_jail_id -get_bsd_jail_path = bsd_jail_path diff --git a/stem/util/test_tools.py b/stem/util/test_tools.py index d65b3ea4..117d273e 100644 --- a/stem/util/test_tools.py +++ b/stem/util/test_tools.py @@ -606,13 +606,3 @@ def _python_files(paths): if not skip: yield file_path - - -# TODO: drop with stem 2.x -# We renamed our methods to drop a redundant 'get_*' prefix, so alias the old -# names for backward compatability, and account for pep8 being renamed to -# pycodestyle. - -get_stylistic_issues = stylistic_issues -get_pyflakes_issues = pyflakes_issues -is_pep8_available = is_pycodestyle_available

1 0

[stem/master] Drop sockstat connection resolution
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit f53715ebe6e36327d0bca1c8c9ffe800ffd8c4d5 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 1 15:03:53 2020 -0800 Drop sockstat connection resolution We disabled sockstat tests a while ago due to unreliability... https://github.com/torproject/stem/issues/42 We have plently of better resolvers so simply dropping this one. --- stem/util/connection.py | 15 +-------------- test/integ/util/connection.py | 1 - test/unit/util/connection.py | 34 ++-------------------------------- 3 files changed, 3 insertions(+), 47 deletions(-) diff --git a/stem/util/connection.py b/stem/util/connection.py index 5480f95a..eaeafec4 100644 --- a/stem/util/connection.py +++ b/stem/util/connection.py @@ -36,10 +36,6 @@ Connection and networking based utility functions. .. versionchanged:: 1.6.0 Added **BSD_FSTAT**. - .. deprecated:: 1.6.0 - The SOCKSTAT connection resolver is proving to be unreliable - (:trac:`23057`), and will be dropped in the 2.0.0 release unless fixed. - ==================== =========== Resolver Description ==================== =========== @@ -48,7 +44,6 @@ Connection and networking based utility functions. **NETSTAT_WINDOWS** netstat command under Windows **SS** ss command **LSOF** lsof command - **SOCKSTAT** sockstat command under \\*nix **BSD_SOCKSTAT** sockstat command under FreeBSD **BSD_PROCSTAT** procstat command under FreeBSD **BSD_FSTAT** fstat command under OpenBSD @@ -84,7 +79,6 @@ Resolver = enum.Enum( ('NETSTAT_WINDOWS', 'netstat (windows)'), ('SS', 'ss'), ('LSOF', 'lsof'), - ('SOCKSTAT', 'sockstat'), ('BSD_SOCKSTAT', 'sockstat (bsd)'), ('BSD_PROCSTAT', 'procstat (bsd)'), ('BSD_FSTAT', 'fstat (bsd)') @@ -111,8 +105,6 @@ RESOLVER_COMMAND = { # (lsof provides a '-p <pid>' but oddly in practice it seems to be ~11-28% slower) Resolver.LSOF: 'lsof -wnPi', - Resolver.SOCKSTAT: 'sockstat', - # -4 = IPv4, -c = connected sockets Resolver.BSD_SOCKSTAT: 'sockstat -4c', @@ -138,9 +130,6 @@ RESOLVER_FILTER = { # tor 3873 atagar 45u IPv4 40994 0t0 TCP 10.243.55.20:45724->194.154.227.109:9001 (ESTABLISHED) Resolver.LSOF: '^{name}\\s+{pid}\\s+.*\\s+{protocol}\\s+{local}->{remote} \$ESTABLISHED\$$', - # atagar tor 15843 tcp4 192.168.0.20:44092 68.169.35.102:443 ESTABLISHED - Resolver.SOCKSTAT: '^\\S+\\s+{name}\\s+{pid}\\s+{protocol}4\\s+{local}\\s+{remote}\\s+ESTABLISHED$', - # _tor tor 4397 12 tcp4 172.27.72.202:54011 127.0.0.1:9001 Resolver.BSD_SOCKSTAT: '^\\S+\\s+{name}\\s+{pid}\\s+\\S+\\s+{protocol}4\\s+{local}\\s+{remote}$', @@ -380,9 +369,7 @@ def system_resolvers(system = None): resolvers = [Resolver.BSD_SOCKSTAT, Resolver.BSD_PROCSTAT, Resolver.LSOF] else: - # Sockstat isn't available by default on ubuntu. - - resolvers = [Resolver.NETSTAT, Resolver.SOCKSTAT, Resolver.LSOF, Resolver.SS] + resolvers = [Resolver.NETSTAT, Resolver.LSOF, Resolver.SS] # remove any that aren't in the user's PATH diff --git a/test/integ/util/connection.py b/test/integ/util/connection.py index 861b8ba9..f1745ec0 100644 --- a/test/integ/util/connection.py +++ b/test/integ/util/connection.py @@ -92,7 +92,6 @@ class TestConnection(unittest.TestCase): Resolver.NETSTAT_WINDOWS, Resolver.SS, Resolver.LSOF, - Resolver.SOCKSTAT, Resolver.BSD_SOCKSTAT, Resolver.BSD_PROCSTAT, Resolver.BSD_FSTAT, diff --git a/test/unit/util/connection.py b/test/unit/util/connection.py index d848c40b..6f8d8ab8 100644 --- a/test/unit/util/connection.py +++ b/test/unit/util/connection.py @@ -108,17 +108,6 @@ tor 129 atagar 22u IPv4 0xffffff35c9125500 0t0 TCP 192.168.1.20:9 tor 129 atagar 23u IPv4 0xffffff3236168160 0t0 TCP 192.168.1.20:9090->62.135.16.134:14456 (ESTABLISHED) """ -SOCKSTAT_OUTPUT = """\ -USER PROCESS PID PROTO SOURCE ADDRESS FOREIGN ADDRESS STATE -atagar ubuntu-geoip-pr 2164 tcp4 192.168.0.1:55395 141.18.34.33:80 CLOSE_WAIT -atagar tor 15843 tcp4 127.0.0.1:9050 *:* LISTEN -atagar tor 15843 tcp4 127.0.0.1:9051 *:* LISTEN -atagar tor 15843 tcp4 192.168.0.1:44415 38.229.79.2:443 ESTABLISHED -atagar tor 15843 tcp4 192.168.0.1:44092 68.169.35.102:443 ESTABLISHED -atagar firefox 20586 tcp4 192.168.0.1:47486 213.24.100.160:443 ESTABLISHED -atagar firefox 20586 tcp4 192.168.0.1:43762 32.188.221.72:443 CLOSE_WAIT -""" - # I don't have actual sockstat and procstat output for FreeBSD. Rather, these # are snippets of output from email threads. @@ -216,10 +205,10 @@ class TestConnection(unittest.TestCase): self.assertEqual([Resolver.LSOF], stem.util.connection.system_resolvers('Darwin')) self.assertEqual([Resolver.BSD_FSTAT], stem.util.connection.system_resolvers('OpenBSD')) self.assertEqual([Resolver.BSD_SOCKSTAT, Resolver.BSD_PROCSTAT, Resolver.LSOF], stem.util.connection.system_resolvers('FreeBSD')) - self.assertEqual([Resolver.NETSTAT, Resolver.SOCKSTAT, Resolver.LSOF, Resolver.SS], stem.util.connection.system_resolvers('Linux')) + self.assertEqual([Resolver.NETSTAT, Resolver.LSOF, Resolver.SS], stem.util.connection.system_resolvers('Linux')) proc_mock.return_value = True - self.assertEqual([Resolver.PROC, Resolver.NETSTAT, Resolver.SOCKSTAT, Resolver.LSOF, Resolver.SS], stem.util.connection.system_resolvers('Linux')) + self.assertEqual([Resolver.PROC, Resolver.NETSTAT, Resolver.LSOF, Resolver.SS], stem.util.connection.system_resolvers('Linux')) # check that calling without an argument is equivalent to calling for this # platform @@ -389,25 +378,6 @@ class TestConnection(unittest.TestCase): self.assertEqual(expected, stem.util.connection.get_connections(Resolver.LSOF, process_pid = 129, process_name = 'tor')) @patch('stem.util.system.call') - def test_get_connections_by_sockstat(self, call_mock): - """ - Checks the get_connections function with the sockstat resolver. - """ - - call_mock.return_value = SOCKSTAT_OUTPUT.split('\n') - expected = [ - Connection('192.168.0.1', 44415, '38.229.79.2', 443, 'tcp', False), - Connection('192.168.0.1', 44092, '68.169.35.102', 443, 'tcp', False), - ] - self.assertEqual(expected, stem.util.connection.get_connections(Resolver.SOCKSTAT, process_pid = 15843, process_name = 'tor')) - - self.assertRaises(IOError, stem.util.connection.get_connections, Resolver.SOCKSTAT, process_pid = 15843, process_name = 'stuff') - self.assertRaises(IOError, stem.util.connection.get_connections, Resolver.SOCKSTAT, process_pid = 1111, process_name = 'tor') - - call_mock.side_effect = OSError('Unable to call sockstat') - self.assertRaises(IOError, stem.util.connection.get_connections, Resolver.SOCKSTAT, process_pid = 1111) - - @patch('stem.util.system.call') def test_get_connections_by_sockstat_for_bsd(self, call_mock): """ Checks the get_connections function with the bsd variant of the sockstat

1 0

[stem/master] Drop ConfChangedEvent's config attribute
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit a4b9ad573f5a4e07b47bf3250682712b6917b0c8 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Feb 2 12:02:52 2020 -0800 Drop ConfChangedEvent's config attribute A simple string-to-string hash could not convey multi-value configuration values so we replaced it. --- stem/response/events.py | 8 -------- test/unit/response/events.py | 11 ----------- 2 files changed, 19 deletions(-) diff --git a/stem/response/events.py b/stem/response/events.py index 3f43cfbd..eb8565a6 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -500,11 +500,6 @@ class ConfChangedEvent(Event): The CONF_CHANGED event was introduced in tor version 0.2.3.3-alpha. - .. deprecated:: 1.7.0 - Deprecated the *config* attribute. Some tor configuration options (like - ExitPolicy) can have multiple values, so a simple 'str => str' mapping - meant that we only provided the last. - .. versionchanged:: 1.7.0 Added the changed and unset attributes. @@ -519,7 +514,6 @@ class ConfChangedEvent(Event): def _parse(self): self.changed = {} self.unset = [] - self.config = {} # TODO: remove in stem 2.0 # Skip first and last line since they're the header and footer. For # instance... @@ -538,8 +532,6 @@ class ConfChangedEvent(Event): key, value = line, None self.unset.append(key) - self.config[key] = value - class DescChangedEvent(Event): """ diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 46503287..8a93d322 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -862,12 +862,6 @@ class TestEvents(unittest.TestCase): self.assertEqual(['ExitPolicy'], event.unset) - self.assertEqual({ - 'ExitNodes': 'caerSidi', - 'MaxCircuitDirtiness': '20', - 'ExitPolicy': None, - }, event.config) - event = _get_event(CONF_CHANGED_EVENT_MULTIPLE) self.assertTrue(isinstance(event, stem.response.events.ConfChangedEvent)) @@ -878,11 +872,6 @@ class TestEvents(unittest.TestCase): self.assertEqual([], event.unset) - self.assertEqual({ - 'ExitPolicy': 'accept 3.4.53.3', # overwrote with second value - 'MaxCircuitDirtiness': '20', - }, event.config) - def test_descchanged_event(self): # all we can check for is that the event is properly parsed as a # DescChangedEvent instance

1 0

[stem/master] Drop deprecated controller methods
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit 2b77697806d916f5d1f51b73213625b0cadcd8ea Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 1 15:32:12 2020 -0800 Drop deprecated controller methods Removing get_socks_listeners and is_geoip_unavailable as both have better counterparts nowadays. --- stem/control.py | 56 +------------------- test/integ/control/controller.py | 9 ---- test/unit/control/controller.py | 110 --------------------------------------- 3 files changed, 2 insertions(+), 173 deletions(-) diff --git a/stem/control.py b/stem/control.py index e48f6bcd..271a67ec 100644 --- a/stem/control.py +++ b/stem/control.py @@ -140,7 +140,6 @@ If you're fine with allowing your script to raise exceptions then this can be mo |- is_newnym_available - true if tor would currently accept a NEWNYM signal |- get_newnym_wait - seconds until tor would accept a NEWNYM signal |- get_effective_rate - provides our effective relaying rate limit - |- is_geoip_unavailable - true if we've discovered our geoip db to be unavailable |- map_address - maps one address to another such that connections to the original are replaced with the other +- drop_guards - drops our set of guard relays and picks a new set @@ -374,6 +373,7 @@ CACHEABLE_GETINFO_PARAMS = ( 'config/names', 'config/defaults', 'info/names', + 'ip-to-country/ipv4-available', 'events/names', 'features/names', 'process/descriptor-limit', @@ -1042,7 +1042,6 @@ class Controller(BaseController): self._event_listeners = {} self._event_listeners_lock = threading.RLock() self._enabled_features = [] - self._is_geoip_unavailable = None self._last_address_exc = None self._last_fingerprint_exc = None @@ -1158,7 +1157,7 @@ class Controller(BaseController): params = set(params) for param in params: - if param.startswith('ip-to-country/') and param != 'ip-to-country/0.0.0.0' and self.is_geoip_unavailable(): + if param.startswith('ip-to-country/') and param != 'ip-to-country/0.0.0.0' and self.get_info('ip-to-country/ipv4-available', '0') != '1': raise stem.ProtocolError('Tor geoip database is unavailable') elif param == 'address' and self._last_address_exc: raise self._last_address_exc # we already know we can't resolve an address @@ -1480,25 +1479,6 @@ class Controller(BaseController): write_limit = used_written + left_written, ) - def get_socks_listeners(self, default = UNDEFINED): - """ - Provides the SOCKS **(address, port)** tuples that tor has open. - - .. deprecated:: 1.2.0 - Use :func:`~stem.control.Controller.get_listeners` with - **Listener.SOCKS** instead. - - :param object default: response if the query fails - - :returns: list of **(address, port)** tuples for the available SOCKS - listeners - - :raises: :class:`stem.ControllerError` if unable to determine the listeners - and no default was provided - """ - - return self.get_listeners(Listener.SOCKS, default) - @with_default() def get_protocolinfo(self, default = UNDEFINED): """ @@ -3329,7 +3309,6 @@ class Controller(BaseController): with self._cache_lock: self._request_cache = {} self._last_newnym = 0.0 - self._is_geoip_unavailable = None def load_conf(self, configtext): """ @@ -3849,37 +3828,6 @@ class Controller(BaseController): return value - def is_geoip_unavailable(self): - """ - Provides **True** if tor's geoip database is unavailable, **False** - otherwise. - - .. versionchanged:: 1.6.0 - No longer requires previously failed GETINFO requests to determine this. - - .. deprecated:: 1.6.0 - This is available as of Tor 0.3.2.1 through the following instead... - - :: - - controller.get_info('ip-to-country/ipv4-available', 0) == '1' - - :returns: **bool** indicating if we've determined tor's geoip database to - be unavailable or not - """ - - if self._is_geoip_unavailable is None: - try: - self.get_info('ip-to-country/0.0.0.0') - self._is_geoip_unavailable = False - except stem.ControllerError as exc: - if 'GeoIP data not loaded' in str(exc): - self._is_geoip_unavailable = True - else: - return False # unexpected issue, fail open and don't cache - - return self._is_geoip_unavailable - def map_address(self, mapping): """ Map addresses to replacement addresses. Tor replaces subseqent connections diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 6903c65b..7113ea67 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -952,15 +952,6 @@ class TestController(unittest.TestCase): self.assertEqual([], controller.get_listeners(Listener.CONTROL)) @test.require.controller - def test_get_socks_listeners(self): - """ - Test Controller.get_socks_listeners against a running tor instance. - """ - - with test.runner.get_runner().get_tor_controller() as controller: - self.assertEqual([('127.0.0.1', 1112)], controller.get_socks_listeners()) - - @test.require.controller @test.require.online @test.require.version(stem.version.Version('0.1.2.2-alpha')) def test_enable_feature(self): diff --git a/test/unit/control/controller.py b/test/unit/control/controller.py index 34429f49..1ba3001a 100644 --- a/test/unit/control/controller.py +++ b/test/unit/control/controller.py @@ -265,116 +265,6 @@ class TestControl(unittest.TestCase): self.assertEqual([], self.controller.get_ports(Listener.CONTROL)) @patch('stem.control.Controller.get_info') - @patch('stem.control.Controller.get_conf') - def test_get_socks_listeners_old(self, get_conf_mock, get_info_mock): - """ - Exercises the get_socks_listeners() method as though talking to an old tor - instance. - """ - - # An old tor raises stem.InvalidArguments for get_info about socks, but - # get_socks_listeners should work anyway. - - get_info_mock.side_effect = InvalidArguments - - get_conf_mock.side_effect = lambda param, **kwargs: { - 'SocksPort': '9050', - 'SocksListenAddress': ['127.0.0.1'], - }[param] - - self.assertEqual([('127.0.0.1', 9050)], self.controller.get_socks_listeners()) - self.controller.clear_cache() - - # Again, an old tor, but SocksListenAddress overrides the port number. - - get_conf_mock.side_effect = lambda param, **kwargs: { - 'SocksPort': '9050', - 'SocksListenAddress': ['127.0.0.1:1112'], - }[param] - - self.assertEqual([('127.0.0.1', 1112)], self.controller.get_socks_listeners()) - self.controller.clear_cache() - - # Again, an old tor, but multiple listeners - - get_conf_mock.side_effect = lambda param, **kwargs: { - 'SocksPort': '9050', - 'SocksListenAddress': ['127.0.0.1:1112', '127.0.0.1:1114'], - }[param] - - self.assertEqual([('127.0.0.1', 1112), ('127.0.0.1', 1114)], self.controller.get_socks_listeners()) - self.controller.clear_cache() - - # Again, an old tor, but no SOCKS listeners - - get_conf_mock.side_effect = lambda param, **kwargs: { - 'SocksPort': '0', - 'SocksListenAddress': [], - }[param] - - self.assertEqual([], self.controller.get_socks_listeners()) - self.controller.clear_cache() - - # Where tor provides invalid ports or addresses - - get_conf_mock.side_effect = lambda param, **kwargs: { - 'SocksPort': 'blarg', - 'SocksListenAddress': ['127.0.0.1'], - }[param] - - self.assertRaises(stem.ProtocolError, self.controller.get_socks_listeners) - - get_conf_mock.side_effect = lambda param, **kwargs: { - 'SocksPort': '0', - 'SocksListenAddress': ['127.0.0.1:abc'], - }[param] - - self.assertRaises(stem.ProtocolError, self.controller.get_socks_listeners) - - get_conf_mock.side_effect = lambda param, **kwargs: { - 'SocksPort': '40', - 'SocksListenAddress': ['500.0.0.1'], - }[param] - - self.assertRaises(stem.ProtocolError, self.controller.get_socks_listeners) - - @patch('stem.control.Controller.get_info') - def test_get_socks_listeners_new(self, get_info_mock): - """ - Exercises the get_socks_listeners() method as if talking to a newer tor - instance. - """ - - # multiple SOCKS listeners - - get_info_mock.return_value = '"127.0.0.1:1112" "127.0.0.1:1114"' - - self.assertEqual( - [('127.0.0.1', 1112), ('127.0.0.1', 1114)], - self.controller.get_socks_listeners() - ) - - # no SOCKS listeners - - self.controller.clear_cache() - get_info_mock.return_value = '' - self.assertEqual([], self.controller.get_socks_listeners()) - - # check where GETINFO provides malformed content - - invalid_responses = ( - '"127.0.0.1"', # address only - '"1112"', # port only - '"5127.0.0.1:1112"', # invlaid address - '"127.0.0.1:991112"', # invalid port - ) - - for response in invalid_responses: - self.controller.clear_cache() - get_info_mock.return_value = response - self.assertRaises(stem.ProtocolError, self.controller.get_socks_listeners) - - @patch('stem.control.Controller.get_info') @patch('time.time', Mock(return_value = 1410723598.276578)) def test_get_accounting_stats(self, get_info_mock): """

1 0

[stem/master] Drop LogBuffer class
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit 76b6b49fd8164d858b3b081e6b6a7aa8cdf315cb Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 1 14:59:33 2020 -0800 Drop LogBuffer class Deprecated class that was only used within our tests. Python 3's logging module has better handlers for us to use. --- stem/util/log.py | 31 ------------------------------- test/unit/response/events.py | 19 +++++++++++-------- test/unit/util/log.py | 13 +++++++++++-- 3 files changed, 22 insertions(+), 41 deletions(-) diff --git a/stem/util/log.py b/stem/util/log.py index 4ef977b1..3093396f 100644 --- a/stem/util/log.py +++ b/stem/util/log.py @@ -218,37 +218,6 @@ def error(message): log(Runlevel.ERROR, message) -class LogBuffer(logging.Handler): - """ - Basic log handler that listens for stem events and stores them so they can be - read later. Log entries are cleared as they are read. - - .. versionchanged:: 1.4.0 - Added the yield_records argument. - - .. deprecated:: 1.8.0 - This will be dropped in Stem 2.x. Use python's logging.BufferingHandler instead. - """ - - def __init__(self, runlevel, yield_records = False): - super(LogBuffer, self).__init__(level = logging_level(runlevel)) - - self.formatter = FORMATTER - self._buffer = [] - self._yield_records = yield_records - - def is_empty(self): - return not bool(self._buffer) - - def __iter__(self): - while self._buffer: - record = self._buffer.pop(0) - yield record if self._yield_records else self.formatter.format(record) - - def emit(self, record): - self._buffer.append(record) - - class _StdoutLogger(logging.Handler): def __init__(self, runlevel): logging.Handler.__init__(self, level = logging_level(runlevel)) diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 27862054..8e2512bd 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -3,6 +3,8 @@ Unit tests for the stem.response.events classes. """ import datetime +import logging.handlers +import queue import threading import unittest @@ -1642,21 +1644,22 @@ class TestEvents(unittest.TestCase): """ stem_logger = stem.util.log.get_logger() - logging_buffer = stem.util.log.LogBuffer(stem.util.log.INFO) - stem_logger.addHandler(logging_buffer) + + messages = queue.Queue() + handler = logging.handlers.QueueHandler(messages) + handler.setLevel(stem.util.log.INFO) + stem_logger.addHandler(handler) # Try parsing a valid event. We shouldn't log anything. _get_event(STATUS_GENERAL_CONSENSUS_ARRIVED) - self.assertTrue(logging_buffer.is_empty()) - self.assertEqual([], list(logging_buffer)) + self.assertTrue(messages.empty()) # Parse an invalid runlevel. _get_event(STATUS_GENERAL_CONSENSUS_ARRIVED.replace('NOTICE', 'OMEGA_CRITICAL!!!')) - logged_events = list(logging_buffer) - self.assertEqual(1, len(logged_events)) - self.assertTrue('STATUS_GENERAL event had an unrecognized runlevel' in logged_events[0]) + self.assertEqual(1, messages.qsize()) + self.assertTrue('STATUS_GENERAL event had an unrecognized runlevel' in str(messages.get_nowait())) - stem_logger.removeHandler(logging_buffer) + stem_logger.removeHandler(handler) diff --git a/test/unit/util/log.py b/test/unit/util/log.py index 615d8d36..7b5f1209 100644 --- a/test/unit/util/log.py +++ b/test/unit/util/log.py @@ -2,6 +2,7 @@ Unit tests for the stem.util.log functions. """ +import logging import unittest from stem.util import log @@ -15,9 +16,17 @@ class TestLog(unittest.TestCase): try: self.assertFalse(log.is_tracing()) - logger.addHandler(log.LogBuffer(log.DEBUG)) + + handler = logging.NullHandler() + handler.setLevel(log.DEBUG) + logger.addHandler(handler) + self.assertFalse(log.is_tracing()) - logger.addHandler(log.LogBuffer(log.TRACE)) + + handler = logging.NullHandler() + handler.setLevel(log.TRACE) + logger.addHandler(handler) + self.assertTrue(log.is_tracing()) finally: logger.handlers = original_handlers

1 0

[stem/master] Drop deprecated socket methods
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit 8a8a9390ee4b3d3f6862bed9bd7c3e23fb1ca65e Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 1 15:15:31 2020 -0800 Drop deprecated socket methods Mostly methods that were replaced with attributes. --- stem/socket.py | 41 ----------------------------------------- 1 file changed, 41 deletions(-) diff --git a/stem/socket.py b/stem/socket.py index 5da02a0c..45a1c53c 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -437,11 +437,6 @@ class ControlSocket(BaseSocket): Formats and sends a message to the control socket. For more information see the :func:`~stem.socket.send_message` function. - .. deprecated:: 1.7.0 - The **raw** argument was unhelpful and be removed. Use - :func:`stem.socket.send_message` if you need this level of control - instead. - :param str message: message to be formatted and sent to the socket :raises: @@ -494,30 +489,6 @@ class ControlPort(ControlSocket): if connect: self.connect() - def get_address(self): - """ - Provides the ip address our socket connects to. - - .. deprecated:: 1.7.0 - Use the **address** attribute instead. - - :returns: str with the ip address of our socket - """ - - return self.address - - def get_port(self): - """ - Provides the port our socket connects to. - - .. deprecated:: 1.7.0 - Use the **port** attribute instead. - - :returns: int with the port of our socket - """ - - return self.port - def is_localhost(self): return self.address == '127.0.0.1' @@ -555,18 +526,6 @@ class ControlSocketFile(ControlSocket): if connect: self.connect() - def get_socket_path(self): - """ - Provides the path our socket connects to. - - .. deprecated:: 1.7.0 - Use the **path** attribute instead. - - :returns: str with the path for our control socket - """ - - return self.path - def is_localhost(self): return True

1 0

[stem/master] Replace NewConsensusEvent's desc attribute with a method
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit 56aab048c9700effabe2e816f4f7e099c7a556ef Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Feb 2 12:22:33 2020 -0800 Replace NewConsensusEvent's desc attribute with a method The consensus is relatively large, so parsing costs time and cpu. Doing this when the parsed content is requested rather than when the event is first received. Nyx disabled eager parsing long ago because otherwise this is a significant periodic performance hit. --- stem/response/events.py | 31 ++++++++++++++----------------- test/unit/response/events.py | 2 +- 2 files changed, 15 insertions(+), 18 deletions(-) diff --git a/stem/response/events.py b/stem/response/events.py index eb8565a6..9b8a5504 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -21,7 +21,6 @@ from stem.util import connection, log, str_tools, tor_tools KW_ARG = re.compile('^(.*) ([A-Za-z0-9_]+)=(\\S*)$') QUOTED_KW_ARG = re.compile('^(.*) ([A-Za-z0-9_]+)="(.*)"$') CELL_TYPE = re.compile('^[a-z0-9_]+$') -PARSE_NEWCONSENSUS_EVENTS = True class Event(stem.response.ControlMessage): @@ -752,17 +751,7 @@ class NewConsensusEvent(Event): .. versionchanged:: 1.6.0 Added the consensus_content attribute. - .. deprecated:: 1.6.0 - In Stem 2.0 we'll remove the desc attribute, so this event only provides - the unparsed consensus. Callers can then parse it if they'd like. To drop - parsing before then you can set... - - :: - - stem.response.events.PARSE_NEWCONSENSUS_EVENTS = False - :var str consensus_content: consensus content - :var list desc: :class:`~stem.descriptor.router_status_entry.RouterStatusEntryV3` for the changed descriptors """ _SKIP_PARSING = True @@ -770,18 +759,26 @@ class NewConsensusEvent(Event): def _parse(self): self.consensus_content = str(self).lstrip('NEWCONSENSUS\n').rstrip('\nOK') + self._parsed = None - # TODO: For stem 2.0.0 consider changing 'desc' to 'descriptors' to match - # our other events. + def entries(self): + """ + Relay router status entries residing within this consensus. - if PARSE_NEWCONSENSUS_EVENTS: - self.desc = list(stem.descriptor.router_status_entry._parse_file( + .. versionadded:: 2.0.0 + + :returns: **list** of :class:`~stem.descriptor.router_status_entry.RouterStatusEntryV3` + """ + + + if self._parsed is None: + self._parsed = list(stem.descriptor.router_status_entry._parse_file( io.BytesIO(str_tools._to_bytes(self.consensus_content)), False, entry_class = stem.descriptor.router_status_entry.RouterStatusEntryV3, )) - else: - self.desc = None + + return self._parsed class NewDescEvent(Event): diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 8a93d322..ca8b3909 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -1025,7 +1025,7 @@ class TestEvents(unittest.TestCase): event = _get_event(NEWCONSENSUS_EVENT) self.assertTrue(isinstance(event, stem.response.events.NewConsensusEvent)) - self.assertEqual(expected_desc, event.desc) + self.assertEqual(expected_desc, event.entries()) def test_ns_event(self): expected_desc = RouterStatusEntryV3.create({

1 0

[stem/master] Drop get_authorities
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit 00cefce1c51c5f03e9f41a9881147f78dd7f72f3 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Feb 2 16:14:20 2020 -0800 Drop get_authorities Redundant with the DirectoryAuthority's from_cache() function. --- stem/descriptor/remote.py | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/stem/descriptor/remote.py b/stem/descriptor/remote.py index 2632a036..e059a504 100644 --- a/stem/descriptor/remote.py +++ b/stem/descriptor/remote.py @@ -1141,18 +1141,3 @@ def _guess_descriptor_type(resource): return 'bandwidth-file 1.0' raise ValueError("Unable to determine the descriptor type for '%s'" % resource) - - -def get_authorities(): - """ - Provides cached Tor directory authority information. The directory - information hardcoded into Tor and occasionally changes, so the information - this provides might not necessarily match your version of tor. - - .. deprecated:: 1.7.0 - Use stem.directory.Authority.from_cache() instead. - - :returns: **dict** of **str** nicknames to :class:`~stem.directory.Authority` instances - """ - - return DirectoryAuthority.from_cache()

1 0

[stem/master] Drop AUTHDIR_NEWDESCS events
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit 7e3e814e99846d4554412bb32b5d8c06fdf1b8ed Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 1 15:21:56 2020 -0800 Drop AUTHDIR_NEWDESCS events Tor removed this event type. Now we can drop it on our end too. --- stem/control.py | 7 ------- stem/response/events.py | 37 ------------------------------------- test/unit/response/events.py | 15 --------------- 3 files changed, 59 deletions(-) diff --git a/stem/control.py b/stem/control.py index 5501d1c8..e48f6bcd 100644 --- a/stem/control.py +++ b/stem/control.py @@ -182,16 +182,10 @@ If you're fine with allowing your script to raise exceptions then this can be mo Enums are mapped to :class:`~stem.response.events.Event` subclasses as follows... - .. deprecated:: 1.6.0 - - Tor dropped EventType.AUTHDIR_NEWDESCS as of version 0.3.2.1. - (:spec:`6e887ba`) - ======================= =========== EventType Event Class ======================= =========== **ADDRMAP** :class:`stem.response.events.AddrMapEvent` - **AUTHDIR_NEWDESCS** :class:`stem.response.events.AuthDirNewDescEvent` **BUILDTIMEOUT_SET** :class:`stem.response.events.BuildTimeoutSetEvent` **BW** :class:`stem.response.events.BandwidthEvent` **CELL_STATS** :class:`stem.response.events.CellStatsEvent` @@ -291,7 +285,6 @@ State = stem.util.enum.Enum('INIT', 'RESET', 'CLOSED') EventType = stem.util.enum.UppercaseEnum( 'ADDRMAP', - 'AUTHDIR_NEWDESCS', 'BUILDTIMEOUT_SET', 'BW', 'CELL_STATS', diff --git a/stem/response/events.py b/stem/response/events.py index 9b6d8393..3f43cfbd 100644 --- a/stem/response/events.py +++ b/stem/response/events.py @@ -223,42 +223,6 @@ class AddrMapEvent(Event): raise stem.ProtocolError("An ADDRMAP event's CACHED mapping can only be 'YES' or 'NO': %s" % self) -class AuthDirNewDescEvent(Event): - """ - Event specific to directory authorities, indicating that we just received new - descriptors. The descriptor type contained within this event is unspecified - so the descriptor contents are left unparsed. - - The AUTHDIR_NEWDESCS event was introduced in tor version 0.1.1.10-alpha and - removed in 0.3.2.1-alpha. (:spec:`6e887ba`) - - .. deprecated:: 1.6.0 - Tor dropped this event as of version 0.3.2.1. (:spec:`6e887ba`) - - :var stem.AuthDescriptorAction action: what is being done with the descriptor - :var str message: explanation of why we chose this action - :var str descriptor: content of the descriptor - """ - - _SKIP_PARSING = True - _VERSION_ADDED = stem.version.Requirement.EVENT_AUTHDIR_NEWDESCS - - def _parse(self): - lines = str(self).split('\n') - - if len(lines) < 5: - raise stem.ProtocolError("AUTHDIR_NEWDESCS events must contain lines for at least the type, action, message, descriptor, and terminating 'OK'") - elif lines[-1] != 'OK': - raise stem.ProtocolError("AUTHDIR_NEWDESCS doesn't end with an 'OK'") - - # TODO: For stem 2.0.0 we should consider changing 'descriptor' to a - # ServerDescriptor instance. - - self.action = lines[1] - self.message = lines[2] - self.descriptor = '\n'.join(lines[3:-1]) - - class BandwidthEvent(Event): """ Event emitted every second with the bytes sent and received by tor. @@ -1386,7 +1350,6 @@ def _parse_cell_type_mapping(mapping): EVENT_TYPE_TO_CLASS = { 'ADDRMAP': AddrMapEvent, - 'AUTHDIR_NEWDESCS': AuthDirNewDescEvent, 'BUILDTIMEOUT_SET': BuildTimeoutSetEvent, 'BW': BandwidthEvent, 'CELL_STATS': CellStatsEvent, diff --git a/test/unit/response/events.py b/test/unit/response/events.py index 8e2512bd..46503287 100644 --- a/test/unit/response/events.py +++ b/test/unit/response/events.py @@ -640,21 +640,6 @@ class TestEvents(unittest.TestCase): # the CACHED argument should only allow YES or NO self.assertRaises(ProtocolError, _get_event, ADDRMAP_CACHED_MALFORMED) - def test_authdir_newdesc_event(self): - minimal_event = _get_event('650+AUTHDIR_NEWDESCS\nAction\nMessage\nDescriptor\n.\n650 OK\n') - - self.assertTrue(isinstance(minimal_event, stem.response.events.AuthDirNewDescEvent)) - self.assertEqual('Action', minimal_event.action) - self.assertEqual('Message', minimal_event.message) - self.assertEqual('Descriptor', minimal_event.descriptor) - - event = _get_event(AUTHDIR_NEWDESC) - - self.assertTrue(isinstance(event, stem.response.events.AuthDirNewDescEvent)) - self.assertEqual('DROPPED', event.action) - self.assertEqual('Not replacing router descriptor; no information has changed since the last one with this identity.', event.message) - self.assertTrue('Descripto', event.descriptor.startswith('@uploaded-at 2017-05-25 04:46:21')) - def test_build_timeout_set_event(self): event = _get_event(BUILD_TIMEOUT_EVENT)

1 0