[tor-commits] [flashproxy/master] Change the client transport method name from "websocket" to "flashproxy".

[dcf at torproject.org]

commit c47025cd9260a77d65a7ca41f5f806a87c1baf27
Author: David Fifield <david at bamsoftware.com>
Date:   Sun Oct 13 17:21:11 2013 -0700

    Change the client transport method name from "websocket" to "flashproxy".
    
    Both names still work and are equivalent. This only affects what string
    appears in the configuration files we ship.
---
 ChangeLog                        |   10 ++++++++++
 README                           |    6 +++---
 doc/design.txt                   |    4 ++--
 experiments/exercise/exercise.sh |    2 +-
 torrc                            |    4 ++--
 5 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index ff115cf..8707b89 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -16,6 +16,16 @@
     assign proxies to clients that use matching transports. Patch by
     George Kadianakis. Part of bug 9349.
 
+  o Changed to use the pluggable transport method name "flashproxy"
+    rather than "websocket". Both names are equivalent and "websocket"
+    continues to work. The reason for this change is to reduce confusion
+    with a transport that simply makes a WebSocket connection to a
+    "websocket" bridge, without receiving an inbound connection from a
+    flash proxy. The default argument to the --transport option
+    continues to be "websocket", because that option controls which
+    particular protocol flash proxies should use to connect to you, and
+    is distinct from the transport method name used by Tor.
+
 Changes in version 1.3
   o Added a new observed Google public key pin.
 
diff --git a/README b/README
index ca93ce8..aa1dc6a 100644
--- a/README
+++ b/README
@@ -19,11 +19,11 @@ By default the transport plugin listens on Internet-facing TCP port
 9000. If you have to use a different port (to get through a firewall,
 for example), edit the ClientTransportPlugin line of the torrc to give a
 different port number:
-	ClientTransportPlugin websocket exec ./flashproxy-client --register :0 :8888
+	ClientTransportPlugin flashproxy exec ./flashproxy-client --register :0 :8888
 If the flashproxy-client program is in a different directoy (after being
 installed, for example), use the full path in the ClientTransportPlugin
 line:
-	ClientTransportPlugin websocket exec /usr/local/bin/flashproxy-client --register
+	ClientTransportPlugin flashproxy exec /usr/local/bin/flashproxy-client --register
 
 You should receive a flash proxy connection within about 60 seconds. See
 "Troubleshooting" below if it doesn't work.
@@ -69,7 +69,7 @@ public instance of it. This way is not as realistic because all your Tor
 traffic will first go to a fixed address and can be easily blocked.
 However this is an easy way to try out the system without having to do
 port forwarding.
-	$ tor ClientTransportPlugin "websocket socks4 fp-facilitator.org:9999" UseBridges 1 Bridge "websocket 0.0.1.0:1" LearnCircuitBuildTimeout 0 CircuitBuildTimeout 60
+	$ tor ClientTransportPlugin "flashproxy socks4 fp-facilitator.org:9999" UseBridges 1 Bridge "flashproxy 0.0.1.0:1" LearnCircuitBuildTimeout 0 CircuitBuildTimeout 60
 
 
 == Troubleshooting
diff --git a/doc/design.txt b/doc/design.txt
index bc0f377..20b63b7 100644
--- a/doc/design.txt
+++ b/doc/design.txt
@@ -100,9 +100,9 @@ Design of flash proxies
   The Tor client must be configured to make its connections through a
   local proxy (the client transport plugin). This configuration is
   sufficient:
-    ClientTransportPlugin websocket socks4 127.0.0.1:9001
+    ClientTransportPlugin flashproxy socks4 127.0.0.1:9001
     UseBridges 1
-    Bridge websocket 0.0.1.0:1
+    Bridge flashproxy 0.0.1.0:1
     LearnCircuitBuildTimeout 0
   The address given for the "Bridge" option is actually irrelevant. The
   client transport plugin will ignore it and connect (through the flash
diff --git a/experiments/exercise/exercise.sh b/experiments/exercise/exercise.sh
index 0bc49c0..efefde7 100755
--- a/experiments/exercise/exercise.sh
+++ b/experiments/exercise/exercise.sh
@@ -26,7 +26,7 @@ PIDS_TO_KILL+=($!)
 
 sleep 20
 
-"$TOR" ClientTransportPlugin "websocket socks4 127.0.0.1:$LOCAL_PORT" UseBridges 1 Bridge "websocket 0.0.1.0:1" LearnCircuitBuildTimeout 0 CircuitBuildTimeout 60 &
+"$TOR" ClientTransportPlugin "flashproxy socks4 127.0.0.1:$LOCAL_PORT" UseBridges 1 Bridge "flashproxy 0.0.1.0:1" LearnCircuitBuildTimeout 0 CircuitBuildTimeout 60 &
 PIDS_TO_KILL+=($!)
 
 sleep 60
diff --git a/torrc b/torrc
index e047cd0..4a66162 100644
--- a/torrc
+++ b/torrc
@@ -4,10 +4,10 @@
 
 UseBridges 1
 # The address and port are ignored by the client transport plugin.
-Bridge websocket 0.0.1.0:1
+Bridge flashproxy 0.0.1.0:1
 LearnCircuitBuildTimeout 0
 CircuitBuildTimeout 60
 # Change the second number here (9000) to the number of a port that can
 # receive connections from the Internet (the port for which you
 # configured port forwarding).
-ClientTransportPlugin websocket exec ./flashproxy-client --register :0 :9000
+ClientTransportPlugin flashproxy exec ./flashproxy-client --register :0 :9000