January 2018 - tor-commits - lists.torproject.org

[translation/tor-browser-manual] Update translations for tor-browser-manual
by translation＠torproject.org 22 Jan '18

22 Jan '18

commit 78891b900bba0edf2078cb727dfffe042dc4f29b Author: Translation commit bot <translation(a)torproject.org> Date: Mon Jan 22 00:50:44 2018 +0000 Update translations for tor-browser-manual --- mk/mk.po | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/mk/mk.po b/mk/mk.po index 6d1401968..d4e9c7845 100644 --- a/mk/mk.po +++ b/mk/mk.po @@ -345,6 +345,9 @@ msgid "" " should try the different transports: obfs3, obfs4, ScrambleSuit, fte, meek-" "azure, meek-amazon." msgstr "" +"Ако се обидувате да заобиколите блокирана конекција за прв пат, треба да се " +"обидете со различни транспортери: obfs3, obfs4, ScrambleSuit, fte, meek-" +"azure, meek-amazon." #: circumvention.page:72 msgid "" @@ -353,10 +356,14 @@ msgid "" "xref=\"bridges\">Bridges</link> section to learn what bridges are and how to" " obtain them." msgstr "" +"Ако се обидовте со сите овие опции, и со ниту една не се конектиравте " +"онлајн, треба рачно да внесете мост адреси. Прочитајте за <link " +"xref=\"bridges\">Мостови</link> секцијата и научете што се мостови и како да" +" ги добиете." #: downloading.page:7 msgid "How to download Tor Browser" -msgstr "" +msgstr "Како да го преземете Tor Browser" #: downloading.page:10 msgid "Downloading"

1 0

[stem/master] Replace cell_attributes() with a couple class functions
by atagar＠torproject.org 21 Jan '18

21 Jan '18

commit 0a46f3db4bb8a8fc5183041c93a990cb8f6a8eb8 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Jan 4 00:05:23 2018 -0800 Replace cell_attributes() with a couple class functions --- stem/client.py | 118 +++++++++++++++++++++++++++++----------------------- test/unit/client.py | 25 +++++------ 2 files changed, 79 insertions(+), 64 deletions(-) diff --git a/stem/client.py b/stem/client.py index 136fc240..8fe2878d 100644 --- a/stem/client.py +++ b/stem/client.py @@ -2,21 +2,21 @@ # See LICENSE for licensing information """ -Module for interacting with the ORPort provided by Tor relays. The -:class:`~stem.client.Relay` is a wrapper for :class:`~stem.socket.RelaySocket`, -providing higher level functions in much the same way as our -:class:`~stem.control.Controller` wraps :class:`~stem.socket.ControlSocket`. +Interaction with a Tor relay's ORPort. :class:`~stem.client.Relay` is +a wrapper for :class:`~stem.socket.RelaySocket`, much the same way as +:class:`~stem.control.Controller` provides higher level functions for +:class:`~stem.socket.ControlSocket`. .. versionadded:: 1.7.0 -.. data:: PackType (enum) +.. data:: Pack (enum) Unsigned `struct.pack format <https://docs.python.org/2/library/struct.html#format-characters>` for network-order fields. ==================== =========== - PackType Description + Pack Description ==================== =========== CHAR Unsigned char (1 byte) SHORT Unsigned short (2 bytes) @@ -36,17 +36,10 @@ import struct from stem.util import enum -PackType = enum.Enum( - ('CHAR', '!B'), # 1 byte - ('SHORT', '!H'), # 2 bytes - ('LONG', '!L'), # 4 bytes - ('LONG_LONG', '!Q'), # 8 bytes -) - -class CellAttributes(collections.namedtuple('CellAttributes', ['name', 'value', 'fixed_size', 'for_circuit'])): +class Cell(collections.namedtuple('Cell', ['name', 'value', 'fixed_size', 'for_circuit'])): """ - Metadata for cells tor will accept on its ORPort. + Metadata for ORPort cells. :var str name: name of the cell type :var int value: integer value of the command on the wire @@ -56,52 +49,44 @@ class CellAttributes(collections.namedtuple('CellAttributes', ['name', 'value', **False** otherwise """ + @staticmethod + def by_name(name): + """ + Provides cell attributes by its name. -CELL_ATTR = ( - CellAttributes('PADDING', 0, True, False), # Padding (section 7.2) - CellAttributes('CREATE', 1, True, True), # Create a circuit (section 5.1) - CellAttributes('CREATED', 2, True, True), # Acknowledge create (section 5.1) - CellAttributes('RELAY', 3, True, True), # End-to-end data (section 5.5 and 6) - CellAttributes('DESTROY', 4, True, True), # Stop using a circuit (section 5.4) - CellAttributes('CREATE_FAST', 5, True, True), # Create a circuit, no PK (section 5.1) - CellAttributes('CREATED_FAST', 6, True, True), # Circuit created, no PK (section 5.1) - CellAttributes('VERSIONS', 7, False, False), # Negotiate proto version (section 4) - CellAttributes('NETINFO', 8, True, False), # Time and address info (section 4.5) - CellAttributes('RELAY_EARLY', 9, True, True), # End-to-end data; limited (section 5.6) - CellAttributes('CREATE2', 10, True, True), # Extended CREATE cell (section 5.1) - CellAttributes('CREATED2', 11, True, True), # Extended CREATED cell (section 5.1) - CellAttributes('PADDING_NEGOTIATE', 12, True, False), # Padding negotiation (section 7.2) - CellAttributes('VPADDING', 128, False, False), # Variable-length padding (section 7.2) - CellAttributes('CERTS', 129, False, False), # Certificates (section 4.2) - CellAttributes('AUTH_CHALLENGE', 130, False, False), # Challenge value (section 4.3) - CellAttributes('AUTHENTICATE', 131, False, False), # Client authentication (section 4.5) - CellAttributes('AUTHORIZE', 132, False, False), # Client authorization (not yet used) -) + :parm str name: name of the cell type to fetch + :raise: **ValueError** if cell type is invalid + """ -class Relay(object): - """ - Connection with a `Tor relay's ORPort - <https://gitweb.torproject.org/torspec.git/tree/tor-spec.txt>`_. - """ + for cell_type in CELL_TYPES: + if name == cell_type.name: + return cell_type + raise ValueError("'%s' isn't a valid cell type" % name) -def cell_attributes(cell_type): - """ - Provides attributes of the given cell type. + @staticmethod + def by_value(value): + """ + Provides cell attributes by its value. - :parm str,int cell_type: cell type as either a string or integer + :parm int value: value of the cell type to fetch - :raise: **ValueError** if cell type is invalid - """ + :raise: **ValueError** if cell type is invalid + """ - param = 'value' if isinstance(cell_type, int) else 'name' + for cell_type in CELL_TYPES: + if value == cell_type.value: + return cell_type - for attr in CELL_ATTR: - if getattr(attr, param) == cell_type: - return attr + raise ValueError("'%s' isn't a valid cell value" % value) - raise ValueError("'%s' isn't a valid cell type" % cell_type) + +class Relay(object): + """ + Connection with a `Tor relay's ORPort + <https://gitweb.torproject.org/torspec.git/tree/tor-spec.txt>`_. + """ def serialize_versions(versions): @@ -113,4 +98,33 @@ def serialize_versions(versions): :returns: **bytes** with a payload for these versions """ - return b''.join([struct.pack(PackType.SHORT, v) for v in versions]) + return b''.join([struct.pack(Pack.SHORT, v) for v in versions]) + + +Pack = enum.Enum( + ('CHAR', '!B'), # 1 byte + ('SHORT', '!H'), # 2 bytes + ('LONG', '!L'), # 4 bytes + ('LONG_LONG', '!Q'), # 8 bytes +) + +CELL_TYPES = ( + Cell('PADDING', 0, True, False), # Padding (section 7.2) + Cell('CREATE', 1, True, True), # Create a circuit (section 5.1) + Cell('CREATED', 2, True, True), # Acknowledge create (section 5.1) + Cell('RELAY', 3, True, True), # End-to-end data (section 5.5 and 6) + Cell('DESTROY', 4, True, True), # Stop using a circuit (section 5.4) + Cell('CREATE_FAST', 5, True, True), # Create a circuit, no PK (section 5.1) + Cell('CREATED_FAST', 6, True, True), # Circuit created, no PK (section 5.1) + Cell('VERSIONS', 7, False, False), # Negotiate proto version (section 4) + Cell('NETINFO', 8, True, False), # Time and address info (section 4.5) + Cell('RELAY_EARLY', 9, True, True), # End-to-end data; limited (section 5.6) + Cell('CREATE2', 10, True, True), # Extended CREATE cell (section 5.1) + Cell('CREATED2', 11, True, True), # Extended CREATED cell (section 5.1) + Cell('PADDING_NEGOTIATE', 12, True, False), # Padding negotiation (section 7.2) + Cell('VPADDING', 128, False, False), # Variable-length padding (section 7.2) + Cell('CERTS', 129, False, False), # Certificates (section 4.2) + Cell('AUTH_CHALLENGE', 130, False, False), # Challenge value (section 4.3) + Cell('AUTHENTICATE', 131, False, False), # Client authentication (section 4.5) + Cell('AUTHORIZE', 132, False, False), # Client authorization (not yet used) +) diff --git a/test/unit/client.py b/test/unit/client.py index 204c55fd..1d2df417 100644 --- a/test/unit/client.py +++ b/test/unit/client.py @@ -4,21 +4,22 @@ Unit tests for the stem.client. import unittest -import stem.client +from stem.client import Cell class TestClient(unittest.TestCase): - def test_cell_attributes(self): - attr = stem.client.cell_attributes('NETINFO') + def test_cell_fetching(self): + cell = Cell.by_name('NETINFO') - self.assertEqual('NETINFO', attr.name) - self.assertEqual(8, attr.value) - self.assertEqual(True, attr.fixed_size) - self.assertEqual(False, attr.for_circuit) + self.assertEqual('NETINFO', cell.name) + self.assertEqual(8, cell.value) + self.assertEqual(True, cell.fixed_size) + self.assertEqual(False, cell.for_circuit) - self.assertEqual(10, stem.client.cell_attributes('CREATE2').value) - self.assertEqual('CREATE2', stem.client.cell_attributes(10).name) + self.assertEqual(10, Cell.by_name('CREATE2').value) + self.assertEqual('CREATE2', Cell.by_value(10).name) - self.assertRaises(ValueError, stem.client.cell_attributes, 'NOPE') - self.assertRaises(ValueError, stem.client.cell_attributes, 85) - self.assertRaises(ValueError, stem.client.cell_attributes, None) + self.assertRaises(ValueError, Cell.by_name, 'NOPE') + self.assertRaises(ValueError, Cell.by_value, 'NOPE') + self.assertRaises(ValueError, Cell.by_name, 85) + self.assertRaises(ValueError, Cell.by_name, None)

1 0

[stem/master] Cell.pack() function
by atagar＠torproject.org 21 Jan '18

21 Jan '18

commit d34b517c9661081d7ac69e464c233e61c5b42ed3 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Jan 4 11:34:30 2018 -0800 Cell.pack() function Counterpart for endosome's pack_cell() function. This deserves more tests once we have an unpack method (assertions for packed values aren't terribly grokable). --- stem/client.py | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++--- test/unit/client.py | 33 ++++++++++++++++++++++++------- 2 files changed, 80 insertions(+), 10 deletions(-) diff --git a/stem/client.py b/stem/client.py index 8fe2878d..2a598747 100644 --- a/stem/client.py +++ b/stem/client.py @@ -36,12 +36,14 @@ import struct from stem.util import enum +ZERO = '\x00' + class Cell(collections.namedtuple('Cell', ['name', 'value', 'fixed_size', 'for_circuit'])): """ Metadata for ORPort cells. - :var str name: name of the cell type + :var str name: command of the cell :var int value: integer value of the command on the wire :var bool fixed_size: **True** if cells have a fixed length, **False** if variable @@ -54,7 +56,7 @@ class Cell(collections.namedtuple('Cell', ['name', 'value', 'fixed_size', 'for_c """ Provides cell attributes by its name. - :parm str name: name of the cell type to fetch + :parm str name: cell command to fetch :raise: **ValueError** if cell type is invalid """ @@ -70,7 +72,7 @@ class Cell(collections.namedtuple('Cell', ['name', 'value', 'fixed_size', 'for_c """ Provides cell attributes by its value. - :parm int value: value of the cell type to fetch + :parm int value: cell value to fetch :raise: **ValueError** if cell type is invalid """ @@ -81,6 +83,55 @@ class Cell(collections.namedtuple('Cell', ['name', 'value', 'fixed_size', 'for_c raise ValueError("'%s' isn't a valid cell value" % value) + @staticmethod + def pack(name, link_version, payload, circ_id = None): + """ + Provides bytes that can be used on the wire for these cell attributes. + + :param str name: cell command + :param int link_version: link protocol version + :param bytes payload: cell payload + :param int circ_id: circuit id, if for a circuit + + :raise: **ValueError** if... + * cell type or circuit id is invalid + * payload is too large + """ + + attr = Cell.by_name(name) + circ_id_len = Pack.LONG if link_version > 3 else Pack.SHORT + + if attr.for_circuit and circ_id is None: + if name.startswith('CREATE'): + # Since we're initiating the circuit we pick any value from a range + # that's determined by our link version. + + circ_id = 0x80000000 if link_version > 3 else 0x01 + else: + raise ValueError('%s cells require a circ_id' % name) + elif not attr.for_circuit: + if circ_id: + raise ValueError("%s cells don't concern circuits, circ_id is unused" % name) + + circ_id = 0 # field is still mandatory for all cells + + packed_circ_id = struct.pack(circ_id_len, circ_id) + packed_command = struct.pack(Pack.CHAR, attr.value) + packed_size = b'' if attr.fixed_size else struct.pack(Pack.SHORT, len(payload)) + cell = b''.join((packed_circ_id, packed_command, packed_size, payload)) + + # pad fixed sized cells to the required length + + if attr.fixed_size: + fixed_cell_len = 514 if link_version > 3 else 512 + + if len(cell) > fixed_cell_len: + raise ValueError('Payload of %s is too large (%i bytes), must be less than %i' % (name, len(cell), fixed_cell_len)) + + cell += ZERO * (fixed_cell_len - len(cell)) + + return cell + class Relay(object): """ diff --git a/test/unit/client.py b/test/unit/client.py index 1d2df417..6faa3e8e 100644 --- a/test/unit/client.py +++ b/test/unit/client.py @@ -2,24 +2,43 @@ Unit tests for the stem.client. """ +import struct import unittest -from stem.client import Cell +from stem.client import Pack, Cell class TestClient(unittest.TestCase): - def test_cell_fetching(self): + def test_cell_by_name(self): cell = Cell.by_name('NETINFO') - self.assertEqual('NETINFO', cell.name) self.assertEqual(8, cell.value) self.assertEqual(True, cell.fixed_size) self.assertEqual(False, cell.for_circuit) - self.assertEqual(10, Cell.by_name('CREATE2').value) - self.assertEqual('CREATE2', Cell.by_value(10).name) - self.assertRaises(ValueError, Cell.by_name, 'NOPE') - self.assertRaises(ValueError, Cell.by_value, 'NOPE') self.assertRaises(ValueError, Cell.by_name, 85) self.assertRaises(ValueError, Cell.by_name, None) + + def test_cell_by_value(self): + cell = Cell.by_value(8) + self.assertEqual('NETINFO', cell.name) + self.assertEqual(8, cell.value) + self.assertEqual(True, cell.fixed_size) + self.assertEqual(False, cell.for_circuit) + + self.assertRaises(ValueError, Cell.by_value, 'NOPE') + self.assertRaises(ValueError, Cell.by_value, 85) + self.assertRaises(ValueError, Cell.by_value, None) + + def test_cell_pack(self): + version_payload = struct.pack(Pack.SHORT, 2) + + # basic link v2 and v4 VERSIONS cell + + self.assertEqual('\x00\x00\x07\x00\x02\x00\x02', Cell.pack('VERSIONS', 2, version_payload)) + self.assertEqual('\x00\x00\x00\x00\x07\x00\x02\x00\x02', Cell.pack('VERSIONS', 4, version_payload)) + + self.assertRaisesRegexp(ValueError, "'NOPE' isn't a valid cell type", Cell.pack, 'NOPE', 2, version_payload) + self.assertRaisesRegexp(ValueError, "VERSIONS cells don't concern circuits, circ_id is unused", Cell.pack, 'VERSIONS', 2, version_payload, circ_id = 5) + self.assertRaisesRegexp(ValueError, 'RELAY_EARLY cells require a circ_id', Cell.pack, 'RELAY_EARLY', 2, version_payload)

1 0

[stem/master] Test VersionsCell.pack
by atagar＠torproject.org 21 Jan '18

21 Jan '18

commit ae90fd8ed263f6ebfd9390df85e35ad75a6e32dc Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Jan 10 10:25:20 2018 -0800 Test VersionsCell.pack --- stem/client/cell.py | 2 +- test/unit/client/cell.py | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/stem/client/cell.py b/stem/client/cell.py index 9a6e6788..e3fb6a71 100644 --- a/stem/client/cell.py +++ b/stem/client/cell.py @@ -184,7 +184,7 @@ class VersionsCell(Cell): # since VERSION cells avoid most version dependent attributes. payload = b''.join([struct.pack(Pack.SHORT, v) for v in versions]) - return cls._pack('VERSIONS', 3, payload) + return cls._pack(3, payload) class NetinfoCell(Cell): diff --git a/test/unit/client/cell.py b/test/unit/client/cell.py index 188fd773..c8161a7e 100644 --- a/test/unit/client/cell.py +++ b/test/unit/client/cell.py @@ -4,7 +4,7 @@ Unit tests for the stem.client.cell. import unittest -from stem.client.cell import Cell +from stem.client.cell import Cell, VersionsCell class TestCell(unittest.TestCase): @@ -29,3 +29,8 @@ class TestCell(unittest.TestCase): self.assertRaises(ValueError, Cell.by_value, 'NOPE') self.assertRaises(ValueError, Cell.by_value, 85) self.assertRaises(ValueError, Cell.by_value, None) + + def test_versions_pack(self): + self.assertEqual('\x00\x00\x07\x00\x00', VersionsCell.pack([])) + self.assertEqual('\x00\x00\x07\x00\x02\x00\x01', VersionsCell.pack([1])) + self.assertEqual('\x00\x00\x07\x00\x06\x00\x01\x00\x02\x00\x03', VersionsCell.pack([1, 2, 3]))

1 0

[stem/master] VersionsCell unpacking
by atagar＠torproject.org 21 Jan '18

21 Jan '18

commit ba91f20beebab6e8ec0496f75bfef37c1c124c52 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Jan 11 17:54:08 2018 -0800 VersionsCell unpacking Implementing our first cell unpack function. --- stem/client/cell.py | 29 ++++++++++++++++++++++++++--- test/unit/client/cell.py | 5 +++++ 2 files changed, 31 insertions(+), 3 deletions(-) diff --git a/stem/client/cell.py b/stem/client/cell.py index 7a1644b3..e29e404f 100644 --- a/stem/client/cell.py +++ b/stem/client/cell.py @@ -36,15 +36,16 @@ Messages communicated over a Tor relay's ORPort. +- unpack - Decodes bytes for this cell class. """ -import collections import inspect import sys from stem import UNDEFINED from stem.client import ZERO, Size +MAX_FIXED_PAYLOAD_LEN = 509 -class Cell(collections.namedtuple('Cell', ['name', 'value', 'fixed_size', 'for_circuit'])): + +class Cell(object): """ Metadata for ORPort cells. @@ -109,7 +110,14 @@ class Cell(collections.namedtuple('Cell', ['name', 'value', 'fixed_size', 'for_c circ_id, content = Size.LONG.pop(content) if link_version > 3 else Size.SHORT.pop(content) command, content = Size.CHAR.pop(content) - return Cell.by_value(command)._unpack(content, link_version, circ_id) + cls = Cell.by_value(command) + + if cls.IS_FIXED_SIZE: + payload_len = MAX_FIXED_PAYLOAD_LEN + else: + payload_len, content = Size.SHORT.pop(content) + + return cls._unpack(content, link_version, circ_id) @classmethod def _pack(cls, link_version, payload, circ_id = 0): @@ -234,12 +242,17 @@ class CreatedFastCell(CircuitCell): class VersionsCell(Cell): """ Link version negotiation cell. + + :var list versions: link versions """ NAME = 'VERSIONS' VALUE = 7 IS_FIXED_SIZE = False + def __init__(self, versions): + self.versions = versions + @classmethod def pack(cls, versions): """ @@ -256,6 +269,16 @@ class VersionsCell(Cell): payload = b''.join([Size.SHORT.pack(v) for v in versions]) return cls._pack(3, payload) + @classmethod + def _unpack(cls, content, circ_id, link_version): + link_versions = [] + + while content: + version, content = Size.SHORT.pop(content) + link_versions.append(version) + + return VersionsCell(link_versions) + class NetinfoCell(Cell): NAME = 'NETINFO' diff --git a/test/unit/client/cell.py b/test/unit/client/cell.py index 857cab84..9502975e 100644 --- a/test/unit/client/cell.py +++ b/test/unit/client/cell.py @@ -35,3 +35,8 @@ class TestCell(unittest.TestCase): self.assertEqual('\x00\x00\x07\x00\x00', VersionsCell.pack([])) self.assertEqual('\x00\x00\x07\x00\x02\x00\x01', VersionsCell.pack([1])) self.assertEqual('\x00\x00\x07\x00\x06\x00\x01\x00\x02\x00\x03', VersionsCell.pack([1, 2, 3])) + + def test_versions_unpack(self): + self.assertEqual([], Cell.unpack('\x00\x00\x07\x00\x00', 2).versions) + self.assertEqual([1], Cell.unpack('\x00\x00\x07\x00\x02\x00\x01', 2).versions) + self.assertEqual([1, 2, 3], Cell.unpack('\x00\x00\x07\x00\x06\x00\x01\x00\x02\x00\x03', 2).versions)

1 0

[stem/master] Support unpacking CERTS cells
by atagar＠torproject.org 21 Jan '18

21 Jan '18

commit b43bd7b72de2a50c094601771bf43ed33301071a Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jan 13 18:44:46 2018 -0800 Support unpacking CERTS cells --- stem/client/__init__.py | 19 +++++++++++++++++++ stem/client/cell.py | 34 ++++++++++++++++++++++++++++++++-- test/unit/client/cell.py | 33 +++++++++++++++++++++++++++++---- 3 files changed, 80 insertions(+), 6 deletions(-) diff --git a/stem/client/__init__.py b/stem/client/__init__.py index c3b18c6c..6909c1a7 100644 --- a/stem/client/__init__.py +++ b/stem/client/__init__.py @@ -17,6 +17,7 @@ a wrapper for :class:`~stem.socket.RelaySocket`, much the same way as +- pop - decodes content with remainder """ +import collections import struct ZERO = '\x00' @@ -26,6 +27,24 @@ __all__ = [ ] +class Certificate(collections.namedtuple('Certificate', ['type', 'value'])): + """ + Relay certificate as defined in tor-spec section 4.2. Certificate types + are... + + ==================== =========== + Type Value Description + ==================== =========== + 1 Link key certificate certified by RSA1024 identity + 2 RSA1024 Identity certificate + 3 RSA1024 AUTHENTICATE cell link certificate + ==================== =========== + + :var int type: certificate type + :var bytes value: certificate value + """ + + class Size(object): """ Unsigned `struct.pack format diff --git a/stem/client/cell.py b/stem/client/cell.py index 4d4667d0..e3793491 100644 --- a/stem/client/cell.py +++ b/stem/client/cell.py @@ -40,7 +40,7 @@ import inspect import sys from stem import UNDEFINED -from stem.client import ZERO, Size +from stem.client import ZERO, Certificate, Size FIXED_PAYLOAD_LEN = 509 @@ -123,7 +123,7 @@ class Cell(object): if len(content) < payload_len: raise ValueError('%s cell should have a payload of %i bytes, but only had %i' % (cls.NAME, payload_len, len(content))) - payload = content[:payload_len].rstrip(ZERO) # strip padding + payload = content[:payload_len] content = content[payload_len:] cells.append(cls._unpack(payload, link_version, circ_id)) @@ -328,10 +328,40 @@ class VPaddingCell(Cell): class CertsCell(Cell): + """ + Certificate held by the relay we're communicating with. + + :var list certificates: :class:`~stem.client.Certificate` of the relay + """ + NAME = 'CERTS' VALUE = 129 IS_FIXED_SIZE = False + def __init__(self, certs): + self.certificates = certs + + @classmethod + def _unpack(cls, content, circ_id, link_version): + cert_count, content = Size.CHAR.pop(content) + certs = [] + + for i in range(cert_count): + if not content: + raise ValueError('CERTS cell indicates it should have %i certificates, but only contained %i' % (cert_count, len(certs))) + + cert_type, content = Size.CHAR.pop(content) + cert_size, content = Size.SHORT.pop(content) + + if cert_size > len(content): + raise ValueError('CERTS cell should have a certificate with %i bytes, but only had %i remaining' % (cert_size, len(content))) + + cert_bytes = content[:cert_size] + content = content[cert_size:] + certs.append(Certificate(cert_type, cert_bytes)) + + return CertsCell(certs) + class AuthChallengeCell(Cell): NAME = 'AUTH_CHALLENGE' diff --git a/test/unit/client/cell.py b/test/unit/client/cell.py index 3a2a55f2..b1001eb7 100644 --- a/test/unit/client/cell.py +++ b/test/unit/client/cell.py @@ -4,6 +4,7 @@ Unit tests for the stem.client.cell. import unittest +from stem.client import Certificate from stem.client.cell import Cell, VersionsCell from test.unit.client import test_data @@ -34,7 +35,7 @@ class TestCell(unittest.TestCase): def test_unpack_for_new_link(self): # TODO: we need to support more cell types before we can test this - self.assertRaisesRegexp(NotImplementedError, 'Unpacking not yet implemented for CERTS cells', Cell.unpack, test_data('new_link_cells'), 2) + self.assertRaisesRegexp(NotImplementedError, 'Unpacking not yet implemented for AUTH_CHALLENGE cells', Cell.unpack, test_data('new_link_cells'), 2) def test_versions_pack(self): self.assertEqual('\x00\x00\x07\x00\x00', VersionsCell.pack([])) @@ -42,6 +43,30 @@ class TestCell(unittest.TestCase): self.assertEqual('\x00\x00\x07\x00\x06\x00\x01\x00\x02\x00\x03', VersionsCell.pack([1, 2, 3])) def test_versions_unpack(self): - self.assertEqual([], Cell.unpack('\x00\x00\x07\x00\x00', 2)[0].versions) - self.assertEqual([1], Cell.unpack('\x00\x00\x07\x00\x02\x00\x01', 2)[0].versions) - self.assertEqual([1, 2, 3], Cell.unpack('\x00\x00\x07\x00\x06\x00\x01\x00\x02\x00\x03', 2)[0].versions) + test_data = { + '\x00\x00\x07\x00\x00': [], + '\x00\x00\x07\x00\x02\x00\x01': [1], + '\x00\x00\x07\x00\x06\x00\x01\x00\x02\x00\x03': [1, 2, 3], + } + + for cell_bytes, expected in test_data.items(): + self.assertEqual(expected, Cell.unpack(cell_bytes, 2)[0].versions) + + def test_certs_unpack(self): + test_data = { + '\x00\x00\x81\x00\x01\x00': [], + '\x00\x00\x81\x00\x04\x01\x01\x00\x00': [Certificate(type = 1, value = '')], + '\x00\x00\x81\x00\x05\x01\x01\x00\x01\x08': [Certificate(type = 1, value = '\x08')], + } + + for cell_bytes, expected in test_data.items(): + self.assertEqual(expected, Cell.unpack(cell_bytes, 2)[0].certificates) + + # extra bytes after the last certificate should be ignored + + self.assertEqual([Certificate(type = 1, value = '\x08')], Cell.unpack('\x00\x00\x81\x00\x07\x01\x01\x00\x01\x08\x06\x04', 2)[0].certificates) + + # ... but truncated or missing certificates should error + + self.assertRaisesRegexp(ValueError, 'CERTS cell should have a certificate with 3 bytes, but only had 1 remaining', Cell.unpack, '\x00\x00\x81\x00\x05\x01\x01\x00\x03\x08', 2) + self.assertRaisesRegexp(ValueError, 'CERTS cell indicates it should have 2 certificates, but only contained 1', Cell.unpack, '\x00\x00\x81\x00\x05\x02\x01\x00\x01\x08', 2)

1 0

[stem/master] VersionCell.pack function
by atagar＠torproject.org 21 Jan '18

21 Jan '18

commit cf78cc48f811a3f0af1a7904ff7d78d5b20ad1ec Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jan 8 02:27:51 2018 -0800 VersionCell.pack function Think I'll model these similar to stem responses, with a pack/unpack method for each cell type. --- stem/client.py | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/stem/client.py b/stem/client.py index 2a598747..a0288f52 100644 --- a/stem/client.py +++ b/stem/client.py @@ -133,23 +133,33 @@ class Cell(collections.namedtuple('Cell', ['name', 'value', 'fixed_size', 'for_c return cell -class Relay(object): +class VersionCell(Cell): """ - Connection with a `Tor relay's ORPort - <https://gitweb.torproject.org/torspec.git/tree/tor-spec.txt>`_. + Link version negotiation cell. """ + @staticmethod + def pack(versions): + """ + Provides the payload for a series of link versions. -def serialize_versions(versions): - """ - Provides the payload for a series of link versions. + :param list versions: link versions to serialize - :param list versions: link versions to serialize + :returns: **bytes** with a payload for these versions + """ - :returns: **bytes** with a payload for these versions - """ + # Used for link version negotiation so we don't have that yet. This is fine + # since VERSION cells avoid most version dependent attributes. - return b''.join([struct.pack(Pack.SHORT, v) for v in versions]) + payload = b''.join([struct.pack(Pack.SHORT, v) for v in versions]) + return Cell.pack('VERSIONS', 3, payload) + + +class Relay(object): + """ + Connection with a `Tor relay's ORPort + <https://gitweb.torproject.org/torspec.git/tree/tor-spec.txt>`_. + """ Pack = enum.Enum(

1 0

[stem/master] Cell module header docs
by atagar＠torproject.org 21 Jan '18

21 Jan '18

commit c9dccb160cec9888f02b237378111664ce9b5e8c Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Jan 10 11:24:31 2018 -0800 Cell module header docs --- stem/client/cell.py | 65 ++++++++++++++++++++++++++++++++++++++--------------- 1 file changed, 47 insertions(+), 18 deletions(-) diff --git a/stem/client/cell.py b/stem/client/cell.py index 1f70b685..ec95fe50 100644 --- a/stem/client/cell.py +++ b/stem/client/cell.py @@ -5,6 +5,35 @@ Messages communicated over a Tor relay's ORPort. .. versionadded:: 1.7.0 + +**Module Overview:** + +:: + + Cell - Base class for ORPort messages. + |- CircuitCell - Cell concerning a tor circuit. + | |- CreateCell - Create a circuit. (section 5.1) + | |- CreatedCell - Acknowledge create. (section 5.1) + | |- RelayCell - End-to-end data. (section 5.5 and 6) + | |- DestroyCell - Stop using a circuit. (section 5.4) + | |- CreateFastCell - Create a circuit, no PK. (section 5.1) + | |- CreatedFastCell - Circuit created, no PK. (section 5.1) + | |- RelayEarlyCell - End-to-end data; limited. (section 5.6) + | |- Create2Cell - Extended CREATE cell. (section 5.1) + | +- Created2Cell - Extended CREATED cell. (section 5.1) + | + |- PaddingCell - Padding negotiation. (section 7.2) + |- VersionsCell - Negotiate proto version. (section 4) + |- NetinfoCell - Time and address info. (section 4.5) + |- PaddingNegotiateCell - Padding negotiation. (section 7.2) + |- VPaddingCell - Variable-length padding. (section 7.2) + |- CertsCell - Relay certificates. (section 4.2) + |- AuthChallengeCell - Challenge value. (section 4.3) + |- AuthenticateCell - Client authentication. (section 4.5) + |- AuthorizeCell - Client authorization. (not yet used) + | + |- pack - Provides encoded bytes for this cell class. + +- unpack - Decodes bytes for this cell class. """ import collections @@ -252,22 +281,22 @@ class AuthorizeCell(Cell): CELL_TYPES = ( - PaddingCell, # Padding (section 7.2) - CreateCell, # Create a circuit (section 5.1) - CreatedCell, # Acknowledge create (section 5.1) - RelayCell, # End-to-end data (section 5.5 and 6) - DestroyCell, # Stop using a circuit (section 5.4) - CreateFastCell, # Create a circuit, no PK (section 5.1) - CreatedFastCell, # Circuit created, no PK (section 5.1) - VersionsCell, # Negotiate proto version (section 4) - NetinfoCell, # Time and address info (section 4.5) - RelayEarlyCell, # End-to-end data; limited (section 5.6) - Create2Cell, # Extended CREATE cell (section 5.1) - Created2Cell, # Extended CREATED cell (section 5.1) - PaddingNegotiateCell, # Padding negotiation (section 7.2) - VPaddingCell, # Variable-length padding (section 7.2) - CertsCell, # Certificates (section 4.2) - AuthChallengeCell, # Challenge value (section 4.3) - AuthenticateCell, # Client authentication (section 4.5) - AuthorizeCell, # Client authorization (not yet used) + PaddingCell, + CreateCell, + CreatedCell, + RelayCell, + DestroyCell, + CreateFastCell, + CreatedFastCell, + VersionsCell, + NetinfoCell, + RelayEarlyCell, + Create2Cell, + Created2Cell, + PaddingNegotiateCell, + VPaddingCell, + CertsCell, + AuthChallengeCell, + AuthenticateCell, + AuthorizeCell, )

1 0

[stem/master] Make stem.client a module
by atagar＠torproject.org 21 Jan '18

21 Jan '18

commit 6d90a05b5f60a0dd768689c44ef65529d9a48bb8 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jan 8 11:31:38 2018 -0800 Make stem.client a module This is gonna be big enoug that we'll want to split it up. --- setup.py | 2 +- stem/{client.py => client/__init__.py} | 0 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 4e9e4c7d..dc9e2937 100644 --- a/setup.py +++ b/setup.py @@ -102,7 +102,7 @@ try: author = stem.__author__, author_email = stem.__contact__, url = stem.__url__, - packages = ['stem', 'stem.descriptor', 'stem.interpreter', 'stem.response', 'stem.util'], + packages = ['stem', 'stem.client', 'stem.descriptor', 'stem.interpreter', 'stem.response', 'stem.util'], keywords = 'tor onion controller', scripts = ['tor-prompt'], package_data = { diff --git a/stem/client.py b/stem/client/__init__.py similarity index 100% rename from stem/client.py rename to stem/client/__init__.py

1 0

[stem/master] Stub all cell classes
by atagar＠torproject.org 21 Jan '18

21 Jan '18

commit 970ad53ebf08a50ca954bd1aae59122d9878d45b Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Jan 9 02:43:14 2018 -0800 Stub all cell classes --- stem/client/cell.py | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 119 insertions(+), 1 deletion(-) diff --git a/stem/client/cell.py b/stem/client/cell.py index 1f10a524..f1917805 100644 --- a/stem/client/cell.py +++ b/stem/client/cell.py @@ -115,11 +115,65 @@ class Cell(collections.namedtuple('Cell', ['name', 'value', 'fixed_size', 'for_c return cell -class VersionCell(Cell): +class PaddingCell(Cell): + NAME = 'PADDING' + VALUE = 0 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = False + + +class CreateCell(Cell): + NAME = 'CREATE' + VALUE = 1 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = True + + +class CreatedCell(Cell): + NAME = 'CREATED' + VALUE = 2 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = True + + +class RelayCell(Cell): + NAME = 'RELAY' + VALUE = 3 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = True + + +class DestroyCell(Cell): + NAME = 'DESTROY' + VALUE = 4 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = True + + +class CreateFastCell(Cell): + NAME = 'CREATE_FAST' + VALUE = 5 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = True + + +class CreatedFastCell(Cell): + NAME = 'CREATED_FAST' + VALUE = 6 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = True + + +class VersionsCell(Cell): """ Link version negotiation cell. """ + NAME = 'VERSIONS' + VALUE = 7 + IS_FIXED_SIZE = False + IS_FOR_CIRCUIT = False + @staticmethod def pack(versions): """ @@ -141,6 +195,70 @@ class NetinfoCell(Cell): NAME = 'NETINFO' VALUE = 8 IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = False + + +class RelayEarlyCell(Cell): + NAME = 'RELAY_EARLY' + VALUE = 9 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = True + + +class Create2Cell(Cell): + NAME = 'CREATE2' + VALUE = 10 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = True + + +class Created2Cell(Cell): + NAME = 'CREATED2' + VALUE = 11 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = False + + +class PaddingNegotiateCell(Cell): + NAME = 'PADDING_NEGOTIATE' + VALUE = 12 + IS_FIXED_SIZE = True + IS_FOR_CIRCUIT = False + + +class VPaddingCell(Cell): + NAME = 'VPADDING' + VALUE = 128 + IS_FIXED_SIZE = False + IS_FOR_CIRCUIT = False + + +class CertsCell(Cell): + NAME = 'CERTS' + VALUE = 129 + IS_FIXED_SIZE = False + IS_FOR_CIRCUIT = False + + +class AuthChallengeCell(Cell): + NAME = 'AUTH_CHALLENGE' + VALUE = 130 + IS_FIXED_SIZE = False + IS_FOR_CIRCUIT = False + + +class AuthenticateCell(Cell): + NAME = 'AUTHENTICATE' + VALUE = 131 + IS_FIXED_SIZE = False + IS_FOR_CIRCUIT = False + + +class AuthorizeCell(Cell): + NAME = 'AUTHORIZE' + VALUE = 132 + IS_FIXED_SIZE = False + IS_FOR_CIRCUIT = False CELL_TYPES = (

1 0