Manual:Tools/Packet Sniffer: Difference between revisions

From MikroTik Wiki
Jump to navigation Jump to search
← Older editNewer edit →
m →‎Quick mode: description
Line 15: Line 15:
==Packet Sniffer Configuration==
==Packet Sniffer Configuration==


<p id="shbox"><b>Sub-menu:</b> <code>/tool sniffer</code></p><br />
<p id="shbox"><b>Sub-menu:</b> <code>/tool sniffer</code></p>


<table class="styled_table">
<tr>
  <th width="44%">Property</th>
  <th >Description</th>
</tr>


<tr>
    <td><var><b>file-limit</b></var> (<em>integer 10..1000000000</em>; Default:<b> 10</b>)</td>
    <td>The limit of the file in KB. Sniffer will stop after this limit is reached</td>
</tr>


<tr>
{{Mr-arg-table-h
    <td><var><b>file-name</b></var> (<em>string</em>; Default:<b> ""</b>)</td>
|prop=Property
    <td>The name of the file where the sniffed packets will be saved to</td>
|desc=Description
</tr>
}}


<tr>
{{Mr-arg-table
    <td><var><b>filter-ip-address</b></var> (<em>IP address/netmask</em>;)</td>
|arg=file-limit
    <td>up to 16 ip addresses to use as a filter</td>
|type=integer 10..4294967295[KiB]
</tr>
|default=1000KiB
<tr>
|desc=File size limit. Sniffer will stop when limit is reached.
    <td><var><b>filter-mac-address</b></var> (<em>MAC address</em>;)</td>
    <td>up to 16 MAC addresses to use as a filter</td>
</tr>


<tr>
}}
    <td><var><b>filter-port</b></var> (<em>port</em>; Default:<b>0-65535</b>)</td>
    <td>up to 16 comma separated entries</td>
</tr>


<tr>
{{Mr-arg-table
    <td><var><b>filter-ip-protocol</b></var> (<em>all-frames | ip-only | mac-only-no-ip</em>;)</td>
|arg=file-name
    <td>Filter specific protocol
|type=string
*<b>ipsec-ah</b> - IPsec AH protocol                                                                                                  *<b>ipsec-esp</b> - IPsec ESP protocol
|default=
|desc=Name of the file where sniffed packets will be saved.
}}
 
{{Mr-arg-table
|arg=filter-ip-address
|type=ip/mask[,ip/mask] (max 16 items)
|default=
|desc=Up to 16 ip addresses used as a filter
}}
 
{{Mr-arg-table
|arg=filter-mac-address
|type=mac/mask[,mac/mask] (max 16 items)
|default=
|desc=Up to 16 MAC addresses and MAC address masks used as a filter
}}
 
{{Mr-arg-table
|arg=filter-port
|type=[!]port[,port] (max 16 items)
|default=
|desc=Up to 16 comma separated entries used as a filter
}}
 
{{Mr-arg-table
|arg=filter-ip-protocol
|type=[!]protocol[,protocol] (max 16 items)
|default=
|desc=Up to 16 comma separated entries used as a filter
IP protocols (instead of protocol names, protocol number can be used)
*<b>ipsec-ah</b> - IPsec AH protocol                                                                                                   
*<b>ipsec-esp</b> - IPsec ESP protocol
*<b>ddp</b> - datagram delivery protocol
*<b>ddp</b> - datagram delivery protocol
*<b>egp</b> - exterior gateway protocol
*<b>egp</b> - exterior gateway protocol
Line 76: Line 93:
*<b>xns-idp</b> - xerox xns idp
*<b>xns-idp</b> - xerox xns idp
*<b>xtp</b> - xpress transfer protocol
*<b>xtp</b> - xpress transfer protocol
}}


</td>
{{Mr-arg-table
</tr>
|arg=filter-mac-protocol
<tr>
|type=[!]protocol[,protocol] (max 16 items)
    <td><var><b>filter-mac-protocol</b></var> (<em>all-frames | ip-only | mac-only-no-ip</em>;)</td>
|default=
    <td>Filter specific protocol
|desc=Up to 16 comma separated entries used as a filter.
Mac protocols (instead of protocol names, protocol number can be used):
*<b>arp</b> - Address Resolution Protocol                                                                                           
*<b>arp</b> - Address Resolution Protocol                                                                                           
*<b>ip</b> - Internet Protocol
*<b>ip</b> - Internet Protocol
Line 87: Line 106:
*<b>ipx</b> - Internetwork Packet Exchange
*<b>ipx</b> - Internetwork Packet Exchange
*<b>rarp</b> - Reverse Address Resolution Protocol
*<b>rarp</b> - Reverse Address Resolution Protocol
</td>
}}
</tr>


<tr>
{{Mr-arg-table
    <td><var><b>filter-stream</b></var> (<em>yes | no</em>; Default:<b> no</b>)</td>
|arg=filter-stream
    <td>Sniffed packets that are devised for sniffer server are ignored</td>
|type=yes {{!}} no
</tr>
|default=yes
|desc=Sniffed packets that are devised for sniffer server are ignored
}}


<tr>
{{Mr-arg-table
    <td><var><b>interface</b></var> (<em>all | ether1 | ...</em>; Default:<b> all</b>)</td>
|arg=filter-direction
    <td>Interface management</td>
|type=any {{!}} rx {{!}} tx
</tr>
|default=
|desc=Specifies om which direction filtering will be applied.
}}


<tr>
{{Mr-arg-table
    <td><var><b>memory-limit</b></var> (<em>integer 10..4294967295</em>; Default:<b> 10</b>)</td>
|arg=interface
    <td>Memory amount reached in KB to stop sniffing</td>
|type=all {{!}} name
</tr>
|default=all
|desc=Interface name on which sniffer will be running. '''all''' indicates that sniffer will sniff packets on all interfaces.
}}


<tr>
{{Mr-arg-table
    <td><var><b>memory-scroll</b></var> (<em>yes | no</em>; Default:<b> no</b>)</td>
|arg=memory-limit
    <td></td>
|type=integer 10..4294967295[KiB]
</tr>
|default=100KiB
|desc=Memory amount used to store sniffed data.
}}


<tr>
{{Mr-arg-table
    <td><var><b>only-headers</b></var> (<em>yes | no</em>; Default:<b> no</b>)</td>
|arg=memory-scroll
    <td>Save in the memory only packet's headers not the whole packet</td>
|type=yes {{!}} no
</tr>
|default=yes
|desc=Whether to rewrite older sniffed data when memory limit is reached.
}}


<tr>
{{Mr-arg-table
    <td><var><b>running</b></var> (<em>read-only</em>)</td>
|arg=only-headers
    <td>If the sniffer is started then the value is <b>yes</b> otherwise <b>no</b></td>
|type=yes {{!}} no
</tr>
|default=no
|desc=Save in the memory only packet's headers not the whole packet.
}}


<tr>
{{Mr-arg-table
    <td><var><b>streaming-enabled</b></var> (<em>yes | no</em>; Default:<b> no</b>)</td>
|arg=streaming-enabled
    <td>Defines whether to send sniffed packets to sniffer's server or not</td>
|type=yes {{!}} no
</tr>
|default=no
|desc=Defines whether to send sniffed packets to streaming server
}}


<tr>
{{Mr-arg-table-end
    <td><var><b>streaming-server</b></var> (<em>ip address</em>; Default:<b> </b>)</td>
|arg=streaming-server
    <td>Tazmen Sniffer Protocol (TZSP) stream receiver</td>
|type=IP
</tr>
|default=0.0.0.0
|desc=Tazmen Sniffer Protocol (TZSP) stream receiver
}}


</table>


<h3>Notes</h3>


<p>
===Example===
<b>filter-address1</b> and <b>filter-address2</b> are used to specify the two participients in communication (i.e. they will match only in the case if one of them matches the source address and the other one matches the destination address of a packet). These properties are taken in account only if <b>filter-protocol</b> is <b>ip-only</b>.
</p>


<h3>Example</h3>
In the following example <b>streaming-server</b> will be added, streaming will be enabled, <b>file-name</b> will be set to test and packet sniffer will be started and stopped after some time:


<p>In the following example <b>streaming-server</b> will be added, streaming will be enabled, <b>file-name</b> will be set to test and packet sniffer will be started and stopped after some time:</p>


<pre>
<pre>
[admin@MikroTik] tool sniffer> set streaming-server=192.168.0.240 \
[admin@MikroTik] tool sniffer> set streaming-server=192.168.0.240 \
\... streaming-enabled=yes file-name=test
\... streaming-enabled=yes file-name=test.pcap
[admin@MikroTik] tool sniffer> print
[admin@MikroTik] tool sniffer> print
          interface: all
            interface: all
      only-headers: no
        only-headers: no
      memory-limit: 1000KiB
        memory-limit: 100KiB
      memory-scroll: no
        memory-scroll: yes
          file-name: test
            file-name: test.pcap
        file-limit: 10KiB
          file-limit: 1000KiB
  streaming-enabled: yes
    streaming-enabled: yes
  streaming-server: 192.168.0.240
    streaming-server: 192.168.0.240
      filter-stream: yes
        filter-stream: yes
            running: no
  filter-mac-address:
  filter-mac-protocol:
    filter-ip-address:
  filter-ip-protocol:
          filter-port:
    filter-direction: any
              running: no
[admin@MikroTik] tool sniffer> start
[admin@MikroTik] tool sniffer> start
[admin@MikroTik] tool sniffer> stop
[admin@MikroTik] tool sniffer> stop

Revision as of 10:20, 1 February 2012

Applies to RouterOS: v2.9, v3, v4+

Summary

Sub-menu: /tool sniffer
Packages required: system


Packet sniffer is a tool that can capture and analyze packets that are going to, leaving or going through the router (except the traffic that passes only through the switch chip).

Packet Sniffer Configuration

Sub-menu: /tool sniffer


Property Description
file-limit (integer 10..4294967295[KiB]; Default: 1000KiB) File size limit. Sniffer will stop when limit is reached.
file-name (string; Default: ) Name of the file where sniffed packets will be saved.
filter-ip-address (ip/mask[,ip/mask] (max 16 items); Default: ) Up to 16 ip addresses used as a filter
filter-mac-address (mac/mask[,mac/mask] (max 16 items); Default: ) Up to 16 MAC addresses and MAC address masks used as a filter
filter-port ([!]port[,port] (max 16 items); Default: ) Up to 16 comma separated entries used as a filter
filter-ip-protocol ([!]protocol[,protocol] (max 16 items); Default: ) Up to 16 comma separated entries used as a filter

IP protocols (instead of protocol names, protocol number can be used)

  • ipsec-ah - IPsec AH protocol
  • ipsec-esp - IPsec ESP protocol
  • ddp - datagram delivery protocol
  • egp - exterior gateway protocol
  • ggp - gateway-gateway protocol
  • gre - general routing encapsulation
  • hmp - host monitoring protocol
  • idpr-cmtp - idpr control message transport
  • icmp - internet control message protocol
  • icmpv6 - internet control message protocol v6
  • igmp - internet group management protocol
  • ipencap - ip encapsulated in ip
  • ipip - ip encapsulation
  • encap - ip encapsulation
  • iso-tp4 - iso transport protocol class 4
  • ospf - open shortest path first
  • pup - parc universal packet protocol
  • pim - protocol independent multicast
  • rspf - radio shortest path first
  • rdp - reliable datagram protocol
  • st - st datagram mode
  • tcp - transmission control protocol
  • udp - user datagram protocol
  • vmtp - versatile message transport
  • vrrp - virtual router redundancy protocol
  • xns-idp - xerox xns idp
  • xtp - xpress transfer protocol
filter-mac-protocol ([!]protocol[,protocol] (max 16 items); Default: ) Up to 16 comma separated entries used as a filter.

Mac protocols (instead of protocol names, protocol number can be used):

  • arp - Address Resolution Protocol
  • ip - Internet Protocol
  • ipv6 - Internet Protocol next generation
  • ipx - Internetwork Packet Exchange
  • rarp - Reverse Address Resolution Protocol
filter-stream (yes | no; Default: yes) Sniffed packets that are devised for sniffer server are ignored
filter-direction (any | rx | tx; Default: ) Specifies om which direction filtering will be applied.
interface (all | name; Default: all) Interface name on which sniffer will be running. all indicates that sniffer will sniff packets on all interfaces.
memory-limit (integer 10..4294967295[KiB]; Default: 100KiB) Memory amount used to store sniffed data.
memory-scroll (yes | no; Default: yes) Whether to rewrite older sniffed data when memory limit is reached.
only-headers (yes | no; Default: no) Save in the memory only packet's headers not the whole packet.
streaming-enabled (yes | no; Default: no) Defines whether to send sniffed packets to streaming server
streaming-server (IP; Default: 0.0.0.0) Tazmen Sniffer Protocol (TZSP) stream receiver


Example

In the following example streaming-server will be added, streaming will be enabled, file-name will be set to test and packet sniffer will be started and stopped after some time: 


[admin@MikroTik] tool sniffer> set streaming-server=192.168.0.240 \
\... streaming-enabled=yes file-name=test.pcap
[admin@MikroTik] tool sniffer> print
            interface: all
         only-headers: no
         memory-limit: 100KiB
        memory-scroll: yes
            file-name: test.pcap
           file-limit: 1000KiB
    streaming-enabled: yes
     streaming-server: 192.168.0.240
        filter-stream: yes
   filter-mac-address: 
  filter-mac-protocol: 
    filter-ip-address: 
   filter-ip-protocol: 
          filter-port: 
     filter-direction: any
              running: no
[admin@MikroTik] tool sniffer> start
[admin@MikroTik] tool sniffer> stop

Running Packet Sniffer

Commands: /tool sniffer start, /tool sniffer stop, /tool sniffer save


The commands are used to control runtime operation of the packet sniffer. The start command is used to start/reset sniffering, stop - stops sniffering. To save currently sniffed packets in a specific file save command is used.

Example

In the following example the packet sniffer will be started and after some time - stopped:

[admin@MikroTik] tool sniffer> start
[admin@MikroTik] tool sniffer> stop

Below the sniffed packets will be saved in the file named test:

[admin@MikroTik] tool sniffer> save file-name=test
[admin@MikroTik] tool sniffer> /file print
  # NAME                           TYPE         SIZE       CREATION-TIME
  0 test                           unknown      1350       apr/07/2003 16:01:52
[admin@MikroTik] tool sniffer>

Sniffed Packets

Sub-menu: /tool sniffer packet


This sub-menu allows to see the list of sniffed packets.

Property Description
data (read-only: text) Specified data inclusion in packets
direction (read-only: in | out) Indicates whether packet is entering (in) or leaving (out) the router
dscp (read-only: integer) IP DSCP field value
dst-address (read-only: IP address) Destination IP address
fragment-offset (read-only: integer) IP fragment offset
identification (read-only: integer) IP identification
interface (read-only: name) Name of the interface the packet has been captured on
ip-header-size (read-only: integer) The size of IP header
ip-packet-size (read-only: integer) The size of IP packet
ip-protocol (read-only: ddp | egp | encap | ggp | gre | hmp | icmp | icmpv6 | dpr-cmt | igmp | ip | ipencap | ipip | ipsec-ah | ipsec-esp | iso-tp4 | ospf | pim | pup | rdp | rspft | st | tcp | udp | vmtp | vrrp | xns-idp | xtp) The name/number of IP protocol
protocol (read-only: ip | arp | rarp | ipx | ipv6) The name/number of ethernet protocol
size (read-only: integer) Size of packet
src-address (read-only: IP address) Source IP address
src-mac (read-only: MAC address) Source MAC address
data (read-only: string) IP data
tcp-flags (read-only: ack | cwr | ece | fin | psh | rst | syn | urg) TCP flags
time (read-only: time) Time when packet arrived
ttl (read-only: integer) IP Time To Live
vlan-id (read-only: integer) VLAN-ID of the packet
vlan-priority (read-only: integer) VLAN-Priority of the packet

Packet Sniffer Protocols

Sub-menu: /tool sniffer protocol


In this submenu you can see all kind of protocols that have been sniffed.


Property Description
bytes (read-only: integer) Total number of data bytes
ip-protocol (read-only: ddp | egp | encap | ggp | gre | hmp | icmp | icmpv6 | dpr-cmt | igmp | ip | ipencap | ipip | ipsec-ah | ipsec-esp | iso-tp4 | ospf | pim | pup | rdp | rspft | st | tcp | udp | vmtp | vrrp | xns-idp | xtp) IP protocol
packets (read-only: integer) The number of packets
port (read-only: integer) The port of TCP/UDP protocol
protocol (read-only: ip | arp | rarp | ipx | ipv6) The name/number of the protocol
share (read-only: decimal) Specific type of traffic compared to all traffic in bytes

Example

[admin@MikroTik] tool sniffer protocol> print
  # PROTOCOL IP-PR... PORT          PACKETS   BYTES   SHARE
  0 ip                              77        4592    100 %
  1 ip       tcp                    74        4328    94.25 %
  2 ip       gre                    3         264     5.74 %
  3 ip       tcp      22 (ssh)      49        3220    70.12 %
  4 ip       tcp      23 (telnet)   25        1108    24.12 %
[admin@MikroTik] tool sniffer protocol>

Packet Sniffer Host

Sub-menu: /tool sniffer host


The submenu shows the list of hosts that were participating in data excange you've sniffed.


Property Description
address (read-only: IP address) IP address of the host
peek-rate (read-only: integer/integer) The maximum data-rate received/transmitted
rate (read-only: integer/integer) Current data-rate received/transmitted
total (read-only: integer/integer) Total packets received/transmitted

Example

In the following example we'll see the list of hosts:

[admin@MikroTik] tool sniffer host> print
  # ADDRESS       RATE         PEEK-RATE           TOTAL
  0 10.0.0.4      0bps/0bps    704bps/0bps         264/0
  1 10.0.0.144    0bps/0bps    6.24kbps/12.2kbps   1092/2128
  2 10.0.0.181    0bps/0bps    12.2kbps/6.24kbps   2994/1598
  3 10.0.0.241    0bps/0bps    1.31kbps/4.85kbps   242/866
[admin@MikroTik] tool sniffer host>

Packet Sniffer Connections

Sub-menu: /tool sniffer connection


Here you can get a list of the connections that have been watched during the sniffing time.


Property Description
active (read-only: yes | no) Indicates whether connection is active or not
bytes (read-only: integer/integer) Bytes in the current connection
dst-address (read-only: IP address:port) Destination address
mss (read-only: integer/integer) Maximum segment size
resends (read-only: integer/integer) The number of packets resends in the current connection
src-address (read-only: IP address:port) Source address

Example

The example shows how to get the list of connections:

[admin@MikroTik] tool sniffer connection> print
Flags: A - active
  #   SRC-ADDRESS       DST-ADDRESS             BYTES     RESENDS   MSS
  0 A 10.0.0.241:1839   10.0.0.181:23 (telnet)  6/42      60/0      0/0
  1 A 10.0.0.144:2265   10.0.0.181:22 (ssh)     504/252   504/0     0/0
[admin@MikroTik] tool sniffer connection>

Quick mode

Quick mode will display results as they are filtered out with limited size buffer for packets. There are several attributes that can be set up filtering. If no attributes are set current configuration will be used.


Property Description
duration length of the test in seconds
freeze-frame-interval time between data printout
interface intarface name or all
ip-address up to 16 addresses to filter
ip-protocol one of listed protocols, up to 16 entries
  • ipsec-ah - IPsec AH protocol *ipsec-esp - IPsec ESP protocol
  • ddp - datagram delivery protocol
  • egp - exterior gateway protocol
  • ggp - gateway-gateway protocol
  • gre - general routing encapsulation
  • hmp - host monitoring protocol
  • idpr-cmtp - idpr control message transport
  • icmp - internet control message protocol
  • icmpv6 - internet control message protocol v6
  • igmp - internet group management protocol
  • ipencap - ip encapsulated in ip
  • ipip - ip encapsulation
  • encap - ip encapsulation
  • iso-tp4 - iso transport protocol class 4
  • ospf - open shortest path first
  • pup - parc universal packet protocol
  • pim - protocol independent multicast
  • rspf - radio shortest path first
  • rdp - reliable datagram protocol
  • st - st datagram mode
  • tcp - transmission control protocol
  • udp - user datagram protocol
  • vmtp - versatile message transport
  • vrrp - virtual router redundancy protocol
  • xns-idp - xerox xns idp
  • xtp - xpress transfer protocol
mac-address up to 16 MAC addresses to filter
mac-protocol up 16 entries
  • arp - Address Resolution Protocol
  • ip - Internet Protocol
  • ipv6 - Internet Protocol next generation
  • ipx - Internetwork Packet Exchange
  • rarp - Reverse Address Resolution Protocol
port up to 16 entries to filter by

Download Sniffer Results

Sub-menu: /tool sniffer


Packet Sniffer results could be downloaded and viewed as file by specific program (for example Wireshark).


Property Description
file-name (string; Default: "") The name of the file where the sniffed packets will be saved to


Example

To save sniffed result to file set,

[admin@MikroTik] /tool sniffer set file-name=example

Run sniffer with required settings, 

[admin@MikroTik] /tool sniffer start

Do not forget to stop sniffer after sniffing is done, 

[admin@MikroTik] /tool sniffer stop


Sniffed results could be downloaded from /file by FTP client or Windows Drag-n-Drop (do not forget to use binary mode, when file is downloaded by FTP). 

[admin@MikroTik] /file print
 # NAME              TYPE             SIZE                 CREATION-TIME       
 0 example           file             44092                jan/02/2010 01:11:59

[ Top | Back to Content ]

Retrieved from "https://wiki.mikrotik.com/index.php?title=Manual:Tools/Packet_Sniffer&oldid=23094"