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.4.0.tar.gz (34.9 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.4.0-py3-none-any.whl (39.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: signature_extraction-0.4.0.tar.gz
  • Upload date:
  • Size: 34.9 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.4.0.tar.gz
Algorithm Hash digest
SHA256 c1c59dcddbc3650a20d38a8019d350ab35c8dd5bb035d5a9b37efd47cdf5e468
MD5 345642eaede0d7eee946c99f4a744851
BLAKE2b-256 7aa360ffcfbdb83521eaf08c29f73216b4e4846508330e3a5ba8adaee67f9f38

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for signature_extraction-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 43928f1cb25b9827c627cfd4ab4e9f5b745bc7a7ebefb7e597867a873476a65a
MD5 75847d51d9077c1353f3bad235ff1469
BLAKE2b-256 f06f9fb17e31660a75fc6a0e737fec5a50e95a4a11e597103ffbd63aacbae5f6

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