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-0.10.0.tar.gz (38.8 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-0.10.0-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for signature_extraction-0.10.0.tar.gz
Algorithm Hash digest
SHA256 f1e405d61e75ff6f0c16be358063c67cc47ae5fb87b63c570a0d780c40740bbf
MD5 7345ffbc8c3771759e0840ff97dcae71
BLAKE2b-256 5079835e7fe5cf92207c4491d9c698400b8b7e10e63e9035a8d7375184ea8c69

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for signature_extraction-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f518c7d884d50a38d2386e04cafa89bfe5e446367fb29e2011f7e81fd4b2cad3
MD5 07a1e0d0e81c7c676b1d15ffc054ffd0
BLAKE2b-256 3754b653dea1df797768e1e273c317bad35b810778381a4ee432fc0acad30cc0

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