December 2019 - tor-commits - lists.torproject.org

[tor-android-service/master] Bug 32547: Add new default bridge at UMN.
by gk＠torproject.org 17 Dec '19

17 Dec '19

commit 4a81e5806f36e7d0bf9492437d824599ecf4ff43 Author: Philipp Winter <phw(a)nymity.ch> Date: Tue Dec 10 13:37:20 2019 -0800 Bug 32547: Add new default bridge at UMN. Researchers at the University of Minnesota generously agreed to running a default bridge. This fixes <https://bugs.torproject.org/32547>. --- service/src/main/assets/common/bridges.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/service/src/main/assets/common/bridges.txt b/service/src/main/assets/common/bridges.txt index 36ed076..adc6b8c 100644 --- a/service/src/main/assets/common/bridges.txt +++ b/service/src/main/assets/common/bridges.txt @@ -10,4 +10,5 @@ obfs4 193.11.166.194:27015 2D82C2E354D531A68469ADF7F878FA6060C6BACA cert=4TLQPJr obfs4 193.11.166.194:27020 86AC7B8D430DAC4117E9F42C9EAED18133863AAF cert=0LDeJH4JzMDtkJJrFphJCiPqKx7loozKN7VNfuukMGfHO0Z8OGdzHVkhVAOfo1mUdv9cMg iat-mode=0 obfs4 193.11.166.194:27025 1AE2C08904527FEA90C4C4F8C1083EA59FBC6FAF cert=ItvYZzW5tn6v3G4UnQa6Qz04Npro6e81AP70YujmK/KXwDFPTs3aHXcHp4n8Vt6w/bv8cA iat-mode=0 obfs4 209.148.46.65:443 74FAD13168806246602538555B5521A0383A1875 cert=ssH+9rP8dG2NLDN2XuFw63hIO/9MNNinLmxQDpVa+7kTOa9/m+tGWT1SmSYpQ9uTBGa6Hw iat-mode=0 +obfs4 146.57.248.225:22 10A6CD36A537FCE513A322361547444B393989F0 cert=K1gDtDAIcUfeLqbstggjIw2rtgIKqdIhUlHp82XRqNSq/mtAjp1BIC9vHKJ2FAEpGssTPw iat-mode=0 meek_lite 0.0.2.0:2 97700DFE9F483596DDA6264C4D7DF7641E1E39CE url=https://meek.azureedge.net/ front=ajax.aspnetcdn.com

1 0

[translation/communitytpo-contentspot] https://gitweb.torproject.org/translation.git/commit/?h=communitytpo-contentspot
by translation＠torproject.org 17 Dec '19

17 Dec '19

commit 6caacfd27f3dc89e1f288520b192c7fefb15e0d0 Author: Translation commit bot <translation(a)torproject.org> Date: Tue Dec 17 06:15:31 2019 +0000 https://gitweb.torproject.org/translation.git/commit/?h=communitytpo-conten… --- contents+ka.po | 70 +++++++++++++++++++++++++++++++++------------------------- 1 file changed, 40 insertions(+), 30 deletions(-) diff --git a/contents+ka.po b/contents+ka.po index 609132652d..69e36b63ce 100644 --- a/contents+ka.po +++ b/contents+ka.po @@ -1298,7 +1298,7 @@ msgstr "" #: https//community.torproject.org/relay/community-resources/ #: (content/relay-operations/community-resources/contents+en.lrpage.body) msgid "## At your university" -msgstr "" +msgstr "## თქვენს უნივერსიტეტში" #: https//community.torproject.org/relay/community-resources/ #: (content/relay-operations/community-resources/contents+en.lrpage.body) @@ -1327,7 +1327,7 @@ msgstr "" #: https//community.torproject.org/relay/community-resources/ #: (content/relay-operations/community-resources/contents+en.lrpage.body) msgid "## At your company or organization" -msgstr "" +msgstr "## თქვენს კომპანიაში ან დაწესებულებაში" #: https//community.torproject.org/relay/community-resources/ #: (content/relay-operations/community-resources/contents+en.lrpage.body) @@ -1335,6 +1335,8 @@ msgid "" "If you work at a Tor-friendly company or organization, that's another ideal " "place to run a relay." msgstr "" +"თუ თქვენ მუშაობთ Tor-ის მიმართ მეგობრულ კომპანიაში ან დაწესებულებაში, ეს " +"კიდევ ერთი საუკეთესო გზაა გადამცემის გასაშვებად." #: https//community.torproject.org/relay/community-resources/ #: (content/relay-operations/community-resources/contents+en.lrpage.body) @@ -1424,7 +1426,7 @@ msgstr "" #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) msgid "# Choosing a hosting provider" -msgstr "" +msgstr "# ჰოსტინგის მომსახურების მომწოდებლის არჩევა" #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) @@ -1471,6 +1473,8 @@ msgstr "" #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) msgid "Many VPS providers will not allow you to run exit relays." msgstr "" +"VPS-ის ბევრი მომწოდებელი, არ მოგცემთ გამსვლელი გადამცემის გაშვების " +"საშუალებას." #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) @@ -1478,6 +1482,8 @@ msgid "" "You must follow the VPS provider's terms of service, or risk having your " "account disabled." msgstr "" +"უნდა გაითვალისწინოთ VPS-მომწოდებლის მომსახურების პირობები, წინააღმდეგ " +"შემთხვევაში შესაძლოა ანგარიში გაგიუქმონ." #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) @@ -1490,7 +1496,7 @@ msgstr "" #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) msgid "## Questions to consider when choosing a host" -msgstr "" +msgstr "## საკითხები, რომლებიც უნდა გაითვალისწინოთ ჰოსტის არჩევისას" #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) @@ -1600,22 +1606,22 @@ msgstr "**შეეცადეთ აირიდოთ** შემდეგი #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) msgid "* OVH SAS (AS16276)" -msgstr "" +msgstr "* OVH SAS (AS16276)" #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) msgid "* Online S.a.s. (AS12876)" -msgstr "" +msgstr "* Online S.a.s. (AS12876)" #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) msgid "* Hetzner Online GmbH (AS24940)" -msgstr "" +msgstr "* Hetzner Online GmbH (AS24940)" #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) msgid "* DigitalOcean, LLC (AS14061)" -msgstr "" +msgstr "* DigitalOcean, LLC (AS14061)" #: https//community.torproject.org/relay/technical-considerations/ #: (content/relay-operations/technical-considerations/contents+en.lrpage.body) @@ -1867,22 +1873,22 @@ msgstr "* კანონიერია ჩემთვის, გარკვ #: https//community.torproject.org/training/risks/ #: (content/training/risks/contents+en.lrpage.body) msgid "* Does my country prohibit me from using:" -msgstr "" +msgstr "* იკრძალება ჩემს ქვეყანაში სარგებლობა:" #: https//community.torproject.org/training/risks/ #: (content/training/risks/contents+en.lrpage.body) msgid "* Cryptography?" -msgstr "" +msgstr "* კრიპტოგრაფიით?" #: https//community.torproject.org/training/risks/ #: (content/training/risks/contents+en.lrpage.body) msgid "* Anonymity software?" -msgstr "" +msgstr "* ვინაობის დასაფარი პროგრამით?" #: https//community.torproject.org/training/risks/ #: (content/training/risks/contents+en.lrpage.body) msgid "Note, this is not an exhaustive list of questions." -msgstr "" +msgstr "გაითვალისწინეთ, რომ ეს არაა საკითხების სრული ჩამონათვალი." #: https//community.torproject.org/training/risks/ #: (content/training/risks/contents+en.lrpage.body) @@ -1929,12 +1935,13 @@ msgstr "" #: https//community.torproject.org/training/risks/ #: (content/training/risks/contents+en.lrpage.body) msgid "Some relevant resources include:" -msgstr "" +msgstr "გამოსადეგი მასალებისთვის იხილეთ:" #: https//community.torproject.org/training/risks/ #: (content/training/risks/contents+en.lrpage.body) msgid "* [EFF Know your rights](https://www.eff.org/issues/know-your-rights)" msgstr "" +"* [EFF იცოდეთ თქვენი უფლებები](https://www.eff.org/issues/know-your-rights)" #: https//community.torproject.org/training/risks/ #: (content/training/risks/contents+en.lrpage.body) @@ -1942,6 +1949,9 @@ msgid "" "* [EFF Tor legal FAQ](https://community.torproject.org/relay/community-" "resources/eff-tor-legal-faq/)" msgstr "" +"* [EFF Tor-ის სამართლებრივ თემებზე " +"ხ.დ.კ.](https://community.torproject.org/relay/community-resources/eff-tor-" +"legal-faq/)" #: https//community.torproject.org/training/risks/ #: (content/training/risks/contents+en.lrpage.body) @@ -1961,7 +1971,7 @@ msgstr "" #: https//community.torproject.org/training/code-of-conduct/ #: (content/training/code-of-conduct/contents+en.lrpage.cta) msgid "Code of Conduct" -msgstr "" +msgstr "ქცევის კოდექსი" #: https//community.torproject.org/training/code-of-conduct/ #: (content/training/code-of-conduct/contents+en.lrpage.body) @@ -2000,7 +2010,7 @@ msgstr "" #: https//community.torproject.org/training/checklist/ #: (content/training/checklist/contents+en.lrpage.body) msgid "## Prepare" -msgstr "" +msgstr "## სამზადისი" #: https//community.torproject.org/training/checklist/ #: (content/training/checklist/contents+en.lrpage.body) @@ -2116,7 +2126,7 @@ msgstr "" #: https//community.torproject.org/training/checklist/ #: (content/training/checklist/contents+en.lrpage.body) msgid "## After the Training" -msgstr "" +msgstr "## გადამზადების შემდგომ" #: https//community.torproject.org/training/checklist/ #: (content/training/checklist/contents+en.lrpage.body) @@ -2520,17 +2530,17 @@ msgstr "" #: https//community.torproject.org/training/resources/ #: (content/training/resources/contents+en.lrpage.title) msgid "Training Resources" -msgstr "" +msgstr "გადამზადების მასალები" #: https//community.torproject.org/training/resources/ #: (content/training/resources/contents+en.lrpage.cta) msgid "Check out our resources" -msgstr "" +msgstr "გადახედეთ ჩვენს მასალებს" #: https//community.torproject.org/training/resources/ #: (content/training/resources/contents+en.lrpage.body) msgid "##Resources" -msgstr "" +msgstr "##მასალები" #: https//community.torproject.org/training/resources/ #: (content/training/resources/contents+en.lrpage.body) @@ -2542,12 +2552,12 @@ msgstr "" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.title) msgid "How do onion services work?" -msgstr "" +msgstr "როგორ მუშაობს onion-მომსახურებები?" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.subtitle) msgid "Learn how onion services work." -msgstr "" +msgstr "იხილეთ, როგორ მუშაობს onion-მომსახურებები." #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) @@ -2564,7 +2574,7 @@ msgstr "" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) msgid "## Why onion services?" -msgstr "" +msgstr "## რატომ onion-მომსახურებები?" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) @@ -2575,12 +2585,12 @@ msgstr "" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) msgid "### Location hiding" -msgstr "" +msgstr "### მდებარეობის დაფარვა" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) msgid "An onion service's IP address is protected." -msgstr "" +msgstr "Onion-მომსახურების IP-მისამართი დაცულია." #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) @@ -2593,7 +2603,7 @@ msgstr "" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) msgid "### End-to-end authentication" -msgstr "" +msgstr "### გამჭოლი დამოწმება" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) @@ -2617,7 +2627,7 @@ msgstr "" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) msgid "### End-to-end encryption" -msgstr "" +msgstr "### გამჭოლი დაშიფვრა" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) @@ -2656,7 +2666,7 @@ msgstr "" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) msgid "## The Onion Service Protocol: Overview" -msgstr "" +msgstr "## Onion-მომსახურების ოქმი: მიმოხილვა" #: https//community.torproject.org/onion-services/overview/ #: (content/onion-services/overview/contents+en.lrpage.body) @@ -3007,17 +3017,17 @@ msgstr "" #: https//community.torproject.org/onion-services/setup/ #: (content/onion-services/setup/contents+en.lrpage.title) msgid "Set up Your Onion Service" -msgstr "" +msgstr "გამართეთ თქვენი Onion-მომსახურება" #: https//community.torproject.org/onion-services/setup/ #: (content/onion-services/setup/contents+en.lrpage.subtitle) msgid "Learn how to set up a .onion site of your very own." -msgstr "" +msgstr "იხილეთ, როგორ უნდა გამართოთ საიტი .onion თქვენი ძალებით." #: https//community.torproject.org/onion-services/setup/ #: (content/onion-services/setup/contents+en.lrpage.cta) msgid "Get Started" -msgstr "" +msgstr "დაიწყეთ" #: https//community.torproject.org/onion-services/setup/ #: (content/onion-services/setup/contents+en.lrpage.body)

1 0

[translation/communitytpo-contentspot] https://gitweb.torproject.org/translation.git/commit/?h=communitytpo-contentspot
by translation＠torproject.org 17 Dec '19

17 Dec '19

commit 5ef1e245a46be5879829b4dff4831bfce9fbcb54 Author: Translation commit bot <translation(a)torproject.org> Date: Tue Dec 17 05:45:30 2019 +0000 https://gitweb.torproject.org/translation.git/commit/?h=communitytpo-conten… --- contents+ka.po | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/contents+ka.po b/contents+ka.po index d0933aac43..609132652d 100644 --- a/contents+ka.po +++ b/contents+ka.po @@ -624,7 +624,7 @@ msgstr "" #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) msgid "# Public IPv4 Address" -msgstr "" +msgstr "# საჯარო IPv4-მისამართი" #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) @@ -677,7 +677,7 @@ msgstr "" #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) msgid "# Memory Requirements" -msgstr "" +msgstr "# მეხსიერების მოთხოვნები" #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) @@ -700,12 +700,12 @@ msgstr "" #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) msgid "# Disk Storage" -msgstr "" +msgstr "# სივრცე დისკზე" #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) msgid "Tor does not need much disk storage." -msgstr "" +msgstr "Tor არ საჭიროებს დიდ ადგილს დისკზე." #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) @@ -717,12 +717,12 @@ msgstr "" #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) msgid "# CPU" -msgstr "" +msgstr "# CPU" #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) msgid "* Any modern CPU should be fine." -msgstr "" +msgstr "* ნებისმიერ თანამედროვე CPU (პროცესორი) გამოდგება." #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) @@ -738,6 +738,8 @@ msgid "" "If the file /proc/cpuinfo contains the word aes your CPU has support for " "AES-NI." msgstr "" +"თუ ფაილი /proc/cpuinfo შეიცავს სიტყვას aes თქვენს CPU-ზე მხარდაჭერილია AES-" +"NI." #: https//community.torproject.org/relay/relays-requirements/ #: (content/relay-operations/relays-requirements/contents+en.lrpage.body) @@ -891,7 +893,7 @@ msgstr "" #: https//community.torproject.org/relay/types-of-relays/ #: (content/relay-operations/types-of-relays/contents+en.lrpage.body) msgid "A non-exit relay does not allow exiting in its exit policy." -msgstr "" +msgstr "არაგამავალი გადამცემი არ იძლევა გასვლის საშუალებას, მისი დებულებით." #: https//community.torproject.org/relay/types-of-relays/ #: (content/relay-operations/types-of-relays/contents+en.lrpage.body)

1 0

[tor/master] changes file for ticket 32708
by teor＠torproject.org 16 Dec '19

16 Dec '19

commit 4bc698f776751c28e9e75b0ec45782630b06f227 Author: Taylor Yu <catalyst(a)torproject.org> Date: Mon Dec 9 15:44:38 2019 -0600 changes file for ticket 32708 --- changes/ticket32708 | 3 +++ 1 file changed, 3 insertions(+) diff --git a/changes/ticket32708 b/changes/ticket32708 new file mode 100644 index 000000000..06bf4cf22 --- /dev/null +++ b/changes/ticket32708 @@ -0,0 +1,3 @@ + o Documentation (manpage): + - Alphabetize the General Options section of the tor + manpage. Closes ticket 32708.

1 0

[tor/master] manpage: minor formatting fixes
by teor＠torproject.org 16 Dec '19

16 Dec '19

commit 1e3f53d613182471d4daed1f34462929bf24f308 Author: Taylor Yu <catalyst(a)torproject.org> Date: Mon Dec 9 14:54:24 2019 -0600 manpage: minor formatting fixes These are unrelated changes done by Swati while doing the alphabetizing. Part of ticket 32708. --- doc/tor.1.txt | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 7e70bb67e..bcc78f765 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -236,7 +236,7 @@ GENERAL OPTIONS When using OpenSSL hardware crypto acceleration attempt to load the dynamic engine of this name. This must be used for any dynamic hardware engine. Names can be verified with the openssl engine command. Can not be changed - while tor is running. + while tor is running. + + If the engine name is prefixed with a "!", then Tor will exit if the engine cannot be loaded. @@ -384,7 +384,7 @@ GENERAL OPTIONS bind to multiple address/port pairs. Set it to "auto" to have Tor pick a port for you. (Default: 0) + + - Recognized flags are... + Recognized flags are: **GroupWritable**;; Unix domain sockets only: makes the socket get created as group-writable. @@ -825,14 +825,14 @@ GENERAL OPTIONS **ExtORPortCookieAuthFile**, **Logs**, **ServerDNSResolvConfFile**, - **ClientOnionAuthDir** (and any files in it won't reload on HUP signal). + **ClientOnionAuthDir** (and any files in it won't reload on HUP signal). + + Launching new Onion Services through the control port is not supported - with current syscall sandboxing implementation. + with current syscall sandboxing implementation. + + Tor must remain in client or server mode (some changes to **ClientOnly** and **ORPort** are not allowed). Currently, if **Sandbox** is 1, - **ControlPort** command "GETINFO address" will not work. + **ControlPort** command "GETINFO address" will not work. + + (Default: 0) @@ -843,7 +843,7 @@ GENERAL OPTIONS unavailable, the second one is tried and so on. It is possible to change these values at runtime. This option mostly effects relays, and most operators should leave it set to its default value. - (Default: KIST,KISTLite,Vanilla) + (Default: KIST,KISTLite,Vanilla) + + The possible scheduler types are: + @@ -852,13 +852,13 @@ GENERAL OPTIONS and when to send it. KIST also handles traffic in batches (see KISTSchedRunInterval) in order to improve traffic prioritization decisions. As implemented, KIST will only work on Linux kernel version 2.6.39 or - higher. + higher. + + **KISTLite**: Same as KIST but without kernel support. Tor will use all the same mechanics as with KIST, including the batching, but its decisions regarding how much data to send will not be as good. KISTLite will work on all kernels and operating systems, and the majority of the benefits of KIST - are still realized with KISTLite. + are still realized with KISTLite. + + **Vanilla**: The scheduler that Tor used before KIST was implemented. It sends as much data as possible, as soon as possible. Vanilla will work on

1 0

[tor/master] manpage: section titles to 1-line
by teor＠torproject.org 16 Dec '19

16 Dec '19

commit 6f31d7e0481330b63600864cd7927df6a26bd1c2 Author: Taylor Yu <catalyst(a)torproject.org> Date: Wed Dec 11 11:23:27 2019 -0600 manpage: section titles to 1-line Change the section title formatting to use the one-line format. This allows Asciidoctor-based tooling to parse it more easily. Part of ticket 32708. --- doc/tor.1.txt | 69 +++++++++++++++++++++++------------------------------------ 1 file changed, 27 insertions(+), 42 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index b867409cd..2cc932cb1 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -4,20 +4,20 @@ // Learn asciidoc on http://www.methods.co.nz/asciidoc/userguide.html :man source: Tor :man manual: Tor Manual -TOR(1) -====== +// compat-mode tells Asciidoctor tools to process this as legacy AsciiDoc +:compat-mode: += TOR(1) + +== NAME -NAME ----- tor - The second-generation onion router -SYNOPSIS --------- +== SYNOPSIS + **tor** [__OPTION__ __value__]... -DESCRIPTION ------------ +== DESCRIPTION Tor is a connection-oriented anonymizing communication service. Users choose a source-routed path through a set of nodes, and negotiate a @@ -38,8 +38,7 @@ providing bandwidth as a relay, change the **ORPort** configuration option as mentioned below. Please also consult the documentation on the Tor Project's website. -COMMAND-LINE OPTIONS --------------------- +== COMMAND-LINE OPTIONS Tor has a powerful command-line interface. This section lists optional arguments you can specify at the command line using the **`tor`** @@ -186,8 +185,7 @@ The following options in this section are only recognized on the of the form: "signing-cert-expiry: 2017-07-25 08:30:15 UTC" [[conf-format]] -THE CONFIGURATION FILE FORMAT ------------------------------ +== THE CONFIGURATION FILE FORMAT All configuration options in a configuration are written on a single line by default. They take the form of an option name and a value, or an option name @@ -225,8 +223,8 @@ command line that you want no SocksPorts at all. To do that, prefix the option name with a forward slash (/). You can use the plus sign (+) and the forward slash (/) in the configuration file and on the command line. -GENERAL OPTIONS ---------------- +== GENERAL OPTIONS + [[AccelDir]] **AccelDir** __DIR__:: Specify this option if using dynamic hardware acceleration and the engine implementation library resides somewhere other than the OpenSSL default. @@ -929,8 +927,7 @@ GENERAL OPTIONS On startup, setuid to this user and setgid to their primary group. Can not be changed while tor is running. -CLIENT OPTIONS --------------- +== CLIENT OPTIONS The following options are useful only for clients (that is, if **SocksPort**, **HTTPTunnelPort**, **TransPort**, **DNSPort**, or @@ -1994,8 +1991,7 @@ The following options are useful only for clients (that is, if is launched for some other reason (for example, by a startup process, or by an application that launches itself on every login.) -SERVER OPTIONS --------------- +== SERVER OPTIONS The following options are useful only for servers (that is, if ORPort is non-zero): @@ -2606,8 +2602,7 @@ is non-zero): changed for a given amount of time. (Default: 24 hours) -DIRECTORY SERVER OPTIONS ------------------------- +== DIRECTORY SERVER OPTIONS The following options are useful only for directory servers. (Relays with enough bandwidth automatically become directory servers; see DirCache for @@ -2652,8 +2647,7 @@ details.) (Default: 0) -DENIAL OF SERVICE MITIGATION OPTIONS ------------------------------------- +== DENIAL OF SERVICE MITIGATION OPTIONS Tor has three built-in mitigation options that can be individually enabled/disabled and fine-tuned, but by default Tor directory authorities will @@ -2782,8 +2776,7 @@ Denial of Service mitigation subsystem described above. (Default: auto) -DIRECTORY AUTHORITY SERVER OPTIONS ----------------------------------- +== DIRECTORY AUTHORITY SERVER OPTIONS The following options enable operation as a directory authority, and control how Tor behaves as a directory authority. You should not need @@ -3002,8 +2995,7 @@ on the public Tor network. before it will treat advertised bandwidths as wholly unreliable. (Default: 500) -HIDDEN SERVICE OPTIONS ----------------------- +== HIDDEN SERVICE OPTIONS The following options are used to configure a hidden service. Some options apply per service and some apply for the whole tor instance. @@ -3181,8 +3173,7 @@ The next section describes the per service options that can only be set including setting SOCKSPort to "0". Can not be changed while tor is running. (Default: 0) -Client Authorization --------------------- +== Client Authorization (Version 3 only) @@ -3223,8 +3214,7 @@ Client side: For more information, please see https://2019.www.torproject.org/docs/tor-onion-service.html.en#ClientAuthor… . -TESTING NETWORK OPTIONS ------------------------ +== TESTING NETWORK OPTIONS The following options are used for running a testing Tor network. @@ -3423,8 +3413,7 @@ The following options are used for running a testing Tor network. we replace it and issue a new key? (Default: 3 hours for link and auth; 1 day for signing.) -NON-PERSISTENT OPTIONS ----------------------- +== NON-PERSISTENT OPTIONS These options are not saved to the torrc file by the "SAVECONF" controller command. Other options of this type are documented in control-spec.txt, @@ -3436,8 +3425,7 @@ section 5.4. End-users should mostly ignore them. torrc file by the controller's SAVECONF command. -SIGNALS -------- +== SIGNALS Tor catches the following signals: @@ -3470,8 +3458,7 @@ Tor catches the following signals: [[SIGXFSZ]] **SIGXFSZ**:: If this signal exists on your platform, Tor catches and ignores it. -FILES ------ +== FILES **`@CONFDIR@/torrc`**:: Default location of the configuration file. @@ -3703,19 +3690,17 @@ __HiddenServiceDirectory__/**`onion_service_non_anonymous`**:: This file is present if a hidden service key was created in **HiddenServiceNonAnonymousMode**. -SEE ALSO --------- +== SEE ALSO For more information, refer to the Tor Project website at https://www.torproject.org/ and the Tor specifications at https://spec.torproject.org. See also **torsocks**(1) and **torify**(1). -BUGS ----- +== BUGS Because Tor is still under development, there may be plenty of bugs. Please report them at https://trac.torproject.org/. -AUTHORS -------- +== AUTHORS + Roger Dingledine [arma at mit.edu] Nick Mathewson [nickm at alum.mit.edu]

1 0

[tor/master] manpage: alphabetize General Options
by teor＠torproject.org 16 Dec '19

16 Dec '19

commit 21b3073b9ad3e49182352cb8c7e3111aa0757f70 Author: Swati Thacker <swati.kgp13(a)gmail.com> Date: Tue Nov 26 14:41:03 2019 +0530 manpage: alphabetize General Options Part of ticket 32708. --- doc/tor.1.txt | 562 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 280 insertions(+), 282 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index ae08c31c1..7e70bb67e 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -227,6 +227,43 @@ forward slash (/) in the configuration file and on the command line. GENERAL OPTIONS --------------- +[[AccelDir]] **AccelDir** __DIR__:: + Specify this option if using dynamic hardware acceleration and the engine + implementation library resides somewhere other than the OpenSSL default. + Can not be changed while tor is running. + +[[AccelName]] **AccelName** __NAME__:: + When using OpenSSL hardware crypto acceleration attempt to load the dynamic + engine of this name. This must be used for any dynamic hardware engine. + Names can be verified with the openssl engine command. Can not be changed + while tor is running. + + + If the engine name is prefixed with a "!", then Tor will exit if the + engine cannot be loaded. + +[[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __ fingerprint__:: +[[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __fingerprint__:: + These options behave as DirAuthority, but they replace fewer of the + default directory authorities. Using + AlternateDirAuthority replaces the default Tor directory authorities, but + leaves the default bridge authorities in + place. Similarly, + AlternateBridgeAuthority replaces the default bridge authority, + but leaves the directory authorities alone. + +[[AndroidIdentityTag]] **AndroidIdentityTag** __tag__:: + When logging to Android's logging subsystem, adds a tag to the log identity + such that log entries are marked with "Tor-__tag__". Can not be changed while + tor is running. (Default: none) + +[[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**:: + If non-zero, try to write to disk less frequently than we would otherwise. + This is useful when running on flash memory or other media that support + only a limited number of writes. (Default: 0) + +[[BandwidthBurst]] **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: + Limit the maximum token bucket size (also known as the burst) to the given + number of bytes in each direction. (Default: 1 GByte) [[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: A token bucket limits the average incoming bandwidth usage on this node @@ -254,41 +291,27 @@ GENERAL OPTIONS To avoid confusion, we recommend writing "bytes" or "bits" explicitly, since it's easy to forget that "B" means bytes, not bits. -[[BandwidthBurst]] **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: - Limit the maximum token bucket size (also known as the burst) to the given - number of bytes in each direction. (Default: 1 GByte) - -[[MaxAdvertisedBandwidth]] **MaxAdvertisedBandwidth** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: - If set, we will not advertise more than this amount of bandwidth for our - BandwidthRate. Server operators who want to reduce the number of clients - who ask to build circuits through them (since this is proportional to - advertised bandwidth rate) can thus reduce the CPU demands on their server - without impacting network performance. - -[[RelayBandwidthRate]] **RelayBandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: - If not 0, a separate token bucket limits the average incoming bandwidth - usage for \_relayed traffic_ on this node to the specified number of bytes - per second, and the average outgoing bandwidth usage to that same value. - Relayed traffic currently is calculated to include answers to directory - requests, but that may change in future versions. They do not include directory - fetches by the relay (from authority or other relays), because that is considered - "client" activity. (Default: 0) - -[[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: - If not 0, limit the maximum token bucket size (also known as the burst) for - \_relayed traffic_ to the given number of bytes in each direction. - They do not include directory fetches by the relay (from authority - or other relays), because that is considered "client" activity. (Default: 0) +[[CacheDirectory]] **CacheDirectory** __DIR__:: + Store cached directory data in DIR. Can not be changed while tor is + running. + (Default: uses the value of DataDirectory.) -[[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: - If this option is set manually, or via the "perconnbwrate" consensus - field, Tor will use it for separate rate limiting for each connection - from a non-relay. (Default: 0) +[[CacheDirectoryGroupReadable]] **CacheDirectoryGroupReadable** **0**|**1**|**auto**:: + If this option is set to 0, don't allow the filesystem group to read the + CacheDirectory. If the option is set to 1, make the CacheDirectory readable + by the default GID. If the option is "auto", then we use the + setting for DataDirectoryGroupReadable when the CacheDirectory is the + same as the DataDirectory, and 0 otherwise. (Default: auto) -[[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: - If this option is set manually, or via the "perconnbwburst" consensus - field, Tor will use it for separate rate limiting for each connection - from a non-relay. (Default: 0) +[[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM__:: + If this value is set, we override the default algorithm for choosing which + circuit's cell to deliver or relay next. It is delivered first to the + circuit that has the lowest weighted cell count, where cells are weighted + exponentially according to this value (in seconds). If the value is -1, it + is taken from the consensus if possible else it will fallback to the + default value of 30. Minimum: 1, Maximum: 2147483647. This can be defined + as a float value. This is an advanced option; you generally shouldn't have + to mess with it. (Default: -1) [[ClientTransportPlugin]] **ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__:: **ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]:: @@ -304,39 +327,6 @@ GENERAL OPTIONS forwards its traffic to it. It's the duty of that proxy to properly forward the traffic to the bridge. (Default: none) -[[ServerTransportPlugin]] **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]:: - The Tor relay launches the pluggable transport proxy in __path-to-binary__ - using __options__ as its command-line options, and expects to receive - proxied client traffic from it. (Default: none) - -[[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__:: - When this option is set, Tor will suggest __IP__:__PORT__ as the - listening address of any pluggable transport proxy that tries to - launch __transport__. (IPv4 addresses should written as-is; IPv6 - addresses should be wrapped in square brackets.) (Default: none) - -[[ServerTransportOptions]] **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...:: - When this option is set, Tor will pass the __k=v__ parameters to - any pluggable transport proxy that tries to launch __transport__. + - (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache) (Default: none) - -[[ExtORPort]] **ExtORPort** \['address':]__port__|**auto**:: - Open this port to listen for Extended ORPort connections from your - pluggable transports. + - (Default: **DataDirectory**/extended_orport_auth_cookie) - -[[ExtORPortCookieAuthFile]] **ExtORPortCookieAuthFile** __Path__:: - If set, this option overrides the default location and file name - for the Extended ORPort's cookie file -- the cookie file is needed - for pluggable transports to communicate through the Extended ORPort. - -[[ExtORPortCookieAuthFileGroupReadable]] **ExtORPortCookieAuthFileGroupReadable** **0**|**1**:: - If this option is set to 0, don't allow the filesystem group to read the - Extended OR Port cookie file. If the option is set to 1, make the cookie - file readable by the default GID. [Making the file readable by other - groups is not yet implemented; let us know if you need this for some - reason.] (Default: 0) - [[ConnLimit]] **ConnLimit** __NUM__:: The minimum number of file descriptors that must be available to the Tor process before it will start. Tor will ask the OS for as many file @@ -353,15 +343,6 @@ GENERAL OPTIONS adjust **ConnLimit** itself. It has no effect on Windows, since that platform lacks getrlimit(). (Default: 1000) -[[DisableNetwork]] **DisableNetwork** **0**|**1**:: - When this option is set, we don't listen for or accept any connections - other than controller connections, and we close (and don't reattempt) - any outbound - connections. Controllers sometimes use this option to avoid using - the network until Tor is fully configured. Tor will make still certain - network-related calls (like DNS lookups) as a part of its configuration - process, even if DisableNetwork is set. (Default: 0) - [[ConstrainedSockets]] **ConstrainedSockets** **0**|**1**:: If set, Tor will tell the kernel to attempt to shrink the buffers for all sockets to the size specified in **ConstrainedSockSize**. This is useful for @@ -414,6 +395,16 @@ GENERAL OPTIONS Unix domain sockets only: Do not insist that the directory that holds the socket be read-restricted. +[[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**:: + If this option is set to 0, don't allow the filesystem group to read the + control port file. If the option is set to 1, make the control port + file readable by the default GID. (Default: 0) + +[[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__:: + If set, Tor writes the address and port of any control port it opens to + this address. Usable by controllers to learn the actual control port + when ControlPort is set to "auto". + [[ControlSocket]] **ControlSocket** __Path__:: Like ControlPort, but listens on a Unix domain socket, rather than a TCP socket. '0' disables ControlSocket. (Unix and Unix-like systems only.) @@ -424,13 +415,6 @@ GENERAL OPTIONS write unix sockets (e.g. ControlSocket). If the option is set to 1, make the control socket readable and writable by the default GID. (Default: 0) -[[HashedControlPassword]] **HashedControlPassword** __hashed_password__:: - Allow connections on the control port if they present - the password whose one-way hash is __hashed_password__. You - can compute the hash of a password by running "tor --hash-password - __password__". You can provide several acceptable passwords by using more - than one HashedControlPassword line. - [[CookieAuthentication]] **CookieAuthentication** **0**|**1**:: If this option is set to 1, allow connections on the control port when the connecting process knows the contents of a file named @@ -448,15 +432,11 @@ GENERAL OPTIONS the default GID. [Making the file readable by other groups is not yet implemented; let us know if you need this for some reason.] (Default: 0) -[[ControlPortWriteToFile]] **ControlPortWriteToFile** __Path__:: - If set, Tor writes the address and port of any control port it opens to - this address. Usable by controllers to learn the actual control port - when ControlPort is set to "auto". - -[[ControlPortFileGroupReadable]] **ControlPortFileGroupReadable** **0**|**1**:: - If this option is set to 0, don't allow the filesystem group to read the - control port file. If the option is set to 1, make the control port - file readable by the default GID. (Default: 0) +[[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**:: + If this option is set, then Tor's rate-limiting applies not only to + remote connections, but also to connections to private addresses like + 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging + rate-limiting. (Default: 0) [[DataDirectory]] **DataDirectory** __DIR__:: Store working data in DIR. Can not be changed while tor is running. @@ -469,39 +449,6 @@ GENERAL OPTIONS DataDirectory. If the option is set to 1, make the DataDirectory readable by the default GID. (Default: 0) -[[CacheDirectory]] **CacheDirectory** __DIR__:: - Store cached directory data in DIR. Can not be changed while tor is - running. - (Default: uses the value of DataDirectory.) - -[[CacheDirectoryGroupReadable]] **CacheDirectoryGroupReadable** **0**|**1**|**auto**:: - If this option is set to 0, don't allow the filesystem group to read the - CacheDirectory. If the option is set to 1, make the CacheDirectory readable - by the default GID. If the option is "auto", then we use the - setting for DataDirectoryGroupReadable when the CacheDirectory is the - same as the DataDirectory, and 0 otherwise. (Default: auto) - -[[FallbackDir]] **FallbackDir** __ipv4address__:__dirport__ orport=__orport__ id=__fingerprint__ [weight=__num__] [ipv6=**[**__ipv6address__**]**:__orport__]:: - When tor is unable to connect to any directory cache for directory info - (usually because it doesn't know about any yet) it tries a hard-coded - directory. Relays try one directory authority at a time. Clients try - multiple directory authorities and FallbackDirs, to avoid hangs on - startup if a hard-coded directory is down. Clients wait for a few seconds - between each attempt, and retry FallbackDirs more often than directory - authorities, to reduce the load on the directory authorities. + - + - FallbackDirs should be stable relays with stable IP addresses, ports, - and identity keys. They must have a DirPort. + - + - By default, the directory authorities are also FallbackDirs. Specifying a - FallbackDir replaces Tor's default hard-coded FallbackDirs (if any). - (See the **DirAuthority** entry for an explanation of each flag.) - -[[UseDefaultFallbackDirs]] **UseDefaultFallbackDirs** **0**|**1**:: - Use Tor's default hard-coded FallbackDirs (if any). (When a - FallbackDir line is present, it replaces the hard-coded FallbackDirs, - regardless of the value of UseDefaultFallbackDirs.) (Default: 1) - [[DirAuthority]] **DirAuthority** [__nickname__] [**flags**] __ipv4address__:__dirport__ __fingerprint__:: Use a nonstandard authoritative directory server at the provided address and port, with the specified key fingerprint. This option can be repeated @@ -540,17 +487,6 @@ GENERAL OPTIONS should be 1.0 or less. The default is less than 1, to reduce load on authorities. (Default: 0.1) -[[AlternateDirAuthority]] **AlternateDirAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __fingerprint__ + - -[[AlternateBridgeAuthority]] **AlternateBridgeAuthority** [__nickname__] [**flags**] __ipv4address__:__port__ __ fingerprint__:: - These options behave as DirAuthority, but they replace fewer of the - default directory authorities. Using - AlternateDirAuthority replaces the default Tor directory authorities, but - leaves the default bridge authorities in - place. Similarly, - AlternateBridgeAuthority replaces the default bridge authority, - but leaves the directory authorities alone. - [[DisableAllSwap]] **DisableAllSwap** **0**|**1**:: If set to 1, Tor will attempt to lock all current and future memory pages, so that memory cannot be paged out. Windows, OS X and Solaris are currently @@ -575,6 +511,55 @@ GENERAL OPTIONS this to 0 for the duration of your debugging. Normal users should leave it on. Disabling this option while Tor is running is prohibited. (Default: 1) +[[DisableNetwork]] **DisableNetwork** **0**|**1**:: + When this option is set, we don't listen for or accept any connections + other than controller connections, and we close (and don't reattempt) + any outbound + connections. Controllers sometimes use this option to avoid using + the network until Tor is fully configured. Tor will make still certain + network-related calls (like DNS lookups) as a part of its configuration + process, even if DisableNetwork is set. (Default: 0) + +[[ExtendByEd25519ID]] **ExtendByEd25519ID** **0**|**1**|**auto**:: + If this option is set to 1, we always try to include a relay's Ed25519 ID + when telling the proceeding relay in a circuit to extend to it. + If this option is set to 0, we never include Ed25519 IDs when extending + circuits. If the option is set to "default", we obey a + parameter in the consensus document. (Default: auto) + +[[ExtORPort]] **ExtORPort** \['address':]__port__|**auto**:: + Open this port to listen for Extended ORPort connections from your + pluggable transports. + + (Default: **DataDirectory**/extended_orport_auth_cookie) + +[[ExtORPortCookieAuthFile]] **ExtORPortCookieAuthFile** __Path__:: + If set, this option overrides the default location and file name + for the Extended ORPort's cookie file -- the cookie file is needed + for pluggable transports to communicate through the Extended ORPort. + +[[ExtORPortCookieAuthFileGroupReadable]] **ExtORPortCookieAuthFileGroupReadable** **0**|**1**:: + If this option is set to 0, don't allow the filesystem group to read the + Extended OR Port cookie file. If the option is set to 1, make the cookie + file readable by the default GID. [Making the file readable by other + groups is not yet implemented; let us know if you need this for some + reason.] (Default: 0) + +[[FallbackDir]] **FallbackDir** __ipv4address__:__dirport__ orport=__orport__ id=__fingerprint__ [weight=__num__] [ipv6=**[**__ipv6address__**]**:__orport__]:: + When tor is unable to connect to any directory cache for directory info + (usually because it doesn't know about any yet) it tries a hard-coded + directory. Relays try one directory authority at a time. Clients try + multiple directory authorities and FallbackDirs, to avoid hangs on + startup if a hard-coded directory is down. Clients wait for a few seconds + between each attempt, and retry FallbackDirs more often than directory + authorities, to reduce the load on the directory authorities. + + + + FallbackDirs should be stable relays with stable IP addresses, ports, + and identity keys. They must have a DirPort. + + + + By default, the directory authorities are also FallbackDirs. Specifying a + FallbackDir replaces Tor's default hard-coded FallbackDirs (if any). + (See the **DirAuthority** entry for an explanation of each flag.) + [[FetchDirInfoEarly]] **FetchDirInfoEarly** **0**|**1**:: If set to 1, Tor will always fetch directory information like other directory caches, even if you don't meet the normal criteria for fetching @@ -614,9 +599,20 @@ GENERAL OPTIONS flavour of consensues and descriptors that is fetched and used for building circuits. (Default: 0) -[[HTTPProxy]] **HTTPProxy** __host__[:__port__]:: - Tor will make all its directory requests through this host:port (or host:80 - if port is not specified), rather than connecting directly to any directory +[[HardwareAccel]] **HardwareAccel** **0**|**1**:: + If non-zero, try to use built-in (static) crypto hardware acceleration when + available. Can not be changed while tor is running. (Default: 0) + +[[HashedControlPassword]] **HashedControlPassword** __hashed_password__:: + Allow connections on the control port if they present + the password whose one-way hash is __hashed_password__. You + can compute the hash of a password by running "tor --hash-password + __password__". You can provide several acceptable passwords by using more + than one HashedControlPassword line. + +[[HTTPProxy]] **HTTPProxy** __host__[:__port__]:: + Tor will make all its directory requests through this host:port (or host:80 + if port is not specified), rather than connecting directly to any directory servers. (DEPRECATED: As of 0.3.1.0-alpha you should use HTTPSProxy.) [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__:: @@ -639,57 +635,23 @@ GENERAL OPTIONS proxy authentication that Tor supports; feel free to submit a patch if you want it to support others. -[[Sandbox]] **Sandbox** **0**|**1**:: - If set to 1, Tor will run securely through the use of a syscall sandbox. - Otherwise the sandbox will be disabled. The option is currently an - experimental feature. It only works on Linux-based operating systems, - and only when Tor has been built with the libseccomp library. This option - can not be changed while tor is running. + - + - When the **Sandbox** is 1, the following options can not be changed when tor - is running: - **Address**, - **ConnLimit**, - **CookieAuthFile**, - **DirPortFrontPage**, - **ExtORPortCookieAuthFile**, - **Logs**, - **ServerDNSResolvConfFile**, - **ClientOnionAuthDir** (and any files in it won't reload on HUP signal). - + - Launching new Onion Services through the control port is not supported - with current syscall sandboxing implementation. - + - Tor must remain in client or server mode (some changes to **ClientOnly** - and **ORPort** are not allowed). Currently, if **Sandbox** is 1, - **ControlPort** command "GETINFO address" will not work. - + - (Default: 0) - -[[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]:: - Tor will make all OR connections through the SOCKS 4 proxy at host:port - (or host:1080 if port is not specified). - -[[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]:: - Tor will make all OR connections through the SOCKS 5 proxy at host:port - (or host:1080 if port is not specified). - -[[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ + - -[[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__:: - If defined, authenticate to the SOCKS 5 server using username and password - in accordance to RFC 1929. Both username and password must be between 1 and - 255 characters. - -[[UnixSocksGroupWritable]] **UnixSocksGroupWritable** **0**|**1**:: - If this option is set to 0, don't allow the filesystem group to read and - write unix sockets (e.g. SocksPort unix:). If the option is set to 1, make - the Unix socket readable and writable by the default GID. (Default: 0) - [[KeepalivePeriod]] **KeepalivePeriod** __NUM__:: To keep firewalls from expiring connections, send a padding keepalive cell every NUM seconds on open connections that are in use. (Default: 5 minutes) +[[KeepBindCapabilities]] **KeepBindCapabilities** **0**|**1**|**auto**:: + On Linux, when we are started as root and we switch our identity using + the **User** option, the **KeepBindCapabilities** option tells us whether to + try to retain our ability to bind to low ports. If this value is 1, we + try to keep the capability; if it is 0 we do not; and if it is **auto**, + we keep the capability only if we are configured to listen on a low port. + Can not be changed while tor is running. + (Default: auto.) +[[LogMessageDomains]] **LogMessageDomains** **0**|**1**:: + If 1, Tor includes message domains with each log message. Every log + message currently has at least one domain; most currently have exactly + one. This doesn't affect controller log messages. (Default: 0) + [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**:: Send all messages between __minSeverity__ and __maxSeverity__ to the standard output stream, the standard error stream, or to the system log. (The @@ -739,10 +701,20 @@ GENERAL OPTIONS messages from domains other than networking and memory management, and all messages of severity notice or higher. -[[LogMessageDomains]] **LogMessageDomains** **0**|**1**:: - If 1, Tor includes message domains with each log message. Every log - message currently has at least one domain; most currently have exactly - one. This doesn't affect controller log messages. (Default: 0) +[[LogTimeGranularity]] **LogTimeGranularity** __NUM__:: + Set the resolution of timestamps in Tor's logs to NUM milliseconds. + NUM must be positive and either a divisor or a multiple of 1 second. + Note that this option only controls the granularity written by Tor to + a file or console log. Tor does not (for example) "batch up" log + messages to affect times logged by a controller, times attached to + syslog messages, or the mtime fields on log files. (Default: 1 second) + +[[MaxAdvertisedBandwidth]] **MaxAdvertisedBandwidth** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: + If set, we will not advertise more than this amount of bandwidth for our + BandwidthRate. Server operators who want to reduce the number of clients + who ask to build circuits through them (since this is proportional to + advertised bandwidth rate) can thus reduce the CPU demands on their server + without impacting network performance. [[MaxUnparseableDescSizeToLog]] **MaxUnparseableDescSizeToLog** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**:: Unparseable descriptors (e.g. for votes, consensuses, routers) are logged @@ -751,6 +723,12 @@ GENERAL OPTIONS total; this is intended to be used to debug problems without opening live servers to resource exhaustion attacks. (Default: 10 MBytes) +[[NoExec]] **NoExec** **0**|**1**:: + If this option is set to 1, then Tor will never launch another + executable, regardless of the settings of ClientTransportPlugin + or ServerTransportPlugin. Once this option has been set to 1, + it cannot be set back to 0 without restarting Tor. (Default: 0) + [[OutboundBindAddress]] **OutboundBindAddress** __IP__:: Make all outbound connections originate from the IP address specified. This is only useful when you have multiple network interfaces, and you want all @@ -760,6 +738,15 @@ GENERAL OPTIONS This setting will be ignored for connections to the loopback addresses (127.0.0.0/8 and ::1), and is not used for DNS requests as well. +[[OutboundBindAddressExit]] **OutboundBindAddressExit** __IP__:: + Make all outbound exit connections originate from the IP address + specified. This option overrides **OutboundBindAddress** for the + same IP version. This option may be used twice, once with an IPv4 + address and once with an IPv6 address. + IPv6 addresses should be wrapped in square brackets. + This setting will be ignored + for connections to the loopback addresses (127.0.0.0/8 and ::1). + [[OutboundBindAddressOR]] **OutboundBindAddressOR** __IP__:: Make all outbound non-exit (relay and other) connections originate from the IP address specified. This option overrides @@ -769,14 +756,15 @@ GENERAL OPTIONS This setting will be ignored for connections to the loopback addresses (127.0.0.0/8 and ::1). -[[OutboundBindAddressExit]] **OutboundBindAddressExit** __IP__:: - Make all outbound exit connections originate from the IP address - specified. This option overrides **OutboundBindAddress** for the - same IP version. This option may be used twice, once with an IPv4 - address and once with an IPv6 address. - IPv6 addresses should be wrapped in square brackets. - This setting will be ignored - for connections to the loopback addresses (127.0.0.0/8 and ::1). +[[PerConnBWBurst]] **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: + If this option is set manually, or via the "perconnbwburst" consensus + field, Tor will use it for separate rate limiting for each connection + from a non-relay. (Default: 0) + +[[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: + If this option is set manually, or via the "perconnbwrate" consensus + field, Tor will use it for separate rate limiting for each connection + from a non-relay. (Default: 0) [[PidFile]] **PidFile** __FILE__:: On startup, write our PID to FILE. On clean shutdown, remove @@ -787,34 +775,27 @@ GENERAL OPTIONS following the Tor specification. Otherwise, they are logged with severity \'info'. (Default: 0) +[[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: + If not 0, limit the maximum token bucket size (also known as the burst) for + \_relayed traffic_ to the given number of bytes in each direction. + They do not include directory fetches by the relay (from authority + or other relays), because that is considered "client" activity. (Default: 0) + +[[RelayBandwidthRate]] **RelayBandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**:: + If not 0, a separate token bucket limits the average incoming bandwidth + usage for \_relayed traffic_ on this node to the specified number of bytes + per second, and the average outgoing bandwidth usage to that same value. + Relayed traffic currently is calculated to include answers to directory + requests, but that may change in future versions. They do not include directory + fetches by the relay (from authority or other relays), because that is considered + "client" activity. (Default: 0) + [[RunAsDaemon]] **RunAsDaemon** **0**|**1**:: If 1, Tor forks and daemonizes to the background. This option has no effect on Windows; instead you should use the --service command-line option. Can not be changed while tor is running. (Default: 0) -[[LogTimeGranularity]] **LogTimeGranularity** __NUM__:: - Set the resolution of timestamps in Tor's logs to NUM milliseconds. - NUM must be positive and either a divisor or a multiple of 1 second. - Note that this option only controls the granularity written by Tor to - a file or console log. Tor does not (for example) "batch up" log - messages to affect times logged by a controller, times attached to - syslog messages, or the mtime fields on log files. (Default: 1 second) - -[[TruncateLogFile]] **TruncateLogFile** **0**|**1**:: - If 1, Tor will overwrite logs at startup and in response to a HUP signal, - instead of appending to them. (Default: 0) - -[[SyslogIdentityTag]] **SyslogIdentityTag** __tag__:: - When logging to syslog, adds a tag to the syslog identity such that - log entries are marked with "Tor-__tag__". Can not be changed while tor is - running. (Default: none) - -[[AndroidIdentityTag]] **AndroidIdentityTag** __tag__:: - When logging to Android's logging subsystem, adds a tag to the log identity - such that log entries are marked with "Tor-__tag__". Can not be changed while - tor is running. (Default: none) - [[SafeLogging]] **SafeLogging** **0**|**1**|**relay**:: Tor can scrub potentially sensitive strings from log messages (e.g. addresses) by replacing them with the string [scrubbed]. This way logs can @@ -828,70 +809,32 @@ GENERAL OPTIONS Note: Tor may not heed this option when logging at log levels below Notice. (Default: 1) -[[User]] **User** __Username__:: - On startup, setuid to this user and setgid to their primary group. - Can not be changed while tor is running. - -[[KeepBindCapabilities]] **KeepBindCapabilities** **0**|**1**|**auto**:: - On Linux, when we are started as root and we switch our identity using - the **User** option, the **KeepBindCapabilities** option tells us whether to - try to retain our ability to bind to low ports. If this value is 1, we - try to keep the capability; if it is 0 we do not; and if it is **auto**, - we keep the capability only if we are configured to listen on a low port. - Can not be changed while tor is running. - (Default: auto.) - -[[HardwareAccel]] **HardwareAccel** **0**|**1**:: - If non-zero, try to use built-in (static) crypto hardware acceleration when - available. Can not be changed while tor is running. (Default: 0) - -[[AccelName]] **AccelName** __NAME__:: - When using OpenSSL hardware crypto acceleration attempt to load the dynamic - engine of this name. This must be used for any dynamic hardware engine. - Names can be verified with the openssl engine command. Can not be changed - while tor is running. +[[Sandbox]] **Sandbox** **0**|**1**:: + If set to 1, Tor will run securely through the use of a syscall sandbox. + Otherwise the sandbox will be disabled. The option is currently an + experimental feature. It only works on Linux-based operating systems, + and only when Tor has been built with the libseccomp library. This option + can not be changed while tor is running. + + - If the engine name is prefixed with a "!", then Tor will exit if the - engine cannot be loaded. - -[[AccelDir]] **AccelDir** __DIR__:: - Specify this option if using dynamic hardware acceleration and the engine - implementation library resides somewhere other than the OpenSSL default. - Can not be changed while tor is running. - -[[AvoidDiskWrites]] **AvoidDiskWrites** **0**|**1**:: - If non-zero, try to write to disk less frequently than we would otherwise. - This is useful when running on flash memory or other media that support - only a limited number of writes. (Default: 0) - -[[CircuitPriorityHalflife]] **CircuitPriorityHalflife** __NUM__:: - If this value is set, we override the default algorithm for choosing which - circuit's cell to deliver or relay next. It is delivered first to the - circuit that has the lowest weighted cell count, where cells are weighted - exponentially according to this value (in seconds). If the value is -1, it - is taken from the consensus if possible else it will fallback to the - default value of 30. Minimum: 1, Maximum: 2147483647. This can be defined - as a float value. This is an advanced option; you generally shouldn't have - to mess with it. (Default: -1) - -[[CountPrivateBandwidth]] **CountPrivateBandwidth** **0**|**1**:: - If this option is set, then Tor's rate-limiting applies not only to - remote connections, but also to connections to private addresses like - 127.0.0.1 or 10.0.0.1. This is mostly useful for debugging - rate-limiting. (Default: 0) - -[[ExtendByEd25519ID]] **ExtendByEd25519ID** **0**|**1**|**auto**:: - If this option is set to 1, we always try to include a relay's Ed25519 ID - when telling the proceeding relay in a circuit to extend to it. - If this option is set to 0, we never include Ed25519 IDs when extending - circuits. If the option is set to "default", we obey a - parameter in the consensus document. (Default: auto) - -[[NoExec]] **NoExec** **0**|**1**:: - If this option is set to 1, then Tor will never launch another - executable, regardless of the settings of ClientTransportPlugin - or ServerTransportPlugin. Once this option has been set to 1, - it cannot be set back to 0 without restarting Tor. (Default: 0) + When the **Sandbox** is 1, the following options can not be changed when tor + is running: + **Address**, + **ConnLimit**, + **CookieAuthFile**, + **DirPortFrontPage**, + **ExtORPortCookieAuthFile**, + **Logs**, + **ServerDNSResolvConfFile**, + **ClientOnionAuthDir** (and any files in it won't reload on HUP signal). + + + Launching new Onion Services through the control port is not supported + with current syscall sandboxing implementation. + + + Tor must remain in client or server mode (some changes to **ClientOnly** + and **ORPort** are not allowed). Currently, if **Sandbox** is 1, + **ControlPort** command "GETINFO address" will not work. + + + (Default: 0) [[Schedulers]] **Schedulers** **KIST**|**KISTLite**|**Vanilla**:: Specify the scheduler type that tor should use. The scheduler is @@ -931,6 +874,61 @@ GENERAL OPTIONS If KIST is used in Schedulers, this is a multiplier of the per-socket limit calculation of the KIST algorithm. (Default: 1.0) + +[[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__:: + When this option is set, Tor will suggest __IP__:__PORT__ as the + listening address of any pluggable transport proxy that tries to + launch __transport__. (IPv4 addresses should written as-is; IPv6 + addresses should be wrapped in square brackets.) (Default: none) + +[[ServerTransportOptions]] **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...:: + When this option is set, Tor will pass the __k=v__ parameters to + any pluggable transport proxy that tries to launch __transport__. + + (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache) (Default: none) + +[[ServerTransportPlugin]] **ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]:: + The Tor relay launches the pluggable transport proxy in __path-to-binary__ + using __options__ as its command-line options, and expects to receive + proxied client traffic from it. (Default: none) + +[[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]:: + Tor will make all OR connections through the SOCKS 4 proxy at host:port + (or host:1080 if port is not specified). + +[[Socks5Proxy]] **Socks5Proxy** __host__[:__port__]:: + Tor will make all OR connections through the SOCKS 5 proxy at host:port + (or host:1080 if port is not specified). + +[[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ + + +[[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__:: + If defined, authenticate to the SOCKS 5 server using username and password + in accordance to RFC 1929. Both username and password must be between 1 and + 255 characters. + +[[SyslogIdentityTag]] **SyslogIdentityTag** __tag__:: + When logging to syslog, adds a tag to the syslog identity such that + log entries are marked with "Tor-__tag__". Can not be changed while tor is + running. (Default: none) + +[[TruncateLogFile]] **TruncateLogFile** **0**|**1**:: + If 1, Tor will overwrite logs at startup and in response to a HUP signal, + instead of appending to them. (Default: 0) + +[[UnixSocksGroupWritable]] **UnixSocksGroupWritable** **0**|**1**:: + If this option is set to 0, don't allow the filesystem group to read and + write unix sockets (e.g. SocksPort unix:). If the option is set to 1, make + the Unix socket readable and writable by the default GID. (Default: 0) + +[[UseDefaultFallbackDirs]] **UseDefaultFallbackDirs** **0**|**1**:: + Use Tor's default hard-coded FallbackDirs (if any). (When a + FallbackDir line is present, it replaces the hard-coded FallbackDirs, + regardless of the value of UseDefaultFallbackDirs.) (Default: 1) + +[[User]] **User** __Username__:: + On startup, setuid to this user and setgid to their primary group. + Can not be changed while tor is running. + CLIENT OPTIONS --------------

1 0

[tor/master] manpage: indent linebreak markup
by teor＠torproject.org 16 Dec '19

16 Dec '19

commit 8dff1d342d1f991cab3eab62e445599b0442b259 Author: Taylor Yu <catalyst(a)torproject.org> Date: Wed Dec 11 09:27:51 2019 -0600 manpage: indent linebreak markup Indent the asciidoc markup for lone linebreaks to match the preceding paragraph line, so that Asciidoctor tools can format them correctly. Part of ticket 32708. --- doc/tor.1.txt | 244 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 122 insertions(+), 122 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index bcc78f765..b867409cd 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -147,7 +147,7 @@ The following options in this section are only recognized on the can encrypt the master identity key with a passphrase. When Tor asks you for a passphrase and you don't want to encrypt the master key, just don't enter any passphrase when asked. + - + + + Use the **`--newpass`** option with **`--keygen`** only when you need to add, change, or remove a passphrase on an existing ed25519 master identity key. You will be prompted for the old passphase @@ -178,7 +178,7 @@ The following options in this section are only recognized on the The __purpose__ specifies which type of key certificate to determine the expiration of. The only currently recognised __purpose__ is "sign". + - + + + Running **`tor --key-expiration sign`** will attempt to find your signing key certificate and will output, both in the logs as well as to stdout, the signing key certificate's expiration time in @@ -237,7 +237,7 @@ GENERAL OPTIONS engine of this name. This must be used for any dynamic hardware engine. Names can be verified with the openssl engine command. Can not be changed while tor is running. + - + + + If the engine name is prefixed with a "!", then Tor will exit if the engine cannot be loaded. @@ -273,13 +273,13 @@ GENERAL OPTIONS relay (that is, 600 kbits) or 50 KBytes for a bridge (400 kbits) -- but of course, more is better; we recommend at least 250 KBytes (2 mbits) if possible. (Default: 1 GByte) + - + + + Note that this option, and other bandwidth-limiting options, apply to TCP data only: They do not count TCP headers or DNS traffic. + - + + + Tor uses powers of two, not powers of ten, so 1 GByte is 1024*1024*1024 bytes as opposed to 1 billion bytes. + - + + + With this option, and in other options that take arguments in bytes, KBytes, and so on, other formats are also supported. Notably, "KBytes" can also be written as "kilobytes" or "kb"; "MBytes" can be written as @@ -320,7 +320,7 @@ GENERAL OPTIONS (IPv4 addresses should written as-is; IPv6 addresses should be wrapped in square brackets.) It's the duty of that proxy to properly forward the traffic to the bridge. + - + + + In its second form, when set along with a corresponding Bridge line, the Tor client launches the pluggable transport proxy executable in __path-to-binary__ using __options__ as its command-line options, and @@ -332,13 +332,13 @@ GENERAL OPTIONS process before it will start. Tor will ask the OS for as many file descriptors as the OS will allow (you can find this by "ulimit -H -n"). If this number is less than ConnLimit, then Tor will refuse to start. + - + + + Tor relays need thousands of sockets, to connect to every other relay. If you are running a private bridge, you can reduce the number of sockets that Tor uses. For example, to limit Tor to 500 sockets, run "ulimit -n 500" in a shell. Then start tor in the same shell, with **ConnLimit 500**. You may also need to set **DisableOOSCheck 0**. + - + + + Unless you have severely limited sockets, you probably don't need to adjust **ConnLimit** itself. It has no effect on Windows, since that platform lacks getrlimit(). (Default: 1000) @@ -350,15 +350,15 @@ GENERAL OPTIONS be limited. If you're on a virtual server, and you encounter the "Error creating network socket: No buffer space available" message, you are likely experiencing this problem. + - + + + The preferred solution is to have the admin increase the buffer pool for the host itself via /proc/sys/net/ipv4/tcp_mem or equivalent facility; this configuration option is a second-resort. + - + + + The DirPort option should also not be used if TCP buffers are scarce. The cached directory requests consume additional sockets which exacerbates the problem. + - + + + You should **not** enable this feature unless you encounter the "no buffer space available" issue. Reducing the TCP buffers affects window size for the TCP stream and will reduce throughput in proportion to round trip @@ -383,7 +383,7 @@ GENERAL OPTIONS C escape sequences. You can specify this directive multiple times, to bind to multiple address/port pairs. Set it to "auto" to have Tor pick a port for you. (Default: 0) + - + + + Recognized flags are: **GroupWritable**;; Unix domain sockets only: makes the socket get created as @@ -456,7 +456,7 @@ GENERAL OPTIONS separated by spaces, and determine what kind of an authority this directory is. By default, an authority is not authoritative for any directory style or version unless an appropriate flag is given. + - + + + Tor will use this authority as a bridge authoritative directory if the "bridge" flag is set. If a flag "orport=**orport**" is given, Tor will use the given port when opening encrypted tunnels to the dirserver. If a @@ -467,13 +467,13 @@ GENERAL OPTIONS if an "ipv6=**[**__ipv6address__**]**:__orport__" flag is present, then the directory authority is listening for IPv6 connections on the indicated IPv6 address and OR Port. + - + + + Tor will contact the authority at __ipv4address__ to download directory documents. Clients always use the ORPort. Relays usually use the DirPort, but will use the ORPort in some circumstances. If an IPv6 ORPort is supplied, clients will also download directory documents at the IPv6 ORPort, if they are configured to use IPv6. + - + + + If no **DirAuthority** line is given, Tor will use the default directory authorities. NOTE: this option is intended for setting up a private Tor network with its own directory authorities. If you use it, you will be @@ -552,10 +552,10 @@ GENERAL OPTIONS startup if a hard-coded directory is down. Clients wait for a few seconds between each attempt, and retry FallbackDirs more often than directory authorities, to reduce the load on the directory authorities. + - + + + FallbackDirs should be stable relays with stable IP addresses, ports, and identity keys. They must have a DirPort. + - + + + By default, the directory authorities are also FallbackDirs. Specifying a FallbackDir replaces Tor's default hard-coded FallbackDirs (if any). (See the **DirAuthority** entry for an explanation of each flag.) @@ -660,7 +660,7 @@ GENERAL OPTIONS since anything more verbose may provide sensitive information to an attacker who obtains the logs. If only one severity level is given, all messages of that level or higher will be sent to the listed destination. + - + + + Some low-level logs may be sent from signal handlers, so their destination logs must be signal-safe. These low-level logs include backtraces, logging function errors, and errors in code called by logging functions. @@ -686,16 +686,16 @@ GENERAL OPTIONS list of logging domains. You can prefix a domain with $$~$$ to indicate negation, and use * to indicate "all domains". If you specify a severity range without a list of domains, it matches all domains. + - + + + This is an advanced feature which is most useful for debugging one or two of Tor's subsystems at a time. + - + + + The currently recognized domains are: general, crypto, net, config, fs, protocol, mm, http, app, control, circ, rend, bug, dir, dirserv, or, edge, acct, hist, handshake, heartbeat, channel, sched, guard, consdiff, dos, process, pt, btrack, and mesg. Domain names are case-insensitive. + - + + + For example, "`Log [handshake]debug [~net,~mm]info notice stdout`" sends to stdout: all handshake messages of any severity, all info-and-higher messages from domains other than networking and memory management, and all @@ -801,7 +801,7 @@ GENERAL OPTIONS addresses) by replacing them with the string [scrubbed]. This way logs can still be useful, but they don't leave behind personally identifying information about what sites a user might have visited. + - + + + If this option is set to 0, Tor will not perform any scrubbing, if it is set to 1, all potentially sensitive strings are replaced. If it is set to relay, all log messages generated when acting as a relay are sanitized, but @@ -815,7 +815,7 @@ GENERAL OPTIONS experimental feature. It only works on Linux-based operating systems, and only when Tor has been built with the libseccomp library. This option can not be changed while tor is running. + - + + + When the **Sandbox** is 1, the following options can not be changed when tor is running: **Address**, @@ -826,14 +826,14 @@ GENERAL OPTIONS **Logs**, **ServerDNSResolvConfFile**, **ClientOnionAuthDir** (and any files in it won't reload on HUP signal). + - + + + Launching new Onion Services through the control port is not supported with current syscall sandboxing implementation. + - + + + Tor must remain in client or server mode (some changes to **ClientOnly** and **ORPort** are not allowed). Currently, if **Sandbox** is 1, **ControlPort** command "GETINFO address" will not work. + - + + + (Default: 0) [[Schedulers]] **Schedulers** **KIST**|**KISTLite**|**Vanilla**:: @@ -844,22 +844,22 @@ GENERAL OPTIONS these values at runtime. This option mostly effects relays, and most operators should leave it set to its default value. (Default: KIST,KISTLite,Vanilla) + - + + + The possible scheduler types are: - + + + **KIST**: Kernel-Informed Socket Transport. Tor will use TCP information from the kernel to make informed decisions regarding how much data to send and when to send it. KIST also handles traffic in batches (see KISTSchedRunInterval) in order to improve traffic prioritization decisions. As implemented, KIST will only work on Linux kernel version 2.6.39 or higher. + - + + + **KISTLite**: Same as KIST but without kernel support. Tor will use all the same mechanics as with KIST, including the batching, but its decisions regarding how much data to send will not be as good. KISTLite will work on all kernels and operating systems, and the majority of the benefits of KIST are still realized with KISTLite. + - + + + **Vanilla**: The scheduler that Tor used before KIST was implemented. It sends as much data as possible, as soon as possible. Vanilla will work on all kernels and operating systems. @@ -943,14 +943,14 @@ The following options are useful only for clients (that is, if the relay running at that location has the right fingerprint. We also use fingerprint to look up the bridge descriptor at the bridge authority, if it's provided and if UpdateBridgesFromAuthority is set too. + - + + + If "transport" is provided, it must match a ClientTransportPlugin line. We then use that pluggable transport's proxy to transfer data to the bridge, rather than connecting to the bridge directly. Some transports use a transport-specific method to work out the remote address to connect to. These transports typically ignore the "IP:ORPort" specified in the bridge line. + - + + + Tor passes any "key=val" settings to the pluggable transport proxy as per-connection arguments when connecting to the bridge. Consult the documentation of the pluggable transport for details of what @@ -1029,19 +1029,19 @@ The following options are useful only for clients (that is, if be wrapped in braces; fingerprints may be preceded by a dollar sign. (Example: ExcludeNodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) + - + + + By default, this option is treated as a preference that Tor is allowed to override in order to keep working. For example, if you try to connect to a hidden service, but you have excluded all of the hidden service's introduction points, Tor will connect to one of them anyway. If you do not want this behavior, set the StrictNodes option (documented below). + - + + + Note also that if you are a relay, this (and the other node selection options below) only affects your own circuits that Tor builds for you. Clients can still build circuits through you to any node. Controllers can tell Tor to build circuits through any node. + - + + + Country codes are case-insensitive. The code "\{??}" refers to nodes whose country can't be identified. No country code, including \{??}, works if no GeoIPFile can be loaded. See also the GeoIPExcludeUnknown option below. @@ -1069,22 +1069,22 @@ The following options are useful only for clients (that is, if patterns of nodes to use as exit node---that is, a node that delivers traffic for you *outside* the Tor network. See the **ExcludeNodes** option for more information on how to specify nodes. + - + + + Note that if you list too few nodes here, or if you exclude too many exit nodes with ExcludeExitNodes, you can degrade functionality. For example, if none of the exits you list allows traffic on port 80 or 443, you won't be able to browse the web. + - + + + Note also that not every circuit is used to deliver traffic *outside* of the Tor network. It is normal to see non-exit circuits (such as those used to connect to hidden services, those that do directory fetches, those used for relay reachability self-tests, and so on) that end at a non-exit node. To keep a node from being used entirely, see ExcludeNodes and StrictNodes. + - + + + The ExcludeNodes option overrides this option: any node listed in both ExitNodes and ExcludeNodes is treated as excluded. + - + + + The .exit address notation, if enabled via MapAddress, overrides this option. @@ -1115,7 +1115,7 @@ The following options are useful only for clients (that is, if circuits except for direct connections to directory servers. The Bridge option overrides this option; if you have configured bridges and UseBridges is 1, the Bridges are used as your entry nodes. + - + + + The ExcludeNodes option overrides this option: any node listed in both EntryNodes and ExcludeNodes is treated as excluded. See the **ExcludeNodes** option for more information on how to specify nodes. @@ -1168,7 +1168,7 @@ The following options are useful only for clients (that is, if these restrictions when connecting to Onion Routers, using TLS/SSL. If not set explicitly then the value of **ReachableAddresses** is used. If **HTTPSProxy** is set then these connections will go through that proxy. + - + + + The separation between **ReachableORAddresses** and **ReachableDirAddresses** is only interesting when you are connecting through proxies (see **HTTPProxy** and **HTTPSProxy**). Most proxies limit @@ -1190,9 +1190,9 @@ The following options are useful only for clients (that is, if Path to the directory containing v3 hidden service authorization files. Each file is for a single onion address, and the files MUST have the suffix ".auth_private" (i.e. "bob_onion.auth_private"). The content format MUST be: - + + + <onion-address>:descriptor:x25519:<base32-encoded-privkey> - + + + The <onion-address> MUST NOT have the ".onion" suffix. The <base32-encoded-privkey> is the base32 representation of the raw key bytes only (32 bytes for x25519). See Appendix G in the rend-spec-v3.txt file of @@ -1223,7 +1223,7 @@ The following options are useful only for clients (that is, if *.example.com www.example.com". If the specified exit is not available, or the exit can not connect to the site, Tor will fail any connections to the mapped address.+ - + + + NOTES: 1. When evaluating MapAddress expressions Tor stops when it hits the most @@ -1300,14 +1300,14 @@ The following options are useful only for clients (that is, if to multiple addresses/ports. If a unix domain socket is used, you may quote the path using standard C escape sequences. (Default: 9050) + - + + + NOTE: Although this option allows you to specify an IP address other than localhost, you should do so only with extreme caution. The SOCKS protocol is unencrypted and (as we use it) unauthenticated, so exposing it in this way could leak your information to anybody watching your network, and allow anybody to use your computer as an open proxy. + - + + + If multiple entries of this option are present in your configuration file, Tor will perform stream isolation between listeners by default. The _isolation flags_ arguments give Tor rules for which streams @@ -1572,7 +1572,7 @@ The following options are useful only for clients (that is, if command from the controller or the AutomapHostsOnResolve feature, Tor picks an unassigned address from this range. (Defaults: 127.192.0.0/10 and [FE80::]/10 respectively.) + - + + + When providing proxy server service to a network of computers using a tool like dns-proxy-tor, change the IPv4 network to "10.192.0.0/10" or "172.16.0.0/12" and change the IPv6 network to "[FC00::]/7". @@ -1608,7 +1608,7 @@ The following options are useful only for clients (that is, if entries of this option are present in your configuration file, Tor will perform stream isolation between listeners by default. See SOCKSPort for an explanation of isolation flags. + - + + + TransPort requires OS support for transparent proxies, such as BSDs' pf or Linux's IPTables. If you're planning to use Tor as a transparent proxy for a network, you'll want to examine and change VirtualAddrNetwork from the @@ -1617,25 +1617,25 @@ The following options are useful only for clients (that is, if [[TransProxyType]] **TransProxyType** **default**|**TPROXY**|**ipfw**|**pf-divert**:: TransProxyType may only be enabled when there is transparent proxy listener enabled. + - + + + Set this to "TPROXY" if you wish to be able to use the TPROXY Linux module to transparently proxy connections that are configured using the TransPort option. Detailed information on how to configure the TPROXY feature can be found in the Linux kernel source tree in the file Documentation/networking/tproxy.txt. + - + + + Set this option to "ipfw" to use the FreeBSD ipfw interface. + - + + + On *BSD operating systems when using pf, set this to "pf-divert" to take advantage of +divert-to+ rules, which do not modify the packets like +rdr-to+ rules do. Detailed information on how to configure pf to use +divert-to+ rules can be found in the pf.conf(5) manual page. On OpenBSD, +divert-to+ is available to use on versions greater than or equal to OpenBSD 4.4. + - + + + Set this to "default", or leave it unconfigured, to use regular IPTables on Linux, or to use pf +rdr-to+ rules on *BSD systems. + - + + + (Default: "default") [[NATDPort]] **NATDPort** \['address':]__port__|**auto** [_isolation flags_]:: @@ -1647,7 +1647,7 @@ The following options are useful only for clients (that is, if entries of this option are present in your configuration file, Tor will perform stream isolation between listeners by default. See SocksPort for an explanation of isolation flags. + - + + + This option is only for people who cannot use TransPort. (Default: 0) [[AutomapHostsOnResolve]] **AutomapHostsOnResolve** **0**|**1**:: @@ -1716,39 +1716,39 @@ The following options are useful only for clients (that is, if and induces your client or service to create many circuits, in order to discover your primary guard node. (Default: Any node in the network may be used in the second hop.) - + + + (Example: HSLayer2Nodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) + - + + + When this is set, the resulting hidden service paths will look like: - + + + C - G - L2 - M - Rend + C - G - L2 - M - HSDir + C - G - L2 - M - Intro + S - G - L2 - M - Rend + S - G - L2 - M - HSDir + S - G - L2 - M - Intro + - + + + where C is this client, S is the service, G is the Guard node, L2 is a node from this option, and M is a random middle node. Rend, HSDir, and Intro point selection is not affected by this option. - + + + This option may be combined with HSLayer3Nodes to create paths of the form: - + + + C - G - L2 - L3 - Rend + C - G - L2 - L3 - M - HSDir + C - G - L2 - L3 - M - Intro + S - G - L2 - L3 - M - Rend + S - G - L2 - L3 - HSDir + S - G - L2 - L3 - Intro + - + + + ExcludeNodes have higher priority than HSLayer2Nodes, which means that nodes specified in ExcludeNodes will not be picked. - + + + When either this option or HSLayer3Nodes are set, the /16 subnet and node family restrictions are removed for hidden service circuits. Additionally, we allow the guard node to be present @@ -1756,7 +1756,7 @@ The following options are useful only for clients (that is, if is done to prevent the adversary from inferring information about our guard, layer2, and layer3 node choices at later points in the path. - + + + This option is meant to be managed by a Tor controller such as https://github.com/mikeperry-tor/vanguards that selects and updates this set of nodes for you. Hence it does not do load @@ -1772,10 +1772,10 @@ The following options are useful only for clients (that is, if and induces your client or service to create many circuits, in order to discover your primary or Layer2 guard nodes. (Default: Any node in the network may be used in the third hop.) - + + + (Example: HSLayer3Nodes ABCD1234CDEF5678ABCD1234CDEF5678ABCD1234, \{cc}, 255.254.0.0/8) + - + + + When this is set by itself, the resulting hidden service paths will look like: + C - G - M - L3 - Rend + @@ -1788,21 +1788,21 @@ The following options are useful only for clients (that is, if L2 is a node from this option, and M is a random middle node. Rend, HSDir, and Intro point selection is not affected by this option. - + + + While it is possible to use this option by itself, it should be combined with HSLayer2Nodes to create paths of the form: - + + + C - G - L2 - L3 - Rend + C - G - L2 - L3 - M - HSDir + C - G - L2 - L3 - M - Intro + S - G - L2 - L3 - M - Rend + S - G - L2 - L3 - HSDir + S - G - L2 - L3 - Intro + - + + + ExcludeNodes have higher priority than HSLayer3Nodes, which means that nodes specified in ExcludeNodes will not be picked. - + + + When either this option or HSLayer2Nodes are set, the /16 subnet and node family restrictions are removed for hidden service circuits. Additionally, we allow the guard node to be present @@ -1841,18 +1841,18 @@ The following options are useful only for clients (that is, if experimental**) path bias detection algorithm. To try to find broken or misbehaving guard nodes, Tor looks for nodes where more than a certain fraction of circuits through that guard fail to get built. + - + + + The PathBiasCircThreshold option controls how many circuits we need to build through a guard before we make these checks. The PathBiasNoticeRate, PathBiasWarnRate and PathBiasExtremeRate options control what fraction of circuits must succeed through a guard so we won't write log messages. If less than PathBiasExtremeRate circuits succeed *and* PathBiasDropGuards is set to 1, we disable use of that guard. + - + + + When we have seen more than PathBiasScaleThreshold circuits through a guard, we scale our observations by 0.5 (governed by the consensus) so that new observations don't get swamped by old ones. + - + + + By default, or if a negative value is provided for one of these options, Tor uses reasonable defaults from the networkstatus consensus document. If no defaults are available there, these options default to 150, .70, @@ -1867,14 +1867,14 @@ The following options are useful only for clients (that is, if [[PathBiasScaleUseThreshold]] **PathBiasScaleUseThreshold** __NUM__:: Similar to the above options, these options override the default behavior of Tor's (**currently experimental**) path use bias detection algorithm. + - + + + Where as the path bias parameters govern thresholds for successfully building circuits, these four path use bias parameters govern thresholds only for circuit usage. Circuits which receive no stream usage are not counted by this detection algorithm. A used circuit is considered successful if it is capable of carrying streams or otherwise receiving well-formed responses to RELAY cells. + - + + + By default, or if a negative value is provided for one of these options, Tor uses reasonable defaults from the networkstatus consensus document. If no defaults are available there, these options default to 20, .80, @@ -1975,7 +1975,7 @@ The following options are useful only for clients (that is, if a request. (This mode is recommended if installing a Tor client for a user who might not actually use it.) If false, Tor bootstraps the first time it is started, whether it sees a user request or not. - + + + After the first time Tor starts, it begins in dormant mode if it was dormant before, and not otherwise. (Default: 0) @@ -1985,7 +1985,7 @@ The following options are useful only for clients (that is, if this option is true, Tor treats every startup event as user activity, and Tor will never start in Dormant mode, even if it has been unused for a long time on previous runs. (Default: 0) - + + + Note: Packagers and application developers should change the value of this option only with great caution: it has the potential to create spurious traffic on the network. This option should only @@ -2021,7 +2021,7 @@ is non-zero): from bridge users to the Tor network. It mainly causes Tor to publish a server descriptor to the bridge database, rather than to the public directory authorities. + - + + + Note: make sure that no MyFamily lines are present in your torrc when relay is configured in bridge mode. @@ -2040,7 +2040,7 @@ is non-zero): spammers might also collect them. You may want to obscure the fact that it's an email address and/or generate a new address for this purpose. + - + + + ContactInfo **must** be set to a working address if you run more than one relay or bridge. (Really, everybody running a relay or bridge should set it.) @@ -2051,10 +2051,10 @@ is non-zero): non-bridge server, and ExitRelay is set to 1, then Tor allows traffic to exit according to the ExitPolicy option, the ReducedExitPolicy option, or the default ExitPolicy (if no other exit policy option is specified). + - + + + If ExitRelay is set to 0, no traffic is allowed to exit, and the ExitPolicy, ReducedExitPolicy, and IPv6Exit options are ignored. + - + + + If ExitRelay is set to "auto", then Tor checks the ExitPolicy, ReducedExitPolicy, and IPv6Exit options. If at least one of these options is set, Tor behaves as if ExitRelay were set to 1. If none of these exit @@ -2071,29 +2071,29 @@ is non-zero): __PORT__ can be a single port number, an interval of ports "__FROM_PORT__-__TO_PORT__", or "\*". If __PORT__ is omitted, that means "\*". + - + + + For example, "accept 18.7.22.69:\*,reject 18.0.0.0/8:\*,accept \*:\*" would reject any IPv4 traffic destined for MIT except for web.mit.edu, and accept any other IPv4 or IPv6 traffic. + - + + + Tor also allows IPv6 exit policy entries. For instance, "reject6 [FC00::]/7:\*" rejects all destinations that share 7 most significant bit prefix with address FC00::. Respectively, "accept6 [C000::]/3:\*" accepts all destinations that share 3 most significant bit prefix with address C000::. + - + + + accept6 and reject6 only produce IPv6 exit policy entries. Using an IPv4 address with accept6 or reject6 is ignored and generates a warning. accept/reject allows either IPv4 or IPv6 addresses. Use \*4 as an IPv4 wildcard address, and \*6 as an IPv6 wildcard address. accept/reject * expands to matching IPv4 and IPv6 wildcard address rules. + - + + + To specify all IPv4 and IPv6 internal and link-local networks (including 0.0.0.0/8, 169.254.0.0/16, 127.0.0.0/8, 192.168.0.0/16, 10.0.0.0/8, 172.16.0.0/12, [::]/8, [FC00::]/7, [FE80::]/10, [FEC0::]/10, [FF00::]/8, and [::]/127), you can use the "private" alias instead of an address. ("private" always produces rules for IPv4 and IPv6 addresses, even when used with accept6/reject6.) + - + + + Private addresses are rejected by default (at the beginning of your exit policy), along with any configured primary public IPv4 and IPv6 addresses. These private addresses are rejected unless you set the @@ -2105,10 +2105,10 @@ is non-zero): about internal and reserved IP address space. See ExitPolicyRejectLocalInterfaces if you want to block every address on the relay, even those that aren't advertised in the descriptor. + - + + + This directive can be specified multiple times so you don't have to put it all on one line. + - + + + Policies are considered first to last, and the first match wins. If you want to allow the same ports on IPv4 and IPv6, write your rules using accept/reject \*. If you want to allow different ports on IPv4 and IPv6, @@ -2116,13 +2116,13 @@ is non-zero): accept/reject \*4. If you want to \_replace_ the default exit policy, end your exit policy with either a reject \*:* or an accept \*:*. Otherwise, you're \_augmenting_ (prepending to) the default exit policy. + - + + + If you want to use a reduced exit policy rather than the default exit policy, set "ReducedExitPolicy 1". If you want to _replace_ the default exit policy with your custom exit policy, end your exit policy with either a reject *:* or an accept *:*. Otherwise, you're _augmenting_ (prepending to) the default or reduced exit policy. + - + + + The default exit policy is: reject *:25 @@ -2162,13 +2162,13 @@ is non-zero): [[ReducedExitPolicy]] **ReducedExitPolicy** **0**|**1**:: If set, use a reduced exit policy rather than the default one. + - + + + The reduced exit policy is an alternative to the default exit policy. It allows as many Internet services as possible while still blocking the majority of TCP ports. Currently, the policy allows approximately 65 ports. This reduces the odds that your node will be used for peer-to-peer applications. + - + + + The reduced exit policy is: accept *:20-21 @@ -2274,13 +2274,13 @@ is non-zero): relay only needs to list the other servers in its family; it doesn't need to list itself, but it won't hurt if it does.) Do not list any bridge relay as it would compromise its concealment. + - + + + When listing a node, it's better to list it by fingerprint than by nickname: fingerprints are more reliable. + - + + + If you run more than one relay, the MyFamily option on each relay **must** list all other relays, as described above. + - + + + Note: do not use MyFamily when configuring your Tor instance as a brigde. @@ -2300,7 +2300,7 @@ is non-zero): servers. This option is required to be a Tor server. Set it to "auto" to have Tor pick a port for you. Set it to 0 to not run an ORPort at all. This option can occur more than once. (Default: 0) + - + + + Tor recognizes these flags on each ORPort: **NoAdvertise**;; By default, we bind to a port and tell our users about it. If @@ -2328,7 +2328,7 @@ is non-zero): This option specifies which descriptors Tor will publish when acting as a relay. You can choose multiple arguments, separated by commas. + - + + + If this option is set to 0, Tor will not publish its descriptors to any directories. (This is useful if you're testing out your server, or if you're using a Tor controller that handles @@ -2381,7 +2381,7 @@ is non-zero): it provides users with a collection of fast servers that are up some of the time, which is more useful than a set of slow servers that are always "available". + - + + + Note that (as also described in the Bandwidth section) Tor uses powers of two, not powers of ten: 1 GByte is 1024*1024*1024, not one billion. Be careful: some internet service providers might count @@ -2624,7 +2624,7 @@ details.) Set it to "auto" to have Tor pick a port for you. This option can occur more than once, but only one advertised DirPort is supported: all but one DirPort must have the **NoAdvertise** flag set. (Default: 0) + - + + + The same flags are supported here as are supported by ORPort. [[DirPolicy]] **DirPolicy** __policy__,__policy__,__...__:: @@ -2664,14 +2664,14 @@ and are as follows: 1. If a single client address makes too many concurrent connections (this is configurable via DoSConnectionMaxConcurrentCount), hang up on further connections. - + + + 2. If a single client IP address (v4 or v6) makes circuits too quickly (default values are more than 3 per second, with an allowed burst of 90, see DoSCircuitCreationRate and DoSCircuitCreationBurst) while also having too many connections open (default is 3, see DoSCircuitCreationMinConnections), tor will refuse any new circuit (CREATE cells) for the next while (random value between 1 and 2 hours). - + + + 3. If a client asks to establish a rendezvous point to you directly (ex: Tor2Web client), ignore the request. @@ -2729,11 +2729,11 @@ Denial of Service mitigation subsystem described above. This is the type of defense applied to a detected client address. The possible values are: - + + + 1: No defense. - + + + 2: Refuse circuit creation for the DoSCircuitCreationDefenseTimePeriod period of time. - + + + "0" means use the consensus parameter. If not defined in the consensus, the value is 2. (Default: 0) @@ -2765,11 +2765,11 @@ Denial of Service mitigation subsystem described above. This is the type of defense applied to a detected client address for the connection mitigation. The possible values are: - + + + 1: No defense. - + + + 2: Immediately close new connections. - + + + "0" means use the consensus parameter. If not defined in the consensus, the value is 2. (Default: 0) @@ -2855,7 +2855,7 @@ on the public Tor network. Authoritative directories only. A set of address patterns for servers that will be listed as bad exits in any network status document this authority publishes, if **AuthDirListBadExits** is set. + - + + + (The address pattern syntax here and in the options below is the same as for exit policies, except that you don't need to say "accept" or "reject", and ports are not needed.) @@ -3066,25 +3066,25 @@ The next section describes the per service options that can only be set identifier of each inbound client circuit. The only protocol supported right now \'haproxy'. This option is only for v3 services. (Default: none) + - + + + The haproxy option works in the following way: when the feature is enabled, the Tor process will write a header line when a client is connecting to the onion service. The header will look like this: + - + + + "PROXY TCP6 fc00:dead:beef:4dad::ffff:ffff ::1 65535 42\r\n" + - + + + We encode the "global circuit identifier" as the last 32-bits of the first IPv6 address. All other values in the header can safely be ignored. You can compute the global circuit identifier using the following formula given the IPv6 address "fc00:dead:beef:4dad::AABB:CCDD": + - + + + global_circuit_id = (0xAA << 24) + (0xBB << 16) + (0xCC << 8) + 0xDD; + - + + + In the case above, where the last 32-bits are 0xffffffff, the global circuit identifier would be 4294967295. You can use this value together with Tor's control port to terminate particular circuits using their global circuit identifiers. For more information about this see control-spec.txt. + - + + + The HAProxy version 1 protocol is described in detail at https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt @@ -3158,7 +3158,7 @@ The next section describes the per service options that can only be set locatable, but clients remain location-anonymous. However, the fact that a client is accessing a Single Onion rather than a Hidden Service may be statistically distinguishable. + - + + + **WARNING:** Once a hidden service directory has been used by a tor instance in HiddenServiceSingleHopMode, it can **NEVER** be used again for a hidden service. It is best practice to create a new hidden service @@ -3166,7 +3166,7 @@ The next section describes the per service options that can only be set Service. It is not possible to run Single Onion Services and Hidden Services from the same tor instance: they should be run on different servers with different IP addresses. + - + + + HiddenServiceSingleHopMode requires HiddenServiceNonAnonymousMode to be set to 1. Since a Single Onion service is non-anonymous, you can not configure a SOCKSPort on a tor instance that is running in @@ -3344,7 +3344,7 @@ The following options are used for running a testing Tor network. address patterns of nodes to vote Exit for regardless of their uptime, bandwidth, or exit policy. See the **ExcludeNodes** option for more information on how to specify nodes. + - + + + In order for this option to have any effect, **TestingTorNetwork** has to be set. See the **ExcludeNodes** option for more information on how to specify nodes. @@ -3353,7 +3353,7 @@ The following options are used for running a testing Tor network. If True (1), a node will never receive the Exit flag unless it is specified in the **TestingDirAuthVoteExit** list, regardless of its uptime, bandwidth, or exit policy. + - + + + In order for this option to have any effect, **TestingTorNetwork** has to be set. @@ -3362,14 +3362,14 @@ The following options are used for running a testing Tor network. address patterns of nodes to vote Guard for regardless of their uptime and bandwidth. See the **ExcludeNodes** option for more information on how to specify nodes. + - + + + In order for this option to have any effect, **TestingTorNetwork** has to be set. [[TestingDirAuthVoteGuardIsStrict]] **TestingDirAuthVoteGuardIsStrict** **0**|**1** :: If True (1), a node will never receive the Guard flag unless it is specified in the **TestingDirAuthVoteGuard** list, regardless of its uptime and bandwidth. + - + + + In order for this option to have any effect, **TestingTorNetwork** has to be set. @@ -3378,14 +3378,14 @@ The following options are used for running a testing Tor network. address patterns of nodes to vote HSDir for regardless of their uptime and DirPort. See the **ExcludeNodes** option for more information on how to specify nodes. + - + + + In order for this option to have any effect, **TestingTorNetwork** must be set. [[TestingDirAuthVoteHSDirIsStrict]] **TestingDirAuthVoteHSDirIsStrict** **0**|**1** :: If True (1), a node will never receive the HSDir flag unless it is specified in the **TestingDirAuthVoteHSDir** list, regardless of its uptime and DirPort. + - + + + In order for this option to have any effect, **TestingTorNetwork** has to be set.

1 0

[tor/master] Merge branch 'pr1590_amended_commit'
by teor＠torproject.org 16 Dec '19

16 Dec '19

commit 11c8c4f23cc25371696030f03144f585f46f886e Merge: e6bffeca6 616c0f823 Author: teor <teor(a)torproject.org> Date: Tue Dec 17 09:49:30 2019 +1000 Merge branch 'pr1590_amended_commit' changes/ticket32708 | 3 + doc/tor.1.txt | 918 ++++++++++++++++++++++++++-------------------------- 2 files changed, 458 insertions(+), 463 deletions(-)

1 0

[tor/master] manpage: fixes to alphabetize General Options
by teor＠torproject.org 16 Dec '19

16 Dec '19

commit 616c0f823c7a65c04de7e03a2c0da1543e2be9e6 Author: Taylor Yu <catalyst(a)torproject.org> Date: Sun Dec 15 22:46:31 2019 -0600 manpage: fixes to alphabetize General Options --- doc/tor.1.txt | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 5469c91b3..aad37204c 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -227,6 +227,9 @@ forward slash (/) in the configuration file and on the command line. == GENERAL OPTIONS +// These options are in alphabetical order, with exceptions as noted. +// Please keep them that way! + [[AccelDir]] **AccelDir** __DIR__:: Specify this option if using dynamic hardware acceleration and the engine implementation library resides somewhere other than the OpenSSL default. @@ -647,10 +650,6 @@ forward slash (/) in the configuration file and on the command line. we keep the capability only if we are configured to listen on a low port. Can not be changed while tor is running. (Default: auto.) -[[LogMessageDomains]] **LogMessageDomains** **0**|**1**:: - If 1, Tor includes message domains with each log message. Every log - message currently has at least one domain; most currently have exactly - one. This doesn't affect controller log messages. (Default: 0) [[Log]] **Log** __minSeverity__[-__maxSeverity__] **stderr**|**stdout**|**syslog**:: Send all messages between __minSeverity__ and __maxSeverity__ to the standard @@ -701,6 +700,11 @@ forward slash (/) in the configuration file and on the command line. messages from domains other than networking and memory management, and all messages of severity notice or higher. +[[LogMessageDomains]] **LogMessageDomains** **0**|**1**:: + If 1, Tor includes message domains with each log message. Every log + message currently has at least one domain; most currently have exactly + one. This doesn't affect controller log messages. (Default: 0) + [[LogTimeGranularity]] **LogTimeGranularity** __NUM__:: Set the resolution of timestamps in Tor's logs to NUM milliseconds. NUM must be positive and either a divisor or a multiple of 1 second. @@ -864,12 +868,14 @@ forward slash (/) in the configuration file and on the command line. sends as much data as possible, as soon as possible. Vanilla will work on all kernels and operating systems. +// Out of order because it logically belongs near the Schedulers option [[KISTSchedRunInterval]] **KISTSchedRunInterval** __NUM__ **msec**:: If KIST or KISTLite is used in the Schedulers option, this controls at which interval the scheduler tick is. If the value is 0 msec, the value is taken from the consensus if possible else it will fallback to the default 10 msec. Maximum possible value is 100 msec. (Default: 0 msec) +// Out of order because it logically belongs near the Schedulers option [[KISTSockBufSizeFactor]] **KISTSockBufSizeFactor** __NUM__:: If KIST is used in Schedulers, this is a multiplier of the per-socket limit calculation of the KIST algorithm. (Default: 1.0) @@ -899,6 +905,7 @@ forward slash (/) in the configuration file and on the command line. Tor will make all OR connections through the SOCKS 5 proxy at host:port (or host:1080 if port is not specified). +// Out of order because Username logically precedes Password [[Socks5ProxyUsername]] **Socks5ProxyUsername** __username__ + [[Socks5ProxyPassword]] **Socks5ProxyPassword** __password__::

1 0