November 2016 - tor-commits - lists.torproject.org

[tor/master] Merge branch 'maint-0.2.9'
by nickm＠torproject.org 07 Nov '16

07 Nov '16

commit 7236e42684de017d66b38bac13c4f7ff8dac428c Merge: 89edef6 e482541 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 7 16:10:55 2016 -0500 Merge branch 'maint-0.2.9' src/test/test_dir.c | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-)

1 0

[tor/master] Fix a unit test (broken by recent 20499 hacking)
by nickm＠torproject.org 07 Nov '16

07 Nov '16

commit d2071c36f69249742de569dd3f5990ca16040228 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 7 16:02:55 2016 -0500 Fix a unit test (broken by recent 20499 hacking) --- src/test/test_dir.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/test/test_dir.c b/src/test/test_dir.c index 77c5dc1..6a39b68 100644 --- a/src/test/test_dir.c +++ b/src/test/test_dir.c @@ -3626,8 +3626,8 @@ test_dir_download_status_random_backoff(void *arg) tt_int_op(increment, OP_GE, min_delay); tt_int_op(increment, OP_LE, max_delay); tt_int_op(increment, OP_GE, old_increment); - /* We at most double, and maybe add one */ - tt_int_op(increment, OP_LE, 2 * old_increment + 1); + /* We at most quadruple, and maybe add one */ + tt_int_op(increment, OP_LE, 4 * old_increment + 1); /* Advance */ current_time += increment;

1 0

[tor/release-0.2.9] Fix a unit test (broken by recent 20499 hacking)
by nickm＠torproject.org 07 Nov '16

07 Nov '16

commit d2071c36f69249742de569dd3f5990ca16040228 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 7 16:02:55 2016 -0500 Fix a unit test (broken by recent 20499 hacking) --- src/test/test_dir.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/test/test_dir.c b/src/test/test_dir.c index 77c5dc1..6a39b68 100644 --- a/src/test/test_dir.c +++ b/src/test/test_dir.c @@ -3626,8 +3626,8 @@ test_dir_download_status_random_backoff(void *arg) tt_int_op(increment, OP_GE, min_delay); tt_int_op(increment, OP_LE, max_delay); tt_int_op(increment, OP_GE, old_increment); - /* We at most double, and maybe add one */ - tt_int_op(increment, OP_LE, 2 * old_increment + 1); + /* We at most quadruple, and maybe add one */ + tt_int_op(increment, OP_LE, 4 * old_increment + 1); /* Advance */ current_time += increment;

1 0

[tor/release-0.2.9] Merge branch 'maint-0.2.9' into release-0.2.9
by nickm＠torproject.org 07 Nov '16

07 Nov '16

commit 6c4aee147eae0c7b2190c8925bc7f6e2581fa743 Merge: 68a10b6 e482541 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 7 16:10:48 2016 -0500 Merge branch 'maint-0.2.9' into release-0.2.9 src/test/test_dir.c | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-)

1 0

[tor/release-0.2.9] Fix another 20499-broken test
by nickm＠torproject.org 07 Nov '16

07 Nov '16

commit e482541cfb0bd85cab8a7fed86e31e0b18912730 Author: Nick Mathewson <nickm(a)torproject.org> Date: Mon Nov 7 16:10:42 2016 -0500 Fix another 20499-broken test --- src/test/test_dir.c | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/src/test/test_dir.c b/src/test/test_dir.c index 6a39b68..cdc56ac 100644 --- a/src/test/test_dir.c +++ b/src/test/test_dir.c @@ -3732,14 +3732,14 @@ test_dir_download_status_increment(void *arg) current_time + delay1 + 10, 0) == 0); - /* Check that failure increments don't happen on 503 for clients, but that - * attempt increments do. */ + /* Check that failure increments do happen on 503 for clients, and + * attempt increments do too. */ mock_get_options_calls = 0; next_at = download_status_increment_failure(&dls_failure, 503, "test", 0, current_time); - tt_assert(next_at == current_time + delay1); - tt_assert(download_status_get_n_failures(&dls_failure) == 1); - tt_assert(download_status_get_n_attempts(&dls_failure) == 2); + tt_i64_op(next_at, ==, current_time + delay2); + tt_int_op(download_status_get_n_failures(&dls_failure), ==, 2); + tt_int_op(download_status_get_n_attempts(&dls_failure), ==, 2); tt_assert(mock_get_options_calls >= 1); /* Check that failure increments do happen on 503 for servers */ @@ -3747,7 +3747,7 @@ test_dir_download_status_increment(void *arg) next_at = download_status_increment_failure(&dls_failure, 503, "test", 1, current_time); tt_assert(next_at == current_time + delay2); - tt_assert(download_status_get_n_failures(&dls_failure) == 2); + tt_assert(download_status_get_n_failures(&dls_failure) == 3); tt_assert(download_status_get_n_attempts(&dls_failure) == 3); tt_assert(mock_get_options_calls >= 1); @@ -3756,7 +3756,7 @@ test_dir_download_status_increment(void *arg) next_at = download_status_increment_failure(&dls_failure, 404, "test", 0, current_time); tt_assert(next_at == current_time + delay2); - tt_assert(download_status_get_n_failures(&dls_failure) == 3); + tt_assert(download_status_get_n_failures(&dls_failure) == 4); tt_assert(download_status_get_n_attempts(&dls_failure) == 4); tt_assert(mock_get_options_calls >= 1); @@ -3918,8 +3918,13 @@ test_dir_download_status_increment(void *arg) /* Check that attempt increments don't happen on failure-based schedules, * and that the attempt is set at the end of time */ mock_get_options_calls = 0; + setup_full_capture_of_logs(LOG_WARN); next_at = download_status_increment_attempt(&dls_failure, "test", current_time); + expect_single_log_msg_containing( + "Tried to launch an attempt-based connection on a failure-based " + "schedule."); + teardown_capture_of_logs(); tt_assert(next_at == TIME_MAX); tt_assert(download_status_get_n_failures(&dls_failure) == 0); tt_assert(download_status_get_n_attempts(&dls_failure) == 0); @@ -3931,6 +3936,7 @@ test_dir_download_status_increment(void *arg) UNMOCK(get_options); mock_options = NULL; mock_get_options_calls = 0; + teardown_capture_of_logs(); } static void

1 0

[nyx/master] Merge readme into FAQ
by atagar＠torproject.org 07 Nov '16

07 Nov '16

commit f240bbf4278251c651701c04c245b51102dcf85f Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Nov 7 11:21:45 2016 -0800 Merge readme into FAQ Adding the questions we had in our readme to the FAQ, rewriting ones that were due with being revised. --- README | 222 --------------------- .../section/screenshots/acs_display_failure.png | Bin 0 -> 161127 bytes .../screenshots/acs_display_failure_full.png | Bin 0 -> 405426 bytes docs/faq.rst | 115 ++++++++++- 4 files changed, 113 insertions(+), 224 deletions(-) diff --git a/README b/README deleted file mode 100644 index ea3997f..0000000 --- a/README +++ /dev/null @@ -1,222 +0,0 @@ -nyx - Terminal status monitor for Tor relays. -Developed by Damian Johnson (www.atagar.com - atagar(a)torproject.org) -All code under the GPL v3 (http://www.gnu.org/licenses/gpl.html) -Project page: www.atagar.com/arm - -Description: -Command line application for monitoring Tor, providing real time status -information such as the current configuration, bandwidth usage, message log, -connections, etc. This uses a curses interface much like 'top' does for system -usage. The application is intended for command-line aficionados, ssh -connections, and anyone with a tty terminal for checking their relay's status. -Releases should be stable so if you manage to make it crash (or have a feature -request) then please let me know! - -The project was originally proposed in 2008 by Jacob and Karsten: - http://archives.seul.org/or/dev/Jan-2008/msg00005.html - -An interview by Brenno Winter discussing the project is available at: - https://www.atagar.com/arm/resources/HFM_INT_0001.mp3 - -Requirements: -Python 2.5 -Stem -Tor is running with an available control port. This means either... - ... starting Tor with '--controlport <PORT>' - ... or including 'ControlPort <PORT>' in your torrc - -It's also highly suggested for the control port to require authentication. -This can be done either with a cookie or password: - * Cookie Authentication - Controllers authenticate to Tor by providing the - contents of the control_auth_cookie file. To set this up... - - add "CookieAuthentication 1" to your torrc - - either restart Tor or run "pkill -sighup tor" - - this method of authentication is automatically handled by nyx, so you - can still start nyx as you normally would - - * Password Authentication - Attaching to the control port requires a - password. To set this up... - - run "tor --hash-password <your password>" - - add "HashedControlPassword <hashed password>" to your torrc - - either restart Tor or run "pkill -sighup tor" - - when starting up nyx will prompt you for this password - -For full functionality this also needs: -- To be ran with the same user as tor to avoid permission issues with - connection resolution and reading the torrc. - -- Common *nix commands including: - * ps - * a method of connection resolution (any of the following): - * sockstat - * netstat - * ss - * lsof - * procstat - * tail - * pwdx - * ulimit - * pgrep or pidof - * host (if dns lookups are enabled) - -This is started via 'nyx' (use the '--help' argument for usage). - -------------------------------------------------------------------------------- - -FAQ: -> Why is it called 'nyx'? - -Simple - because it makes the command short and memorable. Terminal -applications need to be easy to type (like 'top', 'ssh', etc), and anything -longer is just begging command-line aficionados to alias it down. - -> If you're listing connections then what about exit nodes? Won't this include -people's traffic? - -No. Potential client and exit connections are specifically scrubbed of -identifying information. Be aware that it's highly discouraged for relay -operators to fetch this data, so please don't. - -> Is it harmful to share the information provided by nyx? - -Not really, but it's discouraged. The original plan for nyx included a special -emphasis that it wouldn't log any data. The reason is that if a large number of -relay operators published the details of their connections then correlation -attacks could break Tor user's anonymity. Just show some moderation in what you -share and it should be fine. - -> Is there any chance that nyx will leak data? - -No. Nyx is a completely passive listener, fetching all information from either -Tor or the local system. - -> When nyx starts it gives "Unable to resolve tor pid, abandoning connection -listing"... why? - -If you're running multiple instances of Tor then nyx needs to figure out which -pid belongs to the open control port. If it's running as a different user (such -as being in a chroot jail) then it's probably failing due to permission issues. -Nyx still runs, just no connection listing or ps stats. - -> The bandwidth graph isn't showing up - -Some terminals, most notably screen sessions on Gentoo, appear to have a bug -where highlighted spaces aren't rendered. A reported workaround is to set: - TERM="rxvt-unicode" - -> There's borders like 'mwqqqqqqqqj' - -If you're getting something that looks like... -http://www.atagar.com/arm/images/acs_display_failure.png - -then you're encountering a bug between ncurses and your terminal where -alternate character support (ACS) is unavailable. For more information see... -http://invisible-island.net/ncurses/ncurses.faq.html#no_line_drawing - -Unfortunately there doesn't seem to be a way for nyx to automatically detect -and correct this. To work around some of the issues set this in your nyxrc... -features.acsSupport false - -> When I press enter in the connection panel to get details some of the -information is either missing or outdated. Why is this? - -There are two sources of information about Tor relays: their consensus and -descriptor entries. - -The consensus entry is provided on an hourly basis by the Tor directory -authorities (special relays that keep track of all the relays in the network). -The consensus has information like the nickname, flags, and in newer Tor -versions a summarized exit policy. - -The descriptor entry, however, is published by the relays themselves and has -information like their platform, contact information, family, public keys, -exit policy, etc. These are much larger than the consensus entries and don't -change unless the relay changes their configuration. - -Everyone in the Tor network (both relays and users) need the consensus entries -to operate. However, only users (not relays) need the descriptor entries. - -Tor will fetch both the consensus and descriptors for all of the currently -active relays when it first starts. But to save bandwidth only the consensus -entries are updated after this unless... -a. 'FetchUselessDescriptors 1' is set in your torrc -b. the directory service is provided ('DirPort' defined) -c. you use Tor as a client - -This means that some of the information on the connection page (like the -platform and contact information) might be missing or stale due to missing -descriptors. This isn't important to most users, but if you need this -information then this is simple to fix with the above. - -------------------------------------------------------------------------------- - -Layout: - -./ - nyx - startup script - install - installation script - - nyx.1 - man page - nyxrc.sample - example nyx configuration file with defaults - ChangeLog - revision history - LICENSE - copy of the gpl v3 - README - um... guess you figured this one out - setup.py - distutils installation script for nyx - - src/ - __init__.py - starter.py - parses and validates commandline parameters - prereq.py - checks python version and for required packages - version.py - version and last modified information - test.py - method for starting tests and demos - settings.cfg - attributes loaded for parsing tor related data - uninstall - removal script - - cli/ - graphing/ - __init__.py - graphPanel.py - (page 1) presents graphs for data instances - bandwidthStats.py - tracks tor bandwidth usage - psStats.py - tracks system information (such as cpu/memory usage) - connStats.py - tracks number of tor connections - - connections/ - __init__.py - connPanel.py - (page 2) lists the active tor connections - circEntry.py - circuit entries in the connection panel - connEntry.py - individual connections to or from the system - countPopup.py - displays client locale or exit port counts - descriptorPopup.py - displays raw descriptor and consensus entries - entries.py - common parent for connPanel display entries - - menu/ - __init__.py - menu.py - provides an interactive menu - item.py - individual items within the menu - actions.py - handlers for menu selections - - __init__.py - controller.py - main display loop, handling input and layout - headerPanel.py - top of all pages, providing general information - popups.py - toolkit providing display popups - - logPanel.py - (page 1) displays tor, nyx, and stem events - configPanel.py - (page 3) editor panel for the tor configuration - torrcPanel.py - (page 4) displays torrc and validation - - util/ - __init__.py - conf.py - loading and persistence for user configuration - connections.py - service providing periodic connection lookups - enum.py - enumerations for ordered collections - hostnames.py - service providing nonblocking reverse dns lookups - log.py - aggregator for application events - panel.py - wrapper for safely working with curses subwindows - procTools.py - queries process & system information from /proc contents - procName.py - renames our process to a friendlier name - sysTools.py - helper for system calls, providing client side caching - textInput.py - expands the capabilities of text input fields - torConfig.py - functions for working with the torrc and config options - torTools.py - Stem wrapper, providing caching and derived information - uiTools.py - helper functions for presenting the user interface - diff --git a/docs/_static/section/screenshots/acs_display_failure.png b/docs/_static/section/screenshots/acs_display_failure.png new file mode 100644 index 0000000..cd44aa8 Binary files /dev/null and b/docs/_static/section/screenshots/acs_display_failure.png differ diff --git a/docs/_static/section/screenshots/acs_display_failure_full.png b/docs/_static/section/screenshots/acs_display_failure_full.png new file mode 100644 index 0000000..48aff76 Binary files /dev/null and b/docs/_static/section/screenshots/acs_display_failure_full.png differ diff --git a/docs/faq.rst b/docs/faq.rst index d601fdf..9bf2dd5 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -4,11 +4,21 @@ Frequently Asked Questions * **General Information** * :ref:`what_is_nyx` + * :ref:`why_is_it_called_nyx` * :ref:`does_nyx_have_any_dependencies` * :ref:`what_python_versions_is_nyx_compatible_with` * :ref:`are_there_any_other_tor_uis` * :ref:`what_license_is_nyx_under` +* **Usage** + + * :ref:`will_exits_include_user_traffic` + * :ref:`is_it_harmful_to_share_data` + * :ref:`can_nyx_leak_data` + * :ref:`why_dont_i_see_the_bandwith_graph` + * :ref:`why_are_borders_broken` + * :ref:`why_are_relay_details_missing` + * **Development** * :ref:`how_do_i_get_started` @@ -34,6 +44,18 @@ usage, logs, connections, configuration, `and more <screenshots.html>`_. As a curses interface Nyx is particularly well suited for ssh connections, tty terminals, and command-line aficionados. +.. _why_is_it_called_nyx: + +Why is it called Nyx? +--------------------- + +Simple - because it's short and memorable. Terminal applications are handiest +when they're easy to remember and type, such as *top*, *ssh*, etc. Anything +longer is just asking to be aliased down. + +Besides, Nyx is the `Greek goddess of night +<https://en.wikipedia.org/wiki/Nyx>`_. + .. _does_nyx_have_any_dependencies: Does Nyx have any dependencies? @@ -50,7 +72,7 @@ Nyx works with **Python 2.6 and greater**, including the Python 3.x series. .. _are_there_any_other_tor_uis: -Are there any other user interfaces for tor? +Are there any other user interfaces for Tor? -------------------------------------------- .. image:: /_static/section/screenshots/vidalia.png @@ -66,7 +88,7 @@ launcher, settings editor, map, and more. `TorK information as well but never reached the same level of prominence. Both interfaces are now unmaintained. -Smaller widgits include... +Smaller widgets include... * `Syboa <https://gitorious.org/syboa/syboa>`_ - General interface * `OnionLauncher <https://github.com/neelchauhan/OnionLauncher>`_ - Tor launcher @@ -86,6 +108,95 @@ Nyx is under the `GPLv3 <https://www.gnu.org/licenses/gpl>`_. .. _where_can_i_get_help: +Usage +===== + +.. _will_exits_include_user_traffic: + +When running an exit will I see people's traffic? +------------------------------------------------- + +**No**. Potential client and exit connections are scrubbed of sensitive +information. Be aware that it's highly discouraged (and possibly illegal) for +relay operators to view this data, so please don't. + +.. _is_it_harmful_to_share_data: + +Is it harmful to share the information provided by Nyx? +------------------------------------------------------- + +**Not really**, but show some moderation. Screenshots of Nyx are unlikely to do +any harm but try to avoid exposing data en mass. + +.. _can_nyx_leak_data: + +Is there any chance that nyx will leak data? +-------------------------------------------- + +**No**. Nyx is a completely passive listener, fetching all information from +either Tor or the local system. + +.. _why_dont_i_see_the_bandwith_graph: + +Why don't I see the bandwidth graph? +------------------------------------ + +On some terminals such as Gentoo screen sessions appear to have a bug where +highlighted spaces aren't shown. Try running... + +:: + + export TERM="rxvt-unicode" + +.. _why_are_borders_broken: + +Why are there borders like 'mwqqqqqqqqj'? +----------------------------------------- + + +If you're getting something that looks like... + +.. image:: /_static/section/screenshots/acs_display_failure.png + :target: _static/section/screenshots/acs_display_failure_full.png + +... you are encountering a terminal bug where alternate character support (ACS) +`is unavailable +<http://invisible-island.net/ncurses/ncurses.faq.html#no_line_drawing>`_. + +Unfortunately there doesn't seem to be a way for Nyx to automatically detect +or correct this. To work around this you can set the following in your nyxrc +to not use ACS borders... + +:: + + features.acsSupport false + +.. _why_are_relay_details_missing: + +Why are relay details for connections missing? +---------------------------------------------- + +Relays publish information about themselves in documents called *descriptors*. +These documents are downloaded by Tor. New documents available on an hourly +basis but Tor will only download them if it needs them, so the descriptors you +have may be older. + +Nyx's connections page use these descriptors to enrich connection information +with data about the relay you're connected with. If Tor doesn't have this +information the data may be stale or missing. + +**This is fine.** Descriptor information we use changes infrequently so even if +they're a few hours old it won't matter. However, if you really need up-to-date +information you can add the following to your torrc... + +:: + + # download new descriptors even if our cache is still valid + + FetchDirInfoEarly 1 + FetchDirInfoExtraEarly 1 + FetchUselessDescriptors 1 + Development ===========

1 0

[nyx/master] FAQ section
by atagar＠torproject.org 07 Nov '16

07 Nov '16

commit 3daed07a87fc4d5a6ebf756287f0ef123b7fa614 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 6 09:57:39 2016 -0800 FAQ section Adding a FAQ section to our site. Presently it's mosty just a copy of Stem's, with information relevant to us filled in. I'll later need to think of another front page section to regain an even count. --- docs/_static/buttons/faq.png | Bin 0 -> 27450 bytes docs/_static/buttons/resources/faq.xcf | Bin 0 -> 89198 bytes docs/_static/section/screenshots/vidalia.png | Bin 0 -> 21201 bytes docs/_static/section/screenshots/vidalia_full.png | Bin 0 -> 44187 bytes docs/contents.rst | 1 + docs/faq.rst | 180 ++++++++++++++++++++++ docs/index.rst | 13 ++ 7 files changed, 194 insertions(+) diff --git a/docs/_static/buttons/faq.png b/docs/_static/buttons/faq.png new file mode 100644 index 0000000..c2cf142 Binary files /dev/null and b/docs/_static/buttons/faq.png differ diff --git a/docs/_static/buttons/resources/faq.xcf b/docs/_static/buttons/resources/faq.xcf new file mode 100644 index 0000000..ce52f63 Binary files /dev/null and b/docs/_static/buttons/resources/faq.xcf differ diff --git a/docs/_static/section/screenshots/vidalia.png b/docs/_static/section/screenshots/vidalia.png new file mode 100644 index 0000000..5e10610 Binary files /dev/null and b/docs/_static/section/screenshots/vidalia.png differ diff --git a/docs/_static/section/screenshots/vidalia_full.png b/docs/_static/section/screenshots/vidalia_full.png new file mode 100644 index 0000000..3e13855 Binary files /dev/null and b/docs/_static/section/screenshots/vidalia_full.png differ diff --git a/docs/contents.rst b/docs/contents.rst index 63b471f..b2f2ec9 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -7,5 +7,6 @@ Contents change_log change_log_legacy download + faq screenshots diff --git a/docs/faq.rst b/docs/faq.rst new file mode 100644 index 0000000..d601fdf --- /dev/null +++ b/docs/faq.rst @@ -0,0 +1,180 @@ +Frequently Asked Questions +========================== + +* **General Information** + + * :ref:`what_is_nyx` + * :ref:`does_nyx_have_any_dependencies` + * :ref:`what_python_versions_is_nyx_compatible_with` + * :ref:`are_there_any_other_tor_uis` + * :ref:`what_license_is_nyx_under` + +* **Development** + + * :ref:`how_do_i_get_started` + * :ref:`how_do_i_run_the_tests` + * :ref:`how_do_i_build_the_site` + * :ref:`what_is_the_copyright_for_patches` + +General Information +=================== + +.. _what_is_nyx: + +What is Nyx? +------------ + +Nyx is a command-line application for monitoring real time `Tor +<https://www.torproject.org/>`_ status information. This includes bandwidth +usage, logs, connections, configuration, `and more <screenshots.html>`_. + +.. image:: /_static/section/screenshots/main.png + :target: _static/section/screenshots/main_full.png + +As a curses interface Nyx is particularly well suited for ssh connections, tty +terminals, and command-line aficionados. + +.. _does_nyx_have_any_dependencies: + +Does Nyx have any dependencies? +------------------------------- + +**Yes**, Nyx requires `Stem 1.4.5 or later <https://stem.torproject.org/>`_. + +.. _what_python_versions_is_nyx_compatible_with: + +What Python versions is Nyx compatible with? +-------------------------------------------- + +Nyx works with **Python 2.6 and greater**, including the Python 3.x series. + +.. _are_there_any_other_tor_uis: + +Are there any other user interfaces for tor? +-------------------------------------------- + +.. image:: /_static/section/screenshots/vidalia.png + :align: right + +Yes, though sadly this isn't a space that gets much attention. + +For years `Vidalia <https://en.wikipedia.org/wiki/Vidalia_%28software%29>`_ was +the default interface of Tor until it was replaced in 2013 by `Tor Browser +<https://www.torproject.org/projects/torbrowser.html.en>`_. Vidalia includes a +launcher, settings editor, map, and more. `TorK +<https://sourceforge.net/projects/tork/>`_ is similar, providing connection +information as well but never reached the same level of prominence. Both +interfaces are now unmaintained. + +Smaller widgits include... + +* `Syboa <https://gitorious.org/syboa/syboa>`_ - General interface +* `OnionLauncher <https://github.com/neelchauhan/OnionLauncher>`_ - Tor launcher +* `TorNova <https://github.com/neelchauhan/TorNova>`_ - Tor launcher +* `OnionView <https://github.com/skyguy/onionview>`_ - Circuit information +* `OnionCircuits <https://git-tails.immerda.ch/onioncircuits/>`_ - Circuit information +* `or-applet <https://github.com/Yawning/or-applet>`_ - Circuit information + +If I missed any then please `let me know <https://www.atagar.com/contact/>`_! + +.. _what_license_is_nyx_under: + +What license is Nyx under? +-------------------------- + +Nyx is under the `GPLv3 <https://www.gnu.org/licenses/gpl>`_. + +.. _where_can_i_get_help: + +Development +=========== + +.. _how_do_i_get_started: + +How do I get started? +--------------------- + +The best way of getting involved with any project is to jump right in! Our `bug +tracker <https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs>`_ lists +several development tasks. In particular look for the 'easy' keyword when +getting started. If you have any questions then I'm always more than happy to +help! I'm **atagar** on `oftc <http://www.oftc.net/>`_ and also available +`via email <https://www.atagar.com/contact/>`_. + +To start hacking on Nyx please do the following and don't hesitate to let me +know if you get stuck or would like to discuss anything! + +#. Clone our `git <http://git-scm.com/>`_ repository: **git clone https://git.torproject.org/nyx.git** +#. Install the development version of `Stem <https://stem.torproject.org/>`_: **git clone https://git.torproject.org/stem.git; cd stem; sudo python setup.py install**. +#. Get our test dependencies: **sudo pip install mock pep8 pyflakes**. +#. Find a `bug or feature <https://trac.torproject.org/projects/tor/wiki/doc/nyx/bugs>`_ that sounds interesting. +#. When you have something that you would like to contribute back do the following... + + * If you don't already have a publicly accessible Nyx repository then set one up. `GitHub <https://github.com/>`_ in particular is great for this. + * File a `trac ticket <https://trac.torproject.org/projects/tor/newticket>`_, the only fields you'll need are... + + * Summary: short description of your change + * Description: longer description and a link to your repository with either the git commits or branch that has your change + * Type: 'defect' if this is a bug fix and 'enhancement' otherwise + * Priority: rough guess at the priority of your change + * Component: Core Tor / Nyx + + * I'll review the change and give suggestions. When we're both happy with it I'll push your change to the official repository. + +.. _how_do_i_run_the_tests: + +How do I run the tests? +----------------------- + +Nyx has unit tests, including tests that exercise our curses functionality. +When you run the tests you may notice your console flicker as these are +exercised. + +If you have them installed we run `pyflakes <https://launchpad.net/pyflakes>`_ +to do static error checking and `pycodestyle +<http://pycodestyle.readthedocs.org/en/latest/>`_ for style checking as part of +our tests. + +Tests are run with... + +:: + + % run_tests.py + +.. _how_do_i_build_the_site: + +How do I build the site? +------------------------ + +If you have `Sphinx <http://sphinx-doc.org/>`_ version 1.1 or later installed +then building our site is as easy as... + +:: + + ~$ cd nyx/docs + ~/nyx/docs$ make html + +When it's finished you can direct your browser to the *_build* directory with a +URI similar to... + +:: + + file:///home/atagar/nyx/docs/_build/html/index.html + +.. _what_is_the_copyright_for_patches: + +What is the copyright for patches? +---------------------------------- + +Nyx is under the GPLv3 which is a fine license, but poses a bit of a problem +for sharing code with our other projects (which are mostly BSD). To share code +without needing to hunt down prior contributors we need Tor to have the +copyright for the whole Nyx codebase. Presently the copyright of Nyx is +jointly held by its main author (`Damian <https://www.atagar.com/>`_) and the +`Tor Project <https://www.torproject.org/>`_. + +If you submit a substantial patch I'll ask if you're fine with it being in the +public domain. This would mean that there are no legal restrictions for using +your contribution, and hence won't pose a problem if we reuse Nyx code in +other projects. + diff --git a/docs/index.rst b/docs/index.rst index 785485e..d83d79b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,6 +18,19 @@ Nyx is a command line interface for `Tor <https://www.torproject.org/>`_, provid .. image:: /_static/buttons/screenshots.png :target: screenshots.html +.. Source: https://openclipart.org/detail/171951/help-by-diamonjohn-171951 + Author: John Diamond (https://openclipart.org/user-detail/diamonjohn) + License: Public Domain + + Alternate: + Source: Oxygen (http://www.oxygen-icons.org/) + Author: Andrea Joseph + License: CCv3 (A, SA) - http://creativecommons.org/licenses/by-sa/3.0/ + File: Oxygen/128x128/categories/system-help.png + +.. image:: /_static/buttons/faq.png + :target: faq.html + .. Source: Nuovo (http://www.silvestre.com.ar/?p=5) Author: Silvestre Herrera (http://www.silvestre.com.ar/) License: GPL v2

1 0

[tor-browser-bundle/hardened-builds] Bug 20583: make the downloads.json file reproducible
by gk＠torproject.org 07 Nov '16

07 Nov '16

commit 4df28e4afbd833126d4f9c3409795c6890b31b74 Author: Nicolas Vigier <boklm(a)torproject.org> Date: Sat Nov 5 19:46:09 2016 +0100 Bug 20583: make the downloads.json file reproducible --- tools/update-responses/update_responses | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tools/update-responses/update_responses b/tools/update-responses/update_responses index 498132e..69535c9 100755 --- a/tools/update-responses/update_responses +++ b/tools/update-responses/update_responses @@ -369,7 +369,8 @@ sub write_downloads_json { version => $version, downloads => get_version_downloads($config, $version), }; - write_htdocs($channel, 'downloads.json', encode_json($data)); + write_htdocs($channel, 'downloads.json', + JSON->new->utf8->canonical->encode($data)); } }

1 0

[tor-browser-bundle/maint-6.0] Bug 20583: make the downloads.json file reproducible
by gk＠torproject.org 07 Nov '16

07 Nov '16

commit 5d9099aa9406a0084aa89df85fe165488b151e60 Author: Nicolas Vigier <boklm(a)torproject.org> Date: Sat Nov 5 19:46:09 2016 +0100 Bug 20583: make the downloads.json file reproducible --- tools/update-responses/update_responses | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tools/update-responses/update_responses b/tools/update-responses/update_responses index faa1037..6f6d8b1 100755 --- a/tools/update-responses/update_responses +++ b/tools/update-responses/update_responses @@ -344,7 +344,8 @@ sub write_downloads_json { version => $version, downloads => get_version_downloads($config, $version), }; - write_htdocs($channel, 'downloads.json', encode_json($data)); + write_htdocs($channel, 'downloads.json', + JSON->new->utf8->canonical->encode($data)); } }

1 0

[tor-browser-bundle/master] Bug 20583: make the downloads.json file reproducible
by gk＠torproject.org 07 Nov '16

07 Nov '16

commit a442c22cd7771bd717558b0d7d41ee478f7a190f Author: Nicolas Vigier <boklm(a)torproject.org> Date: Sat Nov 5 19:46:09 2016 +0100 Bug 20583: make the downloads.json file reproducible --- tools/update-responses/update_responses | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tools/update-responses/update_responses b/tools/update-responses/update_responses index ceba144..bca3386 100755 --- a/tools/update-responses/update_responses +++ b/tools/update-responses/update_responses @@ -379,7 +379,8 @@ sub write_downloads_json { version => $version, downloads => get_version_downloads($config, $version), }; - write_htdocs($channel, 'downloads.json', encode_json($data)); + write_htdocs($channel, 'downloads.json', + JSON->new->utf8->canonical->encode($data)); } }

1 0