example/diameter/pcapDecoder/tsharkDecoder.sh

   1 #!/bin/bash
   2
   3 # ANNA - Anna is Not Nothingness Anymore
   4 #
   5 # (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   6 #
   7 # http://redmine.teslayout.com/projects/anna-suite
   8 #
   9 # Redistribution and use in source and binary forms, with or without
  10 # modification, are permitted provided that the following conditions
  11 # are met:
  12 #
  13 #     * Redistributions of source code must retain the above copyright
  14 # notice, this list of conditions and the following disclaimer.
  15 #     * Redistributions in binary form must reproduce the above
  16 # copyright notice, this list of conditions and the following disclaimer
  17 # in the documentation and/or other materials provided with the
  18 # distribution.
  19 #     *  Neither the name of the copyright holder nor the names of its
  20 # contributors may be used to endorse or promote products derived from
  21 # this software without specific prior written permission.
  22 #
  23 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  26 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  29 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  30 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34 #
  35 # Authors: eduardo.ramos.testillano@gmail.com
  36 #          cisco.tierra@gmail.com
  37
  38
  39 # Decoder version using tshark tool
  40 #
  41 # RESTRICTIONS: TCP & SCTP datagrams. Allow split diameter messages between frames, but not, several messages into single datagram.
  42 #               If sniffing fails, try to create the <frame>.hex and <frame>.metadata files manually (try 'tshark -nr input.pcap -Vx' and so on ...)
  43
  44 #############
  45 # VARIABLES #
  46 #############
  47 tmpdir=$(mktemp -d)
  48 TSHARK=tshark
  49
  50 #############
  51 # FUNCTIONS #
  52 #############
  53
  54 usage() {
  55   echo
  56   echo "Usage: $0 [-h|--help] [-o|--other-ports <list>] [-d|--results-dir <dir>] [-s|--sids <file>] <pcap>"
  57   echo
  58   echo "       -h|--help:                this usage help."
  59   echo "       -o|--other-ports <list>:  space-separated list of ports which frames"
  60   echo "                                 will be decoded as diameter protocol although"
  61   echo "                                 not being standard. For example, we could use"
  62   echo "                                 \"13868\" to disect the Ericsson Sy variant."
  63   echo "       -d|--results-dir <dir>:   directory where results are stored."
  64   echo "                                 By default, pcap dirname."
  65   echo "       -s|--sids <file>:         file containing a list of Session-Id values"
  66   echo "                                 (one per line) to be taken into account."
  67   echo "                                 If missing, all the frames will be extracted."
  68   echo
  69   echo "       pcap:                     pcap formatted file to be processed."
  70   echo
  71   echo "       The utility, dumps the extracted hexadecimal content and useful information"
  72   echo "       (timestamps, source, destination, etc.) within a metadata file:"
  73   echo
  74   echo "          <results directory>/<frame sequence>.hex"
  75   echo "          <results directory>/<frame sequence>.metadata"
  76   echo
  77   _exit
  78 }
  79
  80 parse_arguments() {
  81   OTHER_PORTS=
  82   RESULTS_DIR=
  83   SIDS_FILE=
  84   PCAP_FILE=
  85
  86   while [ $# -gt 0 ]; do
  87     case $1 in
  88       -h|--help)
  89         usage
  90       ;;
  91
  92       -o|--other-ports)
  93         OTHER_PORTS="$2"
  94         [ -z "$OTHER_PORTS" ] && _exit "Missing non-standard ports list"
  95         shift
  96       ;;
  97
  98       -d|--results-dir)
  99         RESULTS_DIR=$2
 100         shift
 101       ;;
 102
 103       -s|--sids)
 104         SIDS_FILE=$2
 105         shift
 106       ;;
 107
 108       *)
 109         first=$(echo $1 | cut -c1)
 110         [ "$first" = "-" ] && _exit "Unsupported script option: $1. Type '$SCR_BN -h' (or --help) to print the available options."
 111         PCAP_FILE=$1
 112       ;;
 113     esac
 114     shift
 115   done
 116
 117   [ -z "$PCAP_FILE" ] && _exit "Missing pcap file"
 118   [ ! -f "$PCAP_FILE" ] && _exit "Cannot found provided pcap file '$PCAP_FILE' !!"
 119   [ -z "$RESULTS_DIR" ] && RESULTS_DIR=`dirname $PCAP_FILE`
 120   [ ! -d $RESULTS_DIR ] && _exit "The results directory '$RESULTS_DIR' must exists !!"
 121   if [ -n "$SIDS_FILE" ]
 122   then
 123     [ ! -f $SIDS_FILE ] && _exit "The Session-Id list file '$SIDS_FILE' provided, does not exist !!"
 124   fi
 125 }
 126
 127 _exit () {
 128   echo
 129   echo -e $1
 130   echo
 131
 132   # Cleanup
 133   rm -rf $tmpdir
 134
 135   rc=1
 136   [ -n "$2" ] && rc=$2
 137   exit $rc
 138 }
 139
 140
 141 #############
 142 # EXECUTION #
 143 #############
 144
 145 echo
 146 echo "============================================"
 147 echo "Diameter buffer extractor from PCAP raw file"
 148 echo "============================================"
 149 echo
 150
 151 # Arguments:
 152 [ "$1" = "" -o "$1" = "--help" -o "$1" = "-h" ] && usage
 153 parse_arguments "$@"
 154
 155 # Tshark available:
 156 which $TSHARK >/dev/null 2>/dev/null
 157 [ $? -ne 0 ] && _exit "Missing 'tshark' tool !!"
 158
 159 # Get the frames with diameter content (take care about '-2' two-pass option and don't add it, because we need to get reassembled parts in their corresponding frames):
 160 # Fields needed (we won't need diameter.hopbyhopid & diameter.endtoendid to verify diameter message as hint patterns; length management will be enough): see https://www.wireshark.org/docs/dfref/d/diameter.html
 161 FIELDS="-e frame.number -e frame.time_epoch -e ip.src_host -e ip.dst_host -e diameter.cmd.code -e diameter.flags.request -e diameter.applicationId -e diameter.hopbyhopid -e diameter.endtoendid -e diameter.Session-Id -e diameter.Origin-Host -e diameter.Subscription-Id-Data -e diameter.Subscription-Id-Type -e frame.len -e tcp.len -e diameter.length -e frame.protocols -e tcp.segment -e sctp.chunk_length"
 162 # Disect selectors for non-standard diameter ports:
 163 for port in $OTHER_PORTS
 164 do
 165   echo "Taking tcp port $port to be decoded as diameter protocol"
 166   DISECT_SELECTORS="$DISECT_SELECTORS -d tcp.port=$port,diameter"
 167 done
 168
 169 $TSHARK -E separator="|" -r $PCAP_FILE -N mntC -Tfields $FIELDS $DISECT_SELECTORS 2>/dev/null > $tmpdir/all_frames
 170 grep -i diameter $tmpdir/all_frames > $tmpdir/diameter_frames
 171 #cat $tmpdir/all_frames
 172
 173 # Example output:
 174 #                                                                                         / lengths \
 175 # frm timestamp src   dst   code R  App-ID   HopByHop   EndToEnd  Sid OHost Subs SubsType FRM TCP DIA   protocol                              segments    sctp chunk length
 176 #   1   2      3       4      5  6    7          8          9     10   11    12     13    14   15  16      17                                    18             19
 177 #   1|tt.tt|gt_traf|vcbavipt|272|1|16777238|0x0004e6e6|0x000bd986|xxx|xxxxx|xxxxx|xxxxxxx|fff|432|432|eth:ip:tcp:diameter:diameter:diameter3gpp|
 178 #   3|tt.tt|vcbavipt|gt_traf|272|0|16777238|0x0004e6e6|0x000bd986|xxx|xxxxx|xxxxx|xxxxxxx|fff|292|292|eth:ip:tcp:diameter:diameter:diameter3gpp|
 179 #   5|tt.tt|gt_traf|vcbavipt||||||ffff|1400||eth:ip:tcp:diameter|
 180 #   6|tt.tt|gt_traf|vcbavipt|265|1|16777236|0x000c73c3|0x0004cee4|xxx|xxxxx|xxxxx|xxxxxxx|fff|572|1972|eth:ip:tcp:diameter:diameter:diameter3gpp|5,6
 181 #   8|tt.tt|vcbavipt|gt_traf|265|0|16777236|0x000c73c3|0x0004cee4|xxx|xxxxx|xxxxx|xxxxxxx|fff|248|248|eth:ip:tcp:diameter:diameter:diameter3gpp|
 182 cat $tmpdir/diameter_frames | cut -d\| -f1 > $tmpdir/frames_num
 183 all_frames=( $(cat $tmpdir/frames_num) )
 184
 185 # Segments groups (TCP or SCTP):
 186 segmentsGroups=
 187
 188 # The case of SCTP is precalculated:
 189 tshark -nr $PCAP_FILE $DISECT_SELECTORS -Tfields -e frame.number -e sctp.chunk_flags 2>/dev/null | awk '{ if ( $2 !~ "0x03" && $2 != "" ) print $1 }' > $tmpdir/extra_frames_num
 190 if [ -s $tmpdir/extra_frames_num ]
 191 then
 192   # Take into account these frames in all_frames array:
 193
 194   cat $tmpdir/extra_frames_num >> $tmpdir/frames_num
 195   all_frames=( $(cat $tmpdir/frames_num | sort -un) )
 196
 197   # Prepare as groups (1,2 7,8 ...)
 198   segmentsGroups=$(tshark -nr $PCAP_FILE $DISECT_SELECTORS -Tfields -e frame.number -e sctp.chunk_flags 2>/dev/null | awk '{ if ( $2 !~ "0x03" && $2 != "" ) print $1; else print "\n" }' | uniq | tr '\n' ',' | sed 's/,,/ /g')
 199 fi
 200
 201
 202 # Reassemble procedure (using frame 1 as example):
 203 # (for non segmented frames, it is enough with tcp or diameter length within the frame content itself)
 204 # 1) Get the TCP length: 432 bytes. 432*2 = 864 characters per byte in hexadecimal string format
 205 # 2) Get the frame length: `wc -c $tmpdir/block.$frame` => 997
 206 # 3) Get 864 from the tail: `cat $tmpdir/block.$frame | cut -c133
 207
 208 # Dump the hex blocks for all the diameter frames:
 209 cat $PCAP_FILE | rawshark -s -r - -d proto:diameter -F data 2>/dev/null > $tmpdir/all_hex_data
 210 for frame in ${all_frames[@]}; do
 211   grep "^$frame " $tmpdir/all_hex_data | cut -d\" -f2 | sed 's/://g' > $tmpdir/block.$frame
 212   frame_info=$(grep "^${frame}|" $tmpdir/diameter_frames)
 213
 214   ##########################################################################################
 215   # Get the diameter part:
 216   frm_len=$(echo $frame_info | cut -d\| -f14)
 217   tcp_len=$(echo $frame_info | cut -d\| -f15)
 218   dia_len=$(echo $frame_info | cut -d\| -f16)
 219   protocol=$(echo $frame_info | cut -d\| -f17)
 220
 221   # TCP and SCTP supported:
 222   transport=$(echo $protocol | grep -ow tcp)
 223   [ -z "$transport" ] && transport=$(echo $protocol | grep -ow sctp)
 224   # in case of segmented SCTP frames, protocol won't be sctp ...:
 225   if [ -s "$tmpdir/extra_frames_num" -a -z "$transport" ]
 226   then
 227     grep -qw ^${frame} $tmpdir/extra_frames_num
 228     if [ $? -eq 0 ]
 229     then
 230       transport=sctp
 231       frame_info=$(grep "^${frame}|" $tmpdir/all_frames)
 232     fi
 233   fi
 234
 235   case $transport in
 236     sctp)
 237       chunk_length=$(echo $frame_info | cut -d\| -f19)
 238       dia_partial_len=$((chunk_length-16))
 239       if [ "$dia_len" != "$dia_partial_len" ]
 240       then
 241         #echo "Segmented SCTP frame $frame; taking partial diameter length = $dia_partial_len"
 242         dia_len=$dia_partial_len
 243       fi
 244       cut_len=$((2*dia_len))
 245       cat $tmpdir/block.$frame | rev | cut -c-${cut_len} | rev > $RESULTS_DIR/$frame.hex
 246       ;;
 247
 248     tcp)
 249       cut_len=$((2*(frm_len-tcp_len) + 1))
 250       cat $tmpdir/block.$frame | cut -c${cut_len}- > $RESULTS_DIR/$frame.hex
 251       cp $tmpdir/block.$frame /tmp/block
 252       segments=$(echo $frame_info | cut -d\| -f18)
 253       segmentsGroups="$segmentsGroups $segments"
 254       ;;
 255
 256     *) _exit "Only TCP and SCTP transports supported !!"
 257       ;;
 258   esac
 259   ##########################################################################################
 260
 261   echo -n "Created $RESULTS_DIR/$frame.hex"
 262
 263   # Metadata:
 264   ts=$(echo $frame_info | cut -d\| -f2)
 265   date=$(date -d @$ts)
 266   src=$(echo $frame_info | cut -d\| -f3)
 267   dst=$(echo $frame_info | cut -d\| -f4)
 268   code=$(echo $frame_info | cut -d\| -f5)
 269   isreq=$(echo $frame_info | cut -d\| -f6)
 270   appid=$(echo $frame_info | cut -d\| -f7)
 271   sid=$(echo $frame_info | cut -d\| -f10)
 272   oh=$(echo $frame_info | cut -d\| -f11)
 273   subscriber=$(echo $frame_info | cut -d\| -f12)
 274   subscribertype=$(echo $frame_info | cut -d\| -f13)
 275   [ "$subscribertype" = "0" ] && subscribertype=msisdn
 276   [ "$subscribertype" = "1" ] && subscribertype=imsi
 277
 278
 279   #hbh=$(echo $frame_info | cut -d\| -f8)
 280   #e2e=$(echo $frame_info | cut -d\| -f9)
 281   # HBH and ETE To decimal:
 282   #hbh=$(printf "%d\n" $hbh)
 283   #e2e=$(printf "%d\n" $e2e)
 284   echo "date=$date" > $RESULTS_DIR/$frame.metadata
 285   echo "timestamp=$ts" >> $RESULTS_DIR/$frame.metadata
 286   echo "src=$src" >> $RESULTS_DIR/$frame.metadata
 287   echo "dst=$dst" >> $RESULTS_DIR/$frame.metadata
 288   echo "code=$code" >> $RESULTS_DIR/$frame.metadata
 289   echo "isrequest=$isreq" >> $RESULTS_DIR/$frame.metadata
 290   echo "applicationid=$appid" >> $RESULTS_DIR/$frame.metadata
 291   [ -n "$sid" ] && echo "sessionid=$sid" >> $RESULTS_DIR/$frame.metadata
 292   echo "originhost=$oh" >> $RESULTS_DIR/$frame.metadata
 293   if [ -n "$subscriber" ]
 294   then
 295     echo "subscriber=$subscriber" >> $RESULTS_DIR/$frame.metadata
 296     echo "subscribertype=$subscribertype" >> $RESULTS_DIR/$frame.metadata
 297   fi
 298   #echo "hopbyhop=$hbh" >> $RESULTS_DIR/$frame.metadata
 299   #echo "endtoend=$e2e" >> $RESULTS_DIR/$frame.metadata
 300
 301   echo " and $RESULTS_DIR/$frame.metadata"
 302 done
 303
 304 # Join frames which need to be reassembled:
 305 to_delete=
 306 for group in $segmentsGroups
 307 do
 308   group_array=( $(echo $group | sed 's/,/ /g') )
 309   echo "Grouping frames ${group_array[*]} ..."
 310   for frame in ${group_array[@]}; do
 311     cat $RESULTS_DIR/$frame.hex >> $tmpdir/diam.$group 2>/dev/null
 312   done
 313   cat $tmpdir/diam.$group | tr -d '\n' > $RESULTS_DIR/$frame.hex
 314   # Delete all frames except last one in the group:
 315   to_delete="$to_delete  $(echo ${group_array[*]} | awk '{$NF=""; print $0}')"
 316 done
 317
 318 # Delete superfluous metadata:
 319 #segments=( $(cat $tmpdir/diameter_frames | awk -F\| '{ if ($16 == "") print $1 }') )
 320 segments=( $(echo $to_delete) )
 321 echo "Deleting superfluous buffers & metadata (${segments[*]}) ..."
 322 for s in ${segments[@]}; do rm -f $RESULTS_DIR/${s}.* ; done
 323
 324 # Basic checking:
 325 ls $RESULTS_DIR/*.metadata >/dev/null 2>/dev/null
 326 [ $? -ne 0 ] && { echo "No metadata generated !" ; exit 1 ; }
 327
 328 # Detecting Session-Id values:
 329 grep ^sessionid= $RESULTS_DIR/*.metadata 2>/dev/null | cut -d= -f2- | sort -u > $RESULTS_DIR/session-ids
 330 if [ -s $RESULTS_DIR/session-ids ]
 331 then
 332   count=0
 333   while read -r line; do count=$((count+1)) ; echo "Detected Session-Id $count:  $line"; done < $RESULTS_DIR/session-ids
 334   rm $RESULTS_DIR/session-ids
 335 fi
 336
 337 # Detecting Origin-Host values:
 338 grep ^originhost= $RESULTS_DIR/*.metadata 2>/dev/null | cut -d= -f2- | sort -u > $RESULTS_DIR/origin-hosts
 339 if [ -s $RESULTS_DIR/origin-hosts ]
 340 then
 341   count=0
 342   while read -r line; do count=$((count+1)) ; echo "Detected Origin-Host $count: $line"; done < $RESULTS_DIR/origin-hosts
 343   #rm $RESULTS_DIR/origin-hosts
 344 fi
 345
 346 # Purge frames with Session-Id not wanted:
 347 if [ -n "$SIDS_FILE" ]
 348 then
 349   grep -l -w -f $SIDS_FILE $RESULTS_DIR/*metadata > $RESULTS_DIR/.wanted
 350   grep -l ^sessionid $RESULTS_DIR/*metadata > $RESULTS_DIR/.all
 351   for file in `grep -vf $RESULTS_DIR/.wanted $RESULTS_DIR/.all`
 352   do
 353     frm=$(basename $file | cut -d\. -f1)
 354     sid=$(grep ^sessionid= $file | cut -d= -f2-)
 355     echo "Purge results for frame $frm (Session-Id: '$sid') ..."
 356     rm $RESULTS_DIR/${frm}.*
 357   done
 358   rm $RESULTS_DIR/.wanted $RESULTS_DIR/.all
 359 fi
 360
 361 # Purge frames with invalid metadata:
 362 invalid=( $(grep -lw "^code=$" $RESULTS_DIR/*metadata) )
 363 for file in ${invalid[@]}
 364 do
 365   frm=$(basename $file | cut -d\. -f1)
 366   rm $RESULTS_DIR/${frm}.*
 367 done
 368
 369 _exit "Done!" 0
 370