VisualEther Protocol Analyzer
VisualEther Protocol Analyzer
Protocol Analyzer
6.1
USER MANUAL
VisualEther Protocol
Analyzer 6.1
Visually debug protocol interactions
Generate sequence diagrams and context
diagrams from Wireshark output. The
sequence diagrams provide a visual trace of
the packet flow between different nodes.
The collaboration diagrams give a birdseye-view of the protocol interactions.
Computer -> System Properties -> Advanced System Settings -> Advanced tab
Update path:
Edit Environment Variables and add VisualEther installation directory in the path
Invoke from command-line:
Wireshark to sequence
diagrams
Convert Wireshark output to sequence
diagrams
1 Save Wireshark
capture in a PCAP file.
4 Click to generate
sequence diagrams.
5 VisualEther generates
a sequence diagram.
6 Click on any
message in the PDF file
to see field level details.
7 See a detailed
dump of the message.
Define a FXT file with templates for messages you wish to include in the message.
2 Regenerate documents
with selected styles.
10
Sample styles
11
12
<!-- Template for Hypertext Transfer Protocol (HTTP) Request Extraction -->
<tcp-message style="redblue">
<opcode>http.request.method</opcode>
<param>http.request.uri</param>
<param>http.request.version</param>
<param>http.response.code</param>
<param>http.If-Modified-Since</param>
<param>tcp.len</param>
</tcp-message>
<!more... -->
</FXT>
13
14
1 By default, IP addresses
are used in sequence
diagram headings.
to names in HOSTS.txt
example
file and place it in the
same directory as the
PCAP file.
3 Generate diagrams.
Notice that the
sequence diagrams now
use the hosts file
translation.
15
16
17
18
19
By default,
VisualEther will select
the fields from the
outer message
20
21
My Documents\VisualEther Documents\Examples
22
23
Add the VisualEther installation directory to the default search path. Use the start /wait primitive in
batch files to invoke VisualEther via a command-line interface.
The run-all.bat sample batch file in the Examples directory generates diagrams from all the samples
included with VisualEther.
24
FXT reference
Supported protocols
<?xml version="1.0" encoding="utf-8" ?>
<FXT>
<!-- Message Templates for Session Initiation Protocol (SIP) Extraction -->
<udp-message>
<opcode display="brief">sip.Request-Line</opcode>
<param display="brief">sip.from.addr</param>
<param display="brief">sdp.connection_info</param>
</udp-message>
UDP v4
<udp-message>
<opcode display="brief">sip.Request-Line</opcode>
<param display="brief">sip.from.addr</param>
<param display="brief">sdp.connection_info</param>
</udp-message>
UDP v6
<!-- Message Template for File Transfer Protocol (FTP) Extraction -->
<tcp-message>
<opcode display="brief">ftp</opcode>
<param display="brief">ftp.response.code</param>
<param display="brief">ftp.response.arg</param>
<param display="brief">ftp.request.command</param>
</tcp-message>
TCP v4
TCP v6
<tcpv6-message>
<opcode display="brief">ftp</opcode>
<param display="brief">ftp.response.code</param>
<param display="brief">ftp.response.arg</param>
<param display="brief">ftp.request.command</param>
</tcpv6-message>
25
<!--
<sctpv6-message style="redblue">
<opcode>tcap</opcode>
<param>tcap.oid</param>
<param>tcap.application_context_name</param>
<param>tcap.otid</param>
<param>tcap.msgtype</param>
</sctpv6-message>
IPv4
<ipv6-message>
<opcode>icmp.type</opcode>
<param>icmp.seq</param>
</ipv6-message>
IPv6
<!-- Display the beacon message, but filter out duplicates -->
<wifi-message filter="true" style="grey">
<opcode regex-match="Type/Subtype: Beacon (.*)" regexreplace="IEEE 802.11: Beacon $1">wlan.fc.type_subtype</opcode>
<param>wlan.seq</param>
<param regex-match="Tag interpretation: (.*)" regexreplace="$1">wlan_mgt.tag.interpretation </param>
<param>data.len</param>
</wifi-message>
26
</FXT>
Ethernet frames
27
<param>
<sctp-message style="redblue">
<opcode regex-match="procedureCode: id-(.*)"
regex-replace="RANAP $1">ranap.procedureCode</opcode>
<param>ranap.pLMNidentity</param>
<param>ranap.id</param>
<param>gsm_a.imsi</param>
</sctp-message>
28
Include remarks
<remark>
29
Attributes
Bookmark messages
Color the messages in a
combination of Green
and Khaki colors.
Bookmark the
message in PDF for
easy access.
30
31
Regular expressions
The samples included with VisualEther should be suitable for a large variety of matching and
searching scenarios. For more complicated needs we recommend:
32
33
Colors
A handy reference for predefined colors in EventStudio. Use these definitions to define your own
styles in VisualEther.fdl file.
BLACK
"0.0,0.0,0.0"
DIMGRAY
"0.41,0.41,0.41"
DIMGREY
GRAY
"0.41,0.41,0.41"
"0.50,0.50,0.50"
GREY
"0.50,0.50,0.50"
DARKGREY
DARKGRAY
"0.66,0.66,0.66"
"0.66,0.66,0.66"
SILVER
"0.75,0.75,0.75"
LIGHTGRAY
LIGHTGREY
"0.83,0.83,0.83"
"0.83,0.83,0.83"
GAINSBORO
"0.86,0.86,0.86"
WHITESMOKE
WHITE
"0.96,0.96,0.96"
"1.00,1.00,1.00"
ROSYBROWN
"0.74,0.56,0.56"
INDIANRED
"0.80,0.36,0.36"
BROWN
FIREBRICK
"0.65,0.16,0.16"
"0.70,0.13,0.13"
LIGHTCORAL
"0.94,0.50,0.50"
MAROON
DARKRED
"0.50,0.0,0.0"
"0.55,0.0,0.0"
RED
"1.00,0.0,0.0"
SNOW
SALMON
"1.00,0.98,0.98"
"0.98,0.50,0.45"
MISTYROSE
"1.00,0.89,0.88"
TOMATO
DARKSALMON
"1.00,0.39,0.28"
"0.91,0.59,0.48"
ORANGERED
"1.00,0.27,0.0"
CORAL
LIGHTSALMON
"1.00,0.50,0.31"
"1.00,0.63,0.48"
34
SIENNA
"0.63,0.32,0.18"
CHOCOLATE
"0.82,0.41,0.12"
SADDLEBROWN
SEASHELL
"0.55,0.27,0.7"
"1.00,0.96,0.93"
SANDYBROWN
"0.96,0.64,0.38"
PEACHPUFF
PERU
"1.00,0.85,0.73"
"0.80,0.52,0.25"
LINEN
"0.98,0.94,0.90"
DARKORANGE
BISQUE
"1.00,0.55,0.0"
"1.00,0.89,0.77"
TAN
"0.82,0.71,0.55"
BURLYWOOD
"0.87,0.72,0.53"
ANTIQUEWHITE
"0.98,0.92,0.84"
NAVAJOWHITE
"1.00,0.87,0.68"
BLANCHEDALMOND
PAPAYAWHIP
"1.00,0.92,0.80"
"1.00,0.94,0.84"
MOCCASIN
"1.00,0.89,0.71"
WHEAT
OLDLACE
"0.96,0.87,0.70"
"0.99,0.96,0.90"
ORANGE
"1.00,0.65,0.0"
FLORALWHITE
GOLDENROD
"1.00,0.98,0.94"
"0.85,0.65,0.13"
DARKGOLDENROD
"0.72,0.53,0.4"
CORNSILK
GOLD
"1.00,0.97,0.86"
"1.00,0.84,0.0"
KHAKI
"0.94,0.90,0.55"
LEMONCHIFFON
PALEGOLDENROD
"1.00,0.98,0.80"
"0.93,0.91,0.67"
DARKKHAKI
"0.74,0.72,0.42"
BEIGE
LIGHTGOLDENRODYELLOW
"0.96,0.96,0.86"
"0.98,0.98,0.82"
OLIVE
"0.50,0.50,0.0"
YELLOW
"1.00,1.00,0.0"
LIGHTYELLOW
IVORY
"1.00,1.00,0.88"
"1.00,1.00,0.94"
OLIVEDRAB
"0.42,0.56,0.14"
35
YELLOWGREEN
"0.60,0.80,0.20"
DARKOLIVEGREEN
"0.33,0.42,0.18"
GREENYELLOW
LAWNGREEN
"0.68,1.00,0.18"
"0.49,0.99,0.0"
CHARTREUSE
"0.50,1.00,0.0"
DARKSEAGREEN
FORESTGREEN
"0.56,0.74,0.56"
"0.13,0.55,0.13"
LIMEGREEN
"0.20,0.80,0.20"
LIGHTGREEN
PALEGREEN
"0.56,0.93,0.56"
"0.60,0.98,0.60"
DARKGREEN
"0.0,0.39,0.0"
GREEN
"0.0,0.50,0.0"
LIME
"0.0,1.00,0.0"
HONEYDEW
"0.94,1.00,0.94"
SEAGREEN
MEDIUMSEAGREEN
"0.18,0.55,0.34"
"0.24,0.70,0.44"
SPRINGGREEN
"0.0,1.00,0.50"
MINTCREAM
MEDIUMSPRINGGREEN
"0.96,1.00,0.98"
"0.0,0.98,0.60"
MEDIUMAQUAMARINE
"0.40,0.80,0.67"
AQUAMARINE
TURQUOISE
"0.50,1.00,0.83"
"0.25,0.88,0.82"
LIGHTSEAGREEN
"0.13,0.70,0.67"
MEDIUMTURQUOISE
DARKSLATEGRAY
"0.28,0.82,0.80"
"0.18,0.31,0.31"
DARKSLATEGREY
"0.18,0.31,0.31"
PALETURQUOISE
TEAL
"0.69,0.93,0.93"
"0.0,0.50,0.50"
DARKCYAN
"0.0,0.55,0.55"
AQUA
CYAN
"0.0,1.00,1.00"
"0.0,1.00,1.00"
LIGHTCYAN
"0.88,1.00,1.00"
AZURE
"0.94,1.00,1.00"
DARKTURQUOISE
CADETBLUE
"0.0,0.81,0.82"
"0.37,0.62,0.63"
POWDERBLUE
"0.69,0.88,0.90"
36
LIGHTBLUE
"0.68,0.85,0.90"
DEEPSKYBLUE
"0.0,0.75,1.00"
SKYBLUE
LIGHTSKYBLUE
"0.53,0.81,0.92"
"0.53,0.81,0.98"
STEELBLUE
"0.27,0.51,0.71"
ALICEBLUE
SLATEGREY
"0.94,0.97,1.00"
"0.44,0.50,0.56"
SLATEGRAY
"0.44,0.50,0.56"
LIGHTSLATEGREY
LIGHTSLATEGRAY
"0.47,0.53,0.60"
"0.47,0.53,0.60"
DODGERBLUE
"0.12,0.56,1.00"
LIGHTSTEELBLUE
"0.69,0.77,0.87"
CORNFLOWERBLUE
"0.39,0.58,0.93"
ROYALBLUE
"0.25,0.41,0.88"
MIDNIGHTBLUE
LAVENDER
"0.10,0.10,0.44"
"0.90,0.90,0.98"
NAVY
"0.0,0.0,0.50"
DARKBLUE
MEDIUMBLUE
"0.0,0.0,0.55"
"0.0,0.0,0.80"
BLUE
"0.0,0.0,1.00"
GHOSTWHITE
DARKSLATEBLUE
"0.97,0.97,1.00"
"0.28,0.24,0.55"
SLATEBLUE
"0.42,0.35,0.80"
MEDIUMSLATEBLUE
MEDIUMPURPLE
"0.48,0.41,0.93"
"0.58,0.44,0.86"
BLUEVIOLET
"0.54,0.17,0.89"
INDIGO
DARKORCHID
"0.29,0.0,0.51"
"0.60,0.20,0.80"
DARKVIOLET
"0.58,0.0,0.83"
MEDIUMORCHID
THISTLE
"0.73,0.33,0.83"
"0.85,0.75,0.85"
PLUM
"0.87,0.63,0.87"
VIOLET
"0.93,0.51,0.93"
PURPLE
DARKMAGENTA
"0.50,0.0,0.50"
"0.55,0.0,0.55"
FUCHSIA
"1.00,0.0,1.00"
37
MAGENTA
"1.00,0.0,1.00"
ORCHID
"0.85,0.44,0.84"
MEDIUMVIOLETRED
DEEPPINK
"0.78,0.08,0.52"
"1.00,0.08,0.58"
HOTPINK
"1.00,0.41,0.71"
PALEVIOLETRED
LAVENDERBLUSH
"0.86,0.44,0.58"
"1.00,0.94,0.96"
CRIMSON
"0.86,0.08,0.24"
PINK
LIGHTPINK
"1.00,0.75,0.80"
"1.00,0.71,0.76"
38