tor-commits August 2019

tor-commits@lists.torproject.org

19 participants
2737 discussions

[stem/master] Parse signing certificate field
by atagar＠torproject.org 25 Aug '19

25 Aug '19

commit 2a98ba70f1e8a0ba7b3e0b1141ad69cfec98fba5 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 24 15:37:43 2019 -0700 Parse signing certificate field --- stem/descriptor/hidden_service.py | 10 +++++++--- test/unit/descriptor/hidden_service_v3.py | 9 +++++++++ 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py index 4af40d46..84b8d5e7 100644 --- a/stem/descriptor/hidden_service.py +++ b/stem/descriptor/hidden_service.py @@ -183,7 +183,8 @@ _parse_publication_time_line = _parse_timestamp_line('publication-time', 'publis _parse_signature_line = _parse_key_block('signature', 'signature', 'SIGNATURE') _parse_v3_version_line = _parse_int_line('hs-descriptor', 'version', allow_negative = False) -_parse_lifetime = _parse_int_line('descriptor-lifetime', 'lifetime', allow_negative = False) +_parse_lifetime_line = _parse_int_line('descriptor-lifetime', 'lifetime', allow_negative = False) +_parse_signing_key_line = _parse_key_block('descriptor-signing-key-cert', 'signing_cert', 'ED25519 CERT') class BaseHiddenServiceDescriptor(Descriptor): @@ -462,6 +463,7 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): :var int version: **\\*** hidden service descriptor version :var int lifetime: **\\*** minutes after publication this descriptor is valid + :var str signing_cert: **\\*** cross-certifier for the short-term descriptor signing key **\\*** attribute is either required when we're parsed with validation or has a default value, others are left as **None** if undefined @@ -473,12 +475,14 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): ATTRIBUTES = { 'version': (None, _parse_v3_version_line), - 'lifetime': (None, _parse_lifetime), + 'lifetime': (None, _parse_lifetime_line), + 'signing_cert': (None, _parse_signing_key_line), } PARSER_FOR_LINE = { 'hs-descriptor': _parse_v3_version_line, - 'descriptor-lifetime': _parse_lifetime, + 'descriptor-lifetime': _parse_lifetime_line, + 'descriptor-signing-key-cert': _parse_signing_key_line, } @classmethod diff --git a/test/unit/descriptor/hidden_service_v3.py b/test/unit/descriptor/hidden_service_v3.py index b7a23c86..07a8e32c 100644 --- a/test/unit/descriptor/hidden_service_v3.py +++ b/test/unit/descriptor/hidden_service_v3.py @@ -16,6 +16,14 @@ from test.unit.descriptor import ( expect_invalid_attr = functools.partial(base_expect_invalid_attr, HiddenServiceDescriptorV3, 'version', 3) +EXPECTED_SIGNING_CERT = """\ +-----BEGIN ED25519 CERT----- +AQgABqKwAQVql1QZETyEwJjg+Cv6f2w/cp+c3juj01NPBaJqihboAQAgBACx+FKK +oDrFE1+ztSxzN8sApKOb5UuDtoe/E03DxZU5+r/K5AV6G0hYn21V7Xbu2pZHvIkT +2oVY4hypWNJE58eFBRFRzBA0J2h0GyFs1pIuRh5QDJuxB5j92V0aRCNZFgM= +-----END ED25519 CERT-----\ +""" + class TestHiddenServiceDescriptorV3(unittest.TestCase): def test_for_riseup(self): @@ -30,6 +38,7 @@ class TestHiddenServiceDescriptorV3(unittest.TestCase): self.assertEqual(3, desc.version) self.assertEqual(180, desc.lifetime) + self.assertEqual(EXPECTED_SIGNING_CERT, desc.signing_cert) def test_invalid_version(self): """

1 0

[stem/master] Helper for parsing integer lines
by atagar＠torproject.org 25 Aug '19

25 Aug '19

commit 546c18a0fc96ab04a7302cd925d1968e10af0a75 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 24 15:28:33 2019 -0700 Helper for parsing integer lines We've done this in quite a few spots, so time for a helper. --- stem/descriptor/__init__.py | 17 +++++++++++++++ stem/descriptor/extrainfo_descriptor.py | 15 ++----------- stem/descriptor/hidden_service.py | 38 ++++++++------------------------- stem/descriptor/server_descriptor.py | 34 ++++++++++++----------------- 4 files changed, 42 insertions(+), 62 deletions(-) diff --git a/stem/descriptor/__init__.py b/stem/descriptor/__init__.py index 1b5e53bc..3a3d1838 100644 --- a/stem/descriptor/__init__.py +++ b/stem/descriptor/__init__.py @@ -657,6 +657,23 @@ def _parse_bytes_line(keyword, attribute): return _parse +def _parse_int_line(keyword, attribute, allow_negative = True): + def _parse(descriptor, entries): + value = _value(keyword, entries) + + try: + int_val = int(value) + except ValueError: + raise ValueError('%s must have a numeric value: %s' % (keyword, value)) + + if not allow_negative and int_val < 0: + raise ValueError('%s must have a positive value: %s' % (keyword, value)) + + setattr(descriptor, attribute, int_val) + + return _parse + + def _parse_timestamp_line(keyword, attribute): # "<keyword>" YYYY-MM-DD HH:MM:SS diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index 82e3154f..d55b8eef 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -88,6 +88,7 @@ from stem.descriptor import ( _value, _values, _parse_simple_line, + _parse_int_line, _parse_timestamp_line, _parse_forty_character_hex, _parse_key_block, @@ -306,19 +307,6 @@ def _parse_transport_line(descriptor, entries): descriptor.transport = transports -def _parse_cell_circuits_per_decline_line(descriptor, entries): - # "cell-circuits-per-decile" num - - value = _value('cell-circuits-per-decile', entries) - - if not value.isdigit(): - raise ValueError('Non-numeric cell-circuits-per-decile value: %s' % value) - elif int(value) < 0: - raise ValueError('Negative cell-circuits-per-decile value: %s' % value) - - descriptor.cell_circuits_per_decile = int(value) - - def _parse_padding_counts_line(descriptor, entries): # "padding-counts" YYYY-MM-DD HH:MM:SS (NSEC s) key=val key=val... @@ -538,6 +526,7 @@ _parse_dirreq_v3_share_line = functools.partial(_parse_dirreq_share_line, 'dirre _parse_cell_processed_cells_line = functools.partial(_parse_cell_line, 'cell-processed-cells', 'cell_processed_cells') _parse_cell_queued_cells_line = functools.partial(_parse_cell_line, 'cell-queued-cells', 'cell_queued_cells') _parse_cell_time_in_queue_line = functools.partial(_parse_cell_line, 'cell-time-in-queue', 'cell_time_in_queue') +_parse_cell_circuits_per_decline_line = _parse_int_line('cell-circuits-per-decile', 'cell_circuits_per_decile', allow_negative = False) _parse_published_line = _parse_timestamp_line('published', 'published') _parse_geoip_start_time_line = _parse_timestamp_line('geoip-start-time', 'geoip_start_time') _parse_cell_stats_end_line = functools.partial(_parse_timestamp_and_interval_line, 'cell-stats-end', 'cell_stats_end', 'cell_stats_interval') diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py index 44bf114b..4af40d46 100644 --- a/stem/descriptor/hidden_service.py +++ b/stem/descriptor/hidden_service.py @@ -42,6 +42,7 @@ from stem.descriptor import ( _bytes_for_block, _value, _parse_simple_line, + _parse_int_line, _parse_timestamp_line, _parse_key_block, _random_date, @@ -144,31 +145,6 @@ def _parse_file(descriptor_file, desc_type = None, validate = False, **kwargs): break # done parsing file -def _parse_version_line(descriptor, entries): - if isinstance(descriptor, HiddenServiceDescriptorV2): - keyword = 'version' - elif isinstance(descriptor, HiddenServiceDescriptorV3): - keyword = 'hs-descriptor' - else: - raise ValueError('BUG: unexpected descriptor type (%s)' % type(descriptor).__name__) - - value = _value(keyword, entries) - - if value.isdigit(): - descriptor.version = int(value) - else: - raise ValueError('%s line must have a positive integer value: %s' % (keyword, value)) - - -def _parse_lifetime(descriptor, entries): - value = _value('descriptor-lifetime', entries) - - if value.isdigit(): - descriptor.lifetime = int(value) - else: - raise ValueError('descriptor-lifetime line must have a positive integer value: %s' % value) - - def _parse_protocol_versions_line(descriptor, entries): value = _value('protocol-versions', entries) @@ -199,12 +175,16 @@ def _parse_introduction_points_line(descriptor, entries): raise ValueError("'introduction-points' isn't base64 encoded content:\n%s" % block_contents) +_parse_v2_version_line = _parse_int_line('version', 'version', allow_negative = False) _parse_rendezvous_service_descriptor_line = _parse_simple_line('rendezvous-service-descriptor', 'descriptor_id') _parse_permanent_key_line = _parse_key_block('permanent-key', 'permanent_key', 'RSA PUBLIC KEY') _parse_secret_id_part_line = _parse_simple_line('secret-id-part', 'secret_id_part') _parse_publication_time_line = _parse_timestamp_line('publication-time', 'published') _parse_signature_line = _parse_key_block('signature', 'signature', 'SIGNATURE') +_parse_v3_version_line = _parse_int_line('hs-descriptor', 'version', allow_negative = False) +_parse_lifetime = _parse_int_line('descriptor-lifetime', 'lifetime', allow_negative = False) + class BaseHiddenServiceDescriptor(Descriptor): """ @@ -252,7 +232,7 @@ class HiddenServiceDescriptorV2(BaseHiddenServiceDescriptor): ATTRIBUTES = { 'descriptor_id': (None, _parse_rendezvous_service_descriptor_line), - 'version': (None, _parse_version_line), + 'version': (None, _parse_v2_version_line), 'permanent_key': (None, _parse_permanent_key_line), 'secret_id_part': (None, _parse_secret_id_part_line), 'published': (None, _parse_publication_time_line), @@ -265,7 +245,7 @@ class HiddenServiceDescriptorV2(BaseHiddenServiceDescriptor): PARSER_FOR_LINE = { 'rendezvous-service-descriptor': _parse_rendezvous_service_descriptor_line, - 'version': _parse_version_line, + 'version': _parse_v2_version_line, 'permanent-key': _parse_permanent_key_line, 'secret-id-part': _parse_secret_id_part_line, 'publication-time': _parse_publication_time_line, @@ -492,12 +472,12 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): TYPE_ANNOTATION_NAME = 'hidden-service-descriptor-3' ATTRIBUTES = { - 'version': (None, _parse_version_line), + 'version': (None, _parse_v3_version_line), 'lifetime': (None, _parse_lifetime), } PARSER_FOR_LINE = { - 'hs-descriptor': _parse_version_line, + 'hs-descriptor': _parse_v3_version_line, 'descriptor-lifetime': _parse_lifetime, } diff --git a/stem/descriptor/server_descriptor.py b/stem/descriptor/server_descriptor.py index 85e35f57..7eaf6e93 100644 --- a/stem/descriptor/server_descriptor.py +++ b/stem/descriptor/server_descriptor.py @@ -78,6 +78,7 @@ from stem.descriptor import ( _value, _values, _parse_simple_line, + _parse_int_line, _parse_if_present, _parse_bytes_line, _parse_timestamp_line, @@ -337,26 +338,6 @@ def _parse_hibernating_line(descriptor, entries): descriptor.hibernating = value == '1' -def _parse_uptime_line(descriptor, entries): - # We need to be tolerant of negative uptimes to accommodate a past tor - # bug... - # - # Changes in version 0.1.2.7-alpha - 2007-02-06 - # - If our system clock jumps back in time, don't publish a negative - # uptime in the descriptor. Also, don't let the global rate limiting - # buckets go absurdly negative. - # - # After parsing all of the attributes we'll double check that negative - # uptimes only occurred prior to this fix. - - value = _value('uptime', entries) - - try: - descriptor.uptime = int(value) - except ValueError: - raise ValueError('Uptime line must have an integer value: %s' % value) - - def _parse_protocols_line(descriptor, entries): value = _value('protocols', entries) protocols_match = re.match('^Link (.*) Circuit (.*)$', value) @@ -454,6 +435,19 @@ _parse_router_sig_ed25519_line = _parse_simple_line('router-sig-ed25519', 'ed255 _parse_router_digest_sha256_line = _parse_simple_line('router-digest-sha256', 'router_digest_sha256') _parse_router_digest_line = _parse_forty_character_hex('router-digest', '_digest') +# TODO: We need to be tolerant of negative uptimes to accommodate a past tor +# bug... +# +# Changes in version 0.1.2.7-alpha - 2007-02-06 +# - If our system clock jumps back in time, don't publish a negative +# uptime in the descriptor. Also, don't let the global rate limiting +# buckets go absurdly negative. +# +# After parsing all of the attributes we'll double check that negative +# uptimes only occurred prior to this fix. + +_parse_uptime_line = _parse_int_line('uptime', 'uptime', allow_negative = True) + class ServerDescriptor(Descriptor): """

1 0

[stem/master] Parse signature field
by atagar＠torproject.org 25 Aug '19

25 Aug '19

commit 6b16f966b1f7d617e396cd9357cfc6766bf3dc78 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 24 16:10:56 2019 -0700 Parse signature field --- stem/descriptor/hidden_service.py | 12 ++++++++---- test/unit/descriptor/hidden_service_v3.py | 1 + 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py index 48cfa807..1ab450fd 100644 --- a/stem/descriptor/hidden_service.py +++ b/stem/descriptor/hidden_service.py @@ -130,7 +130,7 @@ def _parse_file(descriptor_file, desc_type = None, validate = False, **kwargs): # block following it. while True: - descriptor_content = _read_until_keywords('signature', descriptor_file) + descriptor_content = _read_until_keywords('signature', descriptor_file, True) if desc_type == HiddenServiceDescriptorV2: block_end_prefix = PGP_BLOCK_END.split(' ', 1)[0] @@ -180,13 +180,14 @@ _parse_rendezvous_service_descriptor_line = _parse_simple_line('rendezvous-servi _parse_permanent_key_line = _parse_key_block('permanent-key', 'permanent_key', 'RSA PUBLIC KEY') _parse_secret_id_part_line = _parse_simple_line('secret-id-part', 'secret_id_part') _parse_publication_time_line = _parse_timestamp_line('publication-time', 'published') -_parse_signature_line = _parse_key_block('signature', 'signature', 'SIGNATURE') +_parse_v2_signature_line = _parse_key_block('signature', 'signature', 'SIGNATURE') _parse_v3_version_line = _parse_int_line('hs-descriptor', 'version', allow_negative = False) _parse_lifetime_line = _parse_int_line('descriptor-lifetime', 'lifetime', allow_negative = False) _parse_signing_key_line = _parse_key_block('descriptor-signing-key-cert', 'signing_cert', 'ED25519 CERT') _parse_revision_counter_line = _parse_int_line('revision-counter', 'revision_counter', allow_negative = False) _parse_superencrypted_line = _parse_key_block('superencrypted', 'superencrypted', 'MESSAGE') +_parse_v3_signature_line = _parse_simple_line('signature', 'signature') class BaseHiddenServiceDescriptor(Descriptor): @@ -243,7 +244,7 @@ class HiddenServiceDescriptorV2(BaseHiddenServiceDescriptor): '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_signature_line), + 'signature': (None, _parse_v2_signature_line), } PARSER_FOR_LINE = { @@ -254,7 +255,7 @@ class HiddenServiceDescriptorV2(BaseHiddenServiceDescriptor): 'publication-time': _parse_publication_time_line, 'protocol-versions': _parse_protocol_versions_line, 'introduction-points': _parse_introduction_points_line, - 'signature': _parse_signature_line, + 'signature': _parse_v2_signature_line, } @classmethod @@ -468,6 +469,7 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): :var str signing_cert: **\\*** cross-certifier for the short-term descriptor signing key :var int revision_counter: **\\*** descriptor revision number :var str superencrypted: **\\*** encrypted HS-DESC-ENC payload + :var str signature: **\\*** signature of this descriptor **\\*** attribute is either required when we're parsed with validation or has a default value, others are left as **None** if undefined @@ -483,6 +485,7 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): 'signing_cert': (None, _parse_signing_key_line), 'revision_counter': (None, _parse_revision_counter_line), 'superencrypted': (None, _parse_superencrypted_line), + 'signature': (None, _parse_v3_signature_line), } PARSER_FOR_LINE = { @@ -491,6 +494,7 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): 'descriptor-signing-key-cert': _parse_signing_key_line, 'revision-counter': _parse_revision_counter_line, 'superencrypted': _parse_superencrypted_line, + 'signature': _parse_v3_signature_line, } @classmethod diff --git a/test/unit/descriptor/hidden_service_v3.py b/test/unit/descriptor/hidden_service_v3.py index ea7d40c9..d441c8cc 100644 --- a/test/unit/descriptor/hidden_service_v3.py +++ b/test/unit/descriptor/hidden_service_v3.py @@ -41,6 +41,7 @@ class TestHiddenServiceDescriptorV3(unittest.TestCase): self.assertEqual(EXPECTED_SIGNING_CERT, desc.signing_cert) self.assertEqual(15, desc.revision_counter) self.assertTrue('k9uKnDpxhkH0h1h' in desc.superencrypted) + self.assertEqual('wdc7ffr+dPZJ/mIQ1l4WYqNABcmsm6SHW/NL3M3wG7bjjqOJWoPR5TimUXxH52n5Zk0Gc7hl/hz3YYmAx5MvAg', desc.signature) def test_invalid_version(self): """

1 0

[stem/master] Parse revision counter field
by atagar＠torproject.org 25 Aug '19

25 Aug '19

commit e4f364941e89821ab8953698c28c3276d4f76cea Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 24 15:43:24 2019 -0700 Parse revision counter field --- stem/descriptor/hidden_service.py | 4 ++++ test/unit/descriptor/hidden_service_v3.py | 15 +++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py index 84b8d5e7..5336b1bd 100644 --- a/stem/descriptor/hidden_service.py +++ b/stem/descriptor/hidden_service.py @@ -185,6 +185,7 @@ _parse_signature_line = _parse_key_block('signature', 'signature', 'SIGNATURE') _parse_v3_version_line = _parse_int_line('hs-descriptor', 'version', allow_negative = False) _parse_lifetime_line = _parse_int_line('descriptor-lifetime', 'lifetime', allow_negative = False) _parse_signing_key_line = _parse_key_block('descriptor-signing-key-cert', 'signing_cert', 'ED25519 CERT') +_parse_revision_counter_line = _parse_int_line('revision-counter', 'revision_counter', allow_negative = False) class BaseHiddenServiceDescriptor(Descriptor): @@ -464,6 +465,7 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): :var int version: **\\*** hidden service descriptor version :var int lifetime: **\\*** minutes after publication this descriptor is valid :var str signing_cert: **\\*** cross-certifier for the short-term descriptor signing key + :var int revision_counter: **\\*** descriptor revision number **\\*** attribute is either required when we're parsed with validation or has a default value, others are left as **None** if undefined @@ -477,12 +479,14 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): 'version': (None, _parse_v3_version_line), 'lifetime': (None, _parse_lifetime_line), 'signing_cert': (None, _parse_signing_key_line), + 'revision_counter': (None, _parse_revision_counter_line), } PARSER_FOR_LINE = { 'hs-descriptor': _parse_v3_version_line, 'descriptor-lifetime': _parse_lifetime_line, 'descriptor-signing-key-cert': _parse_signing_key_line, + 'revision-counter': _parse_revision_counter_line, } @classmethod diff --git a/test/unit/descriptor/hidden_service_v3.py b/test/unit/descriptor/hidden_service_v3.py index 07a8e32c..5a5f53d4 100644 --- a/test/unit/descriptor/hidden_service_v3.py +++ b/test/unit/descriptor/hidden_service_v3.py @@ -39,6 +39,7 @@ class TestHiddenServiceDescriptorV3(unittest.TestCase): self.assertEqual(3, desc.version) self.assertEqual(180, desc.lifetime) self.assertEqual(EXPECTED_SIGNING_CERT, desc.signing_cert) + self.assertEqual(15, desc.revision_counter) def test_invalid_version(self): """ @@ -67,3 +68,17 @@ class TestHiddenServiceDescriptorV3(unittest.TestCase): for test_value in test_values: expect_invalid_attr(self, {'descriptor-lifetime': test_value}, 'lifetime') + + def test_invalid_revision_counter(self): + """ + Checks that our revision counter field expects a numeric value. + """ + + test_values = ( + '', + '-10', + 'hello', + ) + + for test_value in test_values: + expect_invalid_attr(self, {'revision-counter': test_value}, 'revision_counter')

1 0

[stem/master] Parse superencrypted field
by atagar＠torproject.org 25 Aug '19

25 Aug '19

commit 431883878bf26fe31f03ea5d5916038c199d7f3e Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 24 15:54:09 2019 -0700 Parse superencrypted field --- stem/descriptor/hidden_service.py | 4 ++++ test/unit/descriptor/hidden_service_v3.py | 1 + 2 files changed, 5 insertions(+) diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py index 5336b1bd..48cfa807 100644 --- a/stem/descriptor/hidden_service.py +++ b/stem/descriptor/hidden_service.py @@ -186,6 +186,7 @@ _parse_v3_version_line = _parse_int_line('hs-descriptor', 'version', allow_negat _parse_lifetime_line = _parse_int_line('descriptor-lifetime', 'lifetime', allow_negative = False) _parse_signing_key_line = _parse_key_block('descriptor-signing-key-cert', 'signing_cert', 'ED25519 CERT') _parse_revision_counter_line = _parse_int_line('revision-counter', 'revision_counter', allow_negative = False) +_parse_superencrypted_line = _parse_key_block('superencrypted', 'superencrypted', 'MESSAGE') class BaseHiddenServiceDescriptor(Descriptor): @@ -466,6 +467,7 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): :var int lifetime: **\\*** minutes after publication this descriptor is valid :var str signing_cert: **\\*** cross-certifier for the short-term descriptor signing key :var int revision_counter: **\\*** descriptor revision number + :var str superencrypted: **\\*** encrypted HS-DESC-ENC payload **\\*** attribute is either required when we're parsed with validation or has a default value, others are left as **None** if undefined @@ -480,6 +482,7 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): 'lifetime': (None, _parse_lifetime_line), 'signing_cert': (None, _parse_signing_key_line), 'revision_counter': (None, _parse_revision_counter_line), + 'superencrypted': (None, _parse_superencrypted_line), } PARSER_FOR_LINE = { @@ -487,6 +490,7 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): 'descriptor-lifetime': _parse_lifetime_line, 'descriptor-signing-key-cert': _parse_signing_key_line, 'revision-counter': _parse_revision_counter_line, + 'superencrypted': _parse_superencrypted_line, } @classmethod diff --git a/test/unit/descriptor/hidden_service_v3.py b/test/unit/descriptor/hidden_service_v3.py index 5a5f53d4..ea7d40c9 100644 --- a/test/unit/descriptor/hidden_service_v3.py +++ b/test/unit/descriptor/hidden_service_v3.py @@ -40,6 +40,7 @@ class TestHiddenServiceDescriptorV3(unittest.TestCase): self.assertEqual(180, desc.lifetime) self.assertEqual(EXPECTED_SIGNING_CERT, desc.signing_cert) self.assertEqual(15, desc.revision_counter) + self.assertTrue('k9uKnDpxhkH0h1h' in desc.superencrypted) def test_invalid_version(self): """

1 0

[stem/master] Validate mandatory fields are present
by atagar＠torproject.org 25 Aug '19

25 Aug '19

commit 5b1fc94f6cb6719ff9bc2ab2c3c5620ac158d08b Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 24 16:21:24 2019 -0700 Validate mandatory fields are present --- docs/change_log.rst | 3 ++- docs/contents.rst | 1 + docs/tutorials/mirror_mirror_on_the_wall.rst | 2 +- stem/descriptor/hidden_service.py | 32 +++++++++++++++++++++++----- test/unit/descriptor/hidden_service_v2.py | 4 ++-- test/unit/descriptor/hidden_service_v3.py | 25 +++++++++++++++++++++- 6 files changed, 57 insertions(+), 10 deletions(-) diff --git a/docs/change_log.rst b/docs/change_log.rst index d9c6bfa3..c5b5051e 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -60,6 +60,7 @@ The following are only available within Stem's `git repository * **Descriptors** * Added the `stem.descriptor.collector <api/descriptor/collector.html>`_ module (:trac:`17979`) + * Added `v3 hidden service descriptor support <api/descriptor/hidden_service.html>`_ (:trac:`31369`) * `Bandwidth file support <api/descriptor/bandwidth_file.html>`_ (:trac:`29056`) * `stem.descriptor.remote <api/descriptor/remote.html>`_ methods now raise :class:`stem.DownloadFailed` * Check Ed25519 validity though the cryptography module rather than PyNaCl (:trac:`22022`) @@ -364,7 +365,7 @@ And last, Stem also now runs directly under both python2 and python3 without a * **Descriptors** * Lazy-loading descriptors, improving performance by 25-70% depending on what type it is (:trac:`14011`) - * Added `support for hidden service descriptors <api/descriptor/hidden_service_descriptor.html>`_ (:trac:`15004`) + * Added `support for hidden service descriptors <api/descriptor/hidden_service.html>`_ (:trac:`15004`) * When reading sanitised bridge descriptors (server or extrainfo), :func:`~stem.descriptor.__init__.parse_file` treated the whole file as a single descriptor * The :class:`~stem.descriptor.networkstatus.DirectoryAuthority` 'fingerprint' attribute was actually its 'v3ident' * Added consensus' new package attribute (:spec:`ab64534`) diff --git a/docs/contents.rst b/docs/contents.rst index 98e80a5f..87e75220 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -14,6 +14,7 @@ Contents tutorials/down_the_rabbit_hole tutorials/double_double_toil_and_trouble + tutorials/examples/bandwidth_stats tutorials/examples/check_digests tutorials/examples/compare_flags tutorials/examples/download_descriptor diff --git a/docs/tutorials/mirror_mirror_on_the_wall.rst b/docs/tutorials/mirror_mirror_on_the_wall.rst index 699625e4..f16df19b 100644 --- a/docs/tutorials/mirror_mirror_on_the_wall.rst +++ b/docs/tutorials/mirror_mirror_on_the_wall.rst @@ -34,7 +34,7 @@ Descriptor Type `Microdescriptor <../api/descriptor/microdescriptor.html>`_ Minimalistic document that just includes the information necessary for Tor clients to work. `Network Status Document <../api/descriptor/networkstatus.html>`_ Though Tor relays are decentralized, the directories that track the overall network are not. These central points are called **directory authorities**, and every hour they publish a document called a **consensus** (aka, network status document). The consensus in turn is made up of **router status entries**. `Router Status Entry <../api/descriptor/router_status_entry.html>`_ Relay information provided by the directory authorities including flags, heuristics used for relay selection, etc. -`Hidden Service Descriptor <../api/descriptor/hidden_service.html>`_ Information pertaining to a `Hidden Service <https://www.torproject.org/docs/hidden-services.html.en>`_. These can only be `queried through the tor process <over_the_river.html#hidden-service-descriptors>`_. +`Hidden Service Descriptor <../api/descriptor/hidden_service.html>`_ Information pertaining to a `Hidden Service <https://www.torproject.org/docs/hidden-services.html.en>`_. These can only be `queried through the tor process <over_the_river.html#hidden-service-descriptors>`_. ================================================================================ =========== .. _where-do-descriptors-come-from: diff --git a/stem/descriptor/hidden_service.py b/stem/descriptor/hidden_service.py index 1ab450fd..52e1b0b1 100644 --- a/stem/descriptor/hidden_service.py +++ b/stem/descriptor/hidden_service.py @@ -2,15 +2,17 @@ # See LICENSE for licensing information """ -Parsing for Tor hidden service descriptors as described in Tor's `rend-spec -<https://gitweb.torproject.org/torspec.git/tree/rend-spec.txt>`_. +Parsing for Tor hidden service descriptors as described in Tor's `version 2 +<https://gitweb.torproject.org/torspec.git/tree/rend-spec-v2.txt>`_ and +`version 3 <https://gitweb.torproject.org/torspec.git/tree/rend-spec-v3.txt>`_ +rend-spec. Unlike other descriptor types these describe a hidden service rather than a relay. They're created by the service, and can only be fetched via relays with the HSDir flag. These are only available through the Controller's -:func:`~stem.control.get_hidden_service_descriptor` method. +:func:`~stem.control.Controller.get_hidden_service_descriptor` method. **Module Overview:** @@ -54,7 +56,7 @@ if stem.prereq._is_lru_cache_available(): else: from stem.util.lru_cache import lru_cache -REQUIRED_FIELDS = ( +REQUIRED_V2_FIELDS = ( 'rendezvous-service-descriptor', 'version', 'permanent-key', @@ -64,6 +66,15 @@ REQUIRED_FIELDS = ( 'signature', ) +REQUIRED_V3_FIELDS = ( + 'hs-descriptor', + 'descriptor-lifetime', + 'descriptor-signing-key-cert', + 'revision-counter', + 'superencrypted', + 'signature', +) + INTRODUCTION_POINTS_ATTR = { 'identifier': None, 'address': None, @@ -284,7 +295,7 @@ class HiddenServiceDescriptorV2(BaseHiddenServiceDescriptor): entries = _descriptor_components(raw_contents, validate, non_ascii_fields = ('introduction-points')) if validate: - for keyword in REQUIRED_FIELDS: + for keyword in REQUIRED_V2_FIELDS: if keyword not in entries: raise ValueError("Hidden service descriptor must have a '%s' entry" % keyword) elif keyword in entries and len(entries[keyword]) > 1: @@ -520,6 +531,17 @@ class HiddenServiceDescriptorV3(BaseHiddenServiceDescriptor): entries = _descriptor_components(raw_contents, validate) if validate: + for keyword in REQUIRED_V3_FIELDS: + if keyword not in entries: + raise ValueError("Hidden service descriptor must have a '%s' entry" % keyword) + elif keyword in entries and len(entries[keyword]) > 1: + raise ValueError("The '%s' entry can only appear once in a hidden service descriptor" % keyword) + + if 'hs-descriptor' != list(entries.keys())[0]: + raise ValueError("Hidden service descriptor must start with a 'hs-descriptor' entry") + elif 'signature' != list(entries.keys())[-1]: + raise ValueError("Hidden service descriptor must end with a 'signature' entry") + self._parse(entries, validate) else: self._entries = entries diff --git a/test/unit/descriptor/hidden_service_v2.py b/test/unit/descriptor/hidden_service_v2.py index ac64fa19..5191775e 100644 --- a/test/unit/descriptor/hidden_service_v2.py +++ b/test/unit/descriptor/hidden_service_v2.py @@ -11,7 +11,7 @@ import stem.prereq import test.require from stem.descriptor.hidden_service import ( - REQUIRED_FIELDS, + REQUIRED_V2_FIELDS, DecryptionFailure, HiddenServiceDescriptorV2, ) @@ -468,7 +468,7 @@ class TestHiddenServiceDescriptorV2(unittest.TestCase): 'signature': 'signature', } - for line in REQUIRED_FIELDS: + for line in REQUIRED_V2_FIELDS: desc_text = HiddenServiceDescriptorV2.content(exclude = (line,)) expected = [] if line == 'protocol-versions' else None diff --git a/test/unit/descriptor/hidden_service_v3.py b/test/unit/descriptor/hidden_service_v3.py index d441c8cc..f6407623 100644 --- a/test/unit/descriptor/hidden_service_v3.py +++ b/test/unit/descriptor/hidden_service_v3.py @@ -7,14 +7,19 @@ import unittest import stem.descriptor -from stem.descriptor.hidden_service import HiddenServiceDescriptorV3 +from stem.descriptor.hidden_service import ( + REQUIRED_V3_FIELDS, + HiddenServiceDescriptorV3, +) from test.unit.descriptor import ( get_resource, base_expect_invalid_attr, + base_expect_invalid_attr_for_text, ) expect_invalid_attr = functools.partial(base_expect_invalid_attr, HiddenServiceDescriptorV3, 'version', 3) +expect_invalid_attr_for_text = functools.partial(base_expect_invalid_attr_for_text, HiddenServiceDescriptorV3, 'version', 3) EXPECTED_SIGNING_CERT = """\ -----BEGIN ED25519 CERT----- @@ -43,6 +48,24 @@ class TestHiddenServiceDescriptorV3(unittest.TestCase): self.assertTrue('k9uKnDpxhkH0h1h' in desc.superencrypted) self.assertEqual('wdc7ffr+dPZJ/mIQ1l4WYqNABcmsm6SHW/NL3M3wG7bjjqOJWoPR5TimUXxH52n5Zk0Gc7hl/hz3YYmAx5MvAg', desc.signature) + def test_required_fields(self): + """ + Check that we require the mandatory fields. + """ + + line_to_attr = { + 'hs-descriptor': 'version', + 'descriptor-lifetime': 'lifetime', + 'descriptor-signing-key-cert': 'signing_cert', + 'revision-counter': 'revision_counter', + 'superencrypted': 'superencrypted', + 'signature': 'signature', + } + + for line in REQUIRED_V3_FIELDS: + desc_text = HiddenServiceDescriptorV3.content(exclude = (line,)) + expect_invalid_attr_for_text(self, desc_text, line_to_attr[line], None) + def test_invalid_version(self): """ Checks that our version field expects a numeric value.

1 0

[stem/master] Hidden service v3 descriptor support
by atagar＠torproject.org 25 Aug '19

25 Aug '19

commit 6790035c5756a8022e389f2cb95d2afb78d8c953 Merge: acfcc58b 5b1fc94f Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Aug 24 17:17:15 2019 -0700 Hidden service v3 descriptor support Support for the outer later of v3 hidden service descriptors... https://trac.torproject.org/projects/tor/ticket/31369 https://gitweb.torproject.org/torspec.git/tree/rend-spec-v3.txt#n1046 This does *not* include support for reading HS-DESC-ENC (superencrypted blobs) nor validating the signature. Patches welcome for both! docs/api.rst | 2 +- docs/api/descriptor/hidden_service.rst | 5 + docs/api/descriptor/hidden_service_descriptor.rst | 5 - docs/change_log.rst | 10 +- docs/contents.rst | 3 +- docs/tutorials/mirror_mirror_on_the_wall.rst | 2 +- docs/tutorials/over_the_river.rst | 2 +- stem/control.py | 2 +- stem/descriptor/__init__.py | 38 +- stem/descriptor/extrainfo_descriptor.py | 15 +- stem/descriptor/hidden_service.py | 552 +++++++++++++++++++++ stem/descriptor/hidden_service_descriptor.py | 446 +---------------- stem/descriptor/server_descriptor.py | 34 +- stem/response/events.py | 4 +- test/settings.cfg | 11 +- test/unit/descriptor/data/hidden_service_v3 | 223 +++++++++ ..._service_descriptor.py => hidden_service_v2.py} | 60 +-- test/unit/descriptor/hidden_service_v3.py | 109 ++++ 18 files changed, 987 insertions(+), 536 deletions(-)

1 0

[tor/master] Merge remote-tracking branch 'tor-github/pr/1247'
by nickm＠torproject.org 24 Aug '19

24 Aug '19

commit 6ba05eea8efcfc1f9b4a382ee1849e49ea242891 Merge: 7a45c9c1d 3bf90e704 Author: Nick Mathewson <nickm(a)torproject.org> Date: Sat Aug 24 16:32:50 2019 -0400 Merge remote-tracking branch 'tor-github/pr/1247' doc/HACKING/CodeStructure.md | 151 +++++++++++++++++++++---------------------- doc/HACKING/EndOfLifeTor.md | 4 +- doc/HACKING/Fuzzing.md | 14 ++-- doc/HACKING/ReleasingTor.md | 12 ++-- 4 files changed, 87 insertions(+), 94 deletions(-)

1 0

[tor/master] doc(hacking): enhance markdown style
by nickm＠torproject.org 24 Aug '19

24 Aug '19

commit 0d6c8eed49a9104597a907664675cd4095fb852f Author: Antoine Veuiller <aveuiller(a)gmail.com> Date: Wed Aug 21 16:22:08 2019 +0200 doc(hacking): enhance markdown style --- doc/HACKING/CodeStructure.md | 151 +++++++++++++++++++++---------------------- 1 file changed, 72 insertions(+), 79 deletions(-) diff --git a/doc/HACKING/CodeStructure.md b/doc/HACKING/CodeStructure.md index 736d6cd48..fffafcaed 100644 --- a/doc/HACKING/CodeStructure.md +++ b/doc/HACKING/CodeStructure.md @@ -2,128 +2,121 @@ TODO: revise this to talk about how things are, rather than how things have changed. -TODO: Make this into good markdown. - - - -For quite a while now, the program "tor" has been built from source -code in just two directories: src/common and src/or. +For quite a while now, the program *tor* has been built from source +code in just two directories: **src/common** and **src/or**. This has become more-or-less untenable, for a few reasons -- most notably of which is that it has led our code to become more spaghetti-ish than I can endorse with a clean conscience. So to fix that, we've gone and done a huge code movement in our git -master branch, which will land in a release once Tor 0.3.5.1-alpha is +master branch, which will land in a release once Tor `0.3.5.1-alpha` is out. Here's what we did: - * src/common has been turned into a set of static libraries. These -all live in the "src/lib/*" directories. The dependencies between + * **src/common** has been turned into a set of static libraries. These +all live in the **src/lib/*** directories. The dependencies between these libraries should have no cycles. The libraries are: - arch -- Headers to handle architectural differences - cc -- headers to handle differences among compilers - compress -- wraps zlib, zstd, lzma - container -- high-level container types - crypt_ops -- Cryptographic operations. Planning to split this into + - **arch** -- Headers to handle architectural differences + - **cc** -- headers to handle differences among compilers + - **compress** -- wraps zlib, zstd, lzma + - **container** -- high-level container types + - **crypt_ops** -- Cryptographic operations. Planning to split this into a higher and lower level library - ctime -- Operations that need to run in constant-time. (Properly, + - **ctime** -- Operations that need to run in constant-time. (Properly, data-invariant time) - defs -- miscelaneous definitions needed throughout Tor. - encoding -- transforming one data type into another, and various + - **defs** -- miscelaneous definitions needed throughout Tor. + - **encoding** -- transforming one data type into another, and various data types into strings. - err -- lowest-level error handling, in cases where we can't use + - **err** -- lowest-level error handling, in cases where we can't use the logs because something that the logging system needs has broken. - evloop -- Generic event-loop handling logic - fdio -- Low-level IO wrapper functions for file descriptors. - fs -- Operations on the filesystem - intmath -- low-level integer math and misc bit-twiddling hacks - lock -- low-level locking code - log -- Tor's logging module. This library sits roughly halfway up + - **evloop** -- Generic event-loop handling logic + - **fdio** -- Low-level IO wrapper functions for file descriptors. + - **fs** -- Operations on the filesystem + - **intmath** -- low-level integer math and misc bit-twiddling hacks + - **lock** -- low-level locking code + - **log** -- Tor's logging module. This library sits roughly halfway up the library dependency diagram, since everything it depends on has to be carefully crafted to *not* log. - malloc -- Low-level wrappers for the platform memory allocation functions. - math -- Higher-level mathematical functions, and floating-point math - memarea -- An arena allocator - meminfo -- Functions for querying the current process's memory + - **malloc** -- Low-level wrappers for the platform memory allocation functions. + - **math** -- Higher-level mathematical functions, and floating-point math + - **memarea** -- An arena allocator + - **meminfo** -- Functions for querying the current process's memory status and resources - net -- Networking compatibility and convenience code - osinfo -- Querying information about the operating system - process -- Launching and querying the status of other processes - sandbox -- Backend for the linux seccomp2 sandbox - smartlist_core -- The lowest-level of the smartlist_t data type. + - **net** -- Networking compatibility and convenience code + - **osinfo** -- Querying information about the operating system + - **process** -- Launching and querying the status of other processes + - **sandbox** -- Backend for the linux seccomp2 sandbox + - **smartlist_core** -- The lowest-level of the smartlist_t data type. Separated from the rest of the containers library because the logging subsystem depends on it. - string -- Compatibility and convenience functions for manipulating + - **string** -- Compatibility and convenience functions for manipulating C strings. - term -- Terminal-related functions (currently limited to a getpass + - **term** -- Terminal-related functions (currently limited to a getpass function). - testsupport -- Macros for mocking, unit tests, etc. - thread -- Higher-level thread compatibility code - time -- Higher-level time management code, including format + - **testsupport** -- Macros for mocking, unit tests, etc. + - **thread** -- Higher-level thread compatibility code + - **time** -- Higher-level time management code, including format conversions and monotonic time - tls -- Our wrapper around our TLS library - trace -- Formerly src/trace -- a generic event tracing API - wallclock -- Low-level time code, used by the log module. + - **tls** -- Our wrapper around our TLS library + - **trace** -- Formerly src/trace -- a generic event tracing API + - **wallclock** -- Low-level time code, used by the log module. - * To ensure that the dependency graph in src/common remains under -control, there is a tool that you can run called "make -check-includes". It verifies that each module in Tor only includes + * To ensure that the dependency graph in **src/common** remains under +control, there is a tool that you can run called `make +check-includes`. It verifies that each module in Tor only includes the headers that it is permitted to include, using a per-directory -".may_include" file. +*.may_include* file. - * The src/or/or.h header has been split into numerous smaller + * The **src/or/or.h** header has been split into numerous smaller headers. Notably, many important structures are now declared in a -header called foo_st.h, where "foo" is the name of the structure. +header called *foo_st.h*, where "foo" is the name of the structure. - * The src/or directory, which had most of Tor's code, had been split + * The **src/or** directory, which had most of Tor's code, had been split up into several directories. This is still a work in progress: This code has not itself been refactored, and its dependency graph is still a tangled web. I hope we'll be working on that over the coming releases, but it will take a while to do. - The new top-level source directories are: - - src/core -- Code necessary to actually perform or use onion routing. - src/feature -- Code used only by some onion routing + - The new top-level source directories are: + - **src/core** -- Code necessary to actually perform or use onion routing. + - **src/feature** -- Code used only by some onion routing configurations, or only for a special purpose. - src/app -- Top-level code to run, invoke, and configure the + - **src/app** -- Top-level code to run, invoke, and configure the lower-level code - The new second-level source directories are: - src/core/crypto -- High-level cryptographic protocols used in Tor - src/core/mainloop -- Tor's event loop, connection-handling, and + - The new second-level source directories are: + - **src/core/crypto** -- High-level cryptographic protocols used in Tor + - **src/core/mainloop** -- Tor's event loop, connection-handling, and traffic-routing code. - src/core/or -- Parts related to handling onion routing itself - src/core/proto -- support for encoding and decoding different + - **src/core/or** -- Parts related to handling onion routing itself + - **src/core/proto** -- support for encoding and decoding different wire protocols - - src/feature/api -- Support for making Tor embeddable - src/feature/client -- Functionality which only Tor clients need - src/feature/control -- Controller implementation - src/feature/dirauth -- Directory authority - src/feature/dircache -- Directory cache - src/feature/dirclient -- Directory client - src/feature/dircommon -- Shared code between the other directory modules - src/feature/hibernate -- Hibernating when Tor is out of bandwidth + - **src/feature/api** -- Support for making Tor embeddable + - **src/feature/client** -- Functionality which only Tor clients need + - **src/feature/control** -- Controller implementation + - **src/feature/dirauth** -- Directory authority + - **src/feature/dircache** -- Directory cache + - **src/feature/dirclient** -- Directory client + - **src/feature/dircommon** -- Shared code between the other directory modules + - **src/feature/hibernate** -- Hibernating when Tor is out of bandwidth or shutting down - src/feature/hs -- v3 onion service implementation - src/feature/hs_common -- shared code between both onion service + - **src/feature/hs** -- v3 onion service implementation + - **src/feature/hs_common** -- shared code between both onion service implementations - src/feature/nodelist -- storing and accessing the list of relays on + - **src/feature/nodelist** -- storing and accessing the list of relays on the network. - src/feature/relay -- code that only relay servers and exit servers need. - src/feature/rend -- v2 onion service implementation - src/feature/stats -- statistics and history - - src/app/config -- configuration and state for Tor - src/app/main -- Top-level functions to invoke the rest or Tor. + - **src/feature/relay** -- code that only relay servers and exit servers need. + - **src/feature/rend** -- v2 onion service implementation + - **src/feature/stats** -- statistics and history + - **src/app/config** -- configuration and state for Tor + - **src/app/main** -- Top-level functions to invoke the rest or Tor. - * The "tor" executable is now built in src/app/tor rather than src/or/tor. + * The `tor` executable is now built in **src/app/tor** rather than **src/or/tor**. * There are more static libraries than before that you need to build into your application if you want to embed Tor. Rather than -maintaining this list yourself, I recommend that you run "make -show-libs" to have Tor emit a list of what you need to link. +maintaining this list yourself, I recommend that you run `make +show-libs` to have Tor emit a list of what you need to link.

1 0

[tor/master] doc(hacking): update = to # on sections
by nickm＠torproject.org 24 Aug '19

24 Aug '19

commit 3bf90e704ca14fd0b50f46ff150205b3fbb97a82 Author: Antoine Veuiller <aveuiller(a)gmail.com> Date: Wed Aug 21 16:22:37 2019 +0200 doc(hacking): update = to # on sections --- doc/HACKING/EndOfLifeTor.md | 4 ++-- doc/HACKING/Fuzzing.md | 14 +++++++------- doc/HACKING/ReleasingTor.md | 12 ++++++------ 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/doc/HACKING/EndOfLifeTor.md b/doc/HACKING/EndOfLifeTor.md index c7492f0ca..2fece2ca9 100644 --- a/doc/HACKING/EndOfLifeTor.md +++ b/doc/HACKING/EndOfLifeTor.md @@ -7,7 +7,7 @@ series reaches End of Life. Note that they are _only_ for entire series that have reached their planned EOL: they do not apply to security-related deprecations of individual versions. -=== 0. Preliminaries +### 0. Preliminaries 0. A few months before End of Life: Write a deprecation announcement. @@ -17,7 +17,7 @@ deprecations of individual versions. Send the announcement to tor-announce, tor-talk, tor-relays, and the packagers. -=== 1. On the day +### 1. On the day 1. Open tickets to remove the release from: - the jenkins builds diff --git a/doc/HACKING/Fuzzing.md b/doc/HACKING/Fuzzing.md index 2039d6a4c..c2db7e985 100644 --- a/doc/HACKING/Fuzzing.md +++ b/doc/HACKING/Fuzzing.md @@ -1,6 +1,6 @@ -= Fuzzing Tor +# Fuzzing Tor -== The simple version (no fuzzing, only tests) +## The simple version (no fuzzing, only tests) Check out fuzzing-corpora, and set TOR_FUZZ_CORPORA to point to the place where you checked it out. @@ -12,7 +12,7 @@ This won't actually fuzz Tor! It will just run all the fuzz binaries on our existing set of testcases for the fuzzer. -== Different kinds of fuzzing +## Different kinds of fuzzing Right now we support three different kinds of fuzzer. @@ -37,7 +37,7 @@ In all cases, you'll need some starting examples to give the fuzzer when it starts out. There's a set in the "fuzzing-corpora" git repository. Try setting TOR_FUZZ_CORPORA to point to a checkout of that repository -== Writing Tor fuzzers +## Writing Tor fuzzers A tor fuzzing harness should have: * a fuzz_init() function to set up any necessary global state. @@ -52,7 +52,7 @@ bug, or accesses memory it shouldn't. This helps fuzzing frameworks detect "interesting" cases. -== Guided Fuzzing with AFL +## Guided Fuzzing with AFL There is no HTTPS, hash, or signature for American Fuzzy Lop's source code, so its integrity can't be verified. That said, you really shouldn't fuzz on a @@ -101,7 +101,7 @@ macOS (OS X) requires slightly more preparation, including: * using afl-clang (or afl-clang-fast from the llvm directory) * disabling external crash reporting (AFL will guide you through this step) -== Triaging Issues +## Triaging Issues Crashes are usually interesting, particularly if using AFL_HARDEN=1 and --enable-expensive-hardening. Sometimes crashes are due to bugs in the harness code. @@ -115,7 +115,7 @@ To see what fuzz-http is doing with a test case, call it like this: (Logging is disabled while fuzzing to increase fuzzing speed.) -== Reporting Issues +## Reporting Issues Please report any issues discovered using the process in Tor's security issue policy: diff --git a/doc/HACKING/ReleasingTor.md b/doc/HACKING/ReleasingTor.md index 15c8ac55d..f40e2af57 100644 --- a/doc/HACKING/ReleasingTor.md +++ b/doc/HACKING/ReleasingTor.md @@ -5,7 +5,7 @@ Putting out a new release Here are the steps that the maintainer should take when putting out a new Tor release: -=== 0. Preliminaries +### 0. Preliminaries 1. Get at least two of weasel/arma/Sebastian to put the new version number in their approved versions list. Give them a few @@ -18,7 +18,7 @@ new Tor release: date of a TB that contains it. See note below in "commit, upload, announce". -=== I. Make sure it works +### I. Make sure it works 1. Make sure that CI passes: have a look at Travis (https://travis-ci.org/torproject/tor/branches), Appveyor @@ -52,7 +52,7 @@ new Tor release: memory leaks.) -=== II. Write a changelog +### II. Write a changelog 1a. (Alpha release variant) @@ -139,7 +139,7 @@ new Tor release: text of existing entries, though.) -=== III. Making the source release. +### III. Making the source release. 1. In `maint-0.?.x`, bump the version number in `configure.ac` and run `make update-versions` to update version numbers in other @@ -165,7 +165,7 @@ new Tor release: If it is not, you'll need to poke Roger, Weasel, and Sebastian again: see item 0.1 at the start of this document. -=== IV. Commit, upload, announce +### IV. Commit, upload, announce 1. Sign the tarball, then sign and push the git tag: @@ -241,7 +241,7 @@ new Tor release: For templates to use when announcing, see: https://trac.torproject.org/projects/tor/wiki/org/teams/NetworkTeam/Announc… -=== V. Aftermath and cleanup +### V. Aftermath and cleanup 1. If it's a stable release, bump the version number in the `maint-x.y.z` branch to "newversion-dev", and do a `merge -s ours`

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits August 2019