* Encrypted (obfuscated) handshake and connection support. Patch by

Josef Drexler, public domain as per earlier agreement.


git-svn-id: svn://rakshasa.no/libtorrent/trunk/rtorrent@790 e378c898-3ddf-0310-93e7-cc216c733640

doc/rtorrent.1

@@ -3,7 +3,7 @@
 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
 .\" Please send any bug reports, improvements, comments, patches, 
 .\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "RTORRENT" "1" "11 October 2006" "BitTorrent client for ncurses" ""
+.TH "RTORRENT" "1" "14 October 2006" "BitTorrent client for ncurses" ""
 
 .SH NAME
 rtorrent \- a BitTorrent client for ncurses
@@ -229,6 +229,22 @@ Add a preferred filename encoding to the list. The encodings are
 attempted in the order they are inserted, if none match the torrent
 default is used.
 .TP
+\fBencryption_options = \fIoption\fB,\fI\&...\fB\fR
+Set how rtorrent should deal with encrypted Bittorrent connections. By
+default, encryption is disabled, equivalent to specifying the option
+\fBnone\fR\&. Alternatively, any number of the following
+options may be specified:
+
+\fBallow_incoming\fR (allow incoming encrypted connections), 
+\fBtry_outgoing\fR (use encryption for outgoing connections),
+\fBrequire\fR (disable unencrypted handshakes), 
+\fBrequire_RC4\fR (also disable plaintext transmission after the
+initial encrypted handshake),
+\fBenable_retry\fR (if the initial outgoing connection fails, retry
+with encryption turned on if it was off or off if it was on), 
+\fBprefer_plaintext\fR (choose plaintext when peer offers a choice 
+between plaintext transmission and RC4 encryption, otherwise RC4 will be used).
+.TP
 \fBschedule = \fIid\fB,\fIstart\fB,\fIinterval\fB,\fIcommand\fB\fR
 Call \fBcommand\fR every \fBinterval\fR
 seconds, starting from \fBstart\fR\&. An
@@ -408,6 +424,10 @@ logged at the moment, although disabling it will work as expected.
 Change the TOS of peer connections, by default set to
 \fBthroughput\fR\&. If the option is set to
 \fBdefault\fR then the system default TOS is used.
+.TP
+\fBhandshake_log = \fIyes\fB\fR
+Enable logging of the peer handshake. This generates a large number of
+log messages, but may be useful to debug connection problems.
 .SH "AUTHORS"
 .PP
 

doc/rtorrent.1.xml

@@ -518,6 +518,30 @@ default is used.
         </para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term>encryption_options = <replaceable>option</replaceable>,<replaceable>...</replaceable></term>
+        <listitem><para>
+
+Set how rtorrent should deal with encrypted Bittorrent connections. By
+default, encryption is disabled, equivalent to specifying the option
+<emphasis>none</emphasis>. Alternatively, any number of the following
+options may be specified:
+
+        </para><para>
+
+<emphasis>allow_incoming</emphasis> (allow incoming encrypted connections), 
+<emphasis>try_outgoing</emphasis> (use encryption for outgoing connections),
+<emphasis>require</emphasis> (disable unencrypted handshakes), 
+<emphasis>require_RC4</emphasis> (also disable plaintext transmission after the
+initial encrypted handshake),
+<emphasis>enable_retry</emphasis> (if the initial outgoing connection fails, retry
+with encryption turned on if it was off or off if it was on), 
+<emphasis>prefer_plaintext</emphasis> (choose plaintext when peer offers a choice 
+between plaintext transmission and RC4 encryption, otherwise RC4 will be used).
+
+        </para></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term>schedule = <replaceable>id</replaceable>,<replaceable>start</replaceable>,<replaceable>interval</replaceable>,<replaceable>command</replaceable></term>
         <listitem><para>
@@ -875,6 +899,16 @@ Change the TOS of peer connections, by default set to
         </para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term>handshake_log = <replaceable>yes</replaceable></term>
+        <listitem><para>
+
+Enable logging of the peer handshake. This generates a large number of
+log messages, but may be useful to debug connection problems.
+
+        </para></listitem>
+      </varlistentry>
+
     </variablelist>
 
   </refsect1>

doc/rtorrent.rc

@@ -65,6 +65,15 @@
 #schedule = ip_tick,0,1800,ip=rakshasa
 #schedule = bind_tick,0,1800,bind=rakshasa
 
+# Encryption options, set to none (default) or any combination of the following:
+# allow_incoming, try_outgoing, require, require_RC4, enable_retry, prefer_plaintext
+#
+# The example value allows incoming encrypted connections, starts unencrypted
+# outgoing connections but retries with encryption if they fail, preferring
+# plaintext to RC4 encryption after the encrypted handshake
+#
+# encryption_options = allow_incoming,enable_retry,prefer_plaintext
+
 #
 # Do not modify the following parameters unless you know what you're doing.
 #