[tor-commits] [stem/master] Updating with new config options

[atagar at torproject.org]

commit 645017a5f8c17b143e90602fdfe6c03a1a994a1c
Author: Damian Johnson <atagar at torproject.org>
Date:   Sat Feb 13 18:53:52 2016 -0800

    Updating with new config options
    
    Just pulling in the latest torrc changes, most notably the addition of
    ClientUseIPv4 and ClientPreferIPv6DirPort...
    
      https://gitweb.torproject.org/tor.git/commit/?id=2d33d19
---
 stem/cached_tor_manual.cfg | 26 +++++++++++++++++++-------
 stem/settings.cfg          |  4 +++-
 2 files changed, 22 insertions(+), 8 deletions(-)

diff --git a/stem/cached_tor_manual.cfg b/stem/cached_tor_manual.cfg
index 4866251..7a98873 100644
--- a/stem/cached_tor_manual.cfg
+++ b/stem/cached_tor_manual.cfg
@@ -6,8 +6,8 @@ description
 |Basically, Tor provides a distributed network of servers or relays ("onion routers"). Users bounce their TCP streams -- web traffic, ftp, ssh, etc. -- around the network, and recipients, observers, and even the relays themselves have difficulty tracking the source of the stream.
 |
 |By default, tor will only act as a client only. To help the network by providing bandwidth as a relay, change the ORPort configuration option -- see below. Please also consult the documentation on the Tor Project's website.
-man_commit a5bed4dab2f8521f744d5137e4f439b073c7e5e9
-stem_commit 5b8b5ca5dc3cd2c0797c10910d6826e274651ff5
+man_commit ba2be81fc36ba6140247873799b747605fb07bd4
+stem_commit fc35ea1a74b6f9a95b6d1c2d21069f837dc725bb
 commandline_options -f FILE => Specify a new configuration file to contain further Tor configuration options OR pass - to make Tor read its configuration from standard input. (Default: @CONFDIR@/torrc, or $HOME/.torrc if that file is not found)
 commandline_options --ignore-missing-torrc => Specifies that Tor should treat a missing torrc file as though it were empty. Ordinarily, Tor does this for missing default torrc files, but not for those specified on the command line.
 commandline_options --list-fingerprint => Generate your keys and output your nickname and fingerprint.
@@ -630,16 +630,26 @@ config_options.PathBiasScaleUseThreshold.description
 |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, .60, and 100, respectively.
+config_options.ClientUseIPv4.category Client
+config_options.ClientUseIPv4.name ClientUseIPv4
+config_options.ClientUseIPv4.usage 0|1
+config_options.ClientUseIPv4.summary Allow IPv4 connections to guards and fetching consensus
+config_options.ClientUseIPv4.description If this option is set to 0, Tor will avoid connecting to directory servers and entry nodes over IPv4. Note that clients with an IPv4 address in a Bridge, proxy, or pluggable transport line will try connecting over IPv4 even if ClientUseIPv4 is set to 0. (Default: 1)
 config_options.ClientUseIPv6.category Client
 config_options.ClientUseIPv6.name ClientUseIPv6
 config_options.ClientUseIPv6.usage 0|1
-config_options.ClientUseIPv6.summary Allow IPv6 connections to guards
-config_options.ClientUseIPv6.description If this option is set to 1, Tor might connect to entry nodes over IPv6. Note that clients configured with an IPv6 address in a Bridge line will try connecting over IPv6 even if ClientUseIPv6 is set to 0. (Default: 0)
+config_options.ClientUseIPv6.summary Allow IPv6 connections to guards and fetching consensus
+config_options.ClientUseIPv6.description If this option is set to 1, Tor might connect to directory servers or entry nodes over IPv6. Note that clients configured with an IPv6 address in a Bridge, proxy, or pluggable transport line will try connecting over IPv6 even if ClientUseIPv6 is set to 0. (Default: 0)
+config_options.ClientPreferIPv6DirPort.category Client
+config_options.ClientPreferIPv6DirPort.name ClientPreferIPv6DirPort
+config_options.ClientPreferIPv6DirPort.usage 0|1|auto
+config_options.ClientPreferIPv6DirPort.summary Perfer relays with IPv6 when fetching consensus
+config_options.ClientPreferIPv6DirPort.description If this option is set to 1, Tor prefers a directory port with an IPv6 address over one with IPv4, for direct connections, if a given directory server has both. (Tor also prefers an IPv6 DirPort if IPv4Client is set to 0.) If this option is set to auto, clients prefer IPv4. Other things may influence the choice. This option breaks a tie to the favor of IPv6. (Default: auto)
 config_options.ClientPreferIPv6ORPort.category Client
 config_options.ClientPreferIPv6ORPort.name ClientPreferIPv6ORPort
-config_options.ClientPreferIPv6ORPort.usage 0|1
+config_options.ClientPreferIPv6ORPort.usage 0|1|auto
 config_options.ClientPreferIPv6ORPort.summary Prefer a guard's IPv6 rather than IPv4 endpoint
-config_options.ClientPreferIPv6ORPort.description If this option is set to 1, Tor prefers an OR port with an IPv6 address over one with IPv4 if a given entry node has both. Other things may influence the choice. This option breaks a tie to the favor of IPv6. (Default: 0)
+config_options.ClientPreferIPv6ORPort.description If this option is set to 1, Tor prefers an OR port with an IPv6 address over one with IPv4 if a given entry node has both. (Tor also prefers an IPv6 ORPort if IPv4Client is set to 0.) If this option is set to auto, Tor bridge clients prefer the configured bridge address, and other clients prefer IPv4. Other things may influence the choice. This option breaks a tie to the favor of IPv6. (Default: auto)
 config_options.PathsNeededToBuildCircuits.category Client
 config_options.PathsNeededToBuildCircuits.name PathsNeededToBuildCircuits
 config_options.PathsNeededToBuildCircuits.usage NUM
@@ -859,7 +869,7 @@ config_options.FallbackDir.category General
 config_options.FallbackDir.name FallbackDir
 config_options.FallbackDir.usage address:port orport=port id=fingerprint [weight=num] [ipv6=address:orport]
 config_options.FallbackDir.summary Fallback when unable to retrieve descriptor information
-config_options.FallbackDir.description When we're unable to connect to any directory cache for directory info (usually because we don't know about any yet) we try a directory authority. Clients also simultaneously try a FallbackDir, to avoid hangs on client startup if a directory authority is down. Clients retry FallbackDirs more often than directory authorities, to reduce the load on the directory authorities. By default, the directory authorities are also FallbackDirs. Specifying a FallbackDir replaces Tor's default hard-coded FallbackDirs (if any).
+config_options.FallbackDir.description When we're unable to connect to any directory cache for directory info (usually because we don't know about any yet) we try a directory authority. Clients also simultaneously try a FallbackDir, to avoid hangs on client startup if a directory authority is down. Clients retry FallbackDirs more often than directory authorities, to reduce the load on the directory authorities. 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.)
 config_options.UseDefaultFallbackDirs.category General
 config_options.UseDefaultFallbackDirs.name UseDefaultFallbackDirs
 config_options.UseDefaultFallbackDirs.usage 0|1
@@ -872,6 +882,8 @@ config_options.DirAuthority.summary Alternative directory authorities
 config_options.DirAuthority.description 
 |Use a nonstandard authoritative directory server at the provided address and port, with the specified key fingerprint. This option can be repeated many times, for multiple authoritative directory servers. Flags are 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=port" is given, Tor will use the given port when opening encrypted tunnels to the dirserver. If a flag "weight=num" is given, then the directory server is chosen randomly with probability proportional to that weight (default 1.0). If a flag "v3ident=fp" is given, the dirserver is a v3 directory authority whose v3 long-term signing key has the fingerprint fp. Lastly, if an "ipv6=address:orport" flag is present, then the directory authority is listening for IPv6 connect
 ions on the indicated IPv6 address and OR Port.
 |
+|Tor will contact the authority at address:port (the DirPort) to download directory documents. If an IPv6 address is supplied, Tor will also download directory documents at the IPv6 address on the DirPort.
+|
 |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 distinguishable from other users, because you won't believe the same authorities they do.
 config_options.DirAuthorityFallbackRate.category General
 config_options.DirAuthorityFallbackRate.name DirAuthorityFallbackRate
diff --git a/stem/settings.cfg b/stem/settings.cfg
index 82e8f88..cc90be6 100644
--- a/stem/settings.cfg
+++ b/stem/settings.cfg
@@ -205,7 +205,9 @@ manual.summary.PathBiasUseThreshold Number of streams through a circuit before a
 manual.summary.PathBiasNoticeUseRate Fraction of streams that must succeed before logging a notice
 manual.summary.PathBiasExtremeUseRate Fraction of streams that must succeed before logging an error
 manual.summary.PathBiasScaleUseThreshold Streams through a circuit before scaling past observations down
-manual.summary.ClientUseIPv6 Allow IPv6 connections to guards
+manual.summary.ClientUseIPv4 Allow IPv4 connections to guards and fetching consensus
+manual.summary.ClientUseIPv6 Allow IPv6 connections to guards and fetching consensus
+manual.summary.ClientPreferIPv6DirPort Perfer relays with IPv6 when fetching consensus
 manual.summary.ClientPreferIPv6ORPort Prefer a guard's IPv6 rather than IPv4 endpoint
 manual.summary.PathsNeededToBuildCircuits Portion of relays to require information for before making circuits