Initial commit

Author: datthinh1801

.gitignore

@@ -0,0 +1,10 @@
+Archive/
+__pycache__/
+venv/
+*.csv
+*.csv#
+*.ods
+*.ods#
+*.pcap
+*.pyc
+.idea

.gitlab-ci.yml

@@ -0,0 +1,95 @@
+image: python:3.7
+
+stages:
+  - test
+  - build
+  - release
+  - integration test
+  - deploy
+
+variables:
+  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+
+before_script:
+  - pip install -U pip
+  - pip install virtualenv
+  - virtualenv venv
+  - source venv/bin/activate
+  - pip install tox twine
+
+cache:
+  key: "$CI_JOB_STAGE-$CI_COMMIT_REF_SLUG"
+  paths:
+    - .cache/
+    - .tox/
+    - venv/
+
+linter:
+  stage: test
+  allow_failure: true
+  script:
+    - tox -e linter
+
+test:
+  stage: test
+  script:
+    - tox -e py37
+  artifacts:
+    when: always
+    reports:
+      junit: report.xml
+
+build:
+  stage: build
+  script:
+    - make build
+    - tox -e pypi
+    - make install
+    - cicflowmeter -h
+  needs: [test]
+  artifacts:
+    paths:
+      - dist/
+
+release:
+  stage: release
+  script:
+    - twine upload dist/* -u "__token__" -p $TWINE_TOKEN
+  when: manual
+  artifacts:
+    paths:
+      - dist
+  only:
+    - tags
+# integrate:
+#   stage: integration test
+#   script: echo test
+#   needs:
+#     - linter
+#     - test
+#     - build
+
+# deploy_staging:
+#   stage: deploy
+#   script: echo "Deploy here"
+#   environment:
+#     name: staging
+#     url: https://beta.example.com
+#   needs: [integrate]
+
+# deploy_production:
+#   stage: deploy
+#   script: echo "Deploy here"
+#   environment:
+#     name: production
+#     url: https://example.com
+#   when: manual
+#   needs: [integrate]
+#   only:
+#     - master
+
+# notification:
+#   stage: .post
+#   script:
+#     - curl -X POST $ZULIP_URL -u $ZULIP_EMAIL:$ZULIP_API -d "type=private" -d "to=$ZULIP_EMAIL" -d "content=$CI_COMMIT_DESCRIPTION - passed the tests."
+#   needs: [integrate]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Hieu Le
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,17 @@
+VERSION:=$(shell python setup.py --version)
+
+install:
+	python setup.py install
+
+uninstall:
+	pip uninstall cicflowmeter -y
+
+clean:
+	rm -rf *.egg-info build dist report.xml
+
+build:
+	python setup.py sdist bdist_wheel --universal
+
+release:
+	@git tag -a v$(VERSION)
+	@git push --tag

README.md

@@ -0,0 +1,40 @@
+# Python CICFlowMeter
+
+> This project is not maintained actively by me. If you found something wrong (bugs, incorrect results) feel free to create merge request.
+
+### Installation
+
+```sh
+git clone https://gitlab.com/hieulw/cicflowmeter
+cd cicflowmeter
+python setup.py install
+```
+
+### Usage
+
+```sh
+usage: cicflowmeter [-h] (-i INPUT_INTERFACE | -f INPUT_FILE) [-c] [-u URL_MODEL] output
+
+positional arguments:
+  output                output file name (in flow mode) or directory (in sequence mode)
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -i INPUT_INTERFACE    capture online data from INPUT_INTERFACE
+  -f INPUT_FILE         capture offline data from INPUT_FILE
+  -c, --csv, --flow     output flows as csv
+```
+
+Convert pcap file to flow csv:
+
+```
+cicflowmeter -f example.pcap -c flows.csv
+```
+
+Sniff packets real-time from interface to flow csv: (**need root permission**)
+
+```
+cicflowmeter -i eth0 -c flows.csv
+```
+
+### Reference: https://www.unb.ca/cic/research/applications.html#CICFlowMeter

requirements.txt

@@ -0,0 +1,4 @@
+numpy==1.18
+scipy==1.4.1
+scapy==2.4.3
+requests

setup.cfg

@@ -0,0 +1,5 @@
+[flake8]
+max-line-length = 110
+
+[black]
+line-length=100

setup.py

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+
+import io
+import os
+
+from setuptools import find_packages, setup
+
+# Package meta-data.
+NAME = "cicflowmeter"
+DESCRIPTION = "CICFlowMeter V3 Python Implementation"
+URL = "https://gitlab.com/hieulw/cicflowmeter"
+EMAIL = "[email protected]"
+AUTHOR = "Le Hieu"
+REQUIRES_PYTHON = ">=3.7.0"
+VERSION = None
+
+
+def get_requirements(source: str = "requirements.txt"):
+    requirements = []
+    with open(source) as f:
+        for line in f:
+            package, _, comment = line.partition("#")
+            package = package.strip()
+            if package:
+                requirements.append(package)
+
+    return requirements
+
+
+REQUIRED = get_requirements("requirements.txt")
+
+# The rest you shouldn't have to touch too much :)
+# ------------------------------------------------
+# Except, perhaps the License and Trove Classifiers!
+# If you do change the License, remember to change the Trove Classifier for that!
+
+here = os.path.abspath(os.path.dirname(__file__))
+
+# Import the README and use it as the long-description.
+# Note: this will only work if 'README.md' is present in your MANIFEST.in file!
+try:
+    with io.open(os.path.join(here, "README.md"), encoding="utf-8") as f:
+        long_description = "\n" + f.read()
+except FileNotFoundError:
+    long_description = DESCRIPTION
+
+# Load the package's __version__.py module as a dictionary.
+about = {}
+if not VERSION:
+    prefix = "src"
+    project_slug = NAME.lower().replace("-", "_").replace(" ", "_")
+    with open(os.path.join(here, prefix, project_slug, "__init__.py")) as f:
+        exec(f.read(), about)
+else:
+    about["__version__"] = VERSION
+
+# Where the magic happens:
+setup(
+    name=NAME,
+    version=about["__version__"],
+    description=DESCRIPTION,
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author=AUTHOR,
+    author_email=EMAIL,
+    python_requires=REQUIRES_PYTHON,
+    url=URL,
+    packages=find_packages("src"),
+    # package_dir={"cicflowmeter": "src/cicflowmeter"},
+    package_dir={"": "src"},
+    entry_points={
+        "console_scripts": ["cicflowmeter=cicflowmeter.sniffer:main"],
+    },
+    install_requires=REQUIRED,
+    include_package_data=True,
+    license="MIT",
+    classifiers=[
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: Implementation :: CPython",
+        "Programming Language :: Python :: Implementation :: PyPy",
+    ],
+)

src/cicflowmeter/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.6"

src/cicflowmeter/constants.py

@@ -0,0 +1,4 @@
+EXPIRED_UPDATE = 240
+CLUMP_TIMEOUT = 1
+ACTIVE_TIMEOUT = 0.005
+BULK_BOUND = 4