[{"_1":2,"_186":-5,"_187":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_161":162},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":85,"_104":105,"_154":-5,"_155":11,"_156":17,"_157":11,"_158":-5,"_159":160},"canonicalUrl","https://hub.docker.com/r/intracom/oftraf/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","intracom","reponame","oftraf","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":29,"_69":70,"_75":17,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2016-10-05T12:49:41.420195Z","description","pcap-based, RESTful OpenFlow traffic monitor","is_private","last_updated","2017-02-28T11:36:44.911879Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",400,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","[![Build Status](https://travis-ci.org/intracom-telecom-sdn/oftraf.svg)](https://travis-ci.org/intracom-telecom-sdn/oftraf)\n[![Code Health](https://landscape.io/github/intracom-telecom-sdn/oftraf/master/landscape.svg?style=flat)](https://landscape.io/github/intracom-telecom-sdn/oftraf/master)\n[![Docker Automated build](https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg?maxAge=2592000)](https://hub.docker.com/r/intracom/oftraf/)\n[![Code Issues](https://www.quantifiedcode.com/api/v1/project/8e2065e3b1854903895c4745f7a3b829/badge.svg)](https://www.quantifiedcode.com/app/project/8e2065e3b1854903895c4745f7a3b829)\n\n\n\n# oftraf\n\npcap-based, RESTful OpenFlow traffic monitor\n\nFilters OpenFlow packets from a network interface and reports statistics.\n\nFeatures:\n\n- **Summary and detailed OF statistics in real-time**: summary statistics refer to\n total incoming and outgoing OF traffic (from the viewpoint of the SDN\n controller). Detailed statistics offer a finer-grain breakdown based on the OF\n message type. Both classes are being updated and displayed in real-time.\n- Support for **OF1.0 and OF1.3 protocols**\n- **REST interface** for accessing statistics. This enables remote online\n monitoring of a controller's incoming and outgoing OF traffic.\n- Non-intrusive to the controller\n\n# Requirements\n\n- Python 2\n- `pypcap`, `dpkt` and `bottle` Python packages\n\nOn an Ubuntu-based machine, install the required packages as follows:\n\n```bash\nsudo apt-get install python-pypcap python-dpkt python-bottle\n```\n\n# Usage\n\n```bash\nsudo python oftraf.py --rest-host --rest-port --of-port --ifname [--server]\n```\n\nCommand line arguments:\n\n- `--rest-host`: the IP or hostname of the interface the REST server should listen to\n- `--rest-port`: the port the REST server should listen to\n- `--of-port`: the OpenFlow port number based on which packet filtering will take place\n- `--ifname`: the network interface to sniff packets from\n- `--server`: run `oftraf` as server only without printing stats\n\nExample:\n\n1. Launch an SDN controller and a Mininet topology on the same machine\n2. Launch `oftraf`:\n ```bash\n sudo python oftraf.py --rest-host localhost --rest-port 5555 --of-port 6653 --ifname lo\n ```\n This starts sniffing and counting OF packets on the `lo` interface. The statistics are\n being displayed in real-time in a curses-based console which refreshes every 1 second.\n Sample output:\n\n```\nElapsed seconds:89.1658\nOF in pps: 49.0\nOF in Bps: 27532.0\nOF out pps: 29.0\nOF out Bps: 16000.0\n\nPacket Type Count Bytes\n--------------------------------------------------------------\nTotal OF in: 9807 4275930\nTotal OF out: 5282 3328935\n\nIncoming\n----------------\nOF13_OFPT_ECHO_REQUEST: 6 360\nOF13_OFPT_ERROR: 10 800\nOF13_OFPT_FEATURES_REPLY: 10 840\nOF13_OFPT_HELLO: 10 680\nOF13_OFPT_MULTIPART_REPLY: 6424 2061320\nOF13_OFPT_PACKET_IN: 508 89560\nOF13_OFPT_PORT_STATUS: 26 3432\nOF10_OFPT_ECHO_REQUEST: 9 540\nOF10_OFPT_ERROR: 4 288\nOF10_OFPT_FEATURES_REPLY: 10 1512\nOF10_OFPT_HELLO: 10 600\nOF10_OFPT_PACKET_IN: 284 43054\nOF10_OFPT_PORT_STATUS: 81 9396\nOF10_OFPT_STATS_REPLY: 648 200048\n\nOutgoing\n----------------\nOF13_OFPT_ECHO_REPLY: 6 360\nOF13_OFPT_FEATURES_REQUEST: 7 420\nOF13_OFPT_HELLO: 14 1024\nOF13_OFPT_MULTIPART_REQUEST: 1301 1159444\nOF13_OFPT_PACKET_OUT: 153 57012\nOF13_OFPT_SET_CONFIG: 11 992\nOF10_OFPT_ECHO_REPLY: 9 540\nOF10_OFPT_FEATURES_REQUEST: 6 360\nOF10_OFPT_HELLO: 7 428\nOF10_OFPT_PACKET_OUT: 47 11515\nOF10_OFPT_SET_CONFIG: 11 704\nOF10_OFPT_STATS_REQUEST: 100 92344\n```\n\n **OF in** and **OF out** refer to OF traffic traveling into and out of the SDN controller,\n respectively. **pps** and **Bps** are packets-per-second and bytes-per-second.\n\n3. The REST server starts together with `oftraf`. Let's try to send some statistics requests.\n\n On another console, issue the following REST request to access summary statistics:\n ```bash\n curl http://localhost:5555/get_of_counts\n ```\n Response:\n\n ```json\n {\n \"OF_out_counts\": [366417, 114676077],\n \"OF_in_counts\": [700581, 212923343]\n }\n ```\n In each statistic returned, the first number (e.g. 366417) is the packet count, and the\n second (114676077) is the byte count.\n\n `OF_out_counts` refers to the packets travelling from the controller to the\n switches, `OF_in_counts` refers to the packets travelling at the opposite\n direction.\n\n To access detailed OF13 statistics, issue the following REST request:\n\n ```bash\n curl http://localhost:5555/get_of13_counts\n ```\n\n Response:\n\n ```json\n {\n \"OF13_in_counts\":\n {\n \"OFPT_ERROR\": [10, 800],\n \"OFPT_PORT_STATUS\": [82, 10824],\n \"OFPT_MULTIPART_REPLY\": [107, 28276],\n \"OFPT_FEATURES_REPLY\": [10, 840],\n \"OFPT_HELLO\": [10, 680],\n \"OFPT_PACKET_IN\": [216, 38324],\n \"OFPT_ECHO_REQUEST\": [10, 600]\n },\n \"OF13_out_counts\":\n {\n \"OFPT_PACKET_OUT\": [35, 7201],\n \"OFPT_FEATURES_REQUEST\": [7, 420],\n \"OFPT_MULTIPART_REQUEST\": [17, 8240],\n \"OFPT_SET_CONFIG\": [9, 1332],\n \"OFPT_HELLO\": [11, 788],\n \"OFPT_ECHO_REPLY\": [10, 600]\n }\n}\n ```\n\n Similarly, use the following REST request for OF10 statistics:\n\n ```bash\n curl http://localhost:5555/get_of10_counts\n ```\n\n4. To stop `oftraf`, hit Ctrl-C in the console where it runs, or issue a\n REST request as follows:\n\n ```bash\n $ curl http://localhost:5555/stop\n ```\n\n# Deployment of Docker containers\n\nThis project provides two options for deployment with the use of Docker\nContainers\n\n- Deploy locally, using a `Dockerfile`\n- Deploy using a prebuild image from [Docker Hub](https://hub.docker.com/u/intracom/)\n\nIn both cases, the [docker](https://www.docker.com/) platform must be installed\non the host side.\n\n- essential tool: [docker](https://docs.docker.com/engine/installation/) (v.1.12.1 or later)\n\nand the actions below have to be followed\n\n- Give non-root access to docker daemon\n * Add the docker group if it doesn't already exist sudo groupadd docker\n * Add the connected user \"${USER}\" to the docker group. Change the user name to\nmatch your preferred user\n ```bash\n sudo gpasswd -a ${USER} docker\n ```\n * Restart the Docker daemon:\n ```bash\n sudo service docker restart\n ```\n## Deploy using Dockerfile\n\nThere are 2 different folders, containing `Dockerfiles`,\nunder the path `/deploy`. The one `Dockerfile`\nis for a `proxy` environment and one is for a `no_proxy` environment. The\nnames of the folders containing these `Dockerfiles` are `proxy` and `no_proxy`\nrespectively.\n\nin order to deploy the `proxy` `Dockerfile` (`/deploy/proxy/Dockerfile`),\nedit the proxy settings in the file. These settings are in the following lines.\n\n```bash\nENV http_proxy=\"http://:/\"\nENV https_proxy=\"http://:/\"\n\nRUN echo 'Acquire::http::Proxy \"http://:/\";' | tee -a /etc/apt/apt.conf\nRUN echo 'Acquire::https::Proxy \"http://:/\";'| tee -a /etc/apt/apt.conf\n\nRUN echo \"http_proxy=http://:/\" | tee -a /etc/environment\nRUN echo \"https_proxy=http://:/\" | tee -a /etc/environment\nRUN echo \"no_proxy=127.0.0.1,localhost\" | tee -a /etc/environment\nRUN echo \"HTTP_PROXY=http://:/\" | tee -a /etc/environment\nRUN echo \"HTTPS_PROXY=http://:/\" | tee -a /etc/environment\nRUN echo \"NO_PROXY=127.0.0.1,localhost\" | tee -a /etc/environment\n\n```\n\nAfter configuring the proxy settings, from the path of `Dockerfile`, run the command\n\n```bash\ndocker build -t oftraf_base .\n```\n\nThe above command would be the first step in case we deploy a `no_proxy` docker\nenvironment.\n\nVerify that the image has been built successfully by running the command\n\n```bash\n docker images\n ```\n\nthe output of this command should look like the following sample\n\n```bash\nREPOSITORY TAG IMAGE ID CREATED SIZE\n oftraf_base c2c3152907b5 4 minutes ago 275.1 MB\n```\n\nto run the environment and start the `Docker container`, execute the following line\n\n```bash\ndocker run -it :oftraf_base /bin/bash\n```\n\nand enter the password\n\n```bash\npassword: root123\n```\n\nAfter the above step we get a console inside the docker environment and `oftraf`\ncan be executed with the following command\n\n```bash\n/opt/oftraf/start.sh \n```\n\nor alternatively, activate the virtual environment\n\n```bash\nsource /opt/venv_oftraf/bin/activate\n```\n\nand follow the [Usage](https://github.com/intracom-telecom-sdn/oftraf#usage)\nsection.\n\n## Deploy using prebuild image\n\nThe first step is to get the image from [Docker Hub](https://hub.docker.com/u/intracom/)\n\n```bash\ndocker pull intracom/nstat-sdn-controllers\n```\nOnce the image pull operation is complete, check locally the existence of the\nimage\n\n```bash\ndocker images\n```\nwhich should list the ``intracom/nstat-sdn-controllers:latest`` image. For\nrunning a container out of the ```intracom/nstat-sdn-controllers:latest``` image\n\n```\ndocker run -it intracom/nstat-sdn-controllers /bin/bash\n```\n\n``password: root123``\n\nRun `oftraf` as described in the previous section after starting the `Docker container`.\n\n# Future Extensions\n\n- more efficient OF packet filtering utilizing BPF filters\n- breakdown of certain OF message types to finer-grain subtypes (e.g. multipart replies)\n- graphical client dashboard\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",3212736904,"orgData",{"_86":87,"_88":89,"_90":91,"_92":29,"_93":94,"_95":94,"_96":94,"_97":94,"_98":99,"_100":94,"_101":94,"_102":94,"_103":17},"id","cbcef7c3e6f549a2a7feb53d5ab3b490","uuid","cbcef7c3-e6f5-49a2-a7fe-b53d5ab3b490","type","organization","orgname","full_name","","location","company","profile_url","date_joined","2016-08-23T10:17:47.2158Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[106,142],{"_107":40,"_108":109,"_110":111,"_86":112,"_113":114,"_46":131,"_132":109,"_133":29,"_134":52,"_53":135,"_136":137,"_138":122,"_139":131,"_140":61,"_141":17},"content_type","creator",1050617,"full_size",226365473,5274608,"images",[115],{"_116":117,"_118":119,"_120":94,"_121":122,"_123":124,"_125":126,"_127":94,"_128":-5,"_129":111,"_59":61,"_130":-5},"architecture","amd64","digest","sha256:d58d53c7fbf4a6bb58f74c87c983dd92fe00dff2a8e5c638cc9af35a7d837221","features","last_pulled","2026-09-08T22:40:47.657936821Z","last_pushed","2017-02-28T11:36:45Z","os","linux","os_features","os_version","size","variant","2017-02-28T11:36:44.507255Z","last_updater","last_updater_username","media_type","latest","repository",959839,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_107":40,"_108":143,"_110":144,"_86":145,"_113":146,"_46":151,"_132":143,"_133":152,"_134":52,"_53":153,"_136":137,"_138":149,"_139":151,"_140":61,"_141":17},1062587,236654011,5277538,[147],{"_116":117,"_118":148,"_120":94,"_121":149,"_123":150,"_125":126,"_127":94,"_128":-5,"_129":144,"_59":61,"_130":-5},"sha256:869d329d095fe7f5683ff2ffec185f86ba5cba5ca9d519acdc1152a815041011","2026-09-08T22:40:56.900971374Z","2017-01-05T14:10:12Z","2017-01-05T14:10:11.234181Z","konpap","proxy","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":163,"_170":171,"_159":184,"_185":11},{"_36":164,"_38":165,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":166,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":58,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":29,"_69":167,"_75":17,"_76":169,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":168},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_172":173,"_174":-5,"_175":-5,"_176":177},"count",2,"next","previous","results",[178,181],{"_107":40,"_108":109,"_110":111,"_86":112,"_113":179,"_46":131,"_132":109,"_133":29,"_134":52,"_53":135,"_136":137,"_138":122,"_139":131,"_140":61,"_141":17},[180],{"_116":117,"_118":119,"_120":94,"_121":122,"_123":124,"_125":126,"_127":94,"_128":-5,"_129":111,"_59":61,"_130":-5},{"_107":40,"_108":143,"_110":144,"_86":145,"_113":182,"_46":151,"_132":143,"_133":152,"_134":52,"_53":153,"_136":137,"_138":149,"_139":151,"_140":61,"_141":17},[183],{"_116":117,"_118":148,"_120":94,"_121":149,"_123":150,"_125":126,"_127":94,"_128":-5,"_129":144,"_59":61,"_130":-5},[],"canDeleteTags","actionData","errors"]

intracom/oftraf

Tags for intracom/oftraf