doc/README.request_response_tracking

   1 1. Introduction
   2
   3 It is often useful to enhance dissectors for request/response style protocols
   4 to match requests with responses.
   5 This allows you to display useful information in the decode tree such as which
   6 requests are matched to which response and the response time for individual
   7 transactions.
   8
   9 This is also useful if you want to pass some data from the request onto the
  10 dissection of the actual response. The RPC dissector for example does
  11 something like this to pass the actual command opcode from the request onto
  12 the response dissector since the opcode itself is not part of the response
  13 packet and without the opcode we would not know how to decode the data.
  14
  15 It is also useful when you need to track information on a per conversation
  16 basis such as when some parameters are negotiated during a login phase of the
  17 protocol and when these parameters affect how future commands on that session
  18 are to be decoded. The iSCSI dissector does something similar to that to track
  19 which sessions that HeaderDigest is activated for and which ones it is not.
  20
  21 2. Implementation
  22
  23 The example below shows how simple this is to add to the dissector IF:
  24 1. there is something like a transaction id in the header,
  25 2. it is very unlikely that the transaction identifier is reused for the
  26    same conversation.
  27
  28 The example is taken from the PANA dissector:
  29
  30 First we need to include the definitions for conversations.
  31
  32         #include <epan/conversation.h>
  33
  34 Then we also need a few header fields to show the relations between request
  35 and response as well as the response time.
  36
  37         static int hf_pana_response_in;
  38         static int hf_pana_response_to;
  39         static int hf_pana_response_time;
  40
  41 We need a structure that holds all the information we need to remember
  42 between the request and the responses. One such structure will be allocated
  43 for each unique transaction.
  44 In the example we only keep the frame numbers of the request and the response
  45 as well as the timestamp for the request.
  46 But since this structure is persistent and also a unique one is allocated for
  47 each request/response pair, this is a good place to store other additional
  48 data you may want to keep track of from a request to a response.
  49
  50         typedef struct _pana_transaction_t {
  51                 uint32_t req_frame;
  52                 uint32_t rep_frame;
  53                 nstime_t req_time;
  54         } pana_transaction_t;
  55
  56 We also need a structure that holds persistent information for each
  57 conversation. A conversation is identified by SRC/DST address, protocol and
  58 SRC/DST port, see README.dissector, section 2.2.
  59 In this case we only want to have a hash table to track the actual
  60 transactions that occur for this unique conversation.
  61 Some protocols negotiate session parameters during a login phase and those
  62 parameters may affect how later commands on the same session is to be decoded,
  63 this would be a good place to store that additional info you may want to keep
  64 around.
  65
  66         typedef struct _pana_conv_info_t {
  67                 wmem_map_t *pdus;
  68         } pana_conv_info_t;
  69
  70 Finally for the meat of it, add the conversation and tracking code to the
  71 actual dissector.
  72
  73         ...
  74         uint32_t seq_num;
  75         conversation_t *conversation;
  76         pana_conv_info_t *pana_info;
  77         pana_transaction_t *pana_trans;
  78
  79         ...
  80         /* Get the transaction identifier */
  81         seq_num = tvb_get_ntohl(tvb, 8);
  82         ...
  83
  84         /*
  85          * We need to track some state for this protocol on a per conversation
  86          * basis so we can do neat things like request/response tracking
  87          */
  88         conversation = find_or_create_conversation(pinfo);
  89
  90         /*
  91          * Do we already have a state structure for this conv
  92          */
  93         pana_info = (pana_conv_info_t *)conversation_get_proto_data(conversation, proto_pana);
  94         if (!pana_info) {
  95                 /*
  96                  * No.  Attach that information to the conversation, and add
  97                  * it to the list of information structures.
  98                  */
  99                 pana_info = wmem_new(wmem_file_scope(), pana_conv_info_t);
 100                 pana_info->pdus=wmem_map_new(wmem_file_scope(), g_direct_hash, g_direct_equal);
 101
 102                 conversation_add_proto_data(conversation, proto_pana, pana_info);
 103         }
 104         if (!PINFO_FD_VISITED(pinfo)) {
 105                 if (flags&PANA_FLAG_R) {
 106                         /* This is a request */
 107                         pana_trans=wmem_new(wmem_file_scope(), pana_transaction_t);
 108                         pana_trans->req_frame = pinfo->num;
 109                         pana_trans->rep_frame = 0;
 110                         pana_trans->req_time = pinfo->fd->abs_ts;
 111                         wmem_map_insert(pana_info->pdus, GUINT_TO_POINTER(seq_num), (void *)pana_trans);
 112                 } else {
 113                         pana_trans=(pana_transaction_t *)wmem_map_lookup(pana_info->pdus, GUINT_TO_POINTER(seq_num));
 114                         if (pana_trans) {
 115                                 pana_trans->rep_frame = pinfo->num;
 116                         }
 117                 }
 118         } else {
 119                 pana_trans=(pana_transaction_t *)wmem_map_lookup(pana_info->pdus, GUINT_TO_POINTER(seq_num));
 120         }
 121         if (!pana_trans) {
 122                 /* create a "fake" pana_trans structure */
 123                 pana_trans=wmem_new(pinfo->pool, pana_transaction_t);
 124                 pana_trans->req_frame = 0;
 125                 pana_trans->rep_frame = 0;
 126                 pana_trans->req_time = pinfo->fd->abs_ts;
 127         }
 128
 129         /* print state tracking in the tree */
 130         if (flags&PANA_FLAG_R) {
 131                 /* This is a request */
 132                 if (pana_trans->rep_frame) {
 133                         proto_item *it;
 134
 135                         it = proto_tree_add_uint(pana_tree, hf_pana_response_in,
 136                                         tvb, 0, 0, pana_trans->rep_frame);
 137                         proto_item_set_generated(it);
 138                 }
 139         } else {
 140                 /* This is a reply */
 141                 if (pana_trans->req_frame) {
 142                         proto_item *it;
 143                         nstime_t ns;
 144
 145                         it = proto_tree_add_uint(pana_tree, hf_pana_response_to,
 146                                         tvb, 0, 0, pana_trans->req_frame);
 147                         proto_item_set_generated(it);
 148
 149                         nstime_delta(&ns, &pinfo->fd->abs_ts, &pana_trans->req_time);
 150                         it = proto_tree_add_time(pana_tree, hf_pana_response_time, tvb, 0, 0, &ns);
 151                         proto_item_set_generated(it);
 152                 }
 153         }
 154
 155 Then we just need to declare the hf fields we used.
 156
 157         { &hf_pana_response_in,
 158                 { "Response In", "pana.response_in",
 159                 FT_FRAMENUM, BASE_NONE, FRAMENUM_TYPE(FT_FRAMENUM_RESPONSE), 0x0,
 160                 "The response to this PANA request is in this frame", HFILL }
 161         },
 162         { &hf_pana_response_to,
 163                 { "Request In", "pana.response_to",
 164                 FT_FRAMENUM, BASE_NONE, FRAMENUM_TYPE(FT_FRAMENUM_REQUEST), 0x0,
 165                 "This is a response to the PANA request in this frame", HFILL }
 166         },
 167         { &hf_pana_response_time,
 168                 { "Response Time", "pana.response_time",
 169                 FT_RELATIVE_TIME, BASE_NONE, NULL, 0x0,
 170                 "The time between the Call and the Reply", HFILL }
 171         },