3 # ANNA - Anna is Not Nothingness Anymore
5 # (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
7 # http://redmine.teslayout.com/projects/anna-suite
9 # Redistribution and use in source and binary forms, with or without
10 # modification, are permitted provided that the following conditions
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
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.
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.
35 # Authors: eduardo.ramos.testillano@gmail.com
36 # cisco.tierra@gmail.com
39 # Decoder version using tshark tool
52 echo "Usage: $0 [-h|--help] [-o|--other-ports <list>] [-d|--results-dir <dir>] [-s|--sids <file>] <pcap>"
54 echo " -h|--help: this usage help."
55 echo " -o|--other-ports <list>: space-separated list of ports which frames"
56 echo " will be decoded as diameter protocol although"
57 echo " not being standard. For example, we could use"
58 echo " \"13868\" to disect the Ericsson Sy variant."
59 echo " -d|--results-dir <dir>: directory where results are stored."
60 echo " By default, pcap dirname."
61 echo " -s|--sids <file>: file containing a list of Session-Id values"
62 echo " (one per line) to be taken into account."
63 echo " If missing, all the frames will be extracted."
65 echo " pcap: pcap formatted file to be processed."
67 echo " The utility, dumps the extracted hexadecimal content"
68 echo " and useful information as timestamps, source and"
70 echo " <results directory>/<frame sequence>.hex"
71 echo " <results directory>/<frame sequence>.metadata"
82 while [ $# -gt 0 ]; do
90 [ -z "$OTHER_PORTS" ] && _exit "Missing non-standard ports list"
105 first=$(echo $1 | cut -c1)
106 [ "$first" = "-" ] && _exit "Unsupported script option: $1. Type '$SCR_BN -h' (or --help) to print the available options."
113 [ -z "$PCAP_FILE" ] && _exit "Missing pcap file"
114 [ ! -f "$PCAP_FILE" ] && _exit "Cannot found provided pcap file '$PCAP_FILE' !!"
115 [ -z "$RESULTS_DIR" ] && RESULTS_DIR=`dirname $PCAP_FILE`
116 [ ! -d $RESULTS_DIR ] && _exit "The results directory '$RESULTS_DIR' must exists !!"
117 if [ -n "$SIDS_FILE" ]
119 [ ! -f $SIDS_FILE ] && _exit "The Session-Id list file '$SIDS_FILE' provided, does not exist !!"
142 echo "============================================"
143 echo "Diameter buffer extractor from PCAP raw file"
144 echo "============================================"
148 [ "$1" = "" -o "$1" = "--help" -o "$1" = "-h" ] && usage
152 which tshark >/dev/null
153 [ $? -ne 0 ] && _exit "Missing 'tshark' tool !!"
155 # 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):
156 # 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
157 FIELDS_DIAMETER="-e diameter.cmd.code -e diameter.flags.request -e diameter.applicationId -e diameter.hopbyhopid -e diameter.endtoendid -e diameter.Session-Id -e diameter.length"
158 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"
159 # Disect selectors for non-standard diameter ports:
160 for port in $OTHER_PORTS
162 echo "Taking tcp port $port to be decoded as diameter protocol"
163 DISECT_SELECTORS="$DISECT_SELECTORS -d tcp.port=$port,diameter"
166 tshark -E separator="|" -r $PCAP_FILE -N mntC -Tfields $FIELDS $DISECT_SELECTORS 2>/dev/null | grep -i diameter > $tmpdir/diameter_frames
169 # frame timestamp src dst code R App-ID HopByHop EndToEnd Session-Id DIAM TCP protocol segments
170 # 1 2 3 4 5 6 7 8 9 10 11 12 13 14
171 # 1|1427215933.697904000|gt_traf|vcbavipt|272|1|16777238|0x0004e6e6|0x000bd986|xxxxxxx|432|432|eth:ip:tcp:diameter:diameter:diameter3gpp|
172 # 3|1427215934.449523000|vcbavipt|gt_traf|272|0|16777238|0x0004e6e6|0x000bd986|xxxxxxx|292|292|eth:ip:tcp:diameter:diameter:diameter3gpp|
173 # 5|1427215934.456160000|gt_traf|vcbavipt||||||||1400|eth:ip:tcp:diameter|
174 # 6|1427215934.456204000|gt_traf|vcbavipt|265|1|16777236|0x000c73c3|0x0004cee4|xxxxxxx|1972|572|eth:ip:tcp:diameter:diameter:diameter3gpp|5,6
175 # 8|1427215935.123559000|vcbavipt|gt_traf|265|0|16777236|0x000c73c3|0x0004cee4|xxxxxxx|248|248|eth:ip:tcp:diameter:diameter:diameter3gpp|
176 all_frames=( $(cat $tmpdir/diameter_frames | cut -d\| -f1) )
177 needs_join=( $(cat $tmpdir/diameter_frames | cut -d\| -f14) )
178 main_frames=( $(cat $tmpdir/diameter_frames | awk -F\| '{ if ($12 != "") print $1 }') )
180 # Reassemble procedure (using frame 1 as example):
181 # (for non segmented frames, it is enough with tcp or diameter length within the frame content itself)
182 # 1) Get the TCP length: 432 bytes. 432*2 = 864 characters per byte in hexadecimal string format
183 # 2) Get the frame length: `wc -c $tmpdir/block.$frame` => 997
184 # 3) Get 864 from the tail: `cat $tmpdir/block.$frame | cut -c133
186 # Dump the hex blocks for all the diameter frames:
187 cat $PCAP_FILE | rawshark -s -r - -d proto:diameter -F data 2>/dev/null > $tmpdir/all_hex_data
188 for frame in ${all_frames[@]}; do
189 grep "^$frame " $tmpdir/all_hex_data | cut -d\" -f2 | sed 's/://g' > $tmpdir/block.$frame
190 frame_info=$(grep "^${frame}|" $tmpdir/diameter_frames)
192 # Get the diameter part:
193 tcp_len=$(echo $frame_info | cut -d\| -f12)
194 frm_len=$(wc -c $tmpdir/block.$frame | awk '{ print $1 }')
195 cut_len=$((frm_len-2*tcp_len))
196 cat $tmpdir/block.$frame | cut -c${cut_len}- > $RESULTS_DIR/$frame.hex
197 echo -n "Created $RESULTS_DIR/$frame.hex"
200 ts=$(echo $frame_info | cut -d\| -f2)
202 src=$(echo $frame_info | cut -d\| -f3)
203 dst=$(echo $frame_info | cut -d\| -f4)
204 code=$(echo $frame_info | cut -d\| -f5)
205 isreq=$(echo $frame_info | cut -d\| -f6)
206 appid=$(echo $frame_info | cut -d\| -f7)
207 sid=$(echo $frame_info | cut -d\| -f10)
208 #hbh=$(echo $frame_info | cut -d\| -f8)
209 #e2e=$(echo $frame_info | cut -d\| -f9)
210 # HBH and ETE To decimal:
211 #hbh=$(printf "%d\n" $hbh)
212 #e2e=$(printf "%d\n" $e2e)
213 echo "date=$date" > $RESULTS_DIR/$frame.metadata
214 echo "timestamp=$ts" >> $RESULTS_DIR/$frame.metadata
215 echo "src=$src" >> $RESULTS_DIR/$frame.metadata
216 echo "dst=$dst" >> $RESULTS_DIR/$frame.metadata
217 echo "code=$code" >> $RESULTS_DIR/$frame.metadata
218 echo "isrequest=$isreq" >> $RESULTS_DIR/$frame.metadata
219 echo "applicationid=$appid" >> $RESULTS_DIR/$frame.metadata
220 [ -n "$sid" ] && echo "sessionid=$sid" >> $RESULTS_DIR/$frame.metadata
221 #echo "hopbyhop=$hbh" >> $RESULTS_DIR/$frame.metadata
222 #echo "endtoend=$e2e" >> $RESULTS_DIR/$frame.metadata
224 echo " and $RESULTS_DIR/$frame.metadata"
227 # Join frames which need to be reassembled:
228 for group in ${needs_join[@]}; do
229 echo "Grouping frames $group ..."
230 group_array=( $(echo $group | sed 's/,/ /g') )
231 for frame in ${group_array[@]}; do
232 cat $RESULTS_DIR/$frame.hex >> $tmpdir/diam.$group
234 cat $tmpdir/diam.$group | tr -d '\n' > $RESULTS_DIR/$frame.hex
237 # Delete superfluous metadata:
238 echo "Deleting superfluous buffers & metadata ..."
239 segments=( $(cat $tmpdir/diameter_frames | awk -F\| '{ if ($11 == "") print $1 }') )
240 for s in ${segments[@]}; do rm $RESULTS_DIR/$s.*; done
242 # Detecting Session-Id values:
243 grep ^sessionid= $RESULTS_DIR/*.metadata 2>/dev/null | cut -d= -f2- | sort -u > $RESULTS_DIR/session-ids
244 if [ -s $RESULTS_DIR/session-ids ]
247 while read -r line; do count=$((count+1)) ; echo "Detected Session-Id $count: $line"; done < $RESULTS_DIR/session-ids
248 rm $RESULTS_DIR/session-ids
251 # Purge frames with Session-Id not wanted:
252 if [ -n "$SIDS_FILE" ]
254 grep -l -w -f $SIDS_FILE $RESULTS_DIR/*metadata > $RESULTS_DIR/.wanted
255 grep -l ^sessionid $RESULTS_DIR/*metadata > $RESULTS_DIR/.all
256 for file in `grep -vf $RESULTS_DIR/.wanted $RESULTS_DIR/.all`
258 frm=$(basename $file | cut -d\. -f1)
259 sid=$(grep ^sessionid= $file | cut -d= -f2-)
260 echo "Purge results for frame $frm (Session-Id: '$sid') ..."
261 rm $RESULTS_DIR/${frm}.*
263 rm $RESULTS_DIR/.wanted $RESULTS_DIR/.all