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.
  • (Network) flow: time-ordered sequence of network packets having the same network 5-tuple.
  • Flow Fingerprint: set of relevant packet features which identify a packet / flow. 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 pattern: sequence of flows / flow fingerprints 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.12.tar.gz (40.1 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.12-py3-none-any.whl (45.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: signature_extraction-1.0.12.tar.gz
  • Upload date:
  • Size: 40.1 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.12.tar.gz
Algorithm Hash digest
SHA256 6ac6944d2f85a040b536a7dad2d7d8f7ba48be75b3687b198d5713ed987f2c36
MD5 795d7e5bba424b20251671341082809f
BLAKE2b-256 0d8ea37db588b1335fafe57845a2c8717ac4cfd8dba8d8b8e98dba7f99bef9e1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for signature_extraction-1.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 f0341f2fc2f3cdea0379ea83c15b7b5f1dba99f323d949a0737aca1dac05316c
MD5 38cdca0717a642f5aabf2eb57c158ead
BLAKE2b-256 4406be839b735523306df8f38b37e2de18f6fecb87dca09263912e52e50c3f4e

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