March 2013 - tor-commits - lists.torproject.org

[stem/master] Moving tutorials to sub-pages
by atagar＠torproject.org 04 Mar '13

04 Mar '13

commit f4d2b20b2d954852faa59d39ce9f38f7cb11dcd2 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Feb 18 22:12:01 2013 -0800 Moving tutorials to sub-pages Making pages for each of the tutorials and making tutorial.rst a pretty listing similar to the download page. This should hopefully make this page far more approachable by newcomers. --- docs/_static/label/mirror_mirror_on_the_wall.png | Bin 0 -> 2675 bytes .../label/resources/mirror_mirror_on_the_wall.xcf | Bin 0 -> 7035 bytes .../resources/the_little_relay_that_could.xcf | Bin 0 -> 7273 bytes docs/_static/label/the_little_relay_that_could.png | Bin 0 -> 3162 bytes docs/_static/section/tutorial/mirror.png | Bin 0 -> 2985 bytes docs/_static/section/tutorial/train.png | Bin 0 -> 9887 bytes docs/contents.rst | 3 + docs/tutorial.rst | 168 ++++---------------- docs/tutorial/mirror_mirror_on_the_wall.rst | 83 ++++++++++ docs/tutorial/the_little_relay_that_could.rst | 56 +++++++ 10 files changed, 172 insertions(+), 138 deletions(-) diff --git a/docs/_static/label/mirror_mirror_on_the_wall.png b/docs/_static/label/mirror_mirror_on_the_wall.png new file mode 100644 index 0000000..930d786 Binary files /dev/null and b/docs/_static/label/mirror_mirror_on_the_wall.png differ diff --git a/docs/_static/label/resources/mirror_mirror_on_the_wall.xcf b/docs/_static/label/resources/mirror_mirror_on_the_wall.xcf new file mode 100644 index 0000000..794cf7b Binary files /dev/null and b/docs/_static/label/resources/mirror_mirror_on_the_wall.xcf differ diff --git a/docs/_static/label/resources/the_little_relay_that_could.xcf b/docs/_static/label/resources/the_little_relay_that_could.xcf new file mode 100644 index 0000000..2589e8d Binary files /dev/null and b/docs/_static/label/resources/the_little_relay_that_could.xcf differ diff --git a/docs/_static/label/the_little_relay_that_could.png b/docs/_static/label/the_little_relay_that_could.png new file mode 100644 index 0000000..8c23539 Binary files /dev/null and b/docs/_static/label/the_little_relay_that_could.png differ diff --git a/docs/_static/section/tutorial/mirror.png b/docs/_static/section/tutorial/mirror.png new file mode 100644 index 0000000..69c2938 Binary files /dev/null and b/docs/_static/section/tutorial/mirror.png differ diff --git a/docs/_static/section/tutorial/train.png b/docs/_static/section/tutorial/train.png new file mode 100644 index 0000000..625b82e Binary files /dev/null and b/docs/_static/section/tutorial/train.png differ diff --git a/docs/contents.rst b/docs/contents.rst index 6b0311c..390f0a9 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -36,3 +36,6 @@ Contents api/util/term api/util/tor_tools + tutorial/the_little_relay_that_could + tutorial/mirror_mirror_on_the_wall + diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 0ca3d51..e5afa11 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -1,150 +1,42 @@ Tutorial ======== -Getting started with any new library can be rather daunting, so let's get our feet wet by jumping straight in with a tutorial... - -* :ref:`the-little-relay-that-could` - Hello world with the control port. -* :ref:`mirror-mirror-on-the-wall` - Querying information about the Tor network. - -.. _the-little-relay-that-could: - -The Little Relay that Could ---------------------------- - -Let's say you just set up your very first `Tor relay <https://www.torproject.org/docs/tor-doc-relay.html.en>`_. Thank you! Now you want to write a script that tells you how much it is being used. - -First, for any script we write to be able to talk with our relay it'll need to have a control port available. This is a port that's usually only available on localhost and protected by either a password or authentication cookie. - -Look at your `torrc <https://www.torproject.org/docs/faq.html.en#torrc>`_ for the following configuration options... - -:: - - # This provides a port for the script we write to talk to. If you set this - # then be sure to also have either set the CookieAuthentication flag *or* - # provide a HashedControlPassword! - - ControlPort 9051 - - # This will make Tor write an authentication cookie file. Anything that can - # read that file can connect to Tor. If you're going to run this script with - # the same user as Tor then this is the easiest method of authentication to - # use. - - CookieAuthentication 1 - - # Alternatively we can authenticate with a password. To set a password first - # get its hash... - # - # % tor --hash-password "my_password" - # 16:E600ADC1B52C80BB6022A0E999A7734571A451EB6AE50FED489B72E3DF - # - # ... and use that for the HashedControlPassword in our torrc. - - HashedControlPassword 16:E600ADC1B52C80BB6022A0E999A7734571A451EB6AE50FED489B72E3DF - -You'll need to restart Tor or issue a SIGHUP for these new settings to take effect. Now let's write a script that tells us how many bytes Tor has sent and received... - -:: - - from stem.control import Controller - - controller = Controller.from_port(control_port = 9051) - controller.authenticate() # provide the password here if you set one - - bytes_read = controller.get_info("traffic/read") - bytes_written = controller.get_info("traffic/written") - - print "My Tor relay has read %s bytes and written %s." % (bytes_read, bytes_written) - controller.close() +.. Image Sources: + + * The Little Relay That Could - train.png + Source: https://openclipart.org/detail/140185/tren-train-by-antroares + Author: Antroares + License: Public Domain + Alternate: https://openclipart.org/detail/1128/train-roadsign-by-ryanlerch + + * Mirror Mirror On The Wall - mirror.png + Source: https://openclipart.org/detail/152155/mirror-frame-by-gsagri04 + Author: Unknown (gsagri04?) + License: Public Domain + Alternate: https://openclipart.org/detail/174179/miroir-rectangulaire-by-defaz36-174179 -:: - - % python example.py - My Tor relay has read 33406 bytes and written 29649. - -Congratulations! You've just written your first controller script. - -.. _mirror-mirror-on-the-wall: - -Mirror Mirror on the Wall -------------------------- - -A script that tells us our contributed bandwidth is neat and all, but now let's figure out who the *biggest* exit relays are. - -Information about the Tor relay network come from documents called **descriptors**. Descriptors can come from a few things... - -1. The Tor control port with GETINFO options like **desc/all-recent** and **ns/all**. -2. Files in Tor's data directory, like **cached-descriptors** and **cached-consensus**. -3. The descriptor archive on `Tor's metrics site <https://metrics.torproject.org/data.html>`_. - -We've already used the control port, so for this example we'll use the cached files directly. First locate Tor's data directory. If your torrc has a DataDirectory line then that's the spot. If not then check Tor's man page for the default location. - -Tor has several descriptor types. For bandwidth information we'll go to the server descriptors, which are located in the **cached-descriptors** file. These have somewhat infrequently changing information published by the relays themselves. - -To read this file we'll use the :class:`~stem.descriptor.reader.DescriptorReader`, a class designed to read descriptor files. The **cached-descriptors** is full of server descriptors, so the reader will provide us with :class:`~stem.descriptor.server_descriptor.RelayDescriptor` instances (a :class:`~stem.descriptor.server_descriptor.ServerDescriptor` subclass for relays). +Getting started with any new library can be rather daunting, so let's get our feet wet by jumping straight in with a tutorial... -:: +.. list-table:: + :widths: 1 10 + :header-rows: 0 - import sys - from stem.descriptor.reader import DescriptorReader - from stem.util import str_tools - - # provides a mapping of observed bandwidth to the relay nicknames - def get_bw_to_relay(): - bw_to_relay = {} - - with DescriptorReader(["/home/atagar/.tor/cached-descriptors"]) as reader: - for desc in reader: - if desc.exit_policy.is_exiting_allowed(): - bw_to_relay.setdefault(desc.observed_bandwidth, []).append(desc.nickname) - - return bw_to_relay - - # prints the top fifteen relays - - bw_to_relay = get_bw_to_relay() - count = 1 - - for bw_value in sorted(bw_to_relay.keys(), reverse = True): - for nickname in bw_to_relay[bw_value]: - print "%i. %s (%s/s)" % (count, nickname, str_tools.get_size_label(bw_value, 2)) - count += 1 - - if count > 15: - sys.exit() + * - .. image:: /_static/section/tutorial/train.png + :target: tutorial/the_little_relay_that_could.html -:: + - .. image:: /_static/label/the_little_relay_that_could.png + :target: tutorial/the_little_relay_that_could.html - % python example.py - 1. herngaard (40.95 MB/s) - 2. chaoscomputerclub19 (40.43 MB/s) - 3. chaoscomputerclub18 (40.02 MB/s) - 4. chaoscomputerclub20 (38.98 MB/s) - 5. wannabe (38.63 MB/s) - 6. dorrisdeebrown (38.48 MB/s) - 7. manning2 (38.20 MB/s) - 8. chaoscomputerclub21 (36.90 MB/s) - 9. TorLand1 (36.22 MB/s) - 10. bolobolo1 (35.93 MB/s) - 11. manning1 (35.39 MB/s) - 12. gorz (34.10 MB/s) - 13. ndnr1 (25.36 MB/s) - 14. politkovskaja2 (24.93 MB/s) - 15. wau (24.72 MB/s) + "Hello World" for talking with Tor. This will step you through + configuring Tor and writing your first script to talk with it. -This can be easily done through the controller too... + * - .. image:: /_static/section/tutorial/mirror.png + :target: tutorial/mirror_mirror_on_the_wall.html -:: + - .. image:: /_static/label/mirror_mirror_on_the_wall.png + :target: tutorial/mirror_mirror_on_the_wall.html - def get_bw_to_relay(): - bw_to_relay = {} - - with Controller.from_port(control_port = 9051) as controller: - controller.authenticate() - - for desc in controller.get_server_descriptors(): - if desc.exit_policy.is_exiting_allowed(): - bw_to_relay.setdefault(desc.observed_bandwidth, []).append(desc.nickname) - - return bw_to_relay + Getting and acting on information about relays in the Tor network. This + walks you through Tor descriptors, both where to get them and writing a + small script to tell you the fastest Tor exits. diff --git a/docs/tutorial/mirror_mirror_on_the_wall.rst b/docs/tutorial/mirror_mirror_on_the_wall.rst new file mode 100644 index 0000000..d9a4dd8 --- /dev/null +++ b/docs/tutorial/mirror_mirror_on_the_wall.rst @@ -0,0 +1,83 @@ +Mirror Mirror on the Wall +------------------------- + +A script that tells us our contributed bandwidth is neat and all, but now let's figure out who the *biggest* exit relays are. + +Information about the Tor relay network come from documents called **descriptors**. Descriptors can come from a few things... + +1. The Tor control port with GETINFO options like **desc/all-recent** and **ns/all**. +2. Files in Tor's data directory, like **cached-descriptors** and **cached-consensus**. +3. The descriptor archive on `Tor's metrics site <https://metrics.torproject.org/data.html>`_. + +We've already used the control port, so for this example we'll use the cached files directly. First locate Tor's data directory. If your torrc has a DataDirectory line then that's the spot. If not then check Tor's man page for the default location. + +Tor has several descriptor types. For bandwidth information we'll go to the server descriptors, which are located in the **cached-descriptors** file. These have somewhat infrequently changing information published by the relays themselves. + +To read this file we'll use the :class:`~stem.descriptor.reader.DescriptorReader`, a class designed to read descriptor files. The **cached-descriptors** is full of server descriptors, so the reader will provide us with :class:`~stem.descriptor.server_descriptor.RelayDescriptor` instances (a :class:`~stem.descriptor.server_descriptor.ServerDescriptor` subclass for relays). + +:: + + import sys + from stem.descriptor.reader import DescriptorReader + from stem.util import str_tools + + # provides a mapping of observed bandwidth to the relay nicknames + def get_bw_to_relay(): + bw_to_relay = {} + + with DescriptorReader(["/home/atagar/.tor/cached-descriptors"]) as reader: + for desc in reader: + if desc.exit_policy.is_exiting_allowed(): + bw_to_relay.setdefault(desc.observed_bandwidth, []).append(desc.nickname) + + return bw_to_relay + + # prints the top fifteen relays + + bw_to_relay = get_bw_to_relay() + count = 1 + + for bw_value in sorted(bw_to_relay.keys(), reverse = True): + for nickname in bw_to_relay[bw_value]: + print "%i. %s (%s/s)" % (count, nickname, str_tools.get_size_label(bw_value, 2)) + count += 1 + + if count > 15: + sys.exit() + +:: + + % python example.py + 1. herngaard (40.95 MB/s) + 2. chaoscomputerclub19 (40.43 MB/s) + 3. chaoscomputerclub18 (40.02 MB/s) + 4. chaoscomputerclub20 (38.98 MB/s) + 5. wannabe (38.63 MB/s) + 6. dorrisdeebrown (38.48 MB/s) + 7. manning2 (38.20 MB/s) + 8. chaoscomputerclub21 (36.90 MB/s) + 9. TorLand1 (36.22 MB/s) + 10. bolobolo1 (35.93 MB/s) + 11. manning1 (35.39 MB/s) + 12. gorz (34.10 MB/s) + 13. ndnr1 (25.36 MB/s) + 14. politkovskaja2 (24.93 MB/s) + 15. wau (24.72 MB/s) + +This can be easily done through the controller too... + +:: + + def get_bw_to_relay(): + bw_to_relay = {} + + with Controller.from_port(control_port = 9051) as controller: + controller.authenticate() + + for desc in controller.get_server_descriptors(): + if desc.exit_policy.is_exiting_allowed(): + bw_to_relay.setdefault(desc.observed_bandwidth, []).append(desc.nickname) + + return bw_to_relay + + diff --git a/docs/tutorial/the_little_relay_that_could.rst b/docs/tutorial/the_little_relay_that_could.rst new file mode 100644 index 0000000..e3f7675 --- /dev/null +++ b/docs/tutorial/the_little_relay_that_could.rst @@ -0,0 +1,56 @@ +The Little Relay that Could +--------------------------- + +Let's say you just set up your very first `Tor relay <https://www.torproject.org/docs/tor-doc-relay.html.en>`_. Thank you! Now you want to write a script that tells you how much it is being used. + +First, for any script we write to be able to talk with our relay it'll need to have a control port available. This is a port that's usually only available on localhost and protected by either a password or authentication cookie. + +Look at your `torrc <https://www.torproject.org/docs/faq.html.en#torrc>`_ for the following configuration options... + +:: + + # This provides a port for the script we write to talk to. If you set this + # then be sure to also have either set the CookieAuthentication flag *or* + # provide a HashedControlPassword! + + ControlPort 9051 + + # This will make Tor write an authentication cookie file. Anything that can + # read that file can connect to Tor. If you're going to run this script with + # the same user as Tor then this is the easiest method of authentication to + # use. + + CookieAuthentication 1 + + # Alternatively we can authenticate with a password. To set a password first + # get its hash... + # + # % tor --hash-password "my_password" + # 16:E600ADC1B52C80BB6022A0E999A7734571A451EB6AE50FED489B72E3DF + # + # ... and use that for the HashedControlPassword in our torrc. + + HashedControlPassword 16:E600ADC1B52C80BB6022A0E999A7734571A451EB6AE50FED489B72E3DF + +You'll need to restart Tor or issue a SIGHUP for these new settings to take effect. Now let's write a script that tells us how many bytes Tor has sent and received... + +:: + + from stem.control import Controller + + controller = Controller.from_port(control_port = 9051) + controller.authenticate() # provide the password here if you set one + + bytes_read = controller.get_info("traffic/read") + bytes_written = controller.get_info("traffic/written") + + print "My Tor relay has read %s bytes and written %s." % (bytes_read, bytes_written) + controller.close() + +:: + + % python example.py + My Tor relay has read 33406 bytes and written 29649. + +Congratulations! You've just written your first controller script. +

1 0

[stem/master] Rewriting the descriptor tutorial
by atagar＠torproject.org 04 Mar '13

04 Mar '13

commit a86d250b6702f7dae9ed74778a6e0a5cb2f9358a Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Mar 3 23:11:30 2013 -0800 Rewriting the descriptor tutorial Replacing the 'Mirror, Mirror' tutorial with a new one that gives a better overview of the various descriptors and how to get/use them. This keeps the old example (listing the fastest exits), but otherwise is a full rewrite. --- docs/tutorial/mirror_mirror_on_the_wall.rst | 167 +++++++++++++++++++------ docs/tutorial/the_little_relay_that_could.rst | 2 +- 2 files changed, 132 insertions(+), 37 deletions(-) diff --git a/docs/tutorial/mirror_mirror_on_the_wall.rst b/docs/tutorial/mirror_mirror_on_the_wall.rst index d9a4dd8..3679ec1 100644 --- a/docs/tutorial/mirror_mirror_on_the_wall.rst +++ b/docs/tutorial/mirror_mirror_on_the_wall.rst @@ -1,47 +1,159 @@ Mirror Mirror on the Wall -------------------------- +========================= -A script that tells us our contributed bandwidth is neat and all, but now let's figure out who the *biggest* exit relays are. +* :ref:`what-is-a-descriptor` +* :ref:`where-can-i-get-the-current-descriptors` +* :ref:`where-can-i-get-past-descriptors` +* :ref:`putting-it-together` -Information about the Tor relay network come from documents called **descriptors**. Descriptors can come from a few things... +.. _what-is-a-descriptor: -1. The Tor control port with GETINFO options like **desc/all-recent** and **ns/all**. -2. Files in Tor's data directory, like **cached-descriptors** and **cached-consensus**. -3. The descriptor archive on `Tor's metrics site <https://metrics.torproject.org/data.html>`_. +What is a descriptor? +--------------------- -We've already used the control port, so for this example we'll use the cached files directly. First locate Tor's data directory. If your torrc has a DataDirectory line then that's the spot. If not then check Tor's man page for the default location. +Tor is made up of two parts: the application and a distributed network of a few +thousand volunteer relays. Information about these relays is public, and made +up of documents called **descriptors**. -Tor has several descriptor types. For bandwidth information we'll go to the server descriptors, which are located in the **cached-descriptors** file. These have somewhat infrequently changing information published by the relays themselves. +There are several different kinds of descriptors, the most common ones being... -To read this file we'll use the :class:`~stem.descriptor.reader.DescriptorReader`, a class designed to read descriptor files. The **cached-descriptors** is full of server descriptors, so the reader will provide us with :class:`~stem.descriptor.server_descriptor.RelayDescriptor` instances (a :class:`~stem.descriptor.server_descriptor.ServerDescriptor` subclass for relays). +====================================================================== =========== +Descriptor Type Description +====================================================================== =========== +`Server Descriptor <../api/descriptor/server_descriptor.html>`_ Information that relays publish about themselves. Tor clients once downloaded this information, but now they use microdescriptors instead. +`ExtraInfo Descriptor <../api/descriptor/extrainfo_descriptor.html>`_ Relay information that tor clients do not need in order to function. This is self-published, like server descriptors, but not downloaded by default. +`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. +====================================================================== =========== + +.. _where-can-i-get-the-current-descriptors: + +Where can I get the current descriptors? +---------------------------------------- + +To work tor needs to have up-to-date information about relays within the +network. As such getting current descriptors is easy: *just run tor*. + +Tor only gets the descriptors that it needs by default, so if you're scripting +against tor you may want to set some of the following in your `torrc +<https://www.torproject.org/docs/faq.html.en#torrc>`_. Keep in mind that these +add a small burden to the network, so don't set them in a widely distributed +application. And, of course, please consider `running tor as a relay +<https://www.torproject.org/docs/tor-doc-relay.html.en>`_ so you give back to +the network! + +:: + + # Descriptors have a range of time during which they're valid. To get the + # most recent descriptor information, regardless of if tor needs it or not, + # set the following. + + FetchDirInfoExtraEarly 1 + + # If you aren't actively using tor as a client then tor will eventually stop + # downloading descriptor information that it doesn't need. To prevent this + # from happening set... + + FetchUselessDescriptors 1 + + # Tor no longer downloads server descriptors by default, opting for + # microdescriptors instead. If you want tor to download server descriptors + # then set... + + UseMicrodescriptors 0 + + # Tor doesn't need extrainfo descriptors to work. If you want tor to download + # them anyway then set... + + DownloadExtraInfo 1 + +Now that tor is happy chugging along up-to-date descriptors are available +through tor's control socket... + +:: + + from stem.control import Controller + + with Controller.from_port(control_port = 9051) as controller: + controller.authenticate() + + for desc in controller.get_network_statuses(): + print "found relay %s (%s)" % (desc.nickname, desc.fingerprint) + +... or by reading directly from tor's data directory... + +:: + + from stem.descriptor import parse_file + + for desc in parse_file("/home/atagar/.tor/cached-consensus"): + print "found relay %s (%s)" % (desc.nickname, desc.fingerprint) + +.. _where-can-i-get-past-descriptors: + +Where can I get past descriptors? +--------------------------------- + +Descriptor archives are available on `Tor's metrics site +<https://metrics.torproject.org/data.html>`_. These archives can be read with +the `DescriptorReader <api/descriptor/reader.html>`_... :: - import sys from stem.descriptor.reader import DescriptorReader + + with DescriptorReader(["/home/atagar/server-descriptors-2013-03.tar"]) as reader: + for desc in reader: + print "found relay %s (%s)" % (desc.nickname, desc.fingerprint) + +.. _putting-it-together: + +Putting it together... +---------------------- + +As discussed above there are three methods for reading descriptors... + +* With the :class:`~stem.control.Controller` via methods like :func:`~stem.control.Controller.get_server_descriptors` and :func:`~stem.control.Controller.get_network_statuses`. +* By reading the file directly with :func:`~stem.descriptor.__init__.parse_file`. +* Reading with the `DescriptorReader <api/descriptor/reader.html>`_. This is best if you have you want to read everything from a directory or archive. + +Now lets say you want to figure out who the *biggest* exit relays are. You +could use any of the methods above, but for this example we'll use the +:class:`~stem.control.Controller`. This uses server descriptors, so keep in +mind that you'll likely need to set "UseMicrodescriptors 0" in your torrc for +this to work. + +:: + + import sys + + from stem.contorl import Controller from stem.util import str_tools - + # provides a mapping of observed bandwidth to the relay nicknames def get_bw_to_relay(): bw_to_relay = {} - - with DescriptorReader(["/home/atagar/.tor/cached-descriptors"]) as reader: - for desc in reader: + + with Controller.from_port(control_port = 9051) as controller: + controller.authenticate() + + for desc in controller.get_server_descriptors(): if desc.exit_policy.is_exiting_allowed(): bw_to_relay.setdefault(desc.observed_bandwidth, []).append(desc.nickname) - + return bw_to_relay - + # prints the top fifteen relays - + bw_to_relay = get_bw_to_relay() count = 1 - + for bw_value in sorted(bw_to_relay.keys(), reverse = True): for nickname in bw_to_relay[bw_value]: print "%i. %s (%s/s)" % (count, nickname, str_tools.get_size_label(bw_value, 2)) count += 1 - + if count > 15: sys.exit() @@ -64,20 +176,3 @@ To read this file we'll use the :class:`~stem.descriptor.reader.DescriptorReader 14. politkovskaja2 (24.93 MB/s) 15. wau (24.72 MB/s) -This can be easily done through the controller too... - -:: - - def get_bw_to_relay(): - bw_to_relay = {} - - with Controller.from_port(control_port = 9051) as controller: - controller.authenticate() - - for desc in controller.get_server_descriptors(): - if desc.exit_policy.is_exiting_allowed(): - bw_to_relay.setdefault(desc.observed_bandwidth, []).append(desc.nickname) - - return bw_to_relay - - diff --git a/docs/tutorial/the_little_relay_that_could.rst b/docs/tutorial/the_little_relay_that_could.rst index e3f42d0..96216d1 100644 --- a/docs/tutorial/the_little_relay_that_could.rst +++ b/docs/tutorial/the_little_relay_that_could.rst @@ -1,5 +1,5 @@ The Little Relay that Could ---------------------------- +=========================== Let's say you just set up your very first `Tor relay <https://www.torproject.org/docs/tor-doc-relay.html.en>`_ (thank you!), and now

1 0

[stem/master] Adding microdescriptors to our api docs
by atagar＠torproject.org 04 Mar '13

04 Mar '13

commit fce9b2e92f4d6bf9a01431f993fd0e42dcd6f6ad Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Mar 3 16:12:24 2013 -0800 Adding microdescriptors to our api docs --- docs/api.rst | 1 + docs/api/descriptor/microdescriptor.rst | 5 +++++ docs/contents.rst | 1 + 3 files changed, 7 insertions(+), 0 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 3f9d770..6ea028a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -29,6 +29,7 @@ individual files and `stem.descriptor.reader * `stem.descriptor <api/descriptor/descriptor.html>`_ - Base class for descriptors. * `stem.descriptor.server_descriptor <api/descriptor/server_descriptor.html>`_ - Relay and bridge server descriptors. * `stem.descriptor.extrainfo_descriptor <api/descriptor/extrainfo_descriptor.html>`_ - Relay and bridge extrainfo descriptors. + * `stem.descriptor.microdescriptor <api/descriptor/microdescriptor.html>`_ - Minimalistic counterpart for server descriptors. * `stem.descriptor.networkstatus <api/descriptor/networkstatus.html>`_ - Network status documents which make up the Tor consensus. * `stem.descriptor.router_status_entry <api/descriptor/router_status_entry.html>`_ - Relay entries within a network status document. diff --git a/docs/api/descriptor/microdescriptor.rst b/docs/api/descriptor/microdescriptor.rst new file mode 100644 index 0000000..b559ea5 --- /dev/null +++ b/docs/api/descriptor/microdescriptor.rst @@ -0,0 +1,5 @@ +MicroDescriptor +=============== + +.. automodule:: stem.descriptor.microdescriptor + diff --git a/docs/contents.rst b/docs/contents.rst index 4757212..fbf2495 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -24,6 +24,7 @@ Contents api/descriptor/descriptor api/descriptor/server_descriptor api/descriptor/extrainfo_descriptor + api/descriptor/microdescriptor api/descriptor/networkstatus api/descriptor/router_status_entry

1 0

[stem/master] Cleaning up 'The Little Engine that Could' tutorial test
by atagar＠torproject.org 04 Mar '13

04 Mar '13

commit 478ba3a44f3291367eeaea9ba9ce0f4cab24f517 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Feb 23 11:49:02 2013 -0800 Cleaning up 'The Little Engine that Could' tutorial test Of all our tests the tutorial example tests stick out as being... just aweful. They work I guess but their mix of heavy mocking and the example being tested is both damn confusing and unmaintainable. Breaking it up so the mocking is entirely separate from the tutorial code. --- docs/tutorial/the_little_relay_that_could.rst | 2 +- test/mocking.py | 12 ++++++--- test/unit/tutorial.py | 32 +++++++++++++++--------- 3 files changed, 29 insertions(+), 17 deletions(-) diff --git a/docs/tutorial/the_little_relay_that_could.rst b/docs/tutorial/the_little_relay_that_could.rst index 5f85f6e..e3f42d0 100644 --- a/docs/tutorial/the_little_relay_that_could.rst +++ b/docs/tutorial/the_little_relay_that_could.rst @@ -49,7 +49,7 @@ many bytes Tor has sent and received... from stem.control import Controller with Controller.from_port(control_port = 9051) as controller: - controller.authenticate() # provide the password here if you set one + controller.authenticate() # provide the password here if you set one bytes_read = controller.get_info("traffic/read") bytes_written = controller.get_info("traffic/written") diff --git a/test/mocking.py b/test/mocking.py index 3ee8f08..9ed3fbb 100644 --- a/test/mocking.py +++ b/test/mocking.py @@ -204,14 +204,14 @@ NETWORK_STATUS_DOCUMENT_FOOTER = ( def no_op(): - def _no_op(*args): + def _no_op(*args, **kwargs): pass return _no_op def return_value(value): - def _return_value(*args): + def _return_value(*args, **kwargs): return value return _return_value @@ -318,7 +318,7 @@ def support_with(obj): return obj -def mock(target, mock_call, target_module=None): +def mock(target, mock_call, target_module = None, is_static = False): """ Mocks the given function, saving the initial implementation so it can be reverted later. @@ -331,6 +331,7 @@ def mock(target, mock_call, target_module=None): :param function target: function to be mocked :param functor mock_call: mocking to replace the function with :param module target_module: module that this is mocking, this defaults to the inspected value + :param bool is_static: handles this like a static method of the target_module if True """ if hasattr(target, "mock_id"): @@ -349,7 +350,10 @@ def mock(target, mock_call, target_module=None): # mocks the function with this wrapper - setattr(target_module, target_function, mock_wrapper) + if is_static: + setattr(target_module, target_function, staticmethod(mock_wrapper)) + else: + setattr(target_module, target_function, mock_wrapper) def mock_method(target_class, method_name, mock_call): diff --git a/test/unit/tutorial.py b/test/unit/tutorial.py index 21db41b..7d79eb2 100644 --- a/test/unit/tutorial.py +++ b/test/unit/tutorial.py @@ -8,6 +8,7 @@ import StringIO import sys import unittest +from stem.control import Controller from test import mocking @@ -23,27 +24,34 @@ class TestTutorial(unittest.TestCase): sys.stdout = self.stdout_real def test_the_little_relay_that_could(self): - from stem.control import Controller + def tutorial_example(): + from stem.control import Controller + + with Controller.from_port(control_port = 9051) as controller: + controller.authenticate() # provide the password here if you set one + + bytes_read = controller.get_info("traffic/read") + bytes_written = controller.get_info("traffic/written") + + print "My Tor relay has read %s bytes and written %s." % (bytes_read, bytes_written) controller = mocking.get_object(Controller, { 'authenticate': mocking.no_op(), 'close': mocking.no_op(), 'get_info': mocking.return_for_args({ - ('traffic/read',): '1234', - ('traffic/written',): '5678', + ('traffic/read',): '33406', + ('traffic/written',): '29649', }, is_method = True), }) - controller.authenticate() - - bytes_read = controller.get_info("traffic/read") - bytes_written = controller.get_info("traffic/written") - - print "My Tor relay has read %s bytes and written %s." % (bytes_read, bytes_written) - - controller.close() + mocking.mock( + Controller.from_port, mocking.return_value(controller), + target_module = Controller, + is_static = True, + ) - self.assertEqual("My Tor relay has read 1234 bytes and written 5678.\n", self.stdout.getvalue()) + tutorial_example() + self.assertEqual("My Tor relay has read 33406 bytes and written 29649.\n", self.stdout.getvalue()) def test_mirror_mirror_on_the_wall(self): from stem.descriptor.server_descriptor import RelayDescriptor

1 0

[stem/master] Revising the tutorials
by atagar＠torproject.org 04 Mar '13

04 Mar '13

commit 0c4cb0d9c0178a353df4894bb87ccb835bca2ace Merge: 954bced 7d4efa2 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Mar 4 00:11:59 2013 -0800 Revising the tutorials Changing our tutorial page to be a friendly listing of the tutorials rather than a wall of text. Also rewrote our present tutorials and their corresponding tests. docs/_static/label/mirror_mirror_on_the_wall.png | Bin 0 -> 2675 bytes .../label/resources/mirror_mirror_on_the_wall.xcf | Bin 0 -> 7035 bytes .../resources/the_little_relay_that_could.xcf | Bin 0 -> 7273 bytes docs/_static/label/the_little_relay_that_could.png | Bin 0 -> 3162 bytes docs/_static/section/archlinux.png | Bin 7144 -> 0 bytes docs/_static/section/debian.png | Bin 5646 -> 0 bytes docs/_static/section/download/archlinux.png | Bin 0 -> 7144 bytes docs/_static/section/download/debian.png | Bin 0 -> 5646 bytes docs/_static/section/download/git.png | Bin 0 -> 4749 bytes docs/_static/section/git.png | Bin 4749 -> 0 bytes docs/_static/section/tutorial/mirror.png | Bin 0 -> 2985 bytes docs/_static/section/tutorial/train.png | Bin 0 -> 9887 bytes docs/api.rst | 1 + docs/api/descriptor/microdescriptor.rst | 5 + docs/contents.rst | 9 +- docs/download.rst | 6 +- docs/tutorial.rst | 186 ++++--------------- docs/tutorial/mirror_mirror_on_the_wall.rst | 178 ++++++++++++++++++ docs/tutorial/the_little_relay_that_could.rst | 65 +++++++ test/mocking.py | 12 +- test/unit/tutorial.py | 189 +++++++++++++++----- 21 files changed, 449 insertions(+), 202 deletions(-)

1 0

[stem/master] Tests for descriptor tutorial examples
by atagar＠torproject.org 04 Mar '13

04 Mar '13

commit 7d4efa2102727a1135bd19204e7d35f7b8900ec4 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Mar 4 00:10:07 2013 -0800 Tests for descriptor tutorial examples Unit tests for our new 'mirror, mirror' tutorial examples, and writing our prior tests to conform with the way-less-sucky style that separates the mocking from the example. --- docs/tutorial/mirror_mirror_on_the_wall.rst | 4 +- test/unit/tutorial.py | 152 ++++++++++++++++++++------- 2 files changed, 117 insertions(+), 39 deletions(-) diff --git a/docs/tutorial/mirror_mirror_on_the_wall.rst b/docs/tutorial/mirror_mirror_on_the_wall.rst index 3679ec1..617d898 100644 --- a/docs/tutorial/mirror_mirror_on_the_wall.rst +++ b/docs/tutorial/mirror_mirror_on_the_wall.rst @@ -87,7 +87,7 @@ through tor's control socket... from stem.descriptor import parse_file - for desc in parse_file("/home/atagar/.tor/cached-consensus"): + for desc in parse_file(open("/home/atagar/.tor/cached-consensus")): print "found relay %s (%s)" % (desc.nickname, desc.fingerprint) .. _where-can-i-get-past-descriptors: @@ -128,7 +128,7 @@ this to work. import sys - from stem.contorl import Controller + from stem.control import Controller from stem.util import str_tools # provides a mapping of observed bandwidth to the relay nicknames diff --git a/test/unit/tutorial.py b/test/unit/tutorial.py index 7d79eb2..0aec3a3 100644 --- a/test/unit/tutorial.py +++ b/test/unit/tutorial.py @@ -9,8 +9,16 @@ import sys import unittest from stem.control import Controller +from stem.descriptor.reader import DescriptorReader +from stem.descriptor.server_descriptor import RelayDescriptor from test import mocking +MIRROR_MIRROR_OUTPUT = """\ +1. speedyexit (102.13 KB/s) +2. speedyexit (102.13 KB/s) +3. speedyexit (102.13 KB/s) +""" + class TestTutorial(unittest.TestCase): stdout, stdout_real = None, None @@ -53,53 +61,123 @@ class TestTutorial(unittest.TestCase): tutorial_example() self.assertEqual("My Tor relay has read 33406 bytes and written 29649.\n", self.stdout.getvalue()) - def test_mirror_mirror_on_the_wall(self): - from stem.descriptor.server_descriptor import RelayDescriptor - from stem.descriptor.reader import DescriptorReader - from stem.util import str_tools + def test_mirror_mirror_on_the_wall_1(self): + def tutorial_example(): + from stem.control import Controller - exit_descriptor = mocking.get_relay_server_descriptor({ - 'router': 'speedyexit 149.255.97.109 9001 0 0' - }, content = True).replace('reject *:*', 'accept *:*') - exit_descriptor = mocking.sign_descriptor_content(exit_descriptor) - exit_descriptor = RelayDescriptor(exit_descriptor) + with Controller.from_port(control_port = 9051) as controller: + controller.authenticate() - reader_wrapper = mocking.get_object(DescriptorReader, { - '__enter__': lambda x: x, - '__exit__': mocking.no_op(), - '__iter__': mocking.return_value(iter(( - exit_descriptor, - mocking.get_relay_server_descriptor(), # non-exit - exit_descriptor, - exit_descriptor, - ))) + for desc in controller.get_network_statuses(): + print "found relay %s (%s)" % (desc.nickname, desc.fingerprint) + + controller = mocking.get_object(Controller, { + 'authenticate': mocking.no_op(), + 'close': mocking.no_op(), + 'get_network_statuses': mocking.return_value( + [mocking.get_router_status_entry_v2()], + ), }) - # provides a mapping of observed bandwidth to the relay nicknames - def get_bw_to_relay(): - bw_to_relay = {} + mocking.mock( + Controller.from_port, mocking.return_value(controller), + target_module = Controller, + is_static = True, + ) + + tutorial_example() + self.assertEqual("found relay caerSidi (A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB)\n", self.stdout.getvalue()) + + def test_mirror_mirror_on_the_wall_2(self): + def tutorial_example(): + from stem.descriptor import parse_file + + for desc in parse_file(open("/home/atagar/.tor/cached-consensus")): + print "found relay %s (%s)" % (desc.nickname, desc.fingerprint) + + test_file = StringIO.StringIO(mocking.get_network_status_document_v3( + routers = [mocking.get_router_status_entry_v3()], + content = True, + )) + + mocking.support_with(test_file) + test_file.name = "/home/atagar/.tor/cached-consensus" + mocking.mock(open, mocking.return_value(test_file)) + + tutorial_example() + self.assertEqual("found relay caerSidi (A7569A83B5706AB1B1A9CB52EFF7D2D32E4553EB)\n", self.stdout.getvalue()) + + def test_mirror_mirror_on_the_wall_3(self): + def tutorial_example(): + from stem.descriptor.reader import DescriptorReader - with reader_wrapper as reader: + with DescriptorReader(["/home/atagar/server-descriptors-2013-03.tar"]) as reader: for desc in reader: - if desc.exit_policy.is_exiting_allowed(): - bw_to_relay.setdefault(desc.observed_bandwidth, []).append(desc.nickname) + print "found relay %s (%s)" % (desc.nickname, desc.fingerprint) - return bw_to_relay + mocking.mock( + DescriptorReader.__iter__, + mocking.return_value(iter([mocking.get_relay_server_descriptor()])), + target_module = DescriptorReader + ) + + tutorial_example() + self.assertEqual("found relay caerSidi (None)\n", self.stdout.getvalue()) + + def test_mirror_mirror_on_the_wall_4(self): + def tutorial_example(): + from stem.control import Controller + from stem.util import str_tools + + # provides a mapping of observed bandwidth to the relay nicknames + def get_bw_to_relay(): + bw_to_relay = {} - # prints the top fifteen relays + with Controller.from_port(control_port = 9051) as controller: + controller.authenticate() - bw_to_relay = get_bw_to_relay() - count = 1 + for desc in controller.get_server_descriptors(): + if desc.exit_policy.is_exiting_allowed(): + bw_to_relay.setdefault(desc.observed_bandwidth, []).append(desc.nickname) + + return bw_to_relay + + # prints the top fifteen relays + + bw_to_relay = get_bw_to_relay() + count = 1 + + for bw_value in sorted(bw_to_relay.keys(), reverse = True): + for nickname in bw_to_relay[bw_value]: + print "%i. %s (%s/s)" % (count, nickname, str_tools.get_size_label(bw_value, 2)) + count += 1 + + if count > 15: + return + + exit_descriptor = mocking.get_relay_server_descriptor({ + 'router': 'speedyexit 149.255.97.109 9001 0 0' + }, content = True).replace('reject *:*', 'accept *:*') - for bw_value in sorted(bw_to_relay.keys(), reverse = True): - for nickname in bw_to_relay[bw_value]: - print "%i. %s (%s/s)" % (count, nickname, str_tools.get_size_label(bw_value, 2)) + exit_descriptor = mocking.sign_descriptor_content(exit_descriptor) + exit_descriptor = RelayDescriptor(exit_descriptor) - count += 1 + controller = mocking.get_object(Controller, { + 'authenticate': mocking.no_op(), + 'close': mocking.no_op(), + 'get_server_descriptors': mocking.return_value([ + exit_descriptor, + mocking.get_relay_server_descriptor(), # non-exit + exit_descriptor, + exit_descriptor, + ]) + }) - if count > 15: - return + mocking.mock( + Controller.from_port, mocking.return_value(controller), + target_module = Controller, + is_static = True, + ) - expected_stdout = "".join(["%i. speedyexit (102.13 KB/s)\n" % i for i in xrange(1, 4)]) - self.assertEqual(expected_stdout, self.stdout.getvalue()) - self.assertEqual(4, count) + tutorial_example() + self.assertEqual(MIRROR_MIRROR_OUTPUT, self.stdout.getvalue())

1 0

[stem/master] Revising 'The Little Relay that Could' tutorial
by atagar＠torproject.org 04 Mar '13

04 Mar '13

commit 63bad222dc4de6b7e3c8510e4704ac7af0cabcdb Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Feb 22 08:55:14 2013 -0800 Revising 'The Little Relay that Could' tutorial Changing small bits if the tutorial page and 'hello world' tutorial, adding a little detail here and cleaning up the wording there. --- docs/tutorial.rst | 10 +++-- docs/tutorial/the_little_relay_that_could.rst | 49 +++++++++++++++---------- 2 files changed, 35 insertions(+), 24 deletions(-) diff --git a/docs/tutorial.rst b/docs/tutorial.rst index e5afa11..68572fd 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -15,7 +15,8 @@ Tutorial License: Public Domain Alternate: https://openclipart.org/detail/174179/miroir-rectangulaire-by-defaz36-174179 -Getting started with any new library can be rather daunting, so let's get our feet wet by jumping straight in with a tutorial... +Getting started with any new library can be rather daunting, so let's get our +feet wet by jumping straight in with some tutorials... .. list-table:: :widths: 1 10 @@ -36,7 +37,8 @@ Getting started with any new library can be rather daunting, so let's get our fe - .. image:: /_static/label/mirror_mirror_on_the_wall.png :target: tutorial/mirror_mirror_on_the_wall.html - Getting and acting on information about relays in the Tor network. This - walks you through Tor descriptors, both where to get them and writing a - small script to tell you the fastest Tor exits. + Getting and acting upon information about relays in the Tor network. + Relay information is provided through documents called **descriptors**. + This walks you through both where to get them and a small script to tell + you the fastest Tor exits. diff --git a/docs/tutorial/the_little_relay_that_could.rst b/docs/tutorial/the_little_relay_that_could.rst index e3f7675..5f85f6e 100644 --- a/docs/tutorial/the_little_relay_that_could.rst +++ b/docs/tutorial/the_little_relay_that_could.rst @@ -1,24 +1,32 @@ The Little Relay that Could --------------------------- -Let's say you just set up your very first `Tor relay <https://www.torproject.org/docs/tor-doc-relay.html.en>`_. Thank you! Now you want to write a script that tells you how much it is being used. +Let's say you just set up your very first `Tor relay +<https://www.torproject.org/docs/tor-doc-relay.html.en>`_ (thank you!), and now +you want to write a script that tells you how much it is being used. -First, for any script we write to be able to talk with our relay it'll need to have a control port available. This is a port that's usually only available on localhost and protected by either a password or authentication cookie. +First, for any script to talk with your relay it will need to have a control +port available. This is a port that's usually only available on localhost and +protected by either a **password** or **authentication cookie**. -Look at your `torrc <https://www.torproject.org/docs/faq.html.en#torrc>`_ for the following configuration options... +Look at your `torrc <https://www.torproject.org/docs/faq.html.en#torrc>`_ for +the following configuration options... :: - # This provides a port for the script we write to talk to. If you set this - # then be sure to also have either set the CookieAuthentication flag *or* - # provide a HashedControlPassword! + # This provides a port for our script to talk with. If you set this then be + # sure to also set either CookieAuthentication *or* HashedControlPassword! + # + # You could also use ControlSocket instead of ControlPort, which provides a + # file based socket. You don't need to have authentication if you use + # ControlSocket. For this example however we'll use a port. ControlPort 9051 - # This will make Tor write an authentication cookie file. Anything that can - # read that file can connect to Tor. If you're going to run this script with - # the same user as Tor then this is the easiest method of authentication to - # use. + # Setting this will make Tor write an authentication cookie. Anything with + # permission to read this file can connect to Tor. If you're going to run + # your script with the same user or permission group as Tor then this is the + # easiest method of authentication to use. CookieAuthentication 1 @@ -28,24 +36,25 @@ Look at your `torrc <https://www.torproject.org/docs/faq.html.en#torrc>`_ for th # % tor --hash-password "my_password" # 16:E600ADC1B52C80BB6022A0E999A7734571A451EB6AE50FED489B72E3DF # - # ... and use that for the HashedControlPassword in our torrc. + # ... and use that for the HashedControlPassword in your torrc. HashedControlPassword 16:E600ADC1B52C80BB6022A0E999A7734571A451EB6AE50FED489B72E3DF -You'll need to restart Tor or issue a SIGHUP for these new settings to take effect. Now let's write a script that tells us how many bytes Tor has sent and received... +When you change your torrc you'll need to either restart Tor is issue a SIGHUP +for the new settings to take effect. Now let's write a script that tells us how +many bytes Tor has sent and received... :: from stem.control import Controller - controller = Controller.from_port(control_port = 9051) - controller.authenticate() # provide the password here if you set one - - bytes_read = controller.get_info("traffic/read") - bytes_written = controller.get_info("traffic/written") - - print "My Tor relay has read %s bytes and written %s." % (bytes_read, bytes_written) - controller.close() + with Controller.from_port(control_port = 9051) as controller: + controller.authenticate() # provide the password here if you set one + + bytes_read = controller.get_info("traffic/read") + bytes_written = controller.get_info("traffic/written") + + print "My Tor relay has read %s bytes and written %s." % (bytes_read, bytes_written) ::

1 0

[stem/master] Mocking stdout for tutorial tests
by atagar＠torproject.org 04 Mar '13

04 Mar '13

commit 1749855559044f2547920fa206f72c6fdf7c86f4 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Feb 22 08:53:21 2013 -0800 Mocking stdout for tutorial tests Mocking stdout so the tests can be a little more faithful to the tutorial examples. --- test/unit/tutorial.py | 21 +++++++++++++++------ 1 files changed, 15 insertions(+), 6 deletions(-) diff --git a/test/unit/tutorial.py b/test/unit/tutorial.py index 5880f53..21db41b 100644 --- a/test/unit/tutorial.py +++ b/test/unit/tutorial.py @@ -4,14 +4,23 @@ Tests for the examples given in stem's tutorial. from __future__ import with_statement +import StringIO +import sys import unittest from test import mocking class TestTutorial(unittest.TestCase): + stdout, stdout_real = None, None + + def setUp(self): + self.stdout, self.stdout_real = StringIO.StringIO(), sys.stdout + sys.stdout = self.stdout + def tearDown(self): mocking.revert_mocking() + sys.stdout = self.stdout_real def test_the_little_relay_that_could(self): from stem.control import Controller @@ -30,12 +39,12 @@ class TestTutorial(unittest.TestCase): bytes_read = controller.get_info("traffic/read") bytes_written = controller.get_info("traffic/written") - expected_line = "My Tor relay has read 1234 bytes and written 5678." - printed_line = "My Tor relay has read %s bytes and written %s." % (bytes_read, bytes_written) - self.assertEqual(expected_line, printed_line) + print "My Tor relay has read %s bytes and written %s." % (bytes_read, bytes_written) controller.close() + self.assertEqual("My Tor relay has read 1234 bytes and written 5678.\n", self.stdout.getvalue()) + def test_mirror_mirror_on_the_wall(self): from stem.descriptor.server_descriptor import RelayDescriptor from stem.descriptor.reader import DescriptorReader @@ -76,13 +85,13 @@ class TestTutorial(unittest.TestCase): for bw_value in sorted(bw_to_relay.keys(), reverse = True): for nickname in bw_to_relay[bw_value]: - expected_line = "%i. speedyexit (102.13 KB/s)" % count - printed_line = "%i. %s (%s/s)" % (count, nickname, str_tools.get_size_label(bw_value, 2)) - self.assertEqual(expected_line, printed_line) + print "%i. %s (%s/s)" % (count, nickname, str_tools.get_size_label(bw_value, 2)) count += 1 if count > 15: return + expected_stdout = "".join(["%i. speedyexit (102.13 KB/s)\n" % i for i in xrange(1, 4)]) + self.assertEqual(expected_stdout, self.stdout.getvalue()) self.assertEqual(4, count)

1 0

r26069: {website} add new mirror in germany, remove the project coord position (in website/trunk: . about/en include)
by Andrew Lewman 04 Mar '13

04 Mar '13

Author: phobos Date: 2013-03-04 04:25:57 +0000 (Mon, 04 Mar 2013) New Revision: 26069 Modified: website/trunk/about/en/jobs.wml website/trunk/include/mirrors-table.wmi website/trunk/update-mirrors.pl Log: add new mirror in germany, remove the project coord position. Modified: website/trunk/about/en/jobs.wml =================================================================== --- website/trunk/about/en/jobs.wml 2013-02-28 02:21:26 UTC (rev 26068) +++ website/trunk/about/en/jobs.wml 2013-03-04 04:25:57 UTC (rev 26069) @@ -25,7 +25,6 @@ <ul> <li><a href="<page about/jobs-coredev>">Core developer</a></li> <li><a href="<page about/jobs-translatorsupport>">Support assistants and translators</a></li> -<li><a href="<page about/jobs-projectcoordinator>">Project coordinator</a></li> <li><a href="<page about/jobs-browserhacker>">Browser hacker</a></li> </ul> Modified: website/trunk/include/mirrors-table.wmi =================================================================== --- website/trunk/include/mirrors-table.wmi 2013-02-28 02:21:26 UTC (rev 26068) +++ website/trunk/include/mirrors-table.wmi 2013-03-04 04:25:57 UTC (rev 26069) @@ -1,15 +1,15 @@ <tr> - <td>INT</td> + <td>CZ</td> - <td>CoralCDN</td> + <td>Lightning-bolt.net</td> <td>Up to date</td> <td> - </td> - <td><a href="http://www.torproject.org.nyud.net/dist/">http</a></td> - <td><a href="http://www.torproject.org.nyud.net/">http</a></td> + <td><a href="http://torproject.lightning-bolt.net/dist/">http</a></td> + <td><a href="http://torproject.lightning-bolt.net/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -18,17 +18,17 @@ <tr> - <td>CZ</td> + <td>TN</td> - <td>Lightning-bolt.net</td> + <td></td> <td>Up to date</td> <td> - </td> - <td><a href="http://torproject.lightning-bolt.net/dist/">http</a></td> - <td><a href="http://torproject.lightning-bolt.net/">http</a></td> <td> - </td> + <td><a href="http://torproject.antagonism.org/">http</a></td> <td> - </td> + <td><a href="https://torproject.antagonism.org/">https</a></td> <td> - </td> <td> - </td> </tr> @@ -52,15 +52,15 @@ <tr> - <td>AT</td> + <td>NL</td> - <td></td> + <td>CCC</td> <td>Up to date</td> <td> - </td> - <td><a href="http://torproject.ph3x.at/dist/">http</a></td> - <td><a href="http://torproject.ph3x.at/">http</a></td> + <td><a href="http://tor.ccc.de/dist/">http</a></td> + <td><a href="http://tor.ccc.de/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -69,66 +69,49 @@ <tr> - <td>US</td> + <td>DK</td> - <td>BarkerJr</td> + <td>Zentrum der Gesundheit</td> <td>Up to date</td> <td> - </td> - <td><a href="http://www.torproject.us/dist/">http</a></td> - <td><a href="http://www.torproject.us/">http</a></td> - <td><a href="https://www.torproject.us/dist/">https</a></td> - <td><a href="https://www.torproject.us/">https</a></td> + <td><a href="http://tor.idnr.ws/dist/">http</a></td> + <td><a href="http://tor.idnr.ws/">http</a></td> <td> - </td> - <td><a href="rsync://rsync.torproject.us/tor">rsync</a></td> + <td> - </td> + <td> - </td> + <td> - </td> </tr> <tr> <td>EE</td> - <td></td> + <td>CyberSIDE</td> <td>Up to date</td> <td> - </td> - <td><a href="http://tor.li/dist/">http</a></td> - <td><a href="http://tor.li/">http</a></td> - <td><a href="https://tor.li/dist/">https</a></td> - <td><a href="https://tor.li/">https</a></td> + <td><a href="http://cyberside.net.ee/tor/">http</a></td> + <td><a href="http://cyberside.planet.ee/tor/">http</a></td> <td> - </td> <td> - </td> -</tr> - -<tr> - - <td>DE</td> - - <td></td> - - <td>Up to date</td> - <td> - </td> - <td><a href="http://torproject.cryptowars.info/dist/">http</a></td> - <td><a href="http://torproject.cryptowars.info/">http</a></td> - <td><a href="https://torproject.cryptowars.info/dist/">https</a></td> - <td><a href="https://torproject.cryptowars.info/">https</a></td> <td> - </td> - <td><a href="rsync://torproject.cryptowars.info/">rsync</a></td> </tr> <tr> - <td>UK</td> + <td>IS</td> - <td></td> + <td>torproject.is</td> <td>Up to date</td> <td> - </td> - <td><a href="http://tor.mage.me.uk/dist/">http</a></td> - <td><a href="http://tor.mage.me.uk/">http</a></td> + <td><a href="http://torproject.is/dist/">http</a></td> + <td><a href="http://torproject.is/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -139,64 +122,64 @@ <td>AT</td> - <td>cyberarmy</td> + <td></td> <td>Up to date</td> <td> - </td> + <td><a href="http://torproject.ph3x.at/dist/">http</a></td> + <td><a href="http://torproject.ph3x.at/">http</a></td> <td> - </td> - <td><a href="http://tor.cyberarmy.at/">http</a></td> <td> - </td> <td> - </td> <td> - </td> - <td> - </td> </tr> <tr> - <td>FR</td> + <td>US</td> - <td></td> + <td>BarkerJr</td> <td>Up to date</td> <td> - </td> - <td><a href="http://tor.mirror.chekanov.net/dist/">http</a></td> - <td><a href="http://tor.mirror.chekanov.net/">http</a></td> + <td><a href="http://www.torproject.us/dist/">http</a></td> + <td><a href="http://www.torproject.us/">http</a></td> + <td><a href="https://www.torproject.us/dist/">https</a></td> + <td><a href="https://www.torproject.us/">https</a></td> <td> - </td> - <td> - </td> - <td> - </td> - <td> - </td> + <td><a href="rsync://rsync.torproject.us/tor">rsync</a></td> </tr> <tr> - <td>DE</td> + <td>US</td> - <td>beme it</td> + <td></td> <td>Up to date</td> <td> - </td> - <td><a href="http://tor.beme-it.de/dist/">http</a></td> - <td><a href="http://tor.beme-it.de/">http</a></td> - <td><a href="https://tor.beme-it.de/dist/">https</a></td> - <td><a href="https://tor.beme-it.de/">https</a></td> + <td><a href="http://tor.minibofh.org/dist/">http</a></td> + <td><a href="http://tor.minibofh.org/">http</a></td> <td> - </td> - <td><a href="rsync://tor.beme-it.de/tor">rsync</a></td> + <td> - </td> + <td> - </td> + <td> - </td> </tr> <tr> - <td>IL</td> + <td>AT</td> - <td>Host4site</td> + <td></td> <td>Up to date</td> <td> - </td> - <td><a href="http://mirror.host4site.co.il/torproject.org/dist/">http</a></td> - <td><a href="http://mirror.host4site.co.il/torproject.org/">http</a></td> + <td><a href="http://tor.dont-know-me.at/dist/">http</a></td> + <td><a href="http://tor.dont-know-me.at/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -205,49 +188,49 @@ <tr> - <td>GB</td> + <td>DE</td> - <td>torland</td> + <td>torservers</td> <td>Up to date</td> <td> - </td> - <td><a href="http://mirror.torland.me/torproject.org/dist/">http</a></td> - <td><a href="http://mirror.torland.me/torproject.org/">http</a></td> - <td><a href="https://mirror.torland.me/torproject.org/dist/">https</a></td> - <td><a href="https://mirror.torland.me/torproject.org/">https</a></td> + <td><a href="http://www.torservers.net/mirrors/torproject.org/dist/">http</a></td> + <td><a href="http://www.torservers.net/mirrors/torproject.org/">http</a></td> + <td><a href="https://www.torservers.net/mirrors/torproject.org/dist/">https</a></td> + <td><a href="https://www.torservers.net/mirrors/torproject.org/">https</a></td> <td> - </td> <td> - </td> </tr> <tr> - <td>TN</td> + <td>IS</td> - <td></td> + <td>myRL.net</td> <td>Up to date</td> <td> - </td> + <td><a href="http://tor.myrl.net/dist/">http</a></td> + <td><a href="http://tor.myrl.net/">http</a></td> + <td><a href="https://tor.myrl.net/dist/">https</a></td> + <td><a href="https://tor.myrl.net/">https</a></td> <td> - </td> - <td><a href="http://torproject.antagonism.org/">http</a></td> <td> - </td> - <td><a href="https://torproject.antagonism.org/">https</a></td> - <td> - </td> - <td> - </td> </tr> <tr> - <td>NL</td> + <td>US</td> - <td>CCC</td> + <td>hessmo</td> <td>Up to date</td> <td> - </td> - <td><a href="http://tor.ccc.de/dist/">http</a></td> - <td><a href="http://tor.ccc.de/">http</a></td> + <td><a href="http://mirror.hessmo.com/tor/dist/">http</a></td> + <td><a href="http://mirror.hessmo.com/tor/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -256,32 +239,32 @@ <tr> - <td>DK</td> + <td>DE</td> - <td>Zentrum der Gesundheit</td> + <td></td> <td>Up to date</td> <td> - </td> - <td><a href="http://tor.idnr.ws/dist/">http</a></td> - <td><a href="http://tor.idnr.ws/">http</a></td> + <td><a href="http://tor.linuxlounge.net/dist/">http</a></td> + <td><a href="http://tor.linuxlounge.net/">http</a></td> + <td><a href="https://tor.linuxlounge.net/dist/">https</a></td> + <td><a href="https://tor.linuxlounge.net/">https</a></td> <td> - </td> <td> - </td> - <td> - </td> - <td> - </td> </tr> <tr> - <td>IS</td> + <td>RO</td> - <td>torproject.is</td> + <td>me0w.cc</td> <td>Up to date</td> <td> - </td> - <td><a href="http://torproject.is/dist/">http</a></td> - <td><a href="http://torproject.is/">http</a></td> + <td><a href="http://tor.me0w.cc/dist/">http</a></td> + <td><a href="http://tor.me0w.cc/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -290,32 +273,32 @@ <tr> - <td>IT</td> + <td>CH</td> <td></td> <td>Up to date</td> <td> - </td> - <td><a href="http://torproject.jcsh.it/dist/">http</a></td> - <td><a href="http://torproject.jcsh.it/">http</a></td> + <td><a href="http://torproject.pillo-srv.ch/dist/">http</a></td> + <td><a href="http://torproject.pillo-srv.ch/">http</a></td> + <td><a href="https://torproject.pillo-srv.ch/dist/">https</a></td> + <td><a href="https://torproject.pillo-srv.ch/">https</a></td> <td> - </td> <td> - </td> - <td> - </td> - <td> - </td> </tr> <tr> - <td>US</td> + <td>LT</td> <td></td> <td>Up to date</td> <td> - </td> - <td><a href="http://tor.minibofh.org/dist/">http</a></td> - <td><a href="http://tor.minibofh.org/">http</a></td> + <td><a href="http://tor.vesta.nu/dist/">http</a></td> + <td><a href="http://tor.vesta.nu/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -324,49 +307,49 @@ <tr> - <td>AT</td> + <td>EE</td> <td></td> <td>Up to date</td> <td> - </td> - <td><a href="http://tor.dont-know-me.at/dist/">http</a></td> - <td><a href="http://tor.dont-know-me.at/">http</a></td> + <td><a href="http://tor.li/dist/">http</a></td> + <td><a href="http://tor.li/">http</a></td> + <td><a href="https://tor.li/dist/">https</a></td> + <td><a href="https://tor.li/">https</a></td> <td> - </td> <td> - </td> - <td> - </td> - <td> - </td> </tr> <tr> <td>DE</td> - <td>torservers</td> + <td></td> <td>Up to date</td> <td> - </td> - <td><a href="http://www.torservers.net/mirrors/torproject.org/dist/">http</a></td> - <td><a href="http://www.torservers.net/mirrors/torproject.org/">http</a></td> - <td><a href="https://www.torservers.net/mirrors/torproject.org/dist/">https</a></td> - <td><a href="https://www.torservers.net/mirrors/torproject.org/">https</a></td> + <td><a href="http://torproject.cryptowars.info/dist/">http</a></td> + <td><a href="http://torproject.cryptowars.info/">http</a></td> + <td><a href="https://torproject.cryptowars.info/dist/">https</a></td> + <td><a href="https://torproject.cryptowars.info/">https</a></td> <td> - </td> - <td> - </td> + <td><a href="rsync://torproject.cryptowars.info/">rsync</a></td> </tr> <tr> - <td>RO</td> + <td>UK</td> - <td>me0w.cc</td> + <td></td> <td>Up to date</td> <td> - </td> - <td><a href="http://tor.me0w.cc/dist/">http</a></td> - <td><a href="http://tor.me0w.cc/">http</a></td> + <td><a href="http://tor.mage.me.uk/dist/">http</a></td> + <td><a href="http://tor.mage.me.uk/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -375,23 +358,6 @@ <tr> - <td>CH</td> - - <td></td> - - <td>Up to date</td> - - <td> - </td> - <td><a href="http://torproject.pillo-srv.ch/dist/">http</a></td> - <td><a href="http://torproject.pillo-srv.ch/">http</a></td> - <td><a href="https://torproject.pillo-srv.ch/dist/">https</a></td> - <td><a href="https://torproject.pillo-srv.ch/">https</a></td> - <td> - </td> - <td> - </td> -</tr> - -<tr> - <td>DE</td> <td></td> @@ -426,6 +392,23 @@ <tr> + <td>AT</td> + + <td>cyberarmy</td> + + <td>Up to date</td> + + <td> - </td> + <td> - </td> + <td><a href="http://tor.cyberarmy.at/">http</a></td> + <td> - </td> + <td> - </td> + <td> - </td> + <td> - </td> +</tr> + +<tr> + <td>US</td> <td></td> @@ -460,6 +443,23 @@ <tr> + <td>FR</td> + + <td></td> + + <td>Up to date</td> + + <td> - </td> + <td><a href="http://tor.mirror.chekanov.net/dist/">http</a></td> + <td><a href="http://tor.mirror.chekanov.net/">http</a></td> + <td> - </td> + <td> - </td> + <td> - </td> + <td> - </td> +</tr> + +<tr> + <td>DE</td> <td>chaos darmstadt</td> @@ -528,6 +528,23 @@ <tr> + <td>DE</td> + + <td>beme it</td> + + <td>Up to date</td> + + <td> - </td> + <td><a href="http://tor.beme-it.de/dist/">http</a></td> + <td><a href="http://tor.beme-it.de/">http</a></td> + <td><a href="https://tor.beme-it.de/dist/">https</a></td> + <td><a href="https://tor.beme-it.de/">https</a></td> + <td> - </td> + <td><a href="rsync://tor.beme-it.de/tor">rsync</a></td> +</tr> + +<tr> + <td>US</td> <td>NW Linux</td> @@ -562,6 +579,23 @@ <tr> + <td>IL</td> + + <td>Host4site</td> + + <td>Up to date</td> + + <td> - </td> + <td><a href="http://mirror.host4site.co.il/torproject.org/dist/">http</a></td> + <td><a href="http://mirror.host4site.co.il/torproject.org/">http</a></td> + <td> - </td> + <td> - </td> + <td> - </td> + <td> - </td> +</tr> + +<tr> + <td>DE</td> <td>borgmann.tv</td> @@ -598,6 +632,23 @@ <td>US</td> + <td>AskApache</td> + + <td>Up to date</td> + + <td> - </td> + <td><a href="http://tor.askapache.com/dist/">http</a></td> + <td><a href="http://tor.askapache.com/">http</a></td> + <td> - </td> + <td> - </td> + <td> - </td> + <td> - </td> +</tr> + +<tr> + + <td>US</td> + <td></td> <td>Up to date</td> @@ -647,6 +698,23 @@ <tr> + <td>GB</td> + + <td>torland</td> + + <td>Up to date</td> + + <td> - </td> + <td><a href="http://mirror.torland.me/torproject.org/dist/">http</a></td> + <td><a href="http://mirror.torland.me/torproject.org/">http</a></td> + <td><a href="https://mirror.torland.me/torproject.org/dist/">https</a></td> + <td><a href="https://mirror.torland.me/torproject.org/">https</a></td> + <td> - </td> + <td> - </td> +</tr> + +<tr> + <td>DE</td> <td>spline</td> @@ -681,15 +749,15 @@ <tr> - <td>US</td> + <td>INT</td> - <td></td> + <td>CoralCDN</td> <td>Up to date</td> <td> - </td> - <td><a href="http://mirror.nametoday.me/tor/dist/">http</a></td> - <td><a href="http://mirror.nametoday.me/tor/">http</a></td> + <td><a href="http://www.torproject.org.nyud.net/dist/">http</a></td> + <td><a href="http://www.torproject.org.nyud.net/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -698,15 +766,15 @@ <tr> - <td>LT</td> + <td>US</td> <td></td> <td>Up to date</td> <td> - </td> - <td><a href="http://tor.vesta.nu/dist/">http</a></td> - <td><a href="http://tor.vesta.nu/">http</a></td> + <td><a href="http://mirror.nametoday.me/tor/dist/">http</a></td> + <td><a href="http://mirror.nametoday.me/tor/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -715,59 +783,8 @@ <tr> - <td>US</td> - - <td>AskApache</td> - - <td>Up to date</td> - - <td> - </td> - <td><a href="http://tor.askapache.com/dist/">http</a></td> - <td><a href="http://tor.askapache.com/">http</a></td> - <td> - </td> - <td> - </td> - <td> - </td> - <td> - </td> -</tr> - -<tr> - - <td>US</td> - - <td>hessmo</td> - - <td>Out of date</td> - - <td> - </td> - <td><a href="http://mirror.hessmo.com/tor/dist/">http</a></td> - <td><a href="http://mirror.hessmo.com/tor/">http</a></td> - <td> - </td> - <td> - </td> - <td> - </td> - <td> - </td> -</tr> - -<tr> - <td>DE</td> - <td>[[:bbs:]]</td> - - <td>Out of date</td> - - <td> - </td> - <td><a href="http://tor.blingblingsquad.net/dist/">http</a></td> - <td><a href="http://tor.blingblingsquad.net/">http</a></td> - <td><a href="https://tor.blingblingsquad.net/dist/">https</a></td> - <td><a href="https://tor.blingblingsquad.net/">https</a></td> - <td> - </td> - <td> - </td> -</tr> - -<tr> - - <td>DE</td> - <td>crazyhaze.de</td> <td>Out of date</td> @@ -885,15 +902,15 @@ <tr> - <td>EE</td> + <td>IT</td> - <td>CyberSIDE</td> + <td></td> <td>Unknown</td> <td> - </td> - <td><a href="http://cyberside.net.ee/tor/">http</a></td> - <td><a href="http://cyberside.planet.ee/tor/">http</a></td> + <td><a href="http://torproject.jcsh.it/dist/">http</a></td> + <td><a href="http://torproject.jcsh.it/">http</a></td> <td> - </td> <td> - </td> <td> - </td> @@ -902,23 +919,6 @@ <tr> - <td>IS</td> - - <td>myRL.net</td> - - <td>Unknown</td> - - <td> - </td> - <td><a href="http://tor.myrl.net/dist/">http</a></td> - <td><a href="http://tor.myrl.net/">http</a></td> - <td><a href="https://tor.myrl.net/dist/">https</a></td> - <td><a href="https://tor.myrl.net/">https</a></td> - <td> - </td> - <td> - </td> -</tr> - -<tr> - <td>UA</td> <td></td> @@ -967,3 +967,20 @@ <td> - </td> <td> - </td> </tr> + +<tr> + + <td>DE</td> + + <td>[[:bbs:]]</td> + + <td>Unknown</td> + + <td> - </td> + <td><a href="http://tor.blingblingsquad.net/dist/">http</a></td> + <td><a href="http://tor.blingblingsquad.net/">http</a></td> + <td><a href="https://tor.blingblingsquad.net/dist/">https</a></td> + <td><a href="https://tor.blingblingsquad.net/">https</a></td> + <td> - </td> + <td> - </td> +</tr> Modified: website/trunk/update-mirrors.pl =================================================================== --- website/trunk/update-mirrors.pl 2013-02-28 02:21:26 UTC (rev 26068) +++ website/trunk/update-mirrors.pl 2013-03-04 04:25:57 UTC (rev 26069) @@ -1142,6 +1142,24 @@ httpsDistMirror => "", rsyncDistMirror => "", hiddenServiceMirror => "", + }, + mirror087 => { + adminContact => "", + orgName => "", + isoCC => "DE", + subRegion => "", + region => "DE", + ipv4 => "True", + ipv6 => "False", + loadBalanced => "No", + httpWebsiteMirror => "http://tor.linuxlounge.net/", + httpsWebsiteMirror => "https://tor.linuxlounge.net/", + rsyncWebsiteMirror => "", + ftpWebsiteMirror => "", + httpDistMirror => "http://tor.linuxlounge.net/dist/", + httpsDistMirror => "https://tor.linuxlounge.net/dist/", + rsyncDistMirror => "", + hiddenServiceMirror => "", } );

1 0

[stem/master] Only first 'transport' line was being used
by atagar＠torproject.org 03 Mar '13

03 Mar '13

commit 954bced4f16b05bd6a4923cfe3a8297f0e3347a6 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Mar 3 15:08:01 2013 -0800 Only first 'transport' line was being used The extrainfo descriptor parser only utilized the first 'transport' line, causing further lines to be ignored. Caught by asn. --- stem/descriptor/extrainfo_descriptor.py | 67 +++++++++++++------------- test/unit/descriptor/extrainfo_descriptor.py | 5 ++ 2 files changed, 39 insertions(+), 33 deletions(-) diff --git a/stem/descriptor/extrainfo_descriptor.py b/stem/descriptor/extrainfo_descriptor.py index dce95a5..9b0ffa3 100644 --- a/stem/descriptor/extrainfo_descriptor.py +++ b/stem/descriptor/extrainfo_descriptor.py @@ -480,41 +480,42 @@ class ExtraInfoDescriptor(stem.descriptor.Descriptor): # on non-bridges in the wild when the relay operator configured it this # way. - name, address, port, args = None, None, None, None + for transport_value, _ in values: + name, address, port, args = None, None, None, None - if not ' ' in value: - # scrubbed - name = value - else: - # not scrubbed - value_comp = value.split() - - if len(value_comp) < 1: - raise ValueError("Transport line is missing its transport name: %s" % line) - else: - name = value_comp[0] - - if len(value_comp) < 2: - raise ValueError("Transport line is missing its address:port value: %s" % line) - elif not ":" in value_comp[1]: - raise ValueError("Transport line's address:port entry is missing a colon: %s" % line) - else: - address, port_str = value_comp[1].split(':', 1) - - if not stem.util.connection.is_valid_ip_address(address) or \ - stem.util.connection.is_valid_ipv6_address(address): - raise ValueError("Transport line has a malformed address: %s" % line) - elif not stem.util.connection.is_valid_port(port_str): - raise ValueError("Transport line has a malformed port: %s" % line) - - port = int(port_str) - - if len(value_comp) >= 3: - args = value_comp[2:] + if not ' ' in transport_value: + # scrubbed + name = transport_value else: - args = [] - - self.transport[name] = (address, port, args) + # not scrubbed + value_comp = transport_value.split() + + if len(value_comp) < 1: + raise ValueError("Transport line is missing its transport name: %s" % line) + else: + name = value_comp[0] + + if len(value_comp) < 2: + raise ValueError("Transport line is missing its address:port value: %s" % line) + elif not ":" in value_comp[1]: + raise ValueError("Transport line's address:port entry is missing a colon: %s" % line) + else: + address, port_str = value_comp[1].split(':', 1) + + if not stem.util.connection.is_valid_ip_address(address) or \ + stem.util.connection.is_valid_ipv6_address(address): + raise ValueError("Transport line has a malformed address: %s" % line) + elif not stem.util.connection.is_valid_port(port_str): + raise ValueError("Transport line has a malformed port: %s" % line) + + port = int(port_str) + + if len(value_comp) >= 3: + args = value_comp[2:] + else: + args = [] + + self.transport[name] = (address, port, args) elif keyword == "cell-circuits-per-decile": # "cell-circuits-per-decile" num diff --git a/test/unit/descriptor/extrainfo_descriptor.py b/test/unit/descriptor/extrainfo_descriptor.py index e83a2b1..6a2dd34 100644 --- a/test/unit/descriptor/extrainfo_descriptor.py +++ b/test/unit/descriptor/extrainfo_descriptor.py @@ -487,6 +487,11 @@ class TestExtraInfoDescriptor(unittest.TestCase): self.assertEquals({"obfs2": ("83.212.96.201", 33570, [])}, desc.transport) self.assertEquals([], desc.get_unrecognized_lines()) + # multiple transport lines + desc = get_bridge_extrainfo_descriptor({"transport": "obfs3\ntransport obfs4"}) + self.assertEquals({"obfs3": (None, None, None), "obfs4": (None, None, None)}, desc.transport) + self.assertEquals([], desc.get_unrecognized_lines()) + def _expect_invalid_attr(self, desc_text, attr = None, expected_value = None): """ Asserts that construction will fail due to desc_text having a malformed

1 0