OFP_Snifferは、トラブルシューティングや学習目的で使用するOpenFlowスニファです。

現在バージョン1.2では、すべてのOpenFlow 1.0メッセージを解析し、InfluxDB、Grafana、Slackと連携します。OpenFlow 1.3はOFP_Snifferバージョン1.3で利用可能になる予定です（近日リリース予定）。

Linuxシェル上で直接動作し、ネットワーク上またはlibpcapファイルからすべてのOpenFlowメッセージを解析します。OFP_Snifferを使用すると、X11やWiresharkを開かずにOpenFlowメッセージと関連するエラー（存在する場合）を簡単に追跡できます。OFP_SnifferはPython 3.6で書かれており、AmLight SDNデプロイメント（www.sdn.amlight.net）をサポートしています。AmLight SDNはInternet2 FlowSpace Firewall、OESS、On.Lab ONOSを使用しており、これらのアプリはテスト済みで完全にサポートされています。

コマンドラインインターフェースツールとして、以下の入力パラメータがあります：

# ./ofp_sniffer.py -h
Usage:
 ./ofp_sniffer.py [-p min|full] [-f pcap_filter] [-F filter_file] [-i dev] [-r pcap_file]
	 -p : print all TCP/IP headers. Default: min
	 -f pcap_filter or --pcap-filter=pcap_filter: add a libpcap filter
	 -F filters_file.json or --filters-file=filters.json
	 -i interface or --interface=interface. Default: eth0
	 -r captured.pcap or --src-file=captured.pcap
	 -T topology.json or --topology-file=topology.json
	 -w file or --save-to-file=file: save output to file provided
	 -o or --print-ovs : print using ovs-ofctl format
	 -h or --help : prints this help
	 -c or --no-colors: removes colors
	 -v or --version : prints version
	 -O WARN:CRIT or --oess-fvd=WARN:CRIT: monitor OESS FVD status
	 -N or --notify-via-slack: send notifications via Slack. Param is the Slack channel
	 -S or --enable-statistics: creates statistics

バージョン1.0から、特定のニーズに対応するためのアプリがサポートされています。例えば、OESS FVDメッセージの追跡や、REST経由で統計を作成し、NMS（例：Zabbix）に統合することができます。

More info: https://amlight.net/wp-content/uploads/2015/03/wpeif-2016-ofpsniffer.pdf

##################### インストール ######################

Requires Python 3.6
git clone https://github.com/amlight/ofp_sniffer.git
cd ofp_sniffer
pip3.6 install -r docs/requirements.txt
sudo ./ofp_sniffer.py

##################### 例 #########################

以下に例を示します：

----------------------           -------------------------
| Mininet            |           | OVS-OFCTL 2.3.0       |
| 192.168.56.101:6634| <-------> | eth1 - 192.168.56.102 |
----------------------           -------------------------

# ovs-ofctl dump-flows tcp:192.168.56.101:6634
 cookie=0x0, duration=2183.377s, table=0, n_packets=0, n_bytes=0, idle_age=2183, in_port=1,dl_vlan=2 actions=output:2

# ./ofp_sniffer.py -i eth1 -f " or port 6634"
Sniffing device eth1
2015-09-13 11:47:38.655503 192.168.56.102:37450 -> 192.168.56.101:6634 Size: 74
OpenFlow Version: 1.0(1) Type: Hello(0) Length: 8  XID: 1
1 OpenFlow Hello

2015-09-13 11:47:38.656964 192.168.56.101:6634 -> 192.168.56.102:37450 Size: 74
OpenFlow Version: 1.0(1) Type: Hello(0) Length: 8  XID: 174
174 OpenFlow Hello

2015-09-13 11:47:38.657638 192.168.56.102:37450 -> 192.168.56.101:6634 Size: 86
OpenFlow Version: 1.0(1) Type: Vendor(4) Length: 20  XID: 2
2 OpenFlow Vendor : NICIRA(0x2320)
2 OpenFlow Vendor Data:  12  2 

2015-09-13 11:47:38.657870 192.168.56.102:37450 -> 192.168.56.101:6634 Size: 74
OpenFlow Version: 1.0(1) Type: BarrierReq(18) Length: 8  XID: 3
3 OpenFlow Barrier Request

2015-09-13 11:47:38.659270 192.168.56.101:6634 -> 192.168.56.102:37450 Size: 74
OpenFlow Version: 1.0(1) Type: BarrierRes(19) Length: 8  XID: 3
3 OpenFlow Barrier Reply

# ovs-ofctl add-flow tcp:192.168.56.101:6634 "dl_dst=10:00:00:01:20:00,dl_type=0x88bc actions=mod_vlan_vid:14,output:2"

# ./ofp_sniffer.py -i eth1 -f " or port 6634"

2015-09-13 11:49:08.171463 192.168.56.102:37451 -> 192.168.56.101:6634 Size: 154
OpenFlow Version: 1.0(1) Type: FlowMod(14) Length: 88  XID: 2
2 OpenFlow Match - wildcards: 3678439 dl_type: 0x88bc dl_dst: 10:00:00:01:20:00
2 OpenFlow Body - Cookie: 0x00 Command: Add(0) Idle/Hard Timeouts: 0/0 Priority: 32768 Buffer ID: 0xffffffff Out Port: 65535 Flags: Unknown Flag(0)
2 OpenFlow Action - Type: SetVLANID Length: 8 VLAN ID: 14 Pad: 0
2 OpenFlow Action - Type: OUTPUT Length: 8 Port: 2 Max Length: 0

# ovs-ofctl del-flows tcp:192.168.56.101:6634 "dl_type=0x88bc,dl_dst=10:00:00:01:20:00, "

2015-09-13 11:50:43.636925 192.168.56.102:37454 -> 192.168.56.101:6634 Size: 138
OpenFlow Version: 1.0(1) Type: FlowMod(14) Length: 72  XID: 2
2 OpenFlow Match - wildcards: 3678439 dl_type: 0x88bc dl_dst: 10:00:00:01:20:00
2 OpenFlow Body - Cookie: 0x00 Command: Delete(3) Idle/Hard Timeouts: 0/0 Priority: 32768 Buffer ID: 0xffffffff Out Port: 65535 Flags: Unknown Flag(0)

# ovs-ofctl add-flow tcp:192.168.56.101:6634 "dl_dst=10:00:00:01:20:00,dl_type=0x88bc actions=mod_vlan_vid:14,output:2"

2015-09-13 11:52:58.563737 192.168.56.102:37455 -> 192.168.56.101:6634 Size: 154
OpenFlow Version: 1.0(1) Type: FlowMod(14) Length: 88  XID: 2
2 OpenFlow Match - wildcards: 3678439 dl_type: 0x88bc dl_dst: 10:00:00:01:20:00
2 OpenFlow Body - Cookie: 0x00 Command: Add(0) Idle/Hard Timeouts: 0/0 Priority: 32768 Buffer ID: 0xffffffff Out Port: 65535 Flags: Unknown Flag(0)
2 OpenFlow Action - Type: SetVLANID Length: 8 VLAN ID: 14 Pad: 0
2 OpenFlow Action - Type: OUTPUT Length: 8 Port: 2 Max Length: 0

フィルタの使用：

オプション -F ./filters.json を使用すると、いくつかのオプションがあります：

"rejected_of_types" : 表示したくないOpenFlowメッセージタイプを選択するために使用します。OpenFlowのバージョンに応じて異なるフィルタを定義できます。

Ethertypeによるフィルタ：

PacketOutまたはPacketInメッセージで転送される特定のEthertypeを探している場合、他の全てを除外することで簡単に可視化できます。

例：

  "filters":{
      "ethertypes": {
          "lldp" : 0,
          "fvd"  : 0,
          "arp"  : 1,
          "others": [ "88b5" ]
      },
      "packetIn_filter": {
          "switch_dpid": "any",
          "in_port": "any"
      },
      "packetOut_filter": {
          "switch_dpid": "any",
          "out_port": "any"
      }
  }
}

ethertypeセクションでは、1はフィルタ、0は表示を意味します。例では、ARPメッセージは表示されず、OESS FVDとLLDPは表示されます。"others"セクションにEthertypeの16進数（0xなし）をカンマ区切りで追加できます。

"packetIn_filter": 表示したいPacketIn + LLDPメッセージを定義するために使用します。スイッチごと、ポートごとに定義できます。スイッチには、使用しているアプリケーションで認識されるdatapath_idを使用する必要があります。例えば、一部のアプリはc_idフィールドにof:dpid_idを、他のアプリはdpid:dpid_idを設定します。ポートには、ポート名ではなくOpenFlowポートIDを使用します。例えば、Brocadeではeth1/1 == 1なので、eth1/1の代わりに1を使用します。

"packetOut_filter": 表示したいPacketOut + LLDPメッセージを定義するために使用します。スイッチごと、ポートごとに定義できます。スイッチには、使用しているアプリケーションで認識されるdatapath_idを使用する必要があります。例えば、一部のアプリはc_idフィールドにof:dpid_idを、他のアプリはdpid:dpid_idを設定します。ポートには、ポート名ではなくOpenFlowポートIDを使用します。例えば、Brocadeではeth1/1 == 1なので、eth1/1の代わりに1を使用します。

OpenFlowプロキシのサポート：

OpenFlowプロキシを使用する場合、スニッフィングするインターフェースの選択に応じて、次の2つの可能性のいずれかが表示されます: IP_Controller <-> IP_Proxy、IP_Proxy <-> IP_Switch。

どのコントローラがどのスイッチと通信しているかを関連付けるのは難しいです。このトラブルシューティングを容易にするために、OpenFlowスニファは自動ですべてのPacketOut + LLDPメッセージを監視し、{(IP, port): name_switch}という辞書を作成します。このケースに該当する場合は、ファイルdocs/topology.jsonを変更してください。次回スニファを実行すると、IPアドレスと、括弧内にプロキシの背後にあるデバイスが表示されます。例：

2015-12-16 15:37:41.563621 200.0.207.79(andes1):7801 -> 190.103.184.135:6633 Size: 157 Bytes
OpenFlow Version: 1.0(1) Type: PacketIn(10) Length: 103  XID: 0
0 PacketIn: buffer_id: 0xffffffff total_len: 85 in_port: 49 reason: OFPR_NO_MATCH(0) pad: 0
0 Ethernet: Destination MAC: ff:ff:ff:ff:ff:ff Source MAC: de:ad:be:ef:ba:11 Protocol: 0x8100
0 Ethernet: Prio: 0 CFI: 0 VID: 3720
0 LLDP: Chassis Type(1) Length: 7 SubType: 4 ID: of:cc4e249102000000
0 LLDP: Port Type(2) Length: 5 SubType: 2 ID: 2
0 LLDP: TTL(3) Length: 2 Seconds: 120
0 LLDP: END(0) Length: 0

2015-12-16 15:37:41.564414 190.103.184.133(andes1):56132 -> 190.103.187.72:6633 Size: 165 Bytes
OpenFlow Version: 1.0(1) Type: PacketIn(10) Length: 99  XID: 0
0 PacketIn: buffer_id: 0xffffffff total_len: 81 in_port: 49 reason: OFPR_NO_MATCH(0) pad: 0
0 Ethernet: Destination MAC: ff:ff:ff:ff:ff:ff Source MAC: de:ad:be:ef:ba:11 Protocol: 0x8942
0 LLDP: Chassis Type(1) Length: 7 SubType: 4 ID: of:cc4e249102000000
0 LLDP: Port Type(2) Length: 5 SubType: 2 ID: 2
0 LLDP: TTL(3) Length: 2 Seconds: 120
0 LLDP: END(0) Length: 0

名前（andes1）は、DPID cc4e249126000000を持つ「andes1」というスイッチを表しています。例に示されているDPIDは同じではないことに注意してください。PacketInメッセージを例として使用しているためです。PacketInは「andes1」の隣接スイッチのDPIDを表示します。

このコードがお役に立てば幸いです。

質問/提案: AmLight Dev Team [email protected]

ofp_sniffer

人気