Fork variant for TestStep command
[anna.git] / example / diameter / launcher / resources / scripts / pcap2diameterHex.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 #############
40 # VARIABLES #
41 #############
42 tmpdir=$(mktemp -d)
43
44 #############
45 # FUNCTIONS #
46 #############
47
48 usage () {
49   echo "Usage: $0 <pcap_file> [results_dir]"
50   echo
51   echo "       pcap_file:   pcap formatted file to be processed."
52   echo "       results_dir: directory where results are stored."
53   echo "                    By default, pcap file dirname is used."
54   echo
55   echo "       The utility, dumps the extracted hexadecimal content"
56   echo "       and useful information as timestamps, source and"
57   echo "       destination:"
58   echo "          <results_dir>/<frame sequence>.hex"
59   echo "          <results_dir>/<frame sequence>.metadata"
60   echo
61   _exit
62 }
63
64 _exit () {
65   echo
66   echo -e $1
67   echo
68
69   # Cleanup
70   rm -rf $tmpdir
71
72   rc=1
73   [ -n "$2" ] && rc=$2
74   exit $rc
75 }
76
77
78 #############
79 # EXECUTION #
80 #############
81
82 echo
83 echo "============================================"
84 echo "Diameter buffer extractor from PCAP raw file"
85 echo "============================================"
86 echo
87
88 # Usage:
89 [ "$1" = "" ] && usage
90
91 # Pcap file:
92 PCAP_FILE=$1
93 [ ! -f $PCAP_FILE ] && _exit "Cannot found provided pcap file '$1' !!"
94
95 # Optional result dir:
96 RESULTS_DIR=`dirname $PCAP_FILE`
97 [ "$2" != "" ] && RESULTS_DIR=$2
98 [ ! -d $RESULTS_DIR ] && _exit "The results directory '$RESULTS_DIR' must exists !!"
99
100 # 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):
101 # Fields needed (we won't need diameter.hopbyhopid & diameter.endtoendid to verify diameter message as hint patterns; length management will be enough):
102 FIELDS_DIAMETER="-e diameter.cmd.code -e diameter.flags.request -e diameter.applicationId -e diameter.hopbyhopid -e diameter.endtoendid -e diameter.length"
103 FIELDS="-e frame.number -e frame.time_epoch -e ip.src_host -e ip.dst_host $FIELDS_DIAMETER -e tcp.len -e frame.protocols -e tcp.segment"
104 tshark -E separator="|" -r $PCAP_FILE -N mntC -Tfields $FIELDS 2>/dev/null | grep -i diameter > $tmpdir/diameter_frames
105 # Example output:
106 #                                                                               /length\
107 # frame     timestamp        src     dst   code R  App-ID   HopByHop   EndToEnd DIAM TCP          protocol                         segments 
108 #   1|1427215933.697904000|gt_traf|vcbavipt|272|1|16777238|0x0004e6e6|0x000bd986|432|432|eth:ip:tcp:diameter:diameter:diameter3gpp|
109 #   3|1427215934.449523000|vcbavipt|gt_traf|272|0|16777238|0x0004e6e6|0x000bd986|292|292|eth:ip:tcp:diameter:diameter:diameter3gpp|
110 #   5|1427215934.456160000|gt_traf|vcbavipt|||||||1400|eth:ip:tcp:diameter|
111 #   6|1427215934.456204000|gt_traf|vcbavipt|265|1|16777236|0x000c73c3|0x0004cee4|1972|572|eth:ip:tcp:diameter:diameter:diameter3gpp|5,6
112 #   8|1427215935.123559000|vcbavipt|gt_traf|265|0|16777236|0x000c73c3|0x0004cee4|248|248|eth:ip:tcp:diameter:diameter:diameter3gpp|
113 all_frames=( $(cat $tmpdir/diameter_frames | cut -d\| -f1) )
114 needs_join=( $(cat $tmpdir/diameter_frames | cut -d\| -f13) )
115 main_frames=( $(cat $tmpdir/diameter_frames | awk -F\| '{ if ($11 != "") print $1 }') )
116
117 # Reassemble procedure (using frame 1 as example):
118 # (for non segmented frames, it is enough with tcp or diameter length within the frame content itself)
119 # 1) Get the TCP length: 432 bytes. 432*2 = 864 characters per byte in hexadecimal string format
120 # 2) Get the frame length: `wc -c $tmpdir/block.$frame` => 997
121 # 3) Get 864 from the tail: `cat $tmpdir/block.$frame | cut -c133
122
123 # Dump the hex blocks for all the diameter frames:
124 cat $PCAP_FILE | rawshark -s -r - -d proto:diameter -F data 2>/dev/null > $tmpdir/all_hex_data
125 for frame in ${all_frames[@]}; do
126   grep "^$frame " $tmpdir/all_hex_data | cut -d\" -f2 | sed 's/://g' > $tmpdir/block.$frame
127   frame_info=$(grep "^${frame}|" $tmpdir/diameter_frames)
128
129   # Get the diameter part:
130   tcp_len=$(echo $frame_info | cut -d\| -f11)
131   frm_len=$(wc -c $tmpdir/block.$frame | awk '{ print $1 }')
132   cut_len=$((frm_len-2*tcp_len))
133   cat $tmpdir/block.$frame | cut -c${cut_len}- > $RESULTS_DIR/$frame.hex
134   echo -n "Created $RESULTS_DIR/$frame.hex"
135
136   # Metadata:
137   ts=$(echo $frame_info | cut -d\| -f2)
138   date=$(date -d @$ts)
139   src=$(echo $frame_info | cut -d\| -f3)
140   dst=$(echo $frame_info | cut -d\| -f4)
141   code=$(echo $frame_info | cut -d\| -f5)
142   isreq=$(echo $frame_info | cut -d\| -f6)
143   appid=$(echo $frame_info | cut -d\| -f7)
144   hbh=$(echo $frame_info | cut -d\| -f8)
145   e2e=$(echo $frame_info | cut -d\| -f9)
146   # To decimal:
147   hbh=$(printf "%d\n" $hbh)
148   e2e=$(printf "%d\n" $e2e)
149   echo "date=$date" > $RESULTS_DIR/$frame.metadata
150   echo "timestamp=$ts" >> $RESULTS_DIR/$frame.metadata
151   echo "src=$src" >> $RESULTS_DIR/$frame.metadata
152   echo "dst=$dst" >> $RESULTS_DIR/$frame.metadata
153   echo "code=$code" >> $RESULTS_DIR/$frame.metadata
154   echo "isrequest=$isreq" >> $RESULTS_DIR/$frame.metadata
155   echo "applicationid=$appid" >> $RESULTS_DIR/$frame.metadata
156   #echo "sequence=${hbh}.${e2e}" >> $RESULTS_DIR/$frame.metadata
157 #  echo "hopbyhop=$hbh" >> $RESULTS_DIR/$frame.metadata
158 #  echo "endtoend=$e2e" >> $RESULTS_DIR/$frame.metadata
159
160   echo " and $RESULTS_DIR/$frame.metadata"
161 done
162
163 # Join frames which need to be reassembled:
164 for group in ${needs_join[@]}; do
165   echo "Grouping frames $group ..."
166   group_array=( $(echo $group | sed 's/,/ /g') )
167   for frame in ${group_array[@]}; do
168     cat $RESULTS_DIR/$frame.hex >> $tmpdir/diam.$group
169   done
170   cat $tmpdir/diam.$group | tr -d '\n' > $RESULTS_DIR/$frame.hex
171 done
172
173 # Delete superfluous metadata:
174 echo "Deleting superfluous buffers & metadata ..."
175 segments=( $(cat $tmpdir/diameter_frames | awk -F\| '{ if ($10 == "") print $1 }') )
176 for s in ${segments[@]}; do rm $RESULTS_DIR/$s.*; done
177
178
179 _exit "Done!" 0
180