tor-webwml.git

1) ## translation metadata
2) # Revision: $Revision$
3) # Translation-Priority: 4-optional
4) 
5) #include "head.wmi" TITLE="obfsproxy: Installation instructions" 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">Obfsproxy Instructions</h1>

18) 

19)     <img src="$(IMGROOT)/obfsproxy_diagram.png" alt="client torrc"></a>
20) 

21)     <h3>Step 1: Install dependencies, obfsproxy, and Tor</h3>

22)     <br>
23) 
24)     <p>

25)     You will need a C compiler (<em>gcc</em>), the <em>autoconf</em>
26)     and <em>autotools</em> build system, the <em>git</em> revision
27)     control system, <em>pkg-config</em> and <em>libtool</em>,
28)     <em>libevent-2</em> and its headers, and the development headers of

29)     <em>OpenSSL</em>.
30)      </p>
31) 
32)     <p>

33)     On Debian testing or Ubuntu oneiric, you could do: <br>
34)     <tt># apt-get install autoconf autotools-dev gcc git pkg-config libtool libevent-2.0-5 libevent-dev libevent-openssl-2.0-5 libssl-dev</tt>
35)     </p>
36) 

37)     <p>
38)     If you're on a more stable Linux, you can either <a

39)     href="https://trac.torproject.org/projects/tor/ticket/5009#comment:9">try

40)     our experimental backport libevent2 debs</a> or <a
41)     href="https://trac.torproject.org/projects/tor/ticket/5009#comment:17">build
42)     libevent2 from source</a>.

43)     </p>
44) 
45)     <p>
46)     Clone obfsproxy from its git repository:<br>

47)     <tt>$ git clone https://git.torproject.org/obfsproxy.git</tt> <br>

48) 
49)     The above command should create and populate a directory named

50)     'obfsproxy' in your current directory.
51)     </p>

52) 
53)     <p>
54)     Compile obfsproxy: <br>
55)     <tt>$ cd obfsproxy</tt> <br>
56)     <tt>$ ./autogen.sh && ./configure && make</tt> <br>
57)     </p>
58) 
59)     <p>

60)     Optionally, <strong>as root</strong> install obfsproxy in your
61)     system: <br>

62)     <tt># make install</tt>
63)     </p>
64) 

65)     <p>
66)     If you prefer not to install obfsproxy as root, you can instead
67)     just modify the Transport lines in your torrc file (explained below)
68)     to point to your obfsproxy binary.
69)     </p>
70) 

71)     <p>

72)     You will need Tor 0.2.3.11-alpha or later.

73)     </p>
74) 

75)     <hr>

76) 

77)     <h3 id="client_instructions">Step 2a: If you're the client...</h3>

78)     <br>
79) 
80)     <p>

81)     First, you need to learn the address of a bridge that supports
82)     obfsproxy. If you don't know any, try asking a friend to set one
83)     up for you. Then the appropriate lines to your <a href="<page
84)     docs/faq>#torrc">tor configuration file</a>:

85)     </p>
86) 

87)     <p>

88)     <tt>UseBridges 1</tt> <br>
89)     <tt>Bridge obfs2 128.31.0.34:1051</tt> <br>
90)     <tt>ClientTransportPlugin obfs2 exec /usr/local/bin/obfsproxy --managed</tt>

91)     </p>
92) 
93)     <p>

94)     Don't forget to replace <em>128.31.0.34:1051</em> with the IP address

95)     and port that the bridge's obfsproxy is listening on.

96)     </p>
97) 
98)     <p> <br>
99)     <img src="$(IMGROOT)/sidenav-arrow.png">
100)     <strong>Congratulations!</strong> Your traffic should now be
101)     obfuscated by obfsproxy. You are done! You can now start using Tor.
102)     </p>
103) 
104)     <br> <br> <br> <br>
105) 
106)     <hr>
107) 
108)     <br> <br> <br> <br>
109) 

110)     <h3 id="bridge_instructions">Step 2b: If you're the bridge...</h3>

111)     <br>
112) 
113)     <p>

114)     Configure your Tor to <a href="<page docs/bridges>#RunningABridge">be
115)     a bridge</a> (e.g. by setting "ORPort 9001" and "BridgeRelay 1"). Then
116)     add this new line to your <a href="<page docs/faq>#torrc">tor

117)     configuration file</a>:

118)     </p>
119) 
120)     <p>

121)     <tt>ServerTransportPlugin obfs2 exec /usr/local/bin/obfsproxy --managed</tt>

122)     </p>
123) 
124)     <p>

125)     Launch Tor using this configuration file. You can do this by using
126)     your favorite init script, or by pointing the Tor binary to the
127)     torrc file:

128)     <p>
129) 
130)     <p>

131)     <img src="$(IMGROOT)/obfs-spawn_tor_bridge.png" alt="spawn tor" height="117" width="879"></a>

132)     </p>
133) 
134)     <p>

135)     Next, find the TCP port opened by obfsproxy. Look in your log file

136)     for a line similar to this one: <br>

137)     <img src="$(IMGROOT)/obfs-log_checking.png" alt="bridge torrc" width="437" height="14"></a>
138)     <br>
139)     The last number, in this case <em>34545</em>, is the TCP port
140)     number that your clients should point their obfsproxy to.
141)     </p>
142) 
143)     <p>
144)     <img src="$(IMGROOT)/sidenav-arrow.png">
145)     <strong>Congratulations!</strong> Tell your clients to point their

146)     obfsproxy to your IP address and to port <em>34545</em>.