[tor-commits] [tor/master] config: Deprecate HTTPProxy option

[nickm at torproject.org]

commit 3f807ec05866d0438d81c252ac43946cabd23233
Author: David Goulet <dgoulet at torproject.org>
Date:   Tue Apr 25 09:11:49 2017 -0400

    config: Deprecate HTTPProxy option
    
    Move the HTTPProxy option to the deprecated list so for now it will only warn
    users but feature is still in the code which will be removed in a future
    stable version.
    
    Fixes #20575
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 changes/ticket20575 | 4 ++++
 doc/tor.1.txt       | 7 ++++---
 src/or/config.c     | 7 +++++++
 3 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/changes/ticket20575 b/changes/ticket20575
new file mode 100644
index 0000000..bfbf03f
--- /dev/null
+++ b/changes/ticket20575
@@ -0,0 +1,4 @@
+  o Deprecation (config):
+    - Deprecate HTTPProxy/HTTPProxyAuthenticator config options. It only
+      applies to direct unencrypted HTTP connections to your directory server,
+      which your Tor probably isn't using. Fixes bug 20575.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 568d037..c0fc861 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -522,13 +522,14 @@ GENERAL OPTIONS
 [[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.
+    servers. (DEPRECATED: As of 0.3.1.0-alpha you should use HTTPSProxy.)
 
 [[HTTPProxyAuthenticator]] **HTTPProxyAuthenticator** __username:password__::
     If defined, Tor will use this username:password for Basic HTTP proxy
     authentication, as in RFC 2617. This is currently the only form of HTTP
     proxy authentication that Tor supports; feel free to submit a patch if you
-    want it to support others.
+    want it to support others. (DEPRECATED: As of 0.3.1.0-alpha you should use
+    HTTPSProxyAuthenticator.)
 
 [[HTTPSProxy]] **HTTPSProxy** __host__[:__port__]::
     Tor will make all its OR (SSL) connections through this host:port (or
@@ -646,7 +647,7 @@ GENERAL OPTIONS
     (127.0.0.0/8 and ::1).
 
 [[OutboundBindAddressOR]] **OutboundBindAddressOR** __IP__::
-    Make all outbound non-exit (=relay and other) connections originate from the IP 
+    Make all outbound non-exit (=relay and other) 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. This setting will be ignored for connections to the
diff --git a/src/or/config.c b/src/or/config.c
index a73f397..5fda820 100644
--- a/src/or/config.c
+++ b/src/or/config.c
@@ -693,6 +693,13 @@ static const config_deprecation_t option_deprecation_notes_[] = {
     "NoAdvertise sub-option" },
   /* End of options deprecated since 0.2.9.2-alpha. */
 
+  /* Deprecated since 0.3.1.0-alpha. */
+  { "HTTPProxy", "It only applies to direct unencrypted HTTP connections "
+    "to your directory server, which your Tor probably wasn't using." },
+  { "HTTPProxyAuthenticator", "HTTPProxy is deprecated in favor of HTTPSProxy "
+    "which should be used with HTTPSProxyAuthenticator." },
+  /* End of options deprecated since 0.3.1.0-alpha. */
+
   { NULL, NULL }
 };