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

[tor/master] Reword FILES section of tor.1.txt
by nickm＠torproject.org 24 Oct '19

24 Oct '19

commit e8fe6bd8d6ddfe5df0cd1a67aa4e7a4bf91976cf Author: Taylor Yu <catalyst(a)torproject.org> Date: Mon Oct 21 15:40:18 2019 -0500 Reword FILES section of tor.1.txt Reword the FILES section of tor.1.txt. Based on a patch by Swati Thacker. Part of #32176. --- doc/tor.1.txt | 181 +++++++++++++++++++++++++++++----------------------------- 1 file changed, 89 insertions(+), 92 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 750c7fbe0..97900dc3f 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -3392,7 +3392,7 @@ FILES ----- **@CONFDIR@/torrc**:: - The configuration file, which contains "option value" pairs. + Default location of the configuration file. **$HOME/.torrc**:: Fallback location for torrc, if @CONFDIR@/torrc is not found. @@ -3402,164 +3402,160 @@ FILES __CacheDirectory__**/cached-certs**:: - This file holds downloaded directory key certificates that are used to - verify authenticity of documents generated by Tor directory authorities. + Contains downloaded directory key certificates that are used to verify + authenticity of documents generated by the Tor directory authorities. __CacheDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**:: The most recent consensus network status document we've downloaded. __CacheDirectory__**/cached-descriptors** and **cached-descriptors.new**:: - These files hold downloaded router statuses. Some routers may appear more - than once; if so, the most recently published descriptor is used. Lines - beginning with @-signs are annotations that contain more information about - a given router. The ".new" file is an append-only journal; when it gets - too large, all entries are merged into a new cached-descriptors file. + These files contain the downloaded router statuses. Some routers may appear + more than once; if so, the most recently published descriptor is + used. Lines beginning with **`@`**-signs are annotations that contain more + information about a given router. The **`.new`** file is an append-only + journal; when it gets too large, all entries are merged into a new + cached-descriptors file. __CacheDirectory__**/cached-extrainfo** and **cached-extrainfo.new**:: - As "cached-descriptors", but holds optionally-downloaded "extra-info" - documents. Relays use these documents to send inessential information - about statistics, bandwidth history, and network health to the - authorities. They aren't fetched by default; see the DownloadExtraInfo - option for more info. + Similar to **cached-descriptors**, but holds optionally-downloaded + "extra-info" documents. Relays use these documents to send inessential + information about statistics, bandwidth history, and network health to the + authorities. They aren't fetched by default. See the DownloadExtraInfo + option for more information. __CacheDirectory__**/cached-microdescs** and **cached-microdescs.new**:: These files hold downloaded microdescriptors. Lines beginning with - @-signs are annotations that contain more information about a given - router. The ".new" file is an append-only journal; when it gets too + **`@`**-signs are annotations that contain more information about a given + router. The **`.new`** file is an append-only journal; when it gets too large, all entries are merged into a new cached-microdescs file. __DataDirectory__**/state**:: - A set of persistent key-value mappings. These are documented in - the file. These include: - - The current entry guards and their status. - - The current bandwidth accounting values. - - When the file was last written - - What version of Tor generated the state file - - A short history of bandwidth usage, as produced in the server - descriptors. + Contains a set of persistent key-value mappings. These include: + - the current entry guards and their status. + - the current bandwidth accounting values. + - when the file was last written + - what version of Tor generated the state file + - a short history of bandwidth usage, as produced in the server + descriptors. __DataDirectory__**/sr-state**:: - Authority only. State file used to record information about the current + _Authority only_. This file is used to record information about the current status of the shared-random-value voting state. __CacheDirectory__**/diff-cache**:: - Directory cache only. Holds older consensuses, and diffs from older - consensuses to the most recent consensus of each type, compressed - in various ways. Each file contains a set of key-value arguments - describing its contents, followed by a single NUL byte, followed by the - main file contents. + _Directory cache only_. Holds older consensuses and diffs from oldest to + the most recent consensus of each type compressed in various ways. Each + file contains a set of key-value arguments describing its contents, + followed by a single NUL byte, followed by the main file contents. __DataDirectory__**/bw_accounting**:: - Used to track bandwidth accounting values (when the current period starts - and ends; how much has been read and written so far this period). This file - is obsolete, and the data is now stored in the \'state' file instead. + This file is obsolete and the data is now stored in the **`state`** file + instead. Used to track bandwidth accounting values (when the current period + starts and ends; how much has been read and written so far this period). __DataDirectory__**/control_auth_cookie**:: - Used for cookie authentication with the controller. Location can be - overridden by the CookieAuthFile config option. Regenerated on startup. See + This file can be used only when cookie authentication is enabled. Used for + cookie authentication with the controller. Location can be overridden by + the `CookieAuthFile` configuration option. Regenerated on startup. See control-spec.txt in https://spec.torproject.org/[torspec] for details. - Only used when cookie authentication is enabled. __DataDirectory__**/lock**:: - This file is used to prevent two Tor instances from using same data - directory. If access to this file is locked, data directory is already - in use by Tor. + This file is used to prevent two Tor instances from using the same data + directory. If access to this file is locked, data directory is already in + use by Tor. __DataDirectory__**/key-pinning-journal**:: Used by authorities. A line-based file that records mappings between - RSA1024 identity keys and Ed25519 identity keys. Authorities enforce - these mappings, so that once a relay has picked an Ed25519 key, stealing - or factoring the RSA1024 key will no longer let an attacker impersonate - the relay. + RSA1024 and Ed25519 identity keys. Authorities enforce these mappings, so + that once a relay has picked an Ed25519 key, stealing or factoring the + RSA1024 key will no longer let an attacker impersonate the relay. __KeyDirectory__**/authority_identity_key**:: A v3 directory authority's master identity key, used to authenticate its signing key. Tor doesn't use this while it's running. The tor-gencert - program uses this. If you're running an authority, you should keep this - key offline, and not actually put it here. + program uses this. If you're running an authority, you should keep this key + offline, and not put it in this file. __KeyDirectory__**/authority_certificate**:: - A v3 directory authority's certificate, which authenticates the authority's - current vote- and consensus-signing key using its master identity key. - Only directory authorities use this file. + Only directory authorities use this file. A v3 directory authority's + certificate which authenticates the authority's current vote- and + consensus-signing key using its master identity key. __KeyDirectory__**/authority_signing_key**:: - A v3 directory authority's signing key, used to sign votes and consensuses. - Only directory authorities use this file. Corresponds to the + Only directory authorities use this file. A v3 directory authority's + signing key that is used to sign votes and consensuses. Corresponds to the **authority_certificate** cert. __KeyDirectory__**/legacy_certificate**:: - As authority_certificate: used only when V3AuthUseLegacyKey is set. - See documentation for V3AuthUseLegacyKey. + As authority_certificate; used only when `V3AuthUseLegacyKey` is set. See + documentation for V3AuthUseLegacyKey. __KeyDirectory__**/legacy_signing_key**:: - As authority_signing_key: used only when V3AuthUseLegacyKey is set. - See documentation for V3AuthUseLegacyKey. + As authority_signing_key: used only when `V3AuthUseLegacyKey` is set. See + documentation for V3AuthUseLegacyKey. __KeyDirectory__**/secret_id_key**:: A relay's RSA1024 permanent identity key, including private and public - components. Used to sign router descriptors, and to sign other keys. + components. Used to sign router descriptors, and to sign other keys. __KeyDirectory__**/ed25519_master_id_public_key**:: The public part of a relay's Ed25519 permanent identity key. __KeyDirectory__**/ed25519_master_id_secret_key**:: - The private part of a relay's Ed25519 permanent identity key. This key - is used to sign the medium-term ed25519 signing key. This file can be - kept offline, or kept encrypted. If so, Tor will not be able to generate - new signing keys itself; you'll need to use tor --keygen yourself to do - so. + The private part of a relay's Ed25519 permanent identity key. This key is + used to sign the medium-term ed25519 signing key. This file can be kept + offline or encrypted. If so, Tor will not be able to generate new signing + keys automatically; you'll need to use `tor --keygen` to do so. __KeyDirectory__**/ed25519_signing_secret_key**:: The private and public components of a relay's medium-term Ed25519 signing - key. This key is authenticated by the Ed25519 master key, in turn + key. This key is authenticated by the Ed25519 master key, which in turn authenticates other keys (and router descriptors). __KeyDirectory__**/ed25519_signing_cert**:: - The certificate which authenticates "ed25519_signing_secret_key" as - having been signed by the Ed25519 master key. + The certificate which authenticates "ed25519_signing_secret_key" as having + been signed by the Ed25519 master key. __KeyDirectory__**/secret_onion_key** and **secret_onion_key.old**:: A relay's RSA1024 short-term onion key. Used to decrypt old-style ("TAP") - circuit extension requests. The ".old" file holds the previously - generated key, which the relay uses to handle any requests that were - made by clients that didn't have the new one. + circuit extension requests. The **`.old`** file holds the previously + generated key, which the relay uses to handle any requests that were made + by clients that didn't have the new one. __KeyDirectory__**/secret_onion_key_ntor** and **secret_onion_key_ntor.old**:: A relay's Curve25519 short-term onion key. Used to handle modern ("ntor") - circuit extension requests. The ".old" file holds the previously - generated key, which the relay uses to handle any requests that were - made by clients that didn't have the new one. + circuit extension requests. The **`.old`** file holds the previously + generated key, which the relay uses to handle any requests that were made + by clients that didn't have the new one. __DataDirectory__**/fingerprint**:: - Only used by servers. Holds the fingerprint of the server's identity key. + Only used by servers. Contains the fingerprint of the server's identity key. __DataDirectory__**/hashed-fingerprint**:: - Only used by bridges. Holds the hashed fingerprint of the bridge's + Only used by bridges. Contains the hashed fingerprint of the bridge's identity key. (That is, the hash of the hash of the identity key.) __DataDirectory__**/approved-routers**:: - Only used by authoritative directory servers. This file lists - the status of routers by their identity fingerprint. - Each line lists a status and a fingerprint separated by - whitespace. See your **fingerprint** file in the __DataDirectory__ for an - example line. If the status is **!reject** then descriptors from the - given identity (fingerprint) are rejected by this server. If it is - **!invalid** then descriptors are accepted but marked in the directory as - not valid, that is, not recommended. + Only used by authoritative directory servers. This file lists the status of + routers by their identity fingerprint. Each line lists a status and a + fingerprint separated by whitespace. See your **`fingerprint`** file in the + __DataDirectory__ for an example line. If the status is **!reject**, then + the descriptors from the given identity (fingerprint) are rejected by this + server. If it is **!invalid**, then the descriptors are accepted but marked + in the directory as not valid, that is, not recommended. __DataDirectory__**/v3-status-votes**:: - Only for v3 authoritative directory servers. This file contains - status votes from all the authoritative directory servers. + Only for v3 authoritative directory servers. This file contains status + votes from all the authoritative directory servers. __CacheDirectory__**/unverified-consensus**:: - This file contains a network consensus document that has been downloaded, - but which we didn't have the right certificates to check yet. + Contains a network consensus document that has been downloaded, but which + we didn't have the right certificates to check yet. __CacheDirectory__**/unverified-microdesc-consensus**:: - This file contains a microdescriptor-flavored network consensus document - that has been downloaded, but which we didn't have the right certificates - to check yet. + Contains a microdescriptor-flavored network consensus document that has + been downloaded, but which we didn't have the right certificates to check + yet. __DataDirectory__**/unparseable-desc**:: Onion server descriptors that Tor was unable to parse are dumped to this @@ -3567,7 +3563,7 @@ __DataDirectory__**/unparseable-desc**:: __DataDirectory__**/router-stability**:: Only used by authoritative directory servers. Tracks measurements for - router mean-time-between-failures so that authorities have a good idea of + router mean-time-between-failures so that authorities have a fair idea of how to set their Stable flags. __DataDirectory__**/stats/dirreq-stats**:: @@ -3608,17 +3604,18 @@ __HiddenServiceDirectory__**/hostname**:: The <base32-encoded-fingerprint>.onion domain name for this hidden service. If the hidden service is restricted to authorized clients only, this file also contains authorization data for all clients. - + - Note that clients will ignore any extra subdomains prepended to a hidden - service hostname. So if you have "xyz.onion" as your hostname, you - can tell clients to connect to "www.xyz.onion" or "irc.xyz.onion" ++ +[NOTE] + The clients will ignore any extra subdomains prepended to a hidden + service hostname. Supposing you have "xyz.onion" as your hostname, you + can ask your clients to connect to "www.xyz.onion" or "irc.xyz.onion" for virtual-hosting purposes. __HiddenServiceDirectory__**/private_key**:: - The private key for this hidden service. + Contains the private key for this hidden service. __HiddenServiceDirectory__**/client_keys**:: - Authorization data for a hidden service that is only accessible by + Contains authorization data for a hidden service that is only accessible by authorized clients. __HiddenServiceDirectory__**/onion_service_non_anonymous**::

1 0

[tor/master] Changes file for ticket 32176
by nickm＠torproject.org 24 Oct '19

24 Oct '19

commit 97e8a050837ba112c8de2669f16dc5a607aae97e Author: Taylor Yu <catalyst(a)torproject.org> Date: Mon Oct 21 16:15:45 2019 -0500 Changes file for ticket 32176 --- changes/ticket32176 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/changes/ticket32176 b/changes/ticket32176 new file mode 100644 index 000000000..ad44d3280 --- /dev/null +++ b/changes/ticket32176 @@ -0,0 +1,4 @@ + o Documentation (manpage): + - In the tor(1) manpage, reword and improve formatting of the + FILES, SEE ALSO, and BUGS sections. Closes ticket 32176. Based + on work by Swati Thacker as part of Google Season of Docs.

1 0

[tor/master] Remove redundant FILES entry in tor.1.txt
by nickm＠torproject.org 24 Oct '19

24 Oct '19

commit a4e83cd5e5f936bad8cec7ea1c88511d5beffc7f Author: Taylor Yu <catalyst(a)torproject.org> Date: Mon Oct 21 15:39:57 2019 -0500 Remove redundant FILES entry in tor.1.txt There was a redundant entry for approved-routers in the FILES section of tor.1.txt. Part of #32176. --- doc/tor.1.txt | 4 ---- 1 file changed, 4 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 06bf022b1..750c7fbe0 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -3604,10 +3604,6 @@ __DataDirectory__**/networkstatus-bridges**:: about bridges that have self-reported themselves to the bridge authority. -__DataDirectory__**/approved-routers**:: - Authorities only. This file is used to configure which relays are - known to be valid, invalid, and so forth. - __HiddenServiceDirectory__**/hostname**:: The <base32-encoded-fingerprint>.onion domain name for this hidden service. If the hidden service is restricted to authorized clients only, this file

1 0

[tor/master] Reformat some file names in tor.1.txt
by nickm＠torproject.org 24 Oct '19

24 Oct '19

commit 8b9b51a6cbb37449c6f32205da40b91fa14219f8 Author: Taylor Yu <catalyst(a)torproject.org> Date: Mon Oct 21 11:44:49 2019 -0500 Reformat some file names in tor.1.txt Reformat file name headings in the FILES section of tor.1.txt to display as fixed-width in the HTML version. Based on a patch by Swati Thacker. Part of #32176. --- doc/tor.1.txt | 95 +++++++++++++++++++++++++++++------------------------------ 1 file changed, 47 insertions(+), 48 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 97900dc3f..63dc9d92a 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -3391,24 +3391,23 @@ Tor catches the following signals: FILES ----- -**@CONFDIR@/torrc**:: +**`@CONFDIR@/torrc`**:: Default location of the configuration file. -**$HOME/.torrc**:: +**`$HOME/.torrc`**:: Fallback location for torrc, if @CONFDIR@/torrc is not found. -**@LOCALSTATEDIR@/lib/tor/**:: +**`@LOCALSTATEDIR@/lib/tor/`**:: The tor process stores keys and other data here. - -__CacheDirectory__**/cached-certs**:: +__CacheDirectory__/**`cached-certs`**:: Contains downloaded directory key certificates that are used to verify authenticity of documents generated by the Tor directory authorities. -__CacheDirectory__**/cached-consensus** and/or **cached-microdesc-consensus**:: +__CacheDirectory__/**`cached-consensus`** and/or **`cached-microdesc-consensus`**:: The most recent consensus network status document we've downloaded. -__CacheDirectory__**/cached-descriptors** and **cached-descriptors.new**:: +__CacheDirectory__/**`cached-descriptors`** and **`cached-descriptors.new`**:: These files contain the downloaded router statuses. Some routers may appear more than once; if so, the most recently published descriptor is used. Lines beginning with **`@`**-signs are annotations that contain more @@ -3416,20 +3415,20 @@ __CacheDirectory__**/cached-descriptors** and **cached-descriptors.new**:: journal; when it gets too large, all entries are merged into a new cached-descriptors file. -__CacheDirectory__**/cached-extrainfo** and **cached-extrainfo.new**:: +__CacheDirectory__/**`cached-extrainfo`** and **`cached-extrainfo.new`**:: Similar to **cached-descriptors**, but holds optionally-downloaded "extra-info" documents. Relays use these documents to send inessential information about statistics, bandwidth history, and network health to the authorities. They aren't fetched by default. See the DownloadExtraInfo option for more information. -__CacheDirectory__**/cached-microdescs** and **cached-microdescs.new**:: +__CacheDirectory__/**`cached-microdescs`** and **`cached-microdescs.new`**:: These files hold downloaded microdescriptors. Lines beginning with **`@`**-signs are annotations that contain more information about a given router. The **`.new`** file is an append-only journal; when it gets too large, all entries are merged into a new cached-microdescs file. -__DataDirectory__**/state**:: +__DataDirectory__/**`state`**:: Contains a set of persistent key-value mappings. These include: - the current entry guards and their status. - the current bandwidth accounting values. @@ -3438,104 +3437,104 @@ __DataDirectory__**/state**:: - a short history of bandwidth usage, as produced in the server descriptors. -__DataDirectory__**/sr-state**:: +__DataDirectory__/**`sr-state`**:: _Authority only_. This file is used to record information about the current status of the shared-random-value voting state. -__CacheDirectory__**/diff-cache**:: +__CacheDirectory__/**`diff-cache`**:: _Directory cache only_. Holds older consensuses and diffs from oldest to the most recent consensus of each type compressed in various ways. Each file contains a set of key-value arguments describing its contents, followed by a single NUL byte, followed by the main file contents. -__DataDirectory__**/bw_accounting**:: +__DataDirectory__/**`bw_accounting`**:: This file is obsolete and the data is now stored in the **`state`** file instead. Used to track bandwidth accounting values (when the current period starts and ends; how much has been read and written so far this period). -__DataDirectory__**/control_auth_cookie**:: +__DataDirectory__/**`control_auth_cookie`**:: This file can be used only when cookie authentication is enabled. Used for cookie authentication with the controller. Location can be overridden by the `CookieAuthFile` configuration option. Regenerated on startup. See control-spec.txt in https://spec.torproject.org/[torspec] for details. -__DataDirectory__**/lock**:: +__DataDirectory__/**`lock`**:: This file is used to prevent two Tor instances from using the same data directory. If access to this file is locked, data directory is already in use by Tor. -__DataDirectory__**/key-pinning-journal**:: +__DataDirectory__/**`key-pinning-journal`**:: Used by authorities. A line-based file that records mappings between RSA1024 and Ed25519 identity keys. Authorities enforce these mappings, so that once a relay has picked an Ed25519 key, stealing or factoring the RSA1024 key will no longer let an attacker impersonate the relay. -__KeyDirectory__**/authority_identity_key**:: +__KeyDirectory__/**`authority_identity_key`**:: A v3 directory authority's master identity key, used to authenticate its signing key. Tor doesn't use this while it's running. The tor-gencert program uses this. If you're running an authority, you should keep this key offline, and not put it in this file. -__KeyDirectory__**/authority_certificate**:: +__KeyDirectory__/**`authority_certificate`**:: Only directory authorities use this file. A v3 directory authority's certificate which authenticates the authority's current vote- and consensus-signing key using its master identity key. -__KeyDirectory__**/authority_signing_key**:: +__KeyDirectory__/**`authority_signing_key`**:: Only directory authorities use this file. A v3 directory authority's signing key that is used to sign votes and consensuses. Corresponds to the **authority_certificate** cert. -__KeyDirectory__**/legacy_certificate**:: +__KeyDirectory__/**`legacy_certificate`**:: As authority_certificate; used only when `V3AuthUseLegacyKey` is set. See documentation for V3AuthUseLegacyKey. -__KeyDirectory__**/legacy_signing_key**:: +__KeyDirectory__/**`legacy_signing_key`**:: As authority_signing_key: used only when `V3AuthUseLegacyKey` is set. See documentation for V3AuthUseLegacyKey. -__KeyDirectory__**/secret_id_key**:: +__KeyDirectory__/**`secret_id_key`**:: A relay's RSA1024 permanent identity key, including private and public components. Used to sign router descriptors, and to sign other keys. -__KeyDirectory__**/ed25519_master_id_public_key**:: +__KeyDirectory__/**`ed25519_master_id_public_key`**:: The public part of a relay's Ed25519 permanent identity key. -__KeyDirectory__**/ed25519_master_id_secret_key**:: +__KeyDirectory__/**`ed25519_master_id_secret_key`**:: The private part of a relay's Ed25519 permanent identity key. This key is used to sign the medium-term ed25519 signing key. This file can be kept offline or encrypted. If so, Tor will not be able to generate new signing keys automatically; you'll need to use `tor --keygen` to do so. -__KeyDirectory__**/ed25519_signing_secret_key**:: +__KeyDirectory__/**`ed25519_signing_secret_key`**:: The private and public components of a relay's medium-term Ed25519 signing key. This key is authenticated by the Ed25519 master key, which in turn authenticates other keys (and router descriptors). -__KeyDirectory__**/ed25519_signing_cert**:: +__KeyDirectory__/**`ed25519_signing_cert`**:: The certificate which authenticates "ed25519_signing_secret_key" as having been signed by the Ed25519 master key. -__KeyDirectory__**/secret_onion_key** and **secret_onion_key.old**:: +__KeyDirectory__/**`secret_onion_key`** and **`secret_onion_key.old`**:: A relay's RSA1024 short-term onion key. Used to decrypt old-style ("TAP") circuit extension requests. The **`.old`** file holds the previously generated key, which the relay uses to handle any requests that were made by clients that didn't have the new one. -__KeyDirectory__**/secret_onion_key_ntor** and **secret_onion_key_ntor.old**:: +__KeyDirectory__/**`secret_onion_key_ntor`** and **`secret_onion_key_ntor.old`**:: A relay's Curve25519 short-term onion key. Used to handle modern ("ntor") circuit extension requests. The **`.old`** file holds the previously generated key, which the relay uses to handle any requests that were made by clients that didn't have the new one. -__DataDirectory__**/fingerprint**:: +__DataDirectory__/**`fingerprint`**:: Only used by servers. Contains the fingerprint of the server's identity key. -__DataDirectory__**/hashed-fingerprint**:: +__DataDirectory__/**`hashed-fingerprint`**:: Only used by bridges. Contains the hashed fingerprint of the bridge's identity key. (That is, the hash of the hash of the identity key.) -__DataDirectory__**/approved-routers**:: +__DataDirectory__/**`approved-routers`**:: Only used by authoritative directory servers. This file lists the status of routers by their identity fingerprint. Each line lists a status and a fingerprint separated by whitespace. See your **`fingerprint`** file in the @@ -3544,63 +3543,63 @@ __DataDirectory__**/approved-routers**:: server. If it is **!invalid**, then the descriptors are accepted but marked in the directory as not valid, that is, not recommended. -__DataDirectory__**/v3-status-votes**:: +__DataDirectory__/**`v3-status-votes`**:: Only for v3 authoritative directory servers. This file contains status votes from all the authoritative directory servers. -__CacheDirectory__**/unverified-consensus**:: +__CacheDirectory__/**`unverified-consensus`**:: Contains a network consensus document that has been downloaded, but which we didn't have the right certificates to check yet. -__CacheDirectory__**/unverified-microdesc-consensus**:: +__CacheDirectory__/**`unverified-microdesc-consensus`**:: Contains a microdescriptor-flavored network consensus document that has been downloaded, but which we didn't have the right certificates to check yet. -__DataDirectory__**/unparseable-desc**:: +__DataDirectory__/**`unparseable-desc`**:: Onion server descriptors that Tor was unable to parse are dumped to this file. Only used for debugging. -__DataDirectory__**/router-stability**:: +__DataDirectory__/**`router-stability`**:: Only used by authoritative directory servers. Tracks measurements for router mean-time-between-failures so that authorities have a fair idea of how to set their Stable flags. -__DataDirectory__**/stats/dirreq-stats**:: +__DataDirectory__/**`stats/dirreq-stats`**:: Only used by directory caches and authorities. This file is used to collect directory request statistics. -__DataDirectory__**/stats/entry-stats**:: +__DataDirectory__/**`stats/entry-stats`**:: Only used by servers. This file is used to collect incoming connection statistics by Tor entry nodes. -__DataDirectory__**/stats/bridge-stats**:: +__DataDirectory__/**`stats/bridge-stats`**:: Only used by servers. This file is used to collect incoming connection statistics by Tor bridges. -__DataDirectory__**/stats/exit-stats**:: +__DataDirectory__/**`stats/exit-stats`**:: Only used by servers. This file is used to collect outgoing connection statistics by Tor exit routers. -__DataDirectory__**/stats/buffer-stats**:: +__DataDirectory__/**`stats/buffer-stats`**:: Only used by servers. This file is used to collect buffer usage history. -__DataDirectory__**/stats/conn-stats**:: +__DataDirectory__/**`stats/conn-stats`**:: Only used by servers. This file is used to collect approximate connection history (number of active connections over time). -__DataDirectory__**/stats/hidserv-stats**:: +__DataDirectory__/**`stats/hidserv-stats`**:: Only used by servers. This file is used to collect approximate counts of what fraction of the traffic is hidden service rendezvous traffic, and approximately how many hidden services the relay has seen. -__DataDirectory__**/networkstatus-bridges**:: +__DataDirectory__/**networkstatus-bridges`**:: Only used by authoritative bridge directories. Contains information about bridges that have self-reported themselves to the bridge authority. -__HiddenServiceDirectory__**/hostname**:: +__HiddenServiceDirectory__/**`hostname`**:: The <base32-encoded-fingerprint>.onion domain name for this hidden service. If the hidden service is restricted to authorized clients only, this file also contains authorization data for all clients. @@ -3611,14 +3610,14 @@ __HiddenServiceDirectory__**/hostname**:: can ask your clients to connect to "www.xyz.onion" or "irc.xyz.onion" for virtual-hosting purposes. -__HiddenServiceDirectory__**/private_key**:: +__HiddenServiceDirectory__/**`private_key`**:: Contains the private key for this hidden service. -__HiddenServiceDirectory__**/client_keys**:: +__HiddenServiceDirectory__/**`client_keys`**:: Contains authorization data for a hidden service that is only accessible by authorized clients. -__HiddenServiceDirectory__**/onion_service_non_anonymous**:: +__HiddenServiceDirectory__/**`onion_service_non_anonymous`**:: This file is present if a hidden service key was created in **HiddenServiceNonAnonymousMode**.

1 0

[tor/master] Reword back matter of tor.1.txt
by nickm＠torproject.org 24 Oct '19

24 Oct '19

commit 6f8fad54fdea8341bbe8a522bea90b278ce4f68d Author: Taylor Yu <catalyst(a)torproject.org> Date: Mon Oct 21 11:28:03 2019 -0500 Reword back matter of tor.1.txt Reword the SEE ALSO and BUGS sections of tor.1.txt. Based on a patch by Swati Thacker. Part of #32176. --- doc/tor.1.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 63dc9d92a..e43d0b663 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -3623,16 +3623,16 @@ __HiddenServiceDirectory__/**`onion_service_non_anonymous`**:: SEE ALSO -------- -**torsocks**(1), **torify**(1) + -**https://www.torproject.org/** - -**torspec: https://spec.torproject.org ** +For more information, refer to the Tor project at https://www.torproject.org/ +and the Tor spec at https://spec.torproject.org. See also **torsocks**(1) and +**torify**(1). BUGS ---- -Plenty, probably. Tor is still in development. Please report them at https://trac.torproject.org/. +Because Tor is still under development, there may be plenty of bugs. Please +report them at https://trac.torproject.org/. AUTHORS -------

1 0

[metrics-cloud/master] onionoo-backends: Import Ansible playbook
by irl＠torproject.org 24 Oct '19

24 Oct '19

commit 589dbec92e604f4d3e837a1570c9bb4308fc9c20 Author: Iain R. Learmonth <irl(a)fsfe.org> Date: Thu Oct 24 16:11:06 2019 +0100 onionoo-backends: Import Ansible playbook --- ansible/onionoo-backends.yml | 13 ++ .../roles/onionoo-backend/files/profile.onionoo | 2 + .../onionoo-backend/files/profile.onionoo-unpriv | 2 + ansible/roles/onionoo-backend/tasks/main.yml | 148 +++++++++++++++++++++ .../templates/onionoo-web.service.j2 | 6 + .../onionoo-backend/templates/onionoo.service.j2 | 9 ++ 6 files changed, 180 insertions(+) diff --git a/ansible/onionoo-backends.yml b/ansible/onionoo-backends.yml new file mode 100644 index 0000000..c86be97 --- /dev/null +++ b/ansible/onionoo-backends.yml @@ -0,0 +1,13 @@ +--- +- hosts: onionoo-backends + vars: + onionoo_version: 7.0-1.21.0 + pre_tasks: + - name: get sudo password + local_action: shell pass Tor/sudo/onionoo + register: pass_output + changed_when: False + - name: store as ansible become password + set_fact: ansible_become_password="{{ pass_output.stdout_lines[0] }}" + roles: + - onionoo-backend diff --git a/ansible/roles/onionoo-backend/files/profile.onionoo b/ansible/roles/onionoo-backend/files/profile.onionoo new file mode 100644 index 0000000..bae510e --- /dev/null +++ b/ansible/roles/onionoo-backend/files/profile.onionoo @@ -0,0 +1,2 @@ +export XDG_RUNTIME_DIR="/run/user/1547" +export DBUS_SESSION_BUS_ADDRESS="unix:path=${XDG_RUNTIME_DIR}/bus" diff --git a/ansible/roles/onionoo-backend/files/profile.onionoo-unpriv b/ansible/roles/onionoo-backend/files/profile.onionoo-unpriv new file mode 100644 index 0000000..c6adf1b --- /dev/null +++ b/ansible/roles/onionoo-backend/files/profile.onionoo-unpriv @@ -0,0 +1,2 @@ +export XDG_RUNTIME_DIR="/run/user/2075" +export DBUS_SESSION_BUS_ADDRESS="unix:path=${XDG_RUNTIME_DIR}/bus" diff --git a/ansible/roles/onionoo-backend/tasks/main.yml b/ansible/roles/onionoo-backend/tasks/main.yml new file mode 100644 index 0000000..a0c76fd --- /dev/null +++ b/ansible/roles/onionoo-backend/tasks/main.yml @@ -0,0 +1,148 @@ +--- +# TODO: don't always restart +# TODO: check if the updater is running, and stop if it's ok to stop it, +# but only if needed +# TODO: --single-run if out doesn't exist +- name: set onionoo profile + copy: + src: profile.onionoo + dest: /srv/onionoo.torproject.org/home/.profile + mode: 0600 + become: yes + become_user: onionoo +- name: set onionoo-unpriv profile + copy: + src: profile.onionoo-unpriv + dest: /srv/onionoo.torproject.org/home-unpriv/.profile + mode: 0600 + become: yes + become_user: onionoo-unpriv +- name: check onionoo service status + systemd: + scope: user + name: onionoo + register: onionoo_service + become: yes + become_user: onionoo +- name: debug + debug: + var: onionoo_service +- name: assert that updater service is stopped + assert: + that: onionoo_service.status.ActiveState != "active" +- name: check for latest jar + stat: + path: "/srv/onionoo.torproject.org/onionoo/onionoo-{{ onionoo_version }}.jar" + register: jar_stat +- name: check for latest war + stat: + path: "/srv/onionoo.torproject.org/onionoo/onionoo-{{ onionoo_version }}.war" + register: war_stat +- name: download latest release + get_url: + url: https://dist.torproject.org/onionoo/{{ onionoo_version }}/onionoo-{{ onionoo_version }}.tar.gz + dest: "/srv/onionoo.torproject.org/home/onionoo-{{ onionoo_version }}.tar.gz" + become: true + become_user: onionoo + when: jar_stat.stat.exists == False or war_stat.stat.exists == False +- name: create temp directory + tempfile: + state: directory + register: onionoo_unpack + become: true + become_user: onionoo + when: jar_stat.stat.exists == False or war_stat.stat.exists == False +- name: unpack onionoo release + unarchive: + remote_src: true + src: "/srv/onionoo.torproject.org/home/onionoo-{{ onionoo_version }}.tar.gz" + dest: "{{ onionoo_unpack.path }}/" + become: true + become_user: onionoo + when: jar_stat.stat.exists == False or war_stat.stat.exists == False +- name: copy jar file + copy: + remote_src: true + src: "{{ onionoo_unpack.path }}/onionoo-{{ onionoo_version }}/generated/dist/onionoo-{{ onionoo_version }}.jar" + dest: "/srv/onionoo.torproject.org/onionoo/" + become: true + become_user: onionoo + when: jar_stat.stat.exists == False +- name: copy war file + copy: + remote_src: true + src: "{{ onionoo_unpack.path }}/onionoo-{{ onionoo_version }}/generated/dist/onionoo-{{ onionoo_version }}.war" + dest: "/srv/onionoo.torproject.org/onionoo/" + become: true + become_user: onionoo + when: war_stat.stat.exists == False +- name: delete temporary directory + file: + path: "{{ onionoo_unpack.path }}" + state: absent + become: true + become_user: onionoo + when: jar_stat.stat.exists == False or war_stat.stat.exists == False +- name: create web logs directory + file: + path: /srv/onionoo.torproject.org/home-unpriv/web-logs + state: directory + become: true + become_user: onionoo-unpriv +- name: link web logs directory + file: + path: /srv/onionoo.torproject.org/onionoo/web-logs + src: /srv/onionoo.torproject.org/home-unpriv/web-logs + state: link + become: true + become_user: onionoo +- name: create systemd user directory for onionoo + file: + path: /srv/onionoo.torproject.org/home/.config/systemd/user + state: directory + become: true + become_user: onionoo +- name: create systemd user directory for onionoo-unpriv + file: + path: /srv/onionoo.torproject.org/home-unpriv/.config/systemd/user + state: directory + become: true + become_user: onionoo-unpriv +- name: install oninooo updater service file + template: + src: onionoo.service.j2 + dest: "/srv/onionoo.torproject.org/home/.config/systemd/user/onionoo.service" + become: true + become_user: onionoo +- name: reload systemd daemon + systemd: + scope: user + daemon_reload: yes + become: true + become_user: onionoo +- name: install oninooo web server service file + template: + src: onionoo-web.service.j2 + dest: "/srv/onionoo.torproject.org/home-unpriv/.config/systemd/user/onionoo-web.service" + become: true + become_user: onionoo-unpriv +- name: reload systemd daemon + systemd: + scope: user + daemon_reload: yes + become: true + become_user: onionoo-unpriv +- name: start onionoo service + systemd: + scope: user + name: onionoo + state: started + become: yes + become_user: onionoo +- name: restart onionoo web service status + systemd: + scope: user + name: onionoo-web + state: restarted + become: yes + become_user: onionoo-unpriv diff --git a/ansible/roles/onionoo-backend/templates/onionoo-web.service.j2 b/ansible/roles/onionoo-backend/templates/onionoo-web.service.j2 new file mode 100644 index 0000000..affab11 --- /dev/null +++ b/ansible/roles/onionoo-backend/templates/onionoo-web.service.j2 @@ -0,0 +1,6 @@ +[Unit] +Description=Onionoo Web Server + +[Service] +WorkingDirectory=/srv/onionoo.torproject.org/onionoo +ExecStart=java -Xmx2g -DLOGBASE=web-logs -jar onionoo-{{ onionoo_version }}.war diff --git a/ansible/roles/onionoo-backend/templates/onionoo.service.j2 b/ansible/roles/onionoo-backend/templates/onionoo.service.j2 new file mode 100644 index 0000000..19f40a1 --- /dev/null +++ b/ansible/roles/onionoo-backend/templates/onionoo.service.j2 @@ -0,0 +1,9 @@ +[Unit] +Description=Onionoo Updater + +[Service] +WorkingDirectory=/srv/onionoo.torproject.org/onionoo +ExecStart=java -Xmx4g -Dsun.net.client.defaultConnectTimeout=60000 \ + -Dsun.net.client.defaultReadTimeout=60000 -DLOGBASE=logs \ + -cp onionoo-{{ onionoo_version }}.jar \ + org.torproject.metrics.onionoo.cron.Main

1 0

[tor-browser/tor-browser-68.2.0esr-9.0-1] fixup! Bug 31286: Implementation of bridge, proxy, and firewall settings in about:preferences#tor
by gk＠torproject.org 24 Oct '19

24 Oct '19

commit a339c6ec84d612d37eb409eca1b36706a89c9486 Author: Richard Pospesel <richard(a)torproject.org> Date: Wed Oct 23 13:43:41 2019 -0700 fixup! Bug 31286: Implementation of bridge, proxy, and firewall settings in about:preferences#tor Fixes bug 32210 (hiding the tor pane when using system tor) --- browser/components/preferences/in-content/preferences.js | 9 ++++++++- browser/components/torpreferences/content/torCategory.inc.xul | 3 ++- browser/components/torpreferences/content/torPane.js | 5 +++++ browser/components/torpreferences/content/torPane.xul | 3 ++- browser/modules/TorProtocolService.jsm | 10 ++++++++++ 5 files changed, 27 insertions(+), 3 deletions(-) diff --git a/browser/components/preferences/in-content/preferences.js b/browser/components/preferences/in-content/preferences.js index 04e4f53b312a..9c97c33a8b2a 100644 --- a/browser/components/preferences/in-content/preferences.js +++ b/browser/components/preferences/in-content/preferences.js @@ -93,7 +93,14 @@ function init_all() { document.getElementById("template-paneSync").remove(); } register_module("paneSearchResults", gSearchResultsPane); - register_module("paneTor", gTorPane); + if (gTorPane.enabled) { + document.getElementById("category-tor").hidden = false; + register_module("paneTor", gTorPane); + } else { + // Remove the pane from the DOM so it doesn't get incorrectly included in search results. + document.getElementById("template-paneTor").remove(); + } + gSearchResultsPane.init(); gMainPane.preInit(); diff --git a/browser/components/torpreferences/content/torCategory.inc.xul b/browser/components/torpreferences/content/torCategory.inc.xul index 746059358d5f..abe56200f571 100644 --- a/browser/components/torpreferences/content/torCategory.inc.xul +++ b/browser/components/torpreferences/content/torCategory.inc.xul @@ -2,7 +2,8 @@ class="category" value="paneTor" helpTopic="prefs-tor" - align="center"> + align="center" + hidden="true"> <image class="category-icon"/> <label id="torPreferences-labelCategory" class="category-name" flex="1" value="Tor"/> </richlistitem> diff --git a/browser/components/torpreferences/content/torPane.js b/browser/components/torpreferences/content/torPane.js index 08de0613e1d4..334155e91a59 100644 --- a/browser/components/torpreferences/content/torPane.js +++ b/browser/components/torpreferences/content/torPane.js @@ -478,6 +478,11 @@ const gTorPane = (function() { this._populateXUL(); }, + // whether the page should be present in about:preferences + get enabled() { + return TorProtocolService.ownsTorDaemon; + }, + // // Callbacks // diff --git a/browser/components/torpreferences/content/torPane.xul b/browser/components/torpreferences/content/torPane.xul index b384ce9f9489..5d8451554eb9 100644 --- a/browser/components/torpreferences/content/torPane.xul +++ b/browser/components/torpreferences/content/torPane.xul @@ -2,7 +2,7 @@ <script type="application/javascript" src="chrome://browser/content/torpreferences/torPane.js"/> - +<html:template id="template-paneTor"> <hbox id="torPreferencesCategory" class="subcategory" hidden="true" @@ -117,3 +117,4 @@ <button id="torPreferences-buttonTorLogs" class="torMarginFix" oncommand="gTorPane.onViewTorLogs();"/> </hbox> </groupbox> +</html:template> \ No newline at end of file diff --git a/browser/modules/TorProtocolService.jsm b/browser/modules/TorProtocolService.jsm index 48ae2e14ec64..b4e6ed9a3253 100644 --- a/browser/modules/TorProtocolService.jsm +++ b/browser/modules/TorProtocolService.jsm @@ -2,10 +2,15 @@ var EXPORTED_SYMBOLS = ["TorProtocolService"]; +const { TorLauncherUtil } = ChromeUtils.import( + "resource://torlauncher/modules/tl-util.jsm" +); + var TorProtocolService = { _tlps: Cc["@torproject.org/torlauncher-protocol-service;1"].getService( Ci.nsISupports ).wrappedJSObject, + // maintain a map of tor settings set by Tor Browser so that we don't // repeatedly set the same key/values over and over // this map contains string keys to primitive or array values @@ -199,4 +204,9 @@ var TorProtocolService = { let torLog = this._tlps.TorGetLog(countObj); return torLog; }, + + // true if we launched and control tor, false if using system tor + get ownsTorDaemon() { + return TorLauncherUtil.shouldStartAndOwnTor; + }, };

1 0

[tor-browser/tor-browser-68.2.0esr-9.5-1] fixup! Bug 31286: Implementation of bridge, proxy, and firewall settings in about:preferences#tor
by gk＠torproject.org 24 Oct '19

24 Oct '19

commit 5d24d4b6873de2da8afa7cba448905522311a4b8 Author: Richard Pospesel <richard(a)torproject.org> Date: Wed Oct 23 13:43:41 2019 -0700 fixup! Bug 31286: Implementation of bridge, proxy, and firewall settings in about:preferences#tor Fixes bug 32210 (hiding the tor pane when using system tor) --- browser/components/preferences/in-content/preferences.js | 9 ++++++++- browser/components/torpreferences/content/torCategory.inc.xul | 3 ++- browser/components/torpreferences/content/torPane.js | 5 +++++ browser/components/torpreferences/content/torPane.xul | 3 ++- browser/modules/TorProtocolService.jsm | 10 ++++++++++ 5 files changed, 27 insertions(+), 3 deletions(-) diff --git a/browser/components/preferences/in-content/preferences.js b/browser/components/preferences/in-content/preferences.js index 04e4f53b312a..9c97c33a8b2a 100644 --- a/browser/components/preferences/in-content/preferences.js +++ b/browser/components/preferences/in-content/preferences.js @@ -93,7 +93,14 @@ function init_all() { document.getElementById("template-paneSync").remove(); } register_module("paneSearchResults", gSearchResultsPane); - register_module("paneTor", gTorPane); + if (gTorPane.enabled) { + document.getElementById("category-tor").hidden = false; + register_module("paneTor", gTorPane); + } else { + // Remove the pane from the DOM so it doesn't get incorrectly included in search results. + document.getElementById("template-paneTor").remove(); + } + gSearchResultsPane.init(); gMainPane.preInit(); diff --git a/browser/components/torpreferences/content/torCategory.inc.xul b/browser/components/torpreferences/content/torCategory.inc.xul index 746059358d5f..abe56200f571 100644 --- a/browser/components/torpreferences/content/torCategory.inc.xul +++ b/browser/components/torpreferences/content/torCategory.inc.xul @@ -2,7 +2,8 @@ class="category" value="paneTor" helpTopic="prefs-tor" - align="center"> + align="center" + hidden="true"> <image class="category-icon"/> <label id="torPreferences-labelCategory" class="category-name" flex="1" value="Tor"/> </richlistitem> diff --git a/browser/components/torpreferences/content/torPane.js b/browser/components/torpreferences/content/torPane.js index 08de0613e1d4..334155e91a59 100644 --- a/browser/components/torpreferences/content/torPane.js +++ b/browser/components/torpreferences/content/torPane.js @@ -478,6 +478,11 @@ const gTorPane = (function() { this._populateXUL(); }, + // whether the page should be present in about:preferences + get enabled() { + return TorProtocolService.ownsTorDaemon; + }, + // // Callbacks // diff --git a/browser/components/torpreferences/content/torPane.xul b/browser/components/torpreferences/content/torPane.xul index b384ce9f9489..5d8451554eb9 100644 --- a/browser/components/torpreferences/content/torPane.xul +++ b/browser/components/torpreferences/content/torPane.xul @@ -2,7 +2,7 @@ <script type="application/javascript" src="chrome://browser/content/torpreferences/torPane.js"/> - +<html:template id="template-paneTor"> <hbox id="torPreferencesCategory" class="subcategory" hidden="true" @@ -117,3 +117,4 @@ <button id="torPreferences-buttonTorLogs" class="torMarginFix" oncommand="gTorPane.onViewTorLogs();"/> </hbox> </groupbox> +</html:template> \ No newline at end of file diff --git a/browser/modules/TorProtocolService.jsm b/browser/modules/TorProtocolService.jsm index 48ae2e14ec64..b4e6ed9a3253 100644 --- a/browser/modules/TorProtocolService.jsm +++ b/browser/modules/TorProtocolService.jsm @@ -2,10 +2,15 @@ var EXPORTED_SYMBOLS = ["TorProtocolService"]; +const { TorLauncherUtil } = ChromeUtils.import( + "resource://torlauncher/modules/tl-util.jsm" +); + var TorProtocolService = { _tlps: Cc["@torproject.org/torlauncher-protocol-service;1"].getService( Ci.nsISupports ).wrappedJSObject, + // maintain a map of tor settings set by Tor Browser so that we don't // repeatedly set the same key/values over and over // this map contains string keys to primitive or array values @@ -199,4 +204,9 @@ var TorProtocolService = { let torLog = this._tlps.TorGetLog(countObj); return torLog; }, + + // true if we launched and control tor, false if using system tor + get ownsTorDaemon() { + return TorLauncherUtil.shouldStartAndOwnTor; + }, };

1 0

[tor/master] configure: Add --disable-module-relay to summary
by dgoulet＠torproject.org 24 Oct '19

24 Oct '19

commit cf5f52d6947c653b3e44a331428389abf0f1b16b Author: David Goulet <dgoulet(a)torproject.org> Date: Thu Oct 24 09:08:36 2019 -0400 configure: Add --disable-module-relay to summary Closes #32266 Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- configure.ac | 3 +++ 1 file changed, 3 insertions(+) diff --git a/configure.ac b/configure.ac index 9a903fb11..487361773 100644 --- a/configure.ac +++ b/configure.ac @@ -2624,6 +2624,9 @@ PPRINT_SUBTITLE([Modules]) test "x$enable_module_dirauth" != "xno" && value=1 || value=0 PPRINT_PROP_BOOL([Directory Authority (--disable-module-dirauth)], $value) +test "x$enable_module_relay" != "xno" && value=1 || value=0 +PPRINT_PROP_BOOL([Relay (--disable-module-relay)], $value) + AS_ECHO PPRINT_SUBTITLE([Documentation])

1 0

[tor-browser/tor-browser-68.2.0esr-9.0-1] Bug 31658: Changed the 'SECURITY LEVEL' text color to builtin --panel-disabled-color
by gk＠torproject.org 24 Oct '19

24 Oct '19

commit b2428d30e4b181b687c1509af5687097ef5b2166 Author: Richard Pospesel <richard(a)torproject.org> Date: Wed Oct 23 14:48:27 2019 -0700 Bug 31658: Changed the 'SECURITY LEVEL' text color to builtin --panel-disabled-color --- browser/components/securitylevel/content/securityLevelPanel.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/browser/components/securitylevel/content/securityLevelPanel.css b/browser/components/securitylevel/content/securityLevelPanel.css index 170bf625ea1d..70022e2bd4b2 100644 --- a/browser/components/securitylevel/content/securityLevelPanel.css +++ b/browser/components/securitylevel/content/securityLevelPanel.css @@ -14,7 +14,7 @@ panelview#securityLevel-panelview>vbox.panel-subview-body { label#securityLevel-header { text-transform: uppercase; - color: GrayText; + color: var(--panel-disabled-color); font-size: 0.85em; margin: 0 0 0.4em 0; padding: 0;

1 0