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

[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

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

10 Feb '20

commit b8df452abf8edc85e45f0fca86901c6a34cee298 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 1 15:35:02 2020 -0800 Drop is_bandwidth_authority dirauth attribute This attribute was a moving target that frequenly got out of date so we deprecated it a while ago. --- stem/directory.py | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/stem/directory.py b/stem/directory.py index 7a1ce7b8..67079c80 100644 --- a/stem/directory.py +++ b/stem/directory.py @@ -225,20 +225,13 @@ class Authority(Directory): <https://gitweb.torproject.org/tor.git/plain/src/or/auth_dirs.inc>`_ to enumerate the relays in the network. - .. versionchanged:: 1.3.0 - Added the is_bandwidth_authority attribute. - .. versionchanged:: 1.7.0 Added the orport_v6 attribute. - .. deprecated:: 1.7.0 - The is_bandwidth_authority attribute is deprecated and will be removed in - the future. - :var str v3ident: identity key fingerprint used to sign votes and consensus """ - def __init__(self, address = None, or_port = None, dir_port = None, fingerprint = None, nickname = None, orport_v6 = None, v3ident = None, is_bandwidth_authority = False): + def __init__(self, address = None, or_port = None, dir_port = None, fingerprint = None, nickname = None, orport_v6 = None, v3ident = None): super(Authority, self).__init__(address, or_port, dir_port, fingerprint, nickname, orport_v6) if v3ident and not tor_tools.is_valid_fingerprint(v3ident): @@ -246,7 +239,6 @@ class Authority(Directory): raise ValueError('%s has an invalid v3ident: %s' % (identifier, v3ident)) self.v3ident = v3ident - self.is_bandwidth_authority = is_bandwidth_authority @staticmethod def from_cache(): @@ -308,7 +300,7 @@ class Authority(Directory): return section_lines def __hash__(self): - return stem.util._hash_attr(self, 'v3ident', 'is_bandwidth_authority', parent = Directory, cache = True) + return stem.util._hash_attr(self, 'v3ident', parent = Directory, cache = True) def __eq__(self, other): return hash(self) == hash(other) if isinstance(other, Authority) else False

1 0

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

10 Feb '20

commit 090e6f2da4c6583ce71e6e341b9ae28f01e75819 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Feb 2 16:09:39 2020 -0800 Drop connect_port and connect_socket_file Removing a couple very old methods that are redundant with connect. --- stem/connection.py | 59 ---------------------------------------- test/integ/connection/connect.py | 48 ++------------------------------ 2 files changed, 2 insertions(+), 105 deletions(-) diff --git a/stem/connection.py b/stem/connection.py index 140cff2e..e3032784 100644 --- a/stem/connection.py +++ b/stem/connection.py @@ -295,65 +295,6 @@ def connect(control_port = ('127.0.0.1', 'default'), control_socket = '/var/run/ return _connect_auth(control_connection, password, password_prompt, chroot_path, controller) -def connect_port(address = '127.0.0.1', port = 9051, password = None, chroot_path = None, controller = stem.control.Controller): - """ - Convenience function for quickly getting a control connection. This is very - handy for debugging or CLI setup, handling setup and prompting for a password - if necessary (and none is provided). If any issues arise this prints a - description of the problem and returns **None**. - - .. deprecated:: 1.2.0 - Use :func:`~stem.connection.connect` instead. - - :param str address: ip address of the controller - :param int port: port number of the controller - :param str password: passphrase to authenticate to the socket - :param str chroot_path: path prefix if in a chroot environment - :param Class controller: :class:`~stem.control.BaseController` subclass to be - returned, this provides a :class:`~stem.socket.ControlSocket` if **None** - - :returns: authenticated control connection, the type based on the controller argument - """ - - try: - control_port = stem.socket.ControlPort(address, port) - except stem.SocketError as exc: - print(exc) - return None - - return _connect_auth(control_port, password, True, chroot_path, controller) - - -def connect_socket_file(path = '/var/run/tor/control', password = None, chroot_path = None, controller = stem.control.Controller): - """ - Convenience function for quickly getting a control connection. For more - information see the :func:`~stem.connection.connect_port` function. - - In much the same vein as git porcelain commands, users should not rely on - details of how this works. Messages or details of this function's behavior - might change in the future. - - .. deprecated:: 1.2.0 - Use :func:`~stem.connection.connect` instead. - - :param str path: path where the control socket is located - :param str password: passphrase to authenticate to the socket - :param str chroot_path: path prefix if in a chroot environment - :param Class controller: :class:`~stem.control.BaseController` subclass to be - returned, this provides a :class:`~stem.socket.ControlSocket` if **None** - - :returns: authenticated control connection, the type based on the controller argument - """ - - try: - control_socket = stem.socket.ControlSocketFile(path) - except stem.SocketError as exc: - print(exc) - return None - - return _connect_auth(control_socket, password, True, chroot_path, controller) - - def _connect_auth(control_socket, password, password_prompt, chroot_path, controller): """ Helper for the connect_* functions that authenticates the socket and diff --git a/test/integ/connection/connect.py b/test/integ/connection/connect.py index 84b4a8fc..a271843f 100644 --- a/test/integ/connection/connect.py +++ b/test/integ/connection/connect.py @@ -34,50 +34,6 @@ class TestConnect(unittest.TestCase): @test.require.controller @patch('sys.stdout', new_callable = io.StringIO) - def test_connect_port(self, stdout_mock): - """ - Basic sanity checks for the connect_port function. - """ - - runner = test.runner.get_runner() - - control_socket = stem.connection.connect_port( - port = test.runner.CONTROL_PORT, - password = test.runner.CONTROL_PASSWORD, - chroot_path = runner.get_chroot(), - controller = None) - - if test.runner.Torrc.PORT in runner.get_options(): - test.runner.exercise_controller(self, control_socket) - control_socket.close() - self.assertEqual('', stdout_mock.getvalue()) - else: - self.assertEqual(control_socket, None) - - @test.require.controller - @patch('sys.stdout', new_callable = io.StringIO) - def test_connect_socket_file(self, stdout_mock): - """ - Basic sanity checks for the connect_socket_file function. - """ - - runner = test.runner.get_runner() - - control_socket = stem.connection.connect_socket_file( - path = test.runner.CONTROL_SOCKET_PATH, - password = test.runner.CONTROL_PASSWORD, - chroot_path = runner.get_chroot(), - controller = None) - - if test.runner.Torrc.SOCKET in runner.get_options(): - test.runner.exercise_controller(self, control_socket) - control_socket.close() - self.assertEqual('', stdout_mock.getvalue()) - else: - self.assertEqual(control_socket, None) - - @test.require.controller - @patch('sys.stdout', new_callable = io.StringIO) def test_connect_to_socks_port(self, stdout_mock): """ Common user gotcha is connecting to the SocksPort or ORPort rather than the @@ -87,8 +43,8 @@ class TestConnect(unittest.TestCase): runner = test.runner.get_runner() - control_socket = stem.connection.connect_port( - port = test.runner.SOCKS_PORT, + control_socket = stem.connection.connect( + control_port = ('127.0.0.1', test.runner.SOCKS_PORT), chroot_path = runner.get_chroot(), controller = None)

1 0

[stem/master] Require online target for server descriptor integ test
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit e700b3873be211814c01f8fadc86b76e5912c876 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 8 13:12:17 2020 -0800 Require online target for server descriptor integ test Odd, we have both a test_get_server_descriptor and test_get_server_descriptors (plural) integration test but only the later required the online target. Here at a coffee shop I got the following so adding this requirement to the other as well. ====================================================================== ERROR: test_get_server_descriptor ---------------------------------------------------------------------- Traceback (most recent call last): File "/home/atagar/Desktop/stem/test/require.py", line 58, in wrapped return func(self, *args, **kwargs) File "/home/atagar/Desktop/stem/test/integ/control/controller.py", line 1301, in test_get_server_descriptor test_relay = self._get_router_status_entry(controller) File "/home/atagar/Desktop/stem/test/integ/control/controller.py", line 1489, in _get_router_status_entry for desc in controller.get_network_statuses(): File "/home/atagar/Desktop/stem/stem/control.py", line 482, in wrapped for val in func(self, *args, **kwargs): File "/home/atagar/Desktop/stem/stem/control.py", line 1979, in get_network_statuses raise stem.DescriptorUnavailable('Descriptor information is unavailable, tor might still be downloading it') stem.DescriptorUnavailable: Descriptor information is unavailable, tor might still be downloading it --- test/integ/control/controller.py | 1 + 1 file changed, 1 insertion(+) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 239e0bd7..b6bf9c9a 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -1281,6 +1281,7 @@ class TestController(unittest.TestCase): break @test.require.controller + @test.require.online def test_get_server_descriptor(self): """ Basic checks for get_server_descriptor().

1 0

[stem/master] Drop server descriptor ed25519_certificate attribute
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit 1341bf84d05cea07ae59e995a2cb52a23e58d773 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Feb 6 15:22:28 2020 -0800 Drop server descriptor ed25519_certificate attribute We deprecated this attribute in favor of their parsed 'certificate'. Anyone using 'my_descriptor.ed25519_certificate' can replace it with 'my_descriptor.certificate.encoded' to do the same. --- stem/descriptor/certificate.py | 5 ++++- stem/descriptor/server_descriptor.py | 23 ++++------------------- test/unit/descriptor/server_descriptor.py | 3 --- 3 files changed, 8 insertions(+), 23 deletions(-) diff --git a/stem/descriptor/certificate.py b/stem/descriptor/certificate.py index c391d466..950fcf6b 100644 --- a/stem/descriptor/certificate.py +++ b/stem/descriptor/certificate.py @@ -59,7 +59,6 @@ import hashlib import re import stem.descriptor.hidden_service -import stem.descriptor.server_descriptor import stem.prereq import stem.util import stem.util.enum @@ -377,6 +376,8 @@ class Ed25519CertificateV1(Ed25519Certificate): * **ImportError** if cryptography module or ed25519 support unavailable """ + import stem.descriptor.server_descriptor + if not stem.prereq.is_crypto_available(ed25519 = True): raise ImportError('Certificate validation requires the cryptography module and ed25519 support') @@ -407,6 +408,8 @@ class Ed25519CertificateV1(Ed25519Certificate): the descriptor that's signed. """ + import stem.descriptor.server_descriptor + if isinstance(descriptor, stem.descriptor.server_descriptor.RelayDescriptor): prefix = SIG_PREFIX_SERVER_DESC regex = b'(.+router-sig-ed25519 )' diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index 5236c4db..4a54e42f 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -51,7 +51,6 @@ import functools import hashlib import re -import stem.descriptor.certificate import stem.descriptor.extrainfo_descriptor import stem.exit_policy import stem.prereq @@ -61,6 +60,7 @@ import stem.util.str_tools import stem.util.tor_tools import stem.version +from stem.descriptor.certificate import Ed25519Certificate from stem.descriptor.router_status_entry import RouterStatusEntryV3 from stem.descriptor import ( @@ -394,15 +394,7 @@ def _parse_exit_policy(descriptor, entries): del descriptor._unparsed_exit_policy -def _parse_identity_ed25519_line(descriptor, entries): - # TODO: replace this with Ed25519Certificate._from_descriptor() in stem 2.x - - _parse_key_block('identity-ed25519', 'ed25519_certificate', 'ED25519 CERT')(descriptor, entries) - - if descriptor.ed25519_certificate: - descriptor.certificate = stem.descriptor.certificate.Ed25519Certificate.from_base64(descriptor.ed25519_certificate) - - +_parse_identity_ed25519_line = Ed25519Certificate._from_descriptor('identity-ed25519', 'certificate') _parse_master_key_ed25519_line = _parse_simple_line('master-key-ed25519', 'ed25519_master_key') _parse_master_key_ed25519_for_hash_line = _parse_simple_line('master-key-ed25519', 'ed25519_certificate_hash') _parse_contact_line = _parse_bytes_line('contact', 'contact') @@ -717,7 +709,6 @@ class RelayDescriptor(ServerDescriptor): <https://gitweb.torproject.org/torspec.git/tree/dir-spec.txt>`_) :var stem.certificate.Ed25519Certificate certificate: ed25519 certificate - :var str ed25519_certificate: base64 encoded ed25519 certificate :var str ed25519_master_key: base64 encoded master key for our ed25519 certificate :var str ed25519_signature: signature of this document using ed25519 @@ -731,7 +722,7 @@ class RelayDescriptor(ServerDescriptor): **\\*** attribute is required when we're parsed with validation .. versionchanged:: 1.5.0 - Added the ed25519_certificate, ed25519_master_key, ed25519_signature, + Added the ed25519_master_key, ed25519_signature, onion_key_crosscert, ntor_onion_key_crosscert, and ntor_onion_key_crosscert_sign attributes. @@ -743,11 +734,6 @@ class RelayDescriptor(ServerDescriptor): .. versionchanged:: 1.6.0 Added the certificate attribute. - .. deprecated:: 1.6.0 - Our **ed25519_certificate** is deprecated in favor of our new - **certificate** attribute. The base64 encoded certificate is available via - the certificate's **encoded** attribute. - .. versionchanged:: 1.6.0 Added the **skip_crypto_validation** constructor argument. """ @@ -756,7 +742,6 @@ class RelayDescriptor(ServerDescriptor): ATTRIBUTES = dict(ServerDescriptor.ATTRIBUTES, **{ 'certificate': (None, _parse_identity_ed25519_line), - 'ed25519_certificate': (None, _parse_identity_ed25519_line), 'ed25519_master_key': (None, _parse_master_key_ed25519_line), 'ed25519_signature': (None, _parse_router_sig_ed25519_line), @@ -928,7 +913,7 @@ class RelayDescriptor(ServerDescriptor): def _check_constraints(self, entries): super(RelayDescriptor, self)._check_constraints(entries) - if self.ed25519_certificate: + if self.certificate: if not self.onion_key_crosscert: raise ValueError("Descriptor must have a 'onion-key-crosscert' when identity-ed25519 is present") elif not self.ed25519_signature: diff --git a/test/unit/descriptor/server_descriptor.py b/test/unit/descriptor/server_descriptor.py index ab419575..55b1ac42 100644 --- a/test/unit/descriptor/server_descriptor.py +++ b/test/unit/descriptor/server_descriptor.py @@ -116,7 +116,6 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= self.assertEqual(None, desc.socks_port) self.assertEqual(None, desc.dir_port) self.assertEqual(None, desc.certificate) - self.assertEqual(None, desc.ed25519_certificate) self.assertEqual(None, desc.ed25519_master_key) self.assertEqual(None, desc.ed25519_signature) self.assertEqual(b'Tor 0.2.1.30 on Linux x86_64', desc.platform) @@ -374,7 +373,6 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= self.assertEqual(9001, desc.or_port) self.assertEqual(None, desc.socks_port) self.assertEqual(443, desc.dir_port) - self.assertTrue('bWPo2fIzo3uOywfoM' in desc.ed25519_certificate) self.assertEqual('Z6a1UabSK+N21j6NnyM6N7jssH6DK68qa6W5uB4QpGQ', desc.ed25519_master_key) self.assertEqual('w+cKNZTlL7vz/4WgYdFUblzJy3VdTw0mfFK4N3SPFCt20fNKt9SgiZ5V/2ai3kgGsc6oCsyUesSiYtPcTXMLCw', desc.ed25519_signature) self.assertEqual(b'Tor 0.2.7.2-alpha-dev on Linux', desc.platform) @@ -428,7 +426,6 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= self.assertEqual('ChandlerObfs11', desc.nickname) self.assertEqual('678912ABD7398DF8EFC8FA2BC7DEF610710360C4', desc.fingerprint) self.assertEqual('10.162.85.172', desc.address) - self.assertFalse(hasattr(desc, 'ed25519_certificate')) self.assertEqual('lgIuiAJCoXPRwWoHgG4ZAoKtmrv47aPr4AsbmESj8AA', desc.ed25519_certificate_hash) self.assertEqual('OB/fqLD8lYmjti09R+xXH/D4S2qlizxdZqtudnsunxE', desc.router_digest_sha256) self.assertEqual('@type bridge-server-descriptor 1.0', str(desc.type_annotation()))

1 0

[stem/master] Drop workaround for 'GETINFO onions/current' behavior change
by atagar＠torproject.org 10 Feb '20

10 Feb '20

commit 74615ebfa801f28d3e85ff1e7c52f38b4953297c Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 8 13:17:42 2020 -0800 Drop workaround for 'GETINFO onions/current' behavior change Back in 2017 we changed this GETINFO option's behavior to return an empty list rather than error when no results are available. THis is long enough that we can drop this normalization. https://trac.torproject.org/projects/tor/ticket/21329 --- stem/control.py | 11 +---------- 1 file changed, 1 insertion(+), 10 deletions(-) diff --git a/stem/control.py b/stem/control.py index ff984b57..4016e762 100644 --- a/stem/control.py +++ b/stem/control.py @@ -2788,16 +2788,7 @@ class Controller(BaseController): result = [] if our_services: - try: - result += self.get_info('onions/current').split('\n') - except (stem.ProtocolError, stem.OperationFailed) as exc: - # TODO: Tor's behavior around this was changed in Feb 2017, we should - # drop it when all versions that did this are deprecated... - # - # https://trac.torproject.org/projects/tor/ticket/21329 - - if 'No onion services of the specified type.' not in str(exc): - raise + result += self.get_info('onions/current').split('\n') if detached: try:

1 0

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

10 Feb '20

commit fb82decc3af768f480db7fe7e93c9ce258110567 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Feb 6 13:40:29 2020 -0800 Drop server descriptor annotations Server descriptor files within tor's data directory begin with a couple annotations. This is the only place where these annotations exist, and is not part of tor's dir-spec. I parsed these annotations for completeness when I first authored Stem. However, we effectively never read these files nowadays for a few reasons... 1. Stem's remote and collector modules provide better methods for getting descriptors. 2. When tor is running locally we can get this information via GETINFO rather than reading directly from disk. 3. Tor is trying to discourage us from reading the data directory from disk by restricting its permissions. This isn't to say there aren't merits to reading on-disk descriptors. Nyx does so, for instance, because it's a passive listener (no downloading allowed) and massive GETINFO responses noticably lag the control port. However, reading on-disk descriptors is rare and even in this edge case I'm unaware of anyone using the annotations. --- stem/descriptor/server_descriptor.py | 80 ++++++------------------------- test/unit/descriptor/remote.py | 4 +- test/unit/descriptor/server_descriptor.py | 28 ----------- 3 files changed, 15 insertions(+), 97 deletions(-) diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index 84ba8b65..5236c4db 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -26,9 +26,7 @@ etc). This information is provided from a few sources... | |- is_scrubbed - checks if our content has been properly scrubbed | +- get_scrubbing_issues - description of issues with our scrubbing | - |- digest - calculates the upper-case hex digest value for our content - |- get_annotations - dictionary of content prior to the descriptor entry - +- get_annotation_lines - lines that provided the annotations + +- digest - calculates the upper-case hex digest value for our content .. data:: BridgeDistribution (enum) @@ -190,10 +188,14 @@ def _parse_file(descriptor_file, is_bridge = False, validate = False, **kwargs): # to the caller). while True: - annotations = _read_until_keywords('router', descriptor_file) - annotations = map(bytes.strip, annotations) # strip newlines - annotations = map(stem.util.str_tools._to_unicode, annotations) # convert to unicode - annotations = list(filter(lambda x: x != '', annotations)) # drop any blanks + # skip annotations + + while True: + pos = descriptor_file.tell() + + if not descriptor_file.readline().startswith(b'@'): + descriptor_file.seek(pos) + break if not is_bridge: descriptor_content = _read_until_keywords('router-signature', descriptor_file) @@ -212,13 +214,10 @@ def _parse_file(descriptor_file, is_bridge = False, validate = False, **kwargs): descriptor_text = bytes.join(b'', descriptor_content) if is_bridge: - yield BridgeDescriptor(descriptor_text, validate, annotations, **kwargs) + yield BridgeDescriptor(descriptor_text, validate, **kwargs) else: - yield RelayDescriptor(descriptor_text, validate, annotations, **kwargs) + yield RelayDescriptor(descriptor_text, validate, **kwargs) else: - if validate and annotations: - raise ValueError('Content conform to being a server descriptor:\n%s' % '\n'.join(annotations)) - break # done parsing descriptors @@ -590,7 +589,7 @@ class ServerDescriptor(Descriptor): 'eventdns': _parse_eventdns_line, } - def __init__(self, raw_contents, validate = False, annotations = None): + def __init__(self, raw_contents, validate = False): """ Server descriptor constructor, created from an individual relay's descriptor content (as provided by 'GETINFO desc/*', cached descriptors, @@ -603,13 +602,11 @@ class ServerDescriptor(Descriptor): :param str raw_contents: descriptor content provided by the relay :param bool validate: checks the validity of the descriptor's content if **True**, skips these checks otherwise - :param list annotations: lines that appeared prior to the descriptor :raises: **ValueError** if the contents is malformed and validate is True """ super(ServerDescriptor, self).__init__(raw_contents, lazy_load = not validate) - self._annotation_lines = annotations if annotations else [] # A descriptor contains a series of 'keyword lines' which are simply a # keyword followed by an optional value. Lines can also be followed by a @@ -663,55 +660,6 @@ class ServerDescriptor(Descriptor): raise NotImplementedError('Unsupported Operation: this should be implemented by the ServerDescriptor subclass') - @functools.lru_cache() - def get_annotations(self): - """ - Provides content that appeared prior to the descriptor. If this comes from - the cached-descriptors file then this commonly contains content like... - - :: - - @downloaded-at 2012-03-18 21:18:29 - @source "173.254.216.66" - - .. deprecated:: 1.8.0 - Users very rarely read from cached descriptor files any longer. This - method will be removed in Stem 2.x. If you have some need for us to keep - this please `let me know - <https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs>`_. - - :returns: **dict** with the key/value pairs in our annotations - """ - - annotation_dict = {} - - for line in self._annotation_lines: - if ' ' in line: - key, value = line.split(' ', 1) - annotation_dict[key] = value - else: - annotation_dict[line] = None - - return annotation_dict - - def get_annotation_lines(self): - """ - Provides the lines of content that appeared prior to the descriptor. This - is the same as the - :func:`~stem.descriptor.server_descriptor.ServerDescriptor.get_annotations` - results, but with the unparsed lines and ordering retained. - - .. deprecated:: 1.8.0 - Users very rarely read from cached descriptor files any longer. This - method will be removed in Stem 2.x. If you have some need for us to keep - this please `let me know - <https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs>`_. - - :returns: **list** with the lines of annotation that came before this descriptor - """ - - return self._annotation_lines - def _check_constraints(self, entries): """ Does a basic check that the entries conform to this descriptor type's @@ -831,8 +779,8 @@ class RelayDescriptor(ServerDescriptor): 'router-signature': _parse_router_signature_line, }) - def __init__(self, raw_contents, validate = False, annotations = None, skip_crypto_validation = False): - super(RelayDescriptor, self).__init__(raw_contents, validate, annotations) + def __init__(self, raw_contents, validate = False, skip_crypto_validation = False): + super(RelayDescriptor, self).__init__(raw_contents, validate) if validate: if self.fingerprint: diff --git a/test/unit/descriptor/remote.py b/test/unit/descriptor/remote.py index d9893535..7cdeab46 100644 --- a/test/unit/descriptor/remote.py +++ b/test/unit/descriptor/remote.py @@ -333,12 +333,10 @@ class TestDescriptorDownloader(unittest.TestCase): # checking via the iterator - expected_error_msg = 'Content conform to being a server descriptor:\nsome malformed stuff' - descriptors = list(query) self.assertEqual(0, len(descriptors)) self.assertEqual(ValueError, type(query.error)) - self.assertEqual(expected_error_msg, str(query.error)) + self.assertEqual("Descriptor must have a 'router' entry", str(query.error)) # check via the run() method diff --git a/test/unit/descriptor/server_descriptor.py b/test/unit/descriptor/server_descriptor.py index aeb58df1..ab419575 100644 --- a/test/unit/descriptor/server_descriptor.py +++ b/test/unit/descriptor/server_descriptor.py @@ -705,34 +705,6 @@ Qlx9HNCqCY877ztFRC624ja2ql6A2hBcuoYMbkHjcQ4= self.assertEqual(900, desc.read_history_interval) self.assertEqual([], desc.read_history_values) - @patch('stem.prereq.is_crypto_available', Mock(return_value = False)) - def test_annotations(self): - """ - Checks that content before a descriptor are parsed as annotations. - """ - - desc_text = b'@pepperjack very tasty\n@mushrooms not so much\n' - desc_text += RelayDescriptor.content() - desc_text += b'\ntrailing text that should be invalid, ho hum' - - # running _parse_file should provide an iterator with a single descriptor - desc_iter = stem.descriptor.server_descriptor._parse_file(io.BytesIO(desc_text), validate = True) - self.assertRaises(ValueError, list, desc_iter) - - desc_text = b'@pepperjack very tasty\n@mushrooms not so much\n' - desc_text += RelayDescriptor.content({'router': 'caerSidi 71.35.133.197 9001 0 0'}) - desc_iter = stem.descriptor.server_descriptor._parse_file(io.BytesIO(desc_text)) - - desc_entries = list(desc_iter) - self.assertEqual(1, len(desc_entries)) - desc = desc_entries[0] - - self.assertEqual('caerSidi', desc.nickname) - self.assertEqual('@pepperjack very tasty', desc.get_annotation_lines()[0]) - self.assertEqual('@mushrooms not so much', desc.get_annotation_lines()[1]) - self.assertEqual({'@pepperjack': 'very tasty', '@mushrooms': 'not so much'}, desc.get_annotations()) - self.assertEqual([], desc.get_unrecognized_lines()) - def test_duplicate_field(self): """ Constructs with a field appearing twice.

1 0

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

10 Feb '20

commit 7a4357b2c21d0af5088c1cafce0800fc63cebbb4 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Feb 6 16:36:02 2020 -0800 Drop obsolete version constants Removing the constants and version checks for obsolete tor versions. As of 2/6/20 our consensus has... client-versions 0.3.5.7,0.3.5.8,0.3.5.9,0.4.1.2-alpha,0.4.1.3-alpha,0.4.1.4-rc,0.4.1.5,0.4.1.6,0.4.1.7,0.4.1.8,0.4.2.1-alpha,0.4.2.2-alpha,0.4.2.3-alpha,0.4.2.4-rc,0.4.2.5,0.4.2.6,0.4.3.1-alpha server-versions 0.3.5.8,0.3.5.9,0.4.1.2-alpha,0.4.1.3-alpha,0.4.1.4-rc,0.4.1.5,0.4.1.6,0.4.1.7,0.4.1.8,0.4.2.1-alpha,0.4.2.2-alpha,0.4.2.3-alpha,0.4.2.4-rc,0.4.2.5,0.4.2.6,0.4.3.1-alpha Stem won't have another release for several months so picked 0.3.5.7 as the minimum version to keep. That narrows us down to HSv3 support for HSFETCH and tor's new dormant mode. --- stem/control.py | 184 +++++++------------------------- stem/process.py | 28 +---- stem/version.py | 63 +---------- test/integ/connection/authentication.py | 19 +--- test/integ/control/controller.py | 28 +---- test/integ/process.py | 21 +--- test/integ/response/protocolinfo.py | 4 +- test/integ/socket/control_message.py | 1 - test/require.py | 6 +- test/unit/control/controller.py | 13 --- 10 files changed, 51 insertions(+), 316 deletions(-) diff --git a/stem/control.py b/stem/control.py index 271a67ec..ff984b57 100644 --- a/stem/control.py +++ b/stem/control.py @@ -1615,14 +1615,13 @@ class Controller(BaseController): if start_time: return start_time - if self.get_version() >= stem.version.Requirement.GETINFO_UPTIME: - uptime = self.get_info('uptime', None) + uptime = self.get_info('uptime', None) - if uptime: - if not uptime.isdigit(): - raise ValueError("'GETINFO uptime' did not provide a valid numeric response: %s" % uptime) + if uptime: + if not uptime.isdigit(): + raise ValueError("'GETINFO uptime' did not provide a valid numeric response: %s" % uptime) - start_time = time.time() - float(uptime) + start_time = time.time() - float(uptime) if not start_time and self.is_localhost(): # Tor doesn't yet support this GETINFO option, attempt to determine the @@ -1785,45 +1784,13 @@ class Controller(BaseController): default was provided """ - if self.get_version() >= stem.version.Requirement.GETINFO_MICRODESCRIPTORS: - desc_content = self.get_info('md/all', get_bytes = True) + desc_content = self.get_info('md/all', get_bytes = True) - if not desc_content: - raise stem.DescriptorUnavailable('Descriptor information is unavailable, tor might still be downloading it') - - for desc in stem.descriptor.microdescriptor._parse_file(io.BytesIO(desc_content)): - yield desc - else: - # TODO: remove when tor versions that require this are obsolete - - data_directory = self.get_conf('DataDirectory', None) - - if data_directory is None: - raise stem.OperationFailed(message = "Unable to determine tor's data directory") - - if not os.path.exists(data_directory): - raise stem.OperationFailed(message = "Data directory reported by tor doesn't exist (%s)" % data_directory) - - microdescriptor_file = None - - for filename in ('cached-microdescs', 'cached-microdescs.new'): - cached_descriptors = os.path.join(data_directory, filename) - - if os.path.exists(cached_descriptors): - microdescriptor_file = cached_descriptors - break - - if microdescriptor_file is None: - raise stem.OperationFailed(message = "Data directory doesn't contain cached microdescriptors (%s)" % data_directory) - - for desc in stem.descriptor.parse_file(microdescriptor_file): - # It shouldn't be possible for these to be something other than - # microdescriptors but as the saying goes: trust but verify. - - if not isinstance(desc, stem.descriptor.microdescriptor.Microdescriptor): - raise stem.OperationFailed(message = 'BUG: Descriptor reader provided non-microdescriptor content (%s)' % type(desc)) + if not desc_content: + raise stem.DescriptorUnavailable('Descriptor information is unavailable, tor might still be downloading it') - yield desc + for desc in stem.descriptor.microdescriptor._parse_file(io.BytesIO(desc_content)): + yield desc @with_default() def get_server_descriptor(self, relay = None, default = UNDEFINED): @@ -1862,37 +1829,31 @@ class Controller(BaseController): An exception is only raised if we weren't provided a default response. """ - try: - if relay is None: - try: - relay = self.get_info('fingerprint') - except stem.ControllerError as exc: - raise stem.ControllerError('Unable to determine our own fingerprint: %s' % exc) - - if stem.util.tor_tools.is_valid_fingerprint(relay): - query = 'desc/id/%s' % relay - elif stem.util.tor_tools.is_valid_nickname(relay): - query = 'desc/name/%s' % relay - else: - raise ValueError("'%s' isn't a valid fingerprint or nickname" % relay) - + if relay is None: try: - desc_content = self.get_info(query, get_bytes = True) - except stem.InvalidArguments as exc: - if str(exc).startswith('GETINFO request contained unrecognized keywords:'): - raise stem.DescriptorUnavailable("Tor was unable to provide the descriptor for '%s'" % relay) - else: - raise + relay = self.get_info('fingerprint') + except stem.ControllerError as exc: + raise stem.ControllerError('Unable to determine our own fingerprint: %s' % exc) + + if stem.util.tor_tools.is_valid_fingerprint(relay): + query = 'desc/id/%s' % relay + elif stem.util.tor_tools.is_valid_nickname(relay): + query = 'desc/name/%s' % relay + else: + raise ValueError("'%s' isn't a valid fingerprint or nickname" % relay) - if not desc_content: - raise stem.DescriptorUnavailable('Descriptor information is unavailable, tor might still be downloading it') + try: + desc_content = self.get_info(query, get_bytes = True) + except stem.InvalidArguments as exc: + if str(exc).startswith('GETINFO request contained unrecognized keywords:'): + raise stem.DescriptorUnavailable("Tor was unable to provide the descriptor for '%s'" % relay) + else: + raise - return stem.descriptor.server_descriptor.RelayDescriptor(desc_content) - except: - if not self._is_server_descriptors_available(): - raise ValueError(SERVER_DESCRIPTORS_UNSUPPORTED) + if not desc_content: + raise stem.DescriptorUnavailable('Descriptor information is unavailable, tor might still be downloading it') - raise + return stem.descriptor.server_descriptor.RelayDescriptor(desc_content) @with_default(yields = True) def get_server_descriptors(self, default = UNDEFINED): @@ -1925,27 +1886,11 @@ class Controller(BaseController): desc_content = self.get_info('desc/all-recent', get_bytes = True) if not desc_content: - if not self._is_server_descriptors_available(): - raise stem.ControllerError(SERVER_DESCRIPTORS_UNSUPPORTED) - else: - raise stem.DescriptorUnavailable('Descriptor information is unavailable, tor might still be downloading it') + raise stem.DescriptorUnavailable('Descriptor information is unavailable, tor might still be downloading it') for desc in stem.descriptor.server_descriptor._parse_file(io.BytesIO(desc_content)): yield desc - def _is_server_descriptors_available(self): - """ - Checks to see if tor server descriptors should be available or not. - """ - - # TODO: Replace with a 'GETINFO desc/download-enabled' request when they're - # widely available... - # - # https://gitweb.torproject.org/torspec.git/commit/?id=378699c - - return self.get_version() < stem.version.Requirement.MICRODESCRIPTOR_IS_DEFAULT or \ - self.get_conf('UseMicrodescriptors', None) == '0' - @with_default() def get_network_status(self, relay = None, default = UNDEFINED): """ @@ -2086,9 +2031,6 @@ class Controller(BaseController): if not stem.util.tor_tools.is_valid_hidden_service_address(address): raise ValueError("'%s.onion' isn't a valid hidden service address" % address) - if self.get_version() < stem.version.Requirement.HSFETCH: - raise stem.UnsatisfiableRequest(message = 'HSFETCH was added in tor version %s' % stem.version.Requirement.HSFETCH) - hs_desc_queue, hs_desc_listener = queue.Queue(), None hs_desc_content_queue, hs_desc_content_listener = queue.Queue(), None start_time = time.time() @@ -2843,9 +2785,6 @@ class Controller(BaseController): provided a default response """ - if self.get_version() < stem.version.Requirement.ADD_ONION: - raise stem.UnsatisfiableRequest(message = 'Ephemeral hidden services were added in tor version %s' % stem.version.Requirement.ADD_ONION) - result = [] if our_services: @@ -2971,9 +2910,6 @@ class Controller(BaseController): * :class:`stem.Timeout` if **timeout** was reached """ - if self.get_version() < stem.version.Requirement.ADD_ONION: - raise stem.UnsatisfiableRequest(message = 'Ephemeral hidden services were added in tor version %s' % stem.version.Requirement.ADD_ONION) - hs_desc_queue, hs_desc_listener = queue.Queue(), None start_time = time.time() @@ -2994,20 +2930,13 @@ class Controller(BaseController): flags.append('Detach') if basic_auth is not None: - if self.get_version() < stem.version.Requirement.ADD_ONION_BASIC_AUTH: - raise stem.UnsatisfiableRequest(message = 'Basic authentication support was added to ADD_ONION in tor version %s' % stem.version.Requirement.ADD_ONION_BASIC_AUTH) - flags.append('BasicAuth') if max_streams is not None: - if self.get_version() < stem.version.Requirement.ADD_ONION_MAX_STREAMS: - raise stem.UnsatisfiableRequest(message = 'Limitation of the maximum number of streams to accept was added to ADD_ONION in tor version %s' % stem.version.Requirement.ADD_ONION_MAX_STREAMS) - flags.append('MaxStreamsCloseCircuit') - if self.get_version() >= stem.version.Requirement.ADD_ONION_NON_ANONYMOUS: - if self.get_conf('HiddenServiceSingleHopMode', None) == '1' and self.get_conf('HiddenServiceNonAnonymousMode', None) == '1': - flags.append('NonAnonymous') + if self.get_conf('HiddenServiceSingleHopMode', None) == '1' and self.get_conf('HiddenServiceNonAnonymousMode', None) == '1': + flags.append('NonAnonymous') if flags: request += ' Flags=%s' % ','.join(flags) @@ -3078,9 +3007,6 @@ class Controller(BaseController): :raises: :class:`stem.ControllerError` if the call fails """ - if self.get_version() < stem.version.Requirement.ADD_ONION: - raise stem.UnsatisfiableRequest(message = 'Ephemeral hidden services were added in tor version %s' % stem.version.Requirement.ADD_ONION) - response = self.msg('DEL_ONION %s' % service_id) stem.response.convert('SINGLELINE', response) @@ -3346,9 +3272,6 @@ class Controller(BaseController): the configuration file """ - if self.get_version() < stem.version.Requirement.SAVECONF_FORCE: - force = False - response = self.msg('SAVECONF FORCE' if force else 'SAVECONF') stem.response.convert('SINGLELINE', response) @@ -3371,24 +3294,10 @@ class Controller(BaseController): feature = feature.upper() - if feature in self._enabled_features: - return True - else: - # check if this feature is on by default - defaulted_version = None - - if feature == 'EXTENDED_EVENTS': - defaulted_version = stem.version.Requirement.FEATURE_EXTENDED_EVENTS - elif feature == 'VERBOSE_NAMES': - defaulted_version = stem.version.Requirement.FEATURE_VERBOSE_NAMES + if feature in ('EXTENDED_EVENTS', 'VERBOSE_NAMES'): + return True # EXTENDED_EVENTS and VERBOSE_NAMES are always on as of 0.2.2.1 - if defaulted_version: - our_version = self.get_version(None) - - if our_version and our_version >= defaulted_version: - self._enabled_features.append(feature) - - return feature in self._enabled_features + return feature in self._enabled_features def enable_feature(self, features): """ @@ -3397,11 +3306,6 @@ class Controller(BaseController): control connection must be opened to get a connection with the feature disabled. Feature names are case-insensitive. - The following features are currently accepted: - - * EXTENDED_EVENTS - Requests the extended event syntax - * VERBOSE_NAMES - Replaces ServerID with LongName in events and GETINFO results - :param str,list features: a single feature or a list of features to be enabled :raises: @@ -3553,16 +3457,7 @@ class Controller(BaseController): self.add_event_listener(circ_listener, EventType.CIRC) try: - # we might accidently get integer circuit ids - circuit_id = str(circuit_id) - - if path is None and circuit_id == '0': - path_opt_version = stem.version.Requirement.EXTENDCIRCUIT_PATH_OPTIONAL - - if not self.get_version() >= path_opt_version: - raise stem.InvalidRequest(512, 'EXTENDCIRCUIT requires the path prior to version %s' % path_opt_version) - - args = [circuit_id] + args = [str(circuit_id)] if isinstance(path, (bytes, str)): path = [path] @@ -3862,9 +3757,6 @@ class Controller(BaseController): :raises: :class:`stem.ControllerError` if Tor couldn't fulfill the request """ - if self.get_version() < stem.version.Requirement.DROPGUARDS: - raise stem.UnsatisfiableRequest(message = 'DROPGUARDS was added in tor version %s' % stem.version.Requirement.DROPGUARDS) - self.msg('DROPGUARDS') def _post_authentication(self): diff --git a/stem/process.py b/stem/process.py index 3f1a0e19..913a9be7 100644 --- a/stem/process.py +++ b/stem/process.py @@ -242,14 +242,6 @@ def launch_tor_with_config(config, tor_cmd = 'tor', completion_percent = 100, in timeout without success """ - # TODO: Drop this version check when tor 0.2.6.3 or higher is the only game - # in town. - - try: - use_stdin = stem.version.get_system_tor_version(tor_cmd) >= stem.version.Requirement.TORRC_VIA_STDIN - except IOError: - use_stdin = False - # we need to be sure that we're logging to stdout to figure out when we're # done bootstrapping @@ -278,22 +270,4 @@ def launch_tor_with_config(config, tor_cmd = 'tor', completion_percent = 100, in for value in values: config_str += '%s %s\n' % (key, value) - if use_stdin: - return launch_tor(tor_cmd, ['-f', '-'], None, completion_percent, init_msg_handler, timeout, take_ownership, close_output, stdin = config_str) - else: - torrc_descriptor, torrc_path = tempfile.mkstemp(prefix = 'torrc-', text = True) - - try: - with open(torrc_path, 'w') as torrc_file: - torrc_file.write(config_str) - - # prevents tor from erroring out due to a missing torrc if it gets a sighup - args = ['__ReloadTorrcOnSIGHUP', '0'] - - return launch_tor(tor_cmd, args, torrc_path, completion_percent, init_msg_handler, timeout, take_ownership) - finally: - try: - os.close(torrc_descriptor) - os.remove(torrc_path) - except: - pass + return launch_tor(tor_cmd, ['-f', '-'], None, completion_percent, init_msg_handler, timeout, take_ownership, close_output, stdin = config_str) diff --git a/stem/version.py b/stem/version.py index 71f16e2c..4f873f47 100644 --- a/stem/version.py +++ b/stem/version.py @@ -11,8 +11,8 @@ easily parsed and compared, for instance... >>> my_version = get_system_tor_version() >>> print(my_version) 0.2.1.30 - >>> my_version >= Requirement.TORRC_CONTROL_SOCKET - True + >>> my_version >= Requirement.DORMANT_MODE + False **Module Overview:** @@ -26,18 +26,10 @@ easily parsed and compared, for instance... Enumerations for the version requirements of features. - .. deprecated:: 1.6.0 - Requirement entries belonging to tor versions which have been obsolete for - at least six months will be removed when we break backward compatibility - in the 2.x stem release. - ===================================== =========== Requirement Description ===================================== =========== - **AUTH_SAFECOOKIE** SAFECOOKIE authentication method - **DESCRIPTOR_COMPRESSION** `Expanded compression support for ZSTD and LZMA <https://gitweb.torproject.org/torspec.git/commit/?id=1cb56afdc1e55e303e3e6b…>`_ **DORMANT_MODE** **DORMANT** and **ACTIVE** :data:`~stem.Signal` - **DROPGUARDS** DROPGUARDS requests **EVENT_AUTHDIR_NEWDESCS** AUTHDIR_NEWDESC events **EVENT_BUILDTIMEOUT_SET** BUILDTIMEOUT_SET events **EVENT_CIRC_MINOR** CIRC_MINOR events @@ -58,29 +50,7 @@ easily parsed and compared, for instance... **EVENT_CELL_STATS** CELL_STATS events **EVENT_TB_EMPTY** TB_EMPTY events **EVENT_HS_DESC** HS_DESC events - **EXTENDCIRCUIT_PATH_OPTIONAL** EXTENDCIRCUIT queries can omit the path if the circuit is zero - **FEATURE_EXTENDED_EVENTS** 'EXTENDED_EVENTS' optional feature - **FEATURE_VERBOSE_NAMES** 'VERBOSE_NAMES' optional feature - **GETINFO_CONFIG_TEXT** 'GETINFO config-text' query - **GETINFO_GEOIP_AVAILABLE** 'GETINFO ip-to-country/ipv4-available' query and its ipv6 counterpart - **GETINFO_MICRODESCRIPTORS** 'GETINFO md/all' query - **GETINFO_UPTIME** 'GETINFO uptime' query - **HIDDEN_SERVICE_V3** Support for v3 hidden services - **HSFETCH** HSFETCH requests **HSFETCH_V3** HSFETCH for version 3 hidden services - **HSPOST** HSPOST requests - **ADD_ONION** ADD_ONION and DEL_ONION requests - **ADD_ONION_BASIC_AUTH** ADD_ONION supports basic authentication - **ADD_ONION_NON_ANONYMOUS** ADD_ONION supports non-anonymous mode - **ADD_ONION_MAX_STREAMS** ADD_ONION support for MaxStreamsCloseCircuit - **LOADCONF** LOADCONF requests - **MICRODESCRIPTOR_IS_DEFAULT** Tor gets microdescriptors by default rather than server descriptors - **SAVECONF_FORCE** Added the 'FORCE' flag to SAVECONF - **TAKEOWNERSHIP** TAKEOWNERSHIP requests - **TORRC_CONTROL_SOCKET** 'ControlSocket <path>' config option - **TORRC_PORT_FORWARDING** 'PortForwarding' config option - **TORRC_DISABLE_DEBUGGER_ATTACHMENT** 'DisableDebuggerAttachment' config option - **TORRC_VIA_STDIN** Allow torrc options via 'tor -f -' (:trac:`13865`) ===================================== =========== """ @@ -341,15 +311,8 @@ class _VersionRequirements(object): self.rules.append(new_rule) -safecookie_req = _VersionRequirements() -safecookie_req.in_range(Version('0.2.2.36'), Version('0.2.3.0')) -safecookie_req.greater_than(Version('0.2.3.13')) - Requirement = stem.util.enum.Enum( - ('AUTH_SAFECOOKIE', safecookie_req), - ('DESCRIPTOR_COMPRESSION', Version('0.3.1.1-alpha')), ('DORMANT_MODE', Version('0.4.0.1-alpha')), - ('DROPGUARDS', Version('0.2.5.1-alpha')), ('EVENT_AUTHDIR_NEWDESCS', Version('0.1.1.10-alpha')), ('EVENT_BUILDTIMEOUT_SET', Version('0.2.2.7-alpha')), ('EVENT_CIRC_MINOR', Version('0.2.3.11-alpha')), @@ -370,27 +333,5 @@ Requirement = stem.util.enum.Enum( ('EVENT_CELL_STATS', Version('0.2.5.2-alpha')), ('EVENT_TB_EMPTY', Version('0.2.5.2-alpha')), ('EVENT_HS_DESC', Version('0.2.5.2-alpha')), - ('EXTENDCIRCUIT_PATH_OPTIONAL', Version('0.2.2.9')), - ('FEATURE_EXTENDED_EVENTS', Version('0.2.2.1-alpha')), - ('FEATURE_VERBOSE_NAMES', Version('0.2.2.1-alpha')), - ('GETINFO_CONFIG_TEXT', Version('0.2.2.7-alpha')), - ('GETINFO_GEOIP_AVAILABLE', Version('0.3.2.1-alpha')), - ('GETINFO_MICRODESCRIPTORS', Version('0.3.5.1-alpha')), - ('GETINFO_UPTIME', Version('0.3.5.1-alpha')), - ('HIDDEN_SERVICE_V3', Version('0.3.3.1-alpha')), - ('HSFETCH', Version('0.2.7.1-alpha')), ('HSFETCH_V3', Version('0.4.1.1-alpha')), - ('HSPOST', Version('0.2.7.1-alpha')), - ('ADD_ONION', Version('0.2.7.1-alpha')), - ('ADD_ONION_BASIC_AUTH', Version('0.2.9.1-alpha')), - ('ADD_ONION_NON_ANONYMOUS', Version('0.2.9.3-alpha')), - ('ADD_ONION_MAX_STREAMS', Version('0.2.7.2-alpha')), - ('LOADCONF', Version('0.2.1.1')), - ('MICRODESCRIPTOR_IS_DEFAULT', Version('0.2.3.3')), - ('SAVECONF_FORCE', Version('0.3.1.1-alpha')), - ('TAKEOWNERSHIP', Version('0.2.2.28-beta')), - ('TORRC_CONTROL_SOCKET', Version('0.2.0.30')), - ('TORRC_PORT_FORWARDING', Version('0.2.3.1-alpha')), - ('TORRC_DISABLE_DEBUGGER_ATTACHMENT', Version('0.2.3.9')), - ('TORRC_VIA_STDIN', Version('0.2.6.3-alpha')), ) diff --git a/test/integ/connection/authentication.py b/test/integ/connection/authentication.py index cd562e7b..d07c20b2 100644 --- a/test/integ/connection/authentication.py +++ b/test/integ/connection/authentication.py @@ -43,17 +43,14 @@ def _can_authenticate(auth_type): tor_options = runner.get_options() password_auth = test.runner.Torrc.PASSWORD in tor_options cookie_auth = test.runner.Torrc.COOKIE in tor_options - safecookie_auth = cookie_auth and test.tor_version() >= stem.version.Requirement.AUTH_SAFECOOKIE if not password_auth and not cookie_auth: # open socket, anything but safecookie will work return auth_type != stem.connection.AuthMethod.SAFECOOKIE elif auth_type == stem.connection.AuthMethod.PASSWORD: return password_auth - elif auth_type == stem.connection.AuthMethod.COOKIE: + elif auth_type in (stem.connection.AuthMethod.COOKIE, stem.connection.AuthMethod.SAFECOOKIE): return cookie_auth - elif auth_type == stem.connection.AuthMethod.SAFECOOKIE: - return safecookie_auth else: return False @@ -100,12 +97,6 @@ def _get_auth_failure_message(auth_type): class TestAuthenticate(unittest.TestCase): - def setUp(self): - self.cookie_auth_methods = [stem.connection.AuthMethod.COOKIE] - - if test.tor_version() >= stem.version.Requirement.AUTH_SAFECOOKIE: - self.cookie_auth_methods.append(stem.connection.AuthMethod.SAFECOOKIE) - @test.require.controller def test_authenticate_general_socket(self): """ @@ -293,7 +284,7 @@ class TestAuthenticate(unittest.TestCase): auth_value = test.runner.get_runner().get_auth_cookie_path() - for auth_type in self.cookie_auth_methods: + for auth_type in (stem.connection.AuthMethod.COOKIE, stem.connection.AuthMethod.SAFECOOKIE): if not os.path.exists(auth_value): # If the authentication cookie doesn't exist then we'll be getting an # error for that rather than rejection. This will even fail if @@ -321,7 +312,7 @@ class TestAuthenticate(unittest.TestCase): fake_cookie.write('0' * 32) fake_cookie.close() - for auth_type in self.cookie_auth_methods: + for auth_type in (stem.connection.AuthMethod.COOKIE, stem.connection.AuthMethod.SAFECOOKIE): if _can_authenticate(stem.connection.AuthMethod.NONE): # authentication will work anyway unless this is safecookie if auth_type == stem.connection.AuthMethod.COOKIE: @@ -351,7 +342,7 @@ class TestAuthenticate(unittest.TestCase): shouldn't exist. """ - for auth_type in self.cookie_auth_methods: + for auth_type in (stem.connection.AuthMethod.COOKIE, stem.connection.AuthMethod.SAFECOOKIE): auth_value = "/if/this/exists/then/they're/asking/for/a/failure" self.assertRaises(stem.connection.UnreadableCookieFile, self._check_auth, auth_type, auth_value, False) @@ -365,7 +356,7 @@ class TestAuthenticate(unittest.TestCase): auth_value = test.runner.get_runner().get_torrc_path(True) - for auth_type in self.cookie_auth_methods: + for auth_type in (stem.connection.AuthMethod.COOKIE, stem.connection.AuthMethod.SAFECOOKIE): if os.path.getsize(auth_value) == 32: # Weird coincidence? Fail so we can pick another file to check against. self.fail('Our torrc is 32 bytes, preventing the test_authenticate_cookie_wrong_size test from running.') diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 7113ea67..239e0bd7 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -81,7 +81,6 @@ class TestController(unittest.TestCase): self.assertRaises(stem.SocketError, stem.control.Controller.from_socket_file, test.runner.CONTROL_SOCKET_PATH) @test.require.controller - @test.require.version(Requirement.EVENT_SIGNAL) def test_reset_notification(self): """ Checks that a notificiation listener is... well, notified of SIGHUPs. @@ -342,9 +341,7 @@ class TestController(unittest.TestCase): if test.runner.Torrc.COOKIE in tor_options: auth_methods.append(stem.response.protocolinfo.AuthMethod.COOKIE) - - if test.tor_version() >= stem.version.Requirement.AUTH_SAFECOOKIE: - auth_methods.append(stem.response.protocolinfo.AuthMethod.SAFECOOKIE) + auth_methods.append(stem.response.protocolinfo.AuthMethod.SAFECOOKIE) if test.runner.Torrc.PASSWORD in tor_options: auth_methods.append(stem.response.protocolinfo.AuthMethod.PASSWORD) @@ -553,7 +550,6 @@ class TestController(unittest.TestCase): pass @test.require.controller - @test.require.version(Requirement.ADD_ONION) def test_without_ephemeral_hidden_services(self): """ Exercises ephemeral hidden service methods when none are present. @@ -565,7 +561,6 @@ class TestController(unittest.TestCase): self.assertEqual(False, controller.remove_ephemeral_hidden_service('gfzprpioee3hoppz')) @test.require.controller - @test.require.version(Requirement.ADD_ONION) def test_with_invalid_ephemeral_hidden_service_port(self): with test.runner.get_runner().get_tor_controller() as controller: for ports in (4567890, [4567, 4567890], {4567: '-:4567'}): @@ -573,7 +568,6 @@ class TestController(unittest.TestCase): self.assertRaisesWith(stem.ProtocolError, exc_msg, controller.create_ephemeral_hidden_service, ports) @test.require.controller - @test.require.version(Requirement.ADD_ONION) def test_ephemeral_hidden_services_v2(self): """ Exercises creating v2 ephemeral hidden services. @@ -618,7 +612,6 @@ class TestController(unittest.TestCase): self.assertEqual(0, len(second_controller.list_ephemeral_hidden_services())) @test.require.controller - @test.require.version(Requirement.HIDDEN_SERVICE_V3) def test_ephemeral_hidden_services_v3(self): """ Exercises creating v3 ephemeral hidden services. @@ -663,7 +656,6 @@ class TestController(unittest.TestCase): self.assertEqual(0, len(second_controller.list_ephemeral_hidden_services())) @test.require.controller - @test.require.version(Requirement.ADD_ONION_BASIC_AUTH) def test_with_ephemeral_hidden_services_basic_auth(self): """ Exercises creating ephemeral hidden services that uses basic authentication. @@ -683,7 +675,6 @@ class TestController(unittest.TestCase): self.assertEqual([], controller.list_ephemeral_hidden_services()) @test.require.controller - @test.require.version(Requirement.ADD_ONION_BASIC_AUTH) def test_with_ephemeral_hidden_services_basic_auth_no_credentials(self): """ Exercises creating ephemeral hidden services when attempting to use basic @@ -697,7 +688,6 @@ class TestController(unittest.TestCase): self.assertRaisesWith(stem.ProtocolError, exc_msg, controller.create_ephemeral_hidden_service, 4567, basic_auth = {}) @test.require.controller - @test.require.version(Requirement.ADD_ONION) def test_with_detached_ephemeral_hidden_services(self): """ Exercises creating detached ephemeral hidden services and methods when @@ -733,7 +723,6 @@ class TestController(unittest.TestCase): controller.remove_ephemeral_hidden_service(response.service_id) @test.require.controller - @test.require.version(Requirement.ADD_ONION) def test_rejecting_unanonymous_hidden_services_creation(self): """ Attempt to create a non-anonymous hidden service despite not setting @@ -852,7 +841,6 @@ class TestController(unittest.TestCase): self.assertRaisesWith(stem.InvalidArguments, "DisableAllSwap, User cannot be changed while tor's running", controller.set_options, {'User': 'atagar', 'DisableAllSwap': '1'}) @test.require.controller - @test.require.version(Requirement.LOADCONF) def test_loadconf(self): """ Exercises Controller.load_conf with valid and invalid requests. @@ -1004,7 +992,6 @@ class TestController(unittest.TestCase): @test.require.controller @test.require.online - @test.require.version(Requirement.EXTENDCIRCUIT_PATH_OPTIONAL) def test_extendcircuit(self): with test.runner.get_runner().get_tor_controller() as controller: circuit_id = controller.extend_circuit('0') @@ -1020,7 +1007,6 @@ class TestController(unittest.TestCase): @test.require.controller @test.require.online - @test.require.version(Requirement.EXTENDCIRCUIT_PATH_OPTIONAL) def test_repurpose_circuit(self): """ Tests Controller.repurpose_circuit with valid and invalid input. @@ -1043,7 +1029,6 @@ class TestController(unittest.TestCase): @test.require.controller @test.require.online - @test.require.version(Requirement.EXTENDCIRCUIT_PATH_OPTIONAL) def test_close_circuit(self): """ Tests Controller.close_circuit with valid and invalid input. @@ -1251,7 +1236,6 @@ class TestController(unittest.TestCase): @test.require.controller @test.require.online - @test.require.version(Requirement.MICRODESCRIPTOR_IS_DEFAULT) def test_get_microdescriptor(self): """ Basic checks for get_microdescriptor(). @@ -1304,12 +1288,8 @@ class TestController(unittest.TestCase): runner = test.runner.get_runner() - if test.tor_version() >= Requirement.MICRODESCRIPTOR_IS_DEFAULT: - self.skipTest('(requires server descriptors)') - with runner.get_tor_controller() as controller: # we should balk at invalid content - self.assertRaises(ValueError, controller.get_server_descriptor, None) self.assertRaises(ValueError, controller.get_server_descriptor, '') self.assertRaises(ValueError, controller.get_server_descriptor, 5) self.assertRaises(ValueError, controller.get_server_descriptor, 'z' * 30) @@ -1334,9 +1314,6 @@ class TestController(unittest.TestCase): runner = test.runner.get_runner() - if test.tor_version() >= Requirement.MICRODESCRIPTOR_IS_DEFAULT: - self.skipTest('(requires server descriptors)') - with runner.get_tor_controller() as controller: count = 0 @@ -1402,7 +1379,6 @@ class TestController(unittest.TestCase): @test.require.controller @test.require.online - @test.require.version(Requirement.HSFETCH) def test_get_hidden_service_descriptor(self): """ Fetches a few descriptors via the get_hidden_service_descriptor() method. @@ -1428,7 +1404,6 @@ class TestController(unittest.TestCase): @test.require.controller @test.require.online - @test.require.version(Requirement.EXTENDCIRCUIT_PATH_OPTIONAL) def test_attachstream(self): host = socket.gethostbyname('www.torproject.org') port = 80 @@ -1469,7 +1444,6 @@ class TestController(unittest.TestCase): @test.require.controller @test.require.online - @test.require.version(Requirement.EXTENDCIRCUIT_PATH_OPTIONAL) def test_get_circuits(self): """ Fetches circuits via the get_circuits() method. diff --git a/test/integ/process.py b/test/integ/process.py index e26a22c0..430ed484 100644 --- a/test/integ/process.py +++ b/test/integ/process.py @@ -310,9 +310,6 @@ class TestProcess(unittest.TestCase): Pass configuration options via stdin. """ - if test.tor_version() < stem.version.Requirement.TORRC_VIA_STDIN: - skip('(requires %s)' % stem.version.Requirement.TORRC_VIA_STDIN) - with tempfile.TemporaryDirectory() as data_directory: torrc = BASIC_RELAY_TORRC % data_directory output = run_tor(tor_cmd, '-f', '-', '--dump-config', 'short', stdin = torrc) @@ -345,10 +342,7 @@ class TestProcess(unittest.TestCase): raise AssertionError("Tor shouldn't start with 'HiddenServiceNonAnonymousMode' set but not 'HiddenServiceSingleHopMode'") except OSError as exc: - if test.tor_version() >= stem.version.Requirement.ADD_ONION_NON_ANONYMOUS: - assert_equal('Process terminated: HiddenServiceNonAnonymousMode does not provide any server anonymity. It must be used with HiddenServiceSingleHopMode set to 1.', str(exc)) - else: - assert_equal("Process terminated: Unknown option 'HiddenServiceNonAnonymousMode'. Failing.", str(exc)) + assert_equal('Process terminated: HiddenServiceNonAnonymousMode does not provide any server anonymity. It must be used with HiddenServiceSingleHopMode set to 1.', str(exc)) try: stem.process.launch_tor_with_config( @@ -358,10 +352,7 @@ class TestProcess(unittest.TestCase): raise AssertionError("Tor shouldn't start with 'HiddenServiceSingleHopMode' set but not 'HiddenServiceNonAnonymousMode'") except OSError as exc: - if test.tor_version() >= stem.version.Requirement.ADD_ONION_NON_ANONYMOUS: - assert_equal('Process terminated: HiddenServiceSingleHopMode does not provide any server anonymity. It must be used with HiddenServiceNonAnonymousMode set to 1.', str(exc)) - else: - assert_equal("Process terminated: Unknown option 'HiddenServiceSingleHopMode'. Failing.", str(exc)) + assert_equal('Process terminated: HiddenServiceSingleHopMode does not provide any server anonymity. It must be used with HiddenServiceNonAnonymousMode set to 1.', str(exc)) @asynchronous def test_can_run_multithreaded(tor_cmd): @@ -465,9 +456,6 @@ class TestProcess(unittest.TestCase): Exercises launch_tor_with_config when we provide our torrc via stdin. """ - if test.tor_version() < stem.version.Requirement.TORRC_VIA_STDIN: - skip('(requires %s)' % stem.version.Requirement.TORRC_VIA_STDIN) - with tempfile.TemporaryDirectory() as data_directory: control_port = random_port() control_socket, tor_process = None, None @@ -561,8 +549,6 @@ class TestProcess(unittest.TestCase): if not stem.util.system.is_available('sleep'): skip('(sleep unavailable)') - elif test.tor_version() < stem.version.Requirement.TAKEOWNERSHIP: - skip('(requires %s)' % stem.version.Requirement.TAKEOWNERSHIP) with tempfile.TemporaryDirectory() as data_directory: sleep_process = subprocess.Popen(['sleep', '60']) @@ -608,9 +594,6 @@ class TestProcess(unittest.TestCase): connects, then disconnects.. """ - if test.tor_version() < stem.version.Requirement.TAKEOWNERSHIP: - skip('(requires %s)' % stem.version.Requirement.TAKEOWNERSHIP) - with tempfile.TemporaryDirectory() as data_directory: control_port = random_port() diff --git a/test/integ/response/protocolinfo.py b/test/integ/response/protocolinfo.py index 917b87c3..2fb060db 100644 --- a/test/integ/response/protocolinfo.py +++ b/test/integ/response/protocolinfo.py @@ -126,9 +126,7 @@ class TestProtocolInfo(unittest.TestCase): if test.runner.Torrc.COOKIE in tor_options: auth_methods.append(stem.response.protocolinfo.AuthMethod.COOKIE) - - if test.tor_version() >= stem.version.Requirement.AUTH_SAFECOOKIE: - auth_methods.append(stem.response.protocolinfo.AuthMethod.SAFECOOKIE) + auth_methods.append(stem.response.protocolinfo.AuthMethod.SAFECOOKIE) chroot_path = runner.get_chroot() auth_cookie_path = runner.get_auth_cookie_path() diff --git a/test/integ/socket/control_message.py b/test/integ/socket/control_message.py index 6c044647..e0a4cca2 100644 --- a/test/integ/socket/control_message.py +++ b/test/integ/socket/control_message.py @@ -99,7 +99,6 @@ class TestControlMessage(unittest.TestCase): self.assertEqual([('250', '-', 'config-file=%s' % torrc_dst), ('250', ' ', 'OK')], config_file_response.content()) @test.require.controller - @test.require.version(stem.version.Requirement.GETINFO_CONFIG_TEXT) def test_getinfo_config_text(self): """ Parses the 'GETINFO config-text' response. diff --git a/test/require.py b/test/require.py index 8bdea06b..12b3adf5 100644 --- a/test/require.py +++ b/test/require.py @@ -69,11 +69,7 @@ def _can_access_controller(): def _can_ptrace(): - # If we're running a tor version where ptrace is disabled and we didn't - # set 'DisableDebuggerAttachment=1' then we can infer that it's disabled. - - has_option = test.tor_version() >= stem.version.Requirement.TORRC_DISABLE_DEBUGGER_ATTACHMENT - return not has_option or test.runner.Torrc.PTRACE in test.runner.get_runner().get_options() + return test.runner.Torrc.PTRACE in test.runner.get_runner().get_options() def _is_online(): diff --git a/test/unit/control/controller.py b/test/unit/control/controller.py index 1ba3001a..37e252b9 100644 --- a/test/unit/control/controller.py +++ b/test/unit/control/controller.py @@ -694,19 +694,6 @@ class TestControl(unittest.TestCase): self.assertRaises(ControllerError, self.controller.get_effective_rate) self.assertEqual('my_default', self.controller.get_effective_rate('my_default')) - @patch('stem.control.Controller.get_version') - def test_drop_guards(self, get_version_mock): - """ - Exercises the drop_guards() method. - """ - - get_version_mock.return_value = stem.version.Version('0.1.0.14') - self.assertRaises(UnsatisfiableRequest, self.controller.drop_guards) - - with patch('stem.control.Controller.msg', Mock(return_value = None)): - get_version_mock.return_value = stem.version.Version('0.2.5.2') - self.controller.drop_guards() - def _emit_event(self, event): # Spins up our Controller's thread pool, emits an event, then shuts it # down. This last part is important for a couple reasons...

1 0

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

10 Feb '20

commit 5d37fd35c7e8916a39b064a01c837f365e5e87b9 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 8 14:00:46 2020 -0800 Drop legacy compression enumeration --- stem/descriptor/__init__.py | 15 ++++++++++ stem/descriptor/remote.py | 71 +++++++++------------------------------------ 2 files changed, 28 insertions(+), 58 deletions(-) diff --git a/stem/descriptor/__init__.py b/stem/descriptor/__init__.py index 11fff944..0b9e2056 100644 --- a/stem/descriptor/__init__.py +++ b/stem/descriptor/__init__.py @@ -25,6 +25,21 @@ Package for parsing and processing descriptor data. |- get_unrecognized_lines - unparsed descriptor content +- __str__ - string that the descriptor was made from +.. data:: Compression (enum) + + Compression when downloading descriptors. + + .. versionadded:: 1.7.0 + + =============== =========== + Compression Description + =============== =========== + **PLAINTEXT** Uncompressed data. + **GZIP** `GZip compression <https://www.gnu.org/software/gzip/>`_. + **ZSTD** `Zstandard compression <https://www.zstd.net>`_, this requires the `zstandard module <https://pypi.org/project/zstandard/>`_. + **LZMA** `LZMA compression <https://en.wikipedia.org/wiki/LZMA>`_, this requires the 'lzma module <https://docs.python.org/3/library/lzma.html>`_. + =============== =========== + .. data:: DigestHash (enum) .. versionadded:: 1.8.0 diff --git a/stem/descriptor/remote.py b/stem/descriptor/remote.py index d650c226..be633862 100644 --- a/stem/descriptor/remote.py +++ b/stem/descriptor/remote.py @@ -81,21 +81,6 @@ content. For example... Maximum number of microdescriptors that can requested at a time by their hashes. - -.. data:: Compression (enum) - - Compression when downloading descriptors. - - .. versionadded:: 1.7.0 - - =============== =========== - Compression Description - =============== =========== - **PLAINTEXT** Uncompressed data. - **GZIP** `GZip compression <https://www.gnu.org/software/gzip/>`_. - **ZSTD** `Zstandard compression <https://www.zstd.net>`_, this requires the `zstandard module <https://pypi.org/project/zstandard/>`_. - **LZMA** `LZMA compression <https://en.wikipedia.org/wiki/LZMA>`_, this requires the 'lzma module <https://docs.python.org/3/library/lzma.html>`_. - =============== =========== """ import io @@ -115,24 +100,9 @@ import stem.prereq import stem.util.enum import stem.util.tor_tools +from stem.descriptor import Compression from stem.util import log, str_tools -# TODO: remove in stem 2.x, replaced with stem.descriptor.Compression - -Compression = stem.util.enum.Enum( - ('PLAINTEXT', 'identity'), - ('GZIP', 'gzip'), # can also be 'deflate' - ('ZSTD', 'x-zstd'), - ('LZMA', 'x-tor-lzma'), -) - -COMPRESSION_MIGRATION = { - 'identity': stem.descriptor.Compression.PLAINTEXT, - 'gzip': stem.descriptor.Compression.GZIP, - 'x-zstd': stem.descriptor.Compression.ZSTD, - 'x-tor-lzma': stem.descriptor.Compression.LZMA, -} - # Tor has a limited number of descriptors we can fetch explicitly by their # fingerprint or hashes due to a limit on the url length by squid proxies. @@ -364,8 +334,7 @@ class Query(object): .. versionchanged:: 1.8.0 Using :class:`~stem.descriptor.__init__.Compression` for our compression - argument, usage of strings or this module's Compression enum is deprecated - and will be removed in stem 2.x. + argument. :var str resource: resource being fetched, such as '/tor/server/all' :var str descriptor_type: type of descriptors being fetched (for options see @@ -417,33 +386,19 @@ class Query(object): if resource.endswith('.z'): compression = [Compression.GZIP] resource = resource[:-2] - elif not compression: - compression = [Compression.PLAINTEXT] - else: - if isinstance(compression, str): - compression = [compression] # caller provided only a single option - - if Compression.ZSTD in compression and not stem.prereq.is_zstd_available(): - compression.remove(Compression.ZSTD) - - if Compression.LZMA in compression and not stem.prereq.is_lzma_available(): - compression.remove(Compression.LZMA) + elif isinstance(compression, tuple): + compression = list(compression) + elif not isinstance(compression, list): + compression = [compression] # caller provided only a single option - if not compression: - compression = [Compression.PLAINTEXT] + if Compression.ZSTD in compression and not stem.prereq.is_zstd_available(): + compression.remove(Compression.ZSTD) - # TODO: Normalize from our old compression enum to - # stem.descriptor.Compression. This will get removed in Stem 2.x. + if Compression.LZMA in compression and not stem.prereq.is_lzma_available(): + compression.remove(Compression.LZMA) - new_compression = [] - - for legacy_compression in compression: - if isinstance(legacy_compression, stem.descriptor._Compression): - new_compression.append(legacy_compression) - elif legacy_compression in COMPRESSION_MIGRATION: - new_compression.append(COMPRESSION_MIGRATION[legacy_compression]) - else: - raise ValueError("'%s' (%s) is not a recognized type of compression" % (legacy_compression, type(legacy_compression).__name__)) + if not compression: + compression = [Compression.PLAINTEXT] if descriptor_type: self.descriptor_type = descriptor_type @@ -460,7 +415,7 @@ class Query(object): raise ValueError("Endpoints must be an stem.ORPort or stem.DirPort. '%s' is a %s." % (endpoint, type(endpoint).__name__)) self.resource = resource - self.compression = new_compression + self.compression = compression self.retries = retries self.fall_back_to_authority = fall_back_to_authority

1 0

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

10 Feb '20

commit 27cf44b8825d0148ef98a60c2282619065e369ca Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 8 13:24:54 2020 -0800 Drop hidden service introduction_points_auth This attribute was never implemented within tor. --- stem/descriptor/hidden_service.py | 5 ----- test/unit/descriptor/hidden_service_v2.py | 7 ------- 2 files changed, 12 deletions(-) diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py index 6fa43521..ed455fd1 100644 --- a/stem/descriptor/hidden_service.py +++ b/stem/descriptor/hidden_service.py @@ -551,7 +551,6 @@ def _parse_introduction_points_line(descriptor, entries): raise ValueError("'introduction-points' should be followed by a MESSAGE block, but was a %s" % block_type) descriptor.introduction_points_encoded = block_contents - descriptor.introduction_points_auth = [] # field was never implemented in tor (#15190) try: descriptor.introduction_points_content = _bytes_for_block(block_contents) @@ -646,9 +645,6 @@ class HiddenServiceDescriptorV2(BaseHiddenServiceDescriptor): :var datetime published: **\\*** time in UTC when this descriptor was made :var list protocol_versions: **\\*** list of **int** versions that are supported when establishing a connection :var str introduction_points_encoded: raw introduction points blob - :var list introduction_points_auth: **\\*** tuples of the form - (auth_method, auth_data) for our introduction_points_content - (**deprecated**, always **[]**) :var bytes introduction_points_content: decoded introduction-points content without authentication data, if using cookie authentication this is encrypted @@ -676,7 +672,6 @@ class HiddenServiceDescriptorV2(BaseHiddenServiceDescriptor): 'published': (None, _parse_publication_time_line), 'protocol_versions': ([], _parse_protocol_versions_line), 'introduction_points_encoded': (None, _parse_introduction_points_line), - 'introduction_points_auth': ([], _parse_introduction_points_line), 'introduction_points_content': (None, _parse_introduction_points_line), 'signature': (None, _parse_v2_signature_line), } diff --git a/test/unit/descriptor/hidden_service_v2.py b/test/unit/descriptor/hidden_service_v2.py index 5191775e..fd90f693 100644 --- a/test/unit/descriptor/hidden_service_v2.py +++ b/test/unit/descriptor/hidden_service_v2.py @@ -296,7 +296,6 @@ class TestHiddenServiceDescriptorV2(unittest.TestCase): self.assertEqual(datetime.datetime(2015, 2, 24, 20, 0, 0), desc.published) self.assertEqual([2, 3], desc.protocol_versions) self.assertEqual(EXPECTED_BASIC_AUTH_INTRODUCTION_POINTS_ENCODED, desc.introduction_points_encoded) - self.assertEqual([], desc.introduction_points_auth) self.assertRaises(DecryptionFailure, desc.introduction_points) self.assertRaises(DecryptionFailure, desc.introduction_points, 'aCmx3qIvArbil8A0KM4KgQ==') @@ -342,7 +341,6 @@ class TestHiddenServiceDescriptorV2(unittest.TestCase): self.assertEqual('jczvydhzetbpdiylj3d5nsnjvaigs7xm', desc.secret_id_part) self.assertEqual(datetime.datetime(2015, 2, 24, 20, 0, 0), desc.published) self.assertEqual([2, 3], desc.protocol_versions) - self.assertEqual([], desc.introduction_points_auth) self.assertRaises(DecryptionFailure, desc.introduction_points) self.assertRaises(DecryptionFailure, desc.introduction_points, 'aCmx3qIvArbil8A0KM4KgQ==') @@ -382,7 +380,6 @@ class TestHiddenServiceDescriptorV2(unittest.TestCase): self.assertEqual(datetime.datetime(2015, 2, 23, 20, 0, 0), desc.published) self.assertEqual([2, 3], desc.protocol_versions) self.assertEqual(EXPECTED_DDG_INTRODUCTION_POINTS_ENCODED, desc.introduction_points_encoded) - self.assertEqual([], desc.introduction_points_auth) self.assertEqual(EXPECTED_DDG_INTRODUCTION_POINTS_CONTENT, desc.introduction_points_content) self.assertEqual(EXPECTED_DDG_SIGNATURE, desc.signature) @@ -425,7 +422,6 @@ class TestHiddenServiceDescriptorV2(unittest.TestCase): self.assertEqual('e24kgecavwsznj7gpbktqsiwgvngsf4e', desc.secret_id_part) self.assertEqual([2, 3], desc.protocol_versions) self.assertEqual('-----BEGIN MESSAGE-----\n-----END MESSAGE-----', desc.introduction_points_encoded) - self.assertEqual([], desc.introduction_points_auth) self.assertEqual(b'', desc.introduction_points_content) self.assertEqual([], desc.introduction_points()) self.assertEqual('@type hidden-service-descriptor 1.0', str(desc.type_annotation())) @@ -517,14 +513,12 @@ class TestHiddenServiceDescriptorV2(unittest.TestCase): missing_field_desc = HiddenServiceDescriptorV2.create(exclude = ('introduction-points',)) self.assertEqual(None, missing_field_desc.introduction_points_encoded) - self.assertEqual([], missing_field_desc.introduction_points_auth) self.assertEqual(None, missing_field_desc.introduction_points_content) self.assertEqual([], missing_field_desc.introduction_points()) empty_field_desc = HiddenServiceDescriptorV2.create({'introduction-points': MESSAGE_BLOCK % ''}) self.assertEqual((MESSAGE_BLOCK % '').strip(), empty_field_desc.introduction_points_encoded) - self.assertEqual([], empty_field_desc.introduction_points_auth) self.assertEqual(b'', empty_field_desc.introduction_points_content) self.assertEqual([], empty_field_desc.introduction_points()) @@ -540,6 +534,5 @@ class TestHiddenServiceDescriptorV2(unittest.TestCase): for test_value in test_values: desc = expect_invalid_attr(self, {'introduction-points': test_value}, 'introduction_points_encoded', test_value.strip()) - self.assertEqual([], desc.introduction_points_auth) self.assertEqual(None, desc.introduction_points_content) self.assertEqual([], desc.introduction_points())

1 0