docs/extension_protocol.rst

   1 :Author: Arvid Norberg, arvid@rasterbar.com
   2          Ludvig Strigeus, ludde@utorrent.com
   3
   4 extension protocol for bittorrent
   5 =================================
   6
   7 The intention of this protocol is to provide a simple and thin transport
   8 for extensions to the bittorrent protocol. Supporting this protocol makes
   9 it easy to add new extensions without interfering with the standard
  10 bittorrent protocol or clients that don't support this extension or the
  11 one you want to add.
  12
  13 To advertise to other clients that you support, one bit from the reserved
  14 bytes is used.
  15
  16 The bit selected for the extension protocol is bit 20 from the right (counting
  17 starts at 0). So (reserved_byte[5] & 0x10) is the expression to use for checking
  18 if the client supports extended messaging.
  19
  20 Once support for the protocol is established, the client is supposed to
  21 support 1 new message:
  22
  23 +------------------------+----+
  24 |name                    | id |
  25 +========================+====+
  26 |``extended``            | 20 |
  27 +------------------------+----+
  28
  29 This message is sent as any other bittorrent message, with a 4 byte length
  30 prefix and a single byte identifying the message (the single byte being 20
  31 in this case). At the start of the payload of the message, is a single byte
  32 message identifier. This identifier can refer to different extension messages
  33 and only one ID is specified, 0. If the ID is 0, the message is a handshake
  34 message which is described below. The layout of a general ``extended`` message
  35 follows (including the message headers used by the bittorrent protocol):
  36
  37 +----------+---------------------------------------------------------+
  38 | size     | description                                             |
  39 +==========+=========================================================+
  40 | uint32_t | length prefix. Specifies the number of bytes for the    |
  41 |          | entire message. (Big endian)                            |
  42 +----------+---------------------------------------------------------+
  43 | uint8_t  | bittorrent message ID, = 20                             |
  44 +----------+---------------------------------------------------------+
  45 | uint8_t  | extended message ID. 0 = handshake, >0 = extended       |
  46 |          | message as specified by the handshake.                  |
  47 +----------+---------------------------------------------------------+
  48
  49
  50 handshake message
  51 -----------------
  52
  53 The payload of the handshake message is a bencoded dictionary. All items
  54 in the dictionary are optional. Any unknown names should be ignored
  55 by the client. All parts of the dictionary are case sensitive.
  56 This is the defined item in the dictionary:
  57
  58 +-------+-----------------------------------------------------------+
  59 | name  | description                                               |
  60 +=======+===========================================================+
  61 | m     | Dictionary of supported extension messages which maps     |
  62 |       | names of extensions to an extended message ID for each    |
  63 |       | extension message. The only requirement on these IDs      |
  64 |       | is that no extension message share the same one. Setting  |
  65 |       | an extension number to zero means that the extension is   |
  66 |       | not supported/disabled. The client should ignore any      |
  67 |       | extension names it doesn't recognize.                     |
  68 |       |                                                           |
  69 |       | The extension message IDs are the IDs used to send the    |
  70 |       | extension messages to the peer sending this handshake.    |
  71 |       | i.e. The IDs are local to this particular peer.           |
  72 +-------+-----------------------------------------------------------+
  73
  74
  75 Here are some other items that an implementation may choose to support:
  76
  77 +--------+-----------------------------------------------------------+
  78 | name   | description                                               |
  79 +========+===========================================================+
  80 | p      | Local TCP listen port. Allows each side to learn about    |
  81 |        | the TCP port number of the other side. Note that there is |
  82 |        | no need for the receiving side of the connection to send  |
  83 |        | this extension message, since its port number is already  |
  84 |        | known.                                                    |
  85 +--------+-----------------------------------------------------------+
  86 | v      | Client name and version (as a utf-8 string).              |
  87 |        | This is a much more reliable way of identifying the       |
  88 |        | client than relying on the peer id encoding.              |
  89 +--------+-----------------------------------------------------------+
  90 | yourip | A string containing the compact representation of the ip  |
  91 |        | address this peer sees you as. i.e. this is the           |
  92 |        | receiver's external ip address (no port is included).     |
  93 |        | This may be either an IPv4 (4 bytes) or an IPv6           |
  94 |        | (16 bytes) address.                                       |
  95 +--------+-----------------------------------------------------------+
  96 | ipv6   | If this peer has an IPv6 interface, this is the compact   |
  97 |        | representation of that address (16 bytes). The client may |
  98 |        | prefer to connect back via the IPv6 address.              |
  99 +--------+-----------------------------------------------------------+
 100 | ipv4   | If this peer has an IPv4 interface, this is the compact   |
 101 |        | representation of that address (4 bytes). The client may  |
 102 |        | prefer to connect back via this interface.                |
 103 +--------+-----------------------------------------------------------+
 104 | reqq   | An integer, the number of outstanding request messages    |
 105 |        | this client supports without dropping any. The default in |
 106 |        | in libtorrent is 250.                                     |
 107 +--------+-----------------------------------------------------------+
 108
 109 The handshake dictionary could also include extended handshake
 110 information, such as support for encrypted headers or anything
 111 imaginable.
 112
 113 An example of what the payload of a handshake message could look like:
 114
 115 +------------------------------------------------------+
 116 | Dictionary                                           |
 117 +===================+==================================+
 118 | ``m``             |  +--------------------------+    |
 119 |                   |  | Dictionary               |    |
 120 |                   |  +======================+===+    |
 121 |                   |  | ``LT_metadata``      | 1 |    |
 122 |                   |  +----------------------+---+    |
 123 |                   |  | ``ut_pex``           | 2 |    |
 124 |                   |  +----------------------+---+    |
 125 |                   |                                  |
 126 +-------------------+----------------------------------+
 127 | ``p``             | 6881                             |
 128 +-------------------+----------------------------------+
 129 | ``v``             | "µTorrent 1.2"                   |
 130 +-------------------+----------------------------------+
 131
 132 and in the encoded form:
 133
 134 ``d1:md11:LT_metadatai1e6:µT_PEXi2ee1:pi6881e1:v13:\xc2\xb5Torrent 1.2e``
 135
 136 To make sure the extension names do not collide by mistake, they should be
 137 prefixed with the two (or one) character code that is used to identify the
 138 client that introduced the extension. This applies for both the names of
 139 extension messages, and for any additional information put inside the
 140 top-level dictionary. All one and two byte identifiers are invalid to use
 141 unless defined by this specification.
 142
 143 This message should be sent immediately after the standard bittorrent handshake
 144 to any peer that supports this extension protocol. It is valid to send the
 145 handshake message more than once during the lifetime of a connection,
 146 the sending client should not be disconnected. An implementation may choose
 147 to ignore the subsequent handshake messages (or parts of them).
 148
 149 Subsequent handshake messages can be used to enable/disable extensions
 150 without restarting the connection. If a peer supports changing extensions
 151 at run time, it should note that the ``m`` dictionary is additive.
 152 It's enough that it contains the actual *CHANGES* to the extension list.
 153 To disable the support for ``LT_metadata`` at run-time, without affecting
 154 any other extensions, this message should be sent:
 155 ``d11:LT_metadatai0ee``.
 156 As specified above, the value 0 is used to turn off an extension.
 157
 158 The extension IDs must be stored for every peer, becuase every peer may have
 159 different IDs for the same extension.
 160
 161 This specification, deliberately, does not specify any extensions such as
 162 peer-exchange or metadata exchange. This protocol is merely a transport
 163 for the actual extensions to the bittorrent protocol and the extensions
 164 named in the example above (such as ``p``) are just examples of possible
 165 extensions.
 166
 167 rationale
 168 ---------
 169
 170 The reason why the extension messages' IDs would be defined in the handshake
 171 is to avoid having a global registry of message IDs. Instead the names of the
 172 extension messages requires unique names, which is much easier to do without
 173 a global registry. The convention is to use a two letter prefix on the
 174 extension message names, the prefix would identify the client first
 175 implementing the extension message. e.g. ``LT_metadata`` is implemented by
 176 libtorrent, and hence it has the ``LT`` prefix.
 177
 178 If the client supporting the extensions can decide which numbers the messages
 179 it receives will have, it means they are constants within that client. i.e.
 180 they can be used in ``switch`` statements. It's easy for the other end to
 181 store an array with the ID's we expect for each message and use that for
 182 lookups each time it sends an extension message.
 183
 184 The reason for having a dictionary instead of having an array (using
 185 implicitly assigned index numbers to the extensions) is that if a client
 186 want to disable some extensions, the ID numbers would change, and it wouldn't
 187 be able to use constants (and hence, not use them in a ``switch``). If the
 188 messages IDs would map directly to bittorrent message IDs, It would also make
 189 it possible to map extensions in the handshake to existing extensions with
 190 fixed message IDs.
 191
 192 The reasoning behind having a single byte as extended message identifier is
 193 to follow the the bittorrent spec. with its single byte message identifiers.
 194 It is also considered to be enough. It won't limit the total number of
 195 extensions, only the number of extensions used simultaneously.
 196
 197 The reason for using single byte identifiers for the standardized handshake
 198 identifiers is 1) The mainline DHT uses single byte identifiers. 2) Saves
 199 bandwidth. The only advantage of longer messages is that it makes the
 200 protocol more readable for a human, but the BT protocol wasn't designed to
 201 be a human readable protocol, so why bother.
 202