{"id":17205158,"url":"https://github.com/drnpkr/flowrecorder","last_synced_at":"2025-04-13T21:34:48.488Z","repository":{"id":59507323,"uuid":"143655739","full_name":"drnpkr/flowRecorder","owner":"drnpkr","description":"flowRecorder - a network traffic flow feature measurement tool","archived":false,"fork":false,"pushed_at":"2019-01-14T04:01:48.000Z","size":439,"stargazers_count":21,"open_issues_count":0,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T11:51:17.190Z","etag":null,"topics":["flow-features","ip-flow","network-monitoring","traffic-classification"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/drnpkr.png","metadata":{"files":{"readme":"README.RST","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-05T23:45:12.000Z","updated_at":"2025-01-06T14:16:20.000Z","dependencies_parsed_at":"2022-09-18T05:02:34.379Z","dependency_job_id":null,"html_url":"https://github.com/drnpkr/flowRecorder","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drnpkr%2FflowRecorder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drnpkr%2FflowRecorder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drnpkr%2FflowRecorder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drnpkr%2FflowRecorder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/drnpkr","download_url":"https://codeload.github.com/drnpkr/flowRecorder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248788300,"owners_count":21161721,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flow-features","ip-flow","network-monitoring","traffic-classification"],"created_at":"2024-10-15T02:24:28.232Z","updated_at":"2025-04-13T21:34:48.454Z","avatar_url":"https://github.com/drnpkr.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"flowRecorder\n============\n\nUse flowRecorder to turn packets into flow records.\nThe tool can work in two modes:\n\n1. Live packet capture from a NIC\n2. Parsing packets from a PCAP file.\n\nThe program can take a number of arguments:\n\n-d, --direction \u003cu,b\u003e  sets whether the packets will be organised into flows in uni- or bidirection\n\n-i, --interface interface_name  sets the networking interface card from which the packets will be sniffed\n\n-f, --file file_name  sets the name of the PCAP file\n\n-o, --out file_name  sets the name of the CSV file into which the results will be saved\n\n\n**Examples:**\n\n1. To read in a PCAP file and process the packets into flows\nin one direction, and save the results into a CSV file the following\ncommand can be used:\n\n::\n\n       python ~/flowRecorder/flowRecorder/flowRecorder.py -d u -f p.pcap -o results.csv\n\n2. To start capturing the packets from a NIC (en0) and organize them \ninto flow records in bidirection, the following command can be used:\n\n::\n\n       sudo python ~/flowRecorder/flowRecorder/flowRecorder.py -d b -i en0 -o results.csv\n\nNotes\n=====\n* Only creates flows for IP packets\n* Uses 5-tuple of ip_src, ip_dst, proto, src_port, dst_port flow keys as\n  common properties to identify TCP/UDP flows\n* Uses 3-tuple of ip_src, ip_dst, proto flow keys as\n  common properties to identify non-TCP/UDP flows\n* Packet lengths are calculated on sizes of IP packets (i.e. ignores\n  Ethernet framing size)\n* Flows are considered to have expired if more than a threshold of time\n  has passed since previous packet and when this occurs further packets\n  will be considered as a new flow and the previous packets moved to the\n  flow archive. Threshold for flow expiration is in the config file.\n\nDependencies\n============\n\nflowRecorder depends on the following libraries:\n\n-  dpkt\n-  pcapy\n-  hashlib\n-  numpy\n\nThese can be installed with (Python 2.x):\n\n::\n\n   sudo apt-get update\n   sudo apt-get install libpcap-dev\n\n   sudo apt install python-pip python-pytest python-yaml\n\n   pip install dpkt pcapy numpy\n\nThese can be installed with (Python 3.x):\n\n::\n\n   sudo apt-get update\n   sudo apt-get install libpcap-dev\n\n   sudo apt install python3-pip python-pytest3 python-yaml\n\n   pip3 install dpkt pcapy numpy\n\n\nTesting\n=======\n\nRun python 2.x self tests with:\n\n::\n\n    cd ~/flowRecorder/tests/; py.test\n\nRun python 3.x self tests with:\n\n::\n\n    cd ~/flowRecorder/tests/; py.test-3\n\nKnown issues\n============\n\nThe program is not optimized for processing large PCAP files. For\nexample, processsing 500K packets takes approximately 40 minutes. The\nprocessing time mainly depends on the selected directionality and the\ncomputing resources.\n\n**The tool is under testing. Please report any issues/bugs to the\ndevelopers.**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrnpkr%2Fflowrecorder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdrnpkr%2Fflowrecorder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrnpkr%2Fflowrecorder/lists"}