tor-webwml.git

1) ## translation metadata
2) # Revision: $Revision$
3) # Translation-Priority: 4-optional
4) 

5) #include "head.wmi" TITLE="obfsproxy: Setting up an Obfsproxy Bridge on Debian/Ubuntu" CHARSET="UTF-8"

6) 
7) <div id="content" class="clearfix">
8)   <div id="breadcrumbs">
9)     <a href="<page index>">Home &raquo; </a>
10)     <a href="<page projects/projects>">Projects &raquo; </a>
11)     <a href="<page projects/obfsproxy>">obfsproxy</a>
12)   </div>
13)   <div id="maincol">
14) 
15)     <!-- PUT CONTENT AFTER THIS TAG -->
16) 

17)     <h1 id="instructions">Setting up an Obfsproxy Bridge on Debian/Ubuntu</h1>

18) 
19)     <img src="$(IMGROOT)/obfsproxy_diagram.png" alt="obfsproxy diagram"></a>
20) 
21)     <p>

22)     <img width="7%" height="7%" style="float: left;" src="$(IMGROOT)/icon-Obfsproxy.jpg">
23)     <b> Hey! </b>
24)     If you are <b>not</b> using Debian or Ubuntu, you better look
25)     <a href="../projects/obfsproxy-instructions.html.en">at this other guide</a>
26)     which sets up Obfsproxy from source.
27)     </p>
28)     <br><br>
29) 
30) 
31)     <p>
32)       This is a <b>Debian/Ubuntu</b> guide for installing the Python

33)       version of obfsproxy. If you are still using the C version, we

34)       recommend you to upgrade to the Python version!

35)     </p>
36) 

37)     <h3>Step 0: Install a recent version of Tor (>= 0.2.4.1)</h3>

38)     <br>
39) 
40)     <p>

41)     Add the <a href="<page docs/debian>#ubuntu">official Tor

42)     APT repository</a> and run the specified commands to install <code>tor</code>
43)     and <code>deb.torproject.org-keyring</code>. You need <em>Tor 0.2.4.x</em> because

44)     it knows how to automatically report your obfsproxy address to <a
45)     href="https://bridges.torproject.org/?transport=obfs2">BridgeDB</a>.

46)     </p>
47) 

48)     <h3>Step 1: Install obfsproxy</h3>

49)     <br>
50) 
51)     <p>
52)     Since you installed the Tor APT repository, installing obfsproxy is now a matter of running a command:
53)     </p>

54) 
55)     <pre style="margin: 1.5em 0 1.5em 2em">

56) \# apt-get install obfsproxy

57)     </pre>
58) 

59)     <h3>Step 2: Configure Tor</h3>

60)     <br>
61) 
62)     <p>

63)     Edit your <i>/etc/tor/torrc</i> to add:

64)     </p>
65) 
66)     <pre style="margin: 1.5em 0 1.5em 2em">
67) SocksPort 0

68) ORPort 443 # or some other port if you already run a webserver/skype

69) BridgeRelay 1
70) Exitpolicy reject *:*
71) 

72) \## CHANGEME_1 -> provide a nickname for your bridge, can be anything you like

73) \#Nickname CHANGEME_1

74) \## CHANGEME_2 -> provide some email address so we can contact you if there's a problem

75) \#ContactInfo CHANGEME_2
76) 

77) ServerTransportPlugin obfs2,obfs3 exec /usr/bin/obfsproxy managed

78)     </pre>
79) 
80)     <p>

81)     Don't forget to uncomment and edit the <i>CHANGEME</i> fields!

82)     </p>
83) 

84)     <h3>Step 3: Launch Tor and verify that it bootstraps</h3>

85)     <br>
86) 
87)     <p>

88)     Restart Tor to use the new configuration file.
89)     (Preface with sudo if needed.)

90)     </p>
91) 
92)     <pre style="margin: 1.5em 0 1.5em 2em">

93) \# service tor restart

94)     </pre>
95) 
96)     <p>
97)     Now check <i>/var/log/tor/log</i> and you should see something
98)     like this:
99)     </p>
100) 
101)     <pre style="margin: 1.5em 0 1.5em 2em">
102) Nov 05 16:40:45.000 [notice] We now have enough directory information to build circuits.
103) Nov 05 16:40:45.000 [notice] Bootstrapped 80%: Connecting to the Tor network.
104) Nov 05 16:40:46.000 [notice] Bootstrapped 85%: Finishing handshake with first hop.
105) Nov 05 16:40:46.000 [notice] Bootstrapped 90%: Establishing a Tor circuit.
106) Nov 05 16:40:48.000 [notice] Tor has successfully opened a circuit. Looks like client functionality is working.
107) Nov 05 16:40:48.000 [notice] Bootstrapped 100%: Done.
108)     </pre>
109) 
110)     <p>

111)     If Tor is earlier in the bootstrapping phase, wait until it gets to

112)     100%.
113)     </p>
114) 

115)     <h3>Step 4: Set up port forwarding if needed</h3>
116)     <br>
117) 

118)     <p>

119)     If you're behind a NAT/firewall, you'll need to make your bridge
120)     reachable from the outside world — both on the ORPort and

121)     the obfsproxy ports. The ORPort is whatever you defined in step two
122)     above. To find your obfsproxy ports, check your Tor logs for a line

123)     similar to this one:
124)     </p>

125) 
126)     <pre style="margin: 1.5em 0 1.5em 2em">
127) Oct 05 20:00:41.000 [notice] Registered server transport 'obfs2' at '0.0.0.0:26821

128) Oct 05 20:00:41.000 [notice] Registered server transport 'obfs3' at '0.0.0.0:42000

129)     </pre>
130) 
131)     <p>

132)     The last number in each line, in this case <i>26821</i> and
133)     <i>42000</i>, is the TCP port number that you need to forward
134)     through your firewall. (The ports are randomly chosen the first
135)     time Tor starts, but Tor will cache and reuse the same number in
136)     future runs.) If you want to change the number, use Tor
137)     0.2.4.7-alpha or later, and set something similar to
138)     "ServerTransportListenAddr obfs2 0.0.0.0:26821" in your torrc.