Skip to main content

Extract signatures from IoT event network traffic

Project description

Extraction of network signatures of IoT events

GitHub License GitHub language count

signature-extraction is a Python package which extracts network pattern signatures, i.e. a sequence of network flows, from network traffic related to IoT (smart home) events.

Glossary

  • (User) event: interaction with an IoT device that triggers a change in its state, and the associated network traffic.
  • (Network) packet: unit of data transmitted over a network.
  • (Network) 5-tuple: set of five values that uniquely identify a network flow: source IP address, source port, destination IP address, destination port, and layer 4 protocol. Includes part of, or all, the packet's 5-tuple, as well as other protocol-dependent features, e.g.:
    • HTTP: method, URI
    • DNS: query name, query type
    • DHCP: message type
    • CoAP: message type, method, URI
  • (Network) flow: time-ordered sequence of network packets having the same network 5-tuple.
  • (Packet/Flow) fingerprint: set of relevant packet features which identify a packet / flow.
  • Network pattern: sequence of network flows that repeatedly occurs together, potentially indicating a specific user event.
  • (Event) signature: network pattern that uniquely identifies a user event.

Features

This package is split into three main modules, each responsible for part of the pipeline:

Translation to firewall

Additionally, flow fingerprints can be converted to configuration scripts for @fdekeers's smart-home-firewall, or to a YAML profile exhaustively describing such configuration.

Installation

From PyPI

pip install signature-extraction

PyPI project page

From local source

Clone the repository and install the dependencies using pip.

git clone https://github.com/smart-home-network-security/signature-extraction.git
cd signature-extraction
pip install -r requirements.txt
pip install .

License

This project is licensed under the GPL-3.0 License -- see the LICENSE file for details.

Acknowledgements

This work is part of the Smart Home Network Security research project made by @fdekeers and UCLouvain.

It was partially authored by @remivanboxem during his internship at UCLouvain.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

signature_extraction-1.0.1.tar.gz (39.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

signature_extraction-1.0.1-py3-none-any.whl (45.0 kB view details)

Uploaded Python 3

File details

Details for the file signature_extraction-1.0.1.tar.gz.

File metadata

  • Download URL: signature_extraction-1.0.1.tar.gz
  • Upload date:
  • Size: 39.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.6

File hashes

Hashes for signature_extraction-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b87e6b8239c871f24e2ecc87bec71908f4a7f65e6a8831c3ea2ab050c5030f8e
MD5 c85e6e895904c75b0f862e0dd6dd5338
BLAKE2b-256 69e08c7c9f8653c93dcdaca3b74ee20bd0a326fc109879a4321a7acf9449aac9

See more details on using hashes here.

File details

Details for the file signature_extraction-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for signature_extraction-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd6a06895a41931363aae499aaf5a02368e510b8ddbf393ae2def8889acf5ba0
MD5 e987311eaa5ab6109c7b91ddb846f1a9
BLAKE2b-256 9779e6cb681a21e36f146ee9ae1ab66c51a2cccba1d85f31afe5676a0e2f52d1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page