2ddd097da8be31947a8ac29400a7b11a42342940
[obnox/wireshark/wip.git] / epan / dissectors / packet-bt-dht.c
1 /******************************************************************************************************/
2 /* packet-bt-dht.c
3  * Routines for BT-DHT dissection
4  * Copyright 2011, Xiao Xiangquan <xiaoxiangquan@gmail.com>
5  *
6  * $Id$
7  *
8  * A plugin for BT-DHT packet:
9  *
10  * Wireshark - Network traffic analyzer
11  * By Gerald Combs <gerald@wireshark.org>
12  * Copyright 1999 Gerald Combs
13  *
14  * This program is free software; you can redistribute it and/or
15  * modify it under the terms of the GNU General Public License
16  * as published by the Free Software Foundation; either version 2
17  * of the License, or (at your option) any later version.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
27  */
28
29 #ifdef HAVE_CONFIG_H
30 #include "config.h"
31 #endif
32
33 #include <epan/packet.h>
34 #include <epan/conversation.h>
35
36 /* Specifications: BEP-0005
37  * http://www.bittorrent.org/beps/bep_0005.html
38  */
39
40 static int proto_bt_dht = -1;
41 static dissector_handle_t bt_dht_handle;
42
43 /* fields */
44 static int hf_bencoded_int = -1;
45 static int hf_bencoded_string = -1;
46 static int hf_bencoded_list = -1;
47 static int hf_bencoded_dict = -1;
48 static int hf_bencoded_dict_entry = -1;
49
50 static int hf_bt_dht_error = -1;
51 static int hf_bt_dht_peers = -1;
52 static int hf_bt_dht_peer = -1;
53 static int hf_bt_dht_nodes = -1;
54 static int hf_bt_dht_node = -1;
55 static int hf_bt_dht_id = -1;
56
57 static int hf_ip = -1;
58 static int hf_port = -1;
59 static int hf_truncated_data = -1;
60
61 /* tree types */
62 static gint ett_bt_dht = -1;
63 static gint ett_bencoded_list = -1;
64 static gint ett_bencoded_dict = -1;
65 static gint ett_bencoded_dict_entry = -1;
66 static gint ett_bt_dht_error = -1;
67 static gint ett_bt_dht_peers = -1;
68 static gint ett_bt_dht_nodes = -1;
69
70 /* some keys use short name in packet */
71 static const value_string short_key_name_value_string[] = {
72   { 'y', "message_type" },
73   { 'q', "request_type" },
74   { 'e', "error" },
75   { 't', "transaction ID" },
76   { 'v', "version" },
77   { 'a', "request arguments" },
78   { 'r', "response values" },
79   { 0, NULL }
80 };
81
82 /* some values use short name in packet */
83 static const value_string short_val_name_value_string[] = {
84   { 'q', "request" },
85   { 'r', "response" },
86   { 'e', "error" },
87   { 0, NULL }
88 };
89
90 static const char dict_str[] = "dictionary...";
91 static const char list_str[] = "list...";
92 /*
93  * dissect a bencoded string from tvb, start at offset. it's like "5:abcde"
94  * *result will be the decoded value
95  */
96 static int dissect_bencoded_string(tvbuff_t *tvb, packet_info _U_*pinfo, proto_tree *tree, guint offset, char **result, gboolean tohex, char *label )
97 {
98   guint string_len_start;
99   guint string_len;
100
101   string_len_start = offset;
102
103   while( tvb_get_guint8(tvb,offset) != ':' )
104     offset ++;
105
106   string_len = atoi( tvb_get_string(tvb,string_len_start,offset-string_len_start) );
107   /* skip the ':' */
108   offset++;
109
110   /* fill the return data */
111   if( tohex )
112     *result = tvb_bytes_to_str(tvb, offset, string_len );
113   else
114     *result = tvb_get_string( tvb, offset, string_len );
115
116   proto_tree_add_string_format( tree, hf_bencoded_string, tvb, offset, string_len, *result, "%s: %s", label, *result );
117   offset += string_len;
118   return offset;
119 }
120
121 /*
122  * dissect a bencoded integer from tvb, start at offset. it's like "i5673e"
123  * *result will be the decoded value
124  */
125 static int dissect_bencoded_int(tvbuff_t *tvb, packet_info _U_*pinfo, proto_tree *tree, guint offset, char **result, char *label )
126 {
127   guint start_offset;
128
129   start_offset = offset;
130
131   /* we has confirmed that the first byte is 'i' */
132   offset ++;
133
134   while( tvb_get_guint8(tvb,offset)!='e' )
135     offset ++;
136
137   *result = tvb_get_string( tvb, offset, offset-start_offset-1 );
138   proto_tree_add_string_format( tree, hf_bencoded_int, tvb, offset, offset-start_offset-1, *result,
139     "%s: %s", label, *result );
140
141   offset ++;
142   return offset;
143 }
144
145 /* pre definition of dissect_bencoded_dict(), which is needed by dissect_bencoded_list() */
146 static int dissect_bencoded_dict(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset, char *label );
147
148 /* dissect a bencoded list from tvb, start at offset. it's like "lXXXe", "X" is any bencoded thing */
149 static int dissect_bencoded_list(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset, char *label  )
150 {
151   proto_item *ti;
152   proto_tree *sub_tree;
153   guint one_byte;
154   char *result;
155
156   ti = proto_tree_add_none_format( tree, hf_bencoded_list, tvb, offset, 0, "%s: list...", label );
157   sub_tree = proto_item_add_subtree( ti, ett_bencoded_list);
158
159   /* skip the 'l' */
160   offset++;
161
162   while( (one_byte=tvb_get_guint8(tvb,offset)) != 'e' )
163   {
164     switch( one_byte )
165     {
166     /* a integer */
167     case 'i':
168       offset = dissect_bencoded_int( tvb, pinfo, sub_tree, offset, &result, "Integer" );
169       break;
170     /* a sub-list */
171     case 'l':
172       offset = dissect_bencoded_list( tvb, pinfo, sub_tree, offset, "Sub-list" );
173       break;
174     /* a dictionary */
175     case 'd':
176       offset = dissect_bencoded_dict( tvb, pinfo, sub_tree, offset, "Sub-dict" );
177       break;
178     /* a string */
179     default:
180       offset = dissect_bencoded_string( tvb, pinfo, sub_tree, offset, &result, FALSE, "String" );
181       break;
182     }
183   }
184   offset++;
185   return offset;
186 }
187
188 /* dissect a bt dht error from tvb, start at offset. it's like "li201e9:error msge" */
189 static int dissect_bt_dht_error(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset, char **result, char *label )
190 {
191   proto_item *ti;
192   proto_tree *sub_tree;
193   char *error_no, *error_msg;
194
195   error_no = NULL;
196   error_msg = NULL;
197
198   ti = proto_tree_add_item( tree, hf_bt_dht_error, tvb, offset, 0, ENC_NA );
199   sub_tree = proto_item_add_subtree( ti, ett_bt_dht_error);
200
201   /* we have confirmed that the first byte is 'l' */
202   offset ++;
203
204   /* dissect bt-dht error number and message */
205   offset = dissect_bencoded_int( tvb, pinfo, sub_tree, offset, &error_no, "Error ID" );
206   offset = dissect_bencoded_string( tvb, pinfo, sub_tree, offset, &error_msg, FALSE, "Error Message" );
207
208   proto_item_set_text( ti, "%s: error %s, %s", label, error_no, error_msg );
209   col_append_fstr( pinfo->cinfo, COL_INFO, "error_no=%s  error_msg=%s  ", error_no, error_msg );
210   *result = ep_strdup_printf("error %s, %s", error_no, error_msg );
211
212   return offset;
213 }
214
215 /* dissect a bt dht values list from tvb, start at offset. it's like "l6:....6:....e" */
216 static int dissect_bt_dht_values(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset, char **result, char *label )
217 {
218   proto_item *ti;
219   proto_tree *sub_tree;
220   proto_item *value_ti;
221   proto_tree *value_tree;
222   address addr;
223
224   guint peer_index;
225   guint string_len_start;
226   guint string_len;
227   guint16 port;
228
229   ti = proto_tree_add_item( tree, hf_bt_dht_peers, tvb, offset, 0, ENC_NA );
230   sub_tree = proto_item_add_subtree( ti, ett_bt_dht_peers);
231
232   peer_index = 0;
233   /* we has confirmed that the first byte is 'l' */
234   offset ++;
235
236   /* dissect bt-dht values */
237   while( tvb_get_guint8(tvb,offset)!='e' )
238   {
239     string_len_start = offset;
240     while( tvb_get_guint8(tvb,offset) != ':' )
241       offset ++;
242
243     string_len = atoi( tvb_get_string(tvb,string_len_start,offset-string_len_start) );
244     /* skip the ':' */
245     offset++;
246     /* 4 bytes ip, 2 bytes port */
247     for( ; string_len>=6; string_len-=6, offset+=6 )
248     {
249       peer_index ++;
250       SET_ADDRESS( &addr, AT_IPv4, 4, tvb_get_ptr( tvb, offset, 4) );
251       port = tvb_get_letohl( tvb, offset+4 );
252
253       value_ti = proto_tree_add_none_format( sub_tree, hf_bt_dht_peer, tvb, offset, 6,
254           "%d\t%s:%u", peer_index, ep_address_to_str( &addr ), port );
255       value_tree = proto_item_add_subtree( value_ti, ett_bt_dht_peers);
256
257       proto_tree_add_item( value_tree, hf_ip, tvb, offset, 4, ENC_BIG_ENDIAN);
258       proto_tree_add_item( value_tree, hf_port, tvb, offset+4, 2, ENC_BIG_ENDIAN);
259     }
260     /* truncated data */
261     if( string_len>0 )
262     {
263       proto_tree_add_item( tree, hf_truncated_data, tvb, offset, string_len, ENC_NA );
264       offset += string_len;
265     }
266   }
267   proto_item_set_text( ti, "%s: %d peers", label, peer_index );
268   col_append_fstr( pinfo->cinfo, COL_INFO, "reply=%d peers  ", peer_index );
269   *result = ep_strdup_printf("%d peers", peer_index);
270
271   return offset;
272 }
273
274 static int dissect_bt_dht_nodes(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset, char **result, char *label )
275 {
276   proto_item *ti;
277   proto_tree *sub_tree;
278   proto_item *node_ti;
279   proto_tree *node_tree;
280
281   guint node_index;
282   guint string_len_start;
283   guint string_len;
284   address addr;
285   guint16 port;
286   guint8 *id;
287
288   ti = proto_tree_add_item( tree, hf_bt_dht_nodes, tvb, offset, 0, ENC_NA );
289   sub_tree = proto_item_add_subtree( ti, ett_bt_dht_nodes);
290   node_index = 0;
291
292   string_len_start = offset;
293   while( tvb_get_guint8(tvb,offset) != ':' )
294     offset ++;
295
296   string_len = atoi( tvb_get_string(tvb,string_len_start,offset-string_len_start) );
297   /* skip the ':' */
298   offset++;
299
300   /* 20 bytes id, 4 bytes ip, 2 bytes port */
301   for( ; string_len>=26; string_len-=26, offset+=26 )
302   {
303     node_index++;
304
305     id = tvb_bytes_to_str(tvb, offset, 20 );
306     SET_ADDRESS( &addr, AT_IPv4, 4, tvb_get_ptr( tvb, offset, 4) );
307     port = tvb_get_letohl( tvb, offset+24 );
308
309     node_ti = proto_tree_add_none_format( sub_tree, hf_bt_dht_node, tvb, offset, 26,
310         "%d\t%s %s:%u", node_index, id, ep_address_to_str( &addr ), port );
311     node_tree = proto_item_add_subtree( node_ti, ett_bt_dht_peers);
312
313     proto_tree_add_item( node_tree, hf_bt_dht_id, tvb, offset, 20, ENC_NA);
314     proto_tree_add_item( node_tree, hf_ip, tvb, offset+20, 4, ENC_BIG_ENDIAN);
315     proto_tree_add_item( node_tree, hf_port, tvb, offset+24, 2, ENC_BIG_ENDIAN);
316   }
317   if( string_len>0 )
318   {
319     proto_tree_add_item( tree, hf_truncated_data, tvb, offset, string_len, ENC_NA );
320     offset += string_len;
321   }
322   proto_item_set_text( ti, "%s: %d nodes", label, node_index );
323   col_append_fstr( pinfo->cinfo, COL_INFO, "reply=%d nodes  ", node_index );
324   *result = ep_strdup_printf("%d", node_index);
325
326   return offset;
327 }
328
329 static int dissect_bencoded_dict_entry(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset )
330 {
331   proto_item *ti;
332   proto_tree *sub_tree;
333   gboolean tohex;
334   char *key, *val;
335
336   key = NULL;
337   val = NULL;
338
339   ti = proto_tree_add_item( tree, hf_bencoded_dict_entry, tvb, offset, 0, ENC_NA );
340   sub_tree = proto_item_add_subtree( ti, ett_bencoded_dict_entry);
341
342   /* dissect the key, it must be a string */
343   offset = dissect_bencoded_string( tvb, pinfo, sub_tree, offset, &key, FALSE, "Key" );
344
345   /* it is a dict, just recursion */
346   switch( tvb_get_guint8(tvb,offset) )
347   {
348   case 'd':
349     offset = dissect_bencoded_dict( tvb, pinfo, sub_tree, offset, "Value" );
350     val = (char*)dict_str;
351     break;
352   case 'l':
353     if( strcmp(key,"e")==0 )
354       offset = dissect_bt_dht_error( tvb, pinfo, sub_tree, offset, &val, "Value" );
355     else if( strcmp(key,"values")==0 )
356       offset = dissect_bt_dht_values( tvb, pinfo, sub_tree, offset, &val, "Value" );
357     /* other unfamiliar lists */
358     else
359     {
360       offset = dissect_bencoded_list( tvb, pinfo, sub_tree, offset, "Value" );
361       val = (char*)list_str;
362     }
363     break;
364   case 'i':
365     offset = dissect_bencoded_int( tvb, pinfo, sub_tree, offset, &val, "Value" );
366     break;
367   /* it's a string */
368   default:
369     /* special process */
370   if( strcmp(key,"nodes")==0 )
371       offset = dissect_bt_dht_nodes( tvb, pinfo, sub_tree, offset, &val, "Value" );
372   /* some need to return hex string */
373     else
374     {
375       tohex = strcmp(key,"id")==0 || strcmp(key,"target")==0
376            || strcmp(key,"info_hash")==0 || strcmp(key,"t")==0
377            || strcmp(key,"v")==0;
378       offset = dissect_bencoded_string( tvb, pinfo, sub_tree, offset, &val, tohex, "Value" );
379     }
380   }
381
382   if( strlen(key)==1 )
383     key = (char*)val_to_str( key[0], short_key_name_value_string, key );
384   if( strlen(val)==1 )
385     val = (char*)val_to_str( val[0], short_val_name_value_string, val );
386
387   proto_item_set_text( ti, "%s: %s", key, val );
388
389   if( strcmp(key,"message_type")==0 || strcmp(key,"request_type")==0 )
390     col_append_fstr(pinfo->cinfo, COL_INFO, "%s=%s  ", key, val);
391
392   return offset;
393 }
394
395 /* dict = d...e */
396 static int dissect_bencoded_dict(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, guint offset, char *label )
397 {
398   proto_item *ti;
399   proto_tree *sub_tree;
400
401   ti = proto_tree_add_none_format( tree, hf_bencoded_dict, tvb, offset, 0, "%s: dictionary...", label );
402   sub_tree = proto_item_add_subtree( ti, ett_bencoded_dict);
403
404   /* skip the first char('d') */
405   offset ++;
406
407   while( tvb_get_guint8(tvb,offset)!='e' )
408     offset = dissect_bencoded_dict_entry( tvb, pinfo, sub_tree, offset );
409
410   offset++;
411   return offset;
412 }
413
414 static void dissect_bt_dht(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
415 {
416   col_set_str(pinfo->cinfo, COL_PROTOCOL, "BT-DHT");
417   col_clear(pinfo->cinfo, COL_INFO);
418   if( tree )
419     dissect_bencoded_dict(tvb, pinfo, tree, 0, "BT-DHT Protocol" );
420 }
421
422 static gboolean test_bt_dht_packet (tvbuff_t *tvb, packet_info *pinfo,
423                                         proto_tree *tree)
424 {
425    conversation_t *conversation;
426
427   /* try dissecting */
428   if( tvb_get_guint8(tvb,0)=='d' )
429   {
430       conversation = find_or_create_conversation(pinfo);
431       conversation_set_dissector(conversation, bt_dht_handle);
432
433       dissect_bt_dht(tvb, pinfo, tree);
434       return TRUE;
435    }
436    return FALSE;
437 }
438
439 void proto_register_bt_dht(void)
440 {
441   static hf_register_info hf[] = {
442     { &hf_bencoded_string,
443       { "string", "bt-dht.bencoded.string",
444         FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL }
445     },
446     { &hf_bencoded_list,
447       { "list", "bt-dht.bencoded.list",
448         FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }
449     },
450     { &hf_bencoded_int,
451       { "int", "bt-dht.bencoded.int",
452         FT_STRING, BASE_NONE, NULL, 0x0, NULL, HFILL }
453     },
454     { &hf_bencoded_dict,
455       { "dictionary", "bt-dht.bencoded.dict",
456         FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }
457     },
458     { &hf_bencoded_dict_entry,
459       { "dictionary entry", "bt-dht.bencoded.dict_entry",
460         FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }
461     },
462     { &hf_bt_dht_error,
463       { "Error", "bt-dht.error",
464         FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }
465     },
466     { &hf_bt_dht_peer,
467       { "peer", "bt-dht.peer",
468         FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }
469     },
470     { &hf_bt_dht_peers,
471       { "Peers", "bt-dht.peers",
472         FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }
473     },
474     { &hf_bt_dht_node,
475       { "Node", "bt-dht.node",
476         FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }
477     },
478     { &hf_bt_dht_nodes,
479       { "Nodes", "bt-dht.nodes",
480         FT_NONE, BASE_NONE, NULL, 0x0, NULL, HFILL }
481     },
482     { &hf_bt_dht_id,
483       { "id", "bt-dht.id",
484         FT_BYTES, BASE_NONE, NULL, 0x0, NULL, HFILL }
485     },
486     { &hf_ip,
487       { "ip", "bt-dht.ip",
488         FT_IPv4, BASE_NONE, NULL, 0x0, NULL, HFILL }
489     },
490     { &hf_port,
491       { "port", "bt-dht.port",
492         FT_UINT16, BASE_DEC, NULL, 0x0, NULL, HFILL }
493     },
494     { &hf_truncated_data,
495       { "truncated data", "bt-dht.truncated_data",
496         FT_BYTES, BASE_NONE, NULL, 0x0, NULL, HFILL }
497     }
498   };
499
500   /* Setup protocol subtree array */
501   static gint *ett[] = {
502     &ett_bt_dht,
503     &ett_bencoded_list,
504     &ett_bencoded_dict,
505     &ett_bt_dht_error,
506     &ett_bt_dht_peers,
507     &ett_bt_dht_nodes,
508     &ett_bencoded_dict_entry
509   };
510
511   proto_bt_dht = proto_register_protocol (
512     "Bittorrent DHT Protocol",  /* name */
513     "BT-DHT",                   /* short name */
514     "bt-dht"                    /* abbrev */
515   );
516
517   proto_register_field_array(proto_bt_dht, hf, array_length(hf));
518   proto_register_subtree_array(ett, array_length(ett));
519 }
520
521 void proto_reg_handoff_bt_dht(void)
522 {
523   heur_dissector_add("udp", test_bt_dht_packet, proto_bt_dht);
524 }
525