https://github.com/faucetsdn/daq
DEPRECATED -- DAQ (Device Automated Qualification) framework in no longer in use, supported, or maintained. It is here for archival purposes only.
https://github.com/faucetsdn/daq
Last synced: 2 months ago
JSON representation
DEPRECATED -- DAQ (Device Automated Qualification) framework in no longer in use, supported, or maintained. It is here for archival purposes only.
- Host: GitHub
- URL: https://github.com/faucetsdn/daq
- Owner: faucetsdn
- License: apache-2.0
- Created: 2018-05-15T02:34:21.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-06T12:09:21.000Z (over 1 year ago)
- Last Synced: 2024-05-01T20:31:52.918Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 11 MB
- Stars: 41
- Watchers: 17
- Forks: 34
- Open Issues: 94
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# DAQ: Device Automated Qualification for IoT Devices.
**DEPRECATED DEPRECATED DEPRECATED DEPRECATED DEPRECATED**
DAQ is a framework designed to test and operate IoT devices in an enterprise IoT environment.
Nominally about device testing and qualification, Device Automated Qualification (DAQ), provides
a means to _automate_ many capabilities, resulting in a more manageable, robust, and
secure platform.
Join the [DEPRECATED [email protected]](https://groups.google.com/forum/#!forum/daq-users) email
list for ongoing discussion about using DAQ for enterprise IoT devices.--
There are several main categories of capabilities that DAQ addresses:
* [_Device automated qualification and testing_](docs/qualification.md):
Testing the behavior of a device against established security and network standards.
More details about the goals and objectives behind this can be found in the IEEE Computer article
[Taming the IoT: Operationalized Testing to Secure Connected Devices](https://www.computer.org/csdl/mags/co/2018/06/mco2018060090-abs.html).
* [_Network security orchestration_](docs/orchestration.md): Use standard
[SDN capabilities](https://queue.acm.org/detail.cfm?id=2560327), such as the
[FAUCET OpenFlow controller](https://faucet.nz/), to orchestrate "microsegmentation" on
the network for improved security.
* _Device Management Tools_: A suite of tools, consoles, and dashboards that help operate
a robust ecosystem of IoT devices. (Details forthcoming.)
## System Requirements
Most aspects of DAQ assume a baseline setup consisting of:
* Linux install: DAQ has been tested against both `Ubuntu 18.04.2 LTS bionic` and
`Debian GNU/Linux 9.4 stretch`, YMMV with other platforms.
* Dedicated network adapters: At the very minimum one dedicated ethernet adapter is
required. This could either be a separate built-in NIC, or a USB-Ethernet dongle.
* (Optional) OpenFlow-compatible hardware switch, described in the
[Network Topologies](docs/topologies.md) overview.
## Quick Start
Please reference [here](docs/quickstart.md)
## Folder Structure
The top-level DAQ folders correspond to the following structure:
* `bin/`: System setup and management commands.
* _`build/`_: Dynamically created directory for build logs.
* `cmd/`: Primary commands for running DAQ testing.
* `config/`: System and module configuration files.
* `daq/`: Python source for DAQ runtime.
* `docker/`: Docker build files for DAQ components and tests.
* `docs/`: Documentation.
* `etc/`: Version files and external switch setup files.
* _`faucet/`_: Dynamically downloaded version of SDN controller.
* _`forch/`_: Dynamically downloaded version of SDN orchestrator.
* `firebase/`: Hosted pages and functions for web dashboard.
* `functions/`: Additional Cloud Functions for data processing.
* _`inst/`_: Install directory for specific runtime contents.
* **`local/`**: Local setup and config information.
* _`mininet/`_: Local version of the mininet virtual network host framework.
* `mudacl/`: Utilities for managing and testing MUD network files.
* `mud_files/`: Examples and prototype device MUD files.
* _`out/`_: Misc transitory output files.
* `proto/`: Protobuf related files.
* _`protoc-gen-doc/`_: Dynamically downloaded Protobuf documentation generator.
* `pubber/`: Sample code for generating cloud-ingest traffic.
* `resources/`: Templates for reports, module configs, test-site definitions.
* `schemas/`: Device/cloud data exchange schemas.
* `subset/`: Subsets of device tests (e.g. penetration tests).
* `testing/`: Scripts for system continuous integration testing.
* `topology/`: Network topology setups.
* `validator/`: Tools for validating data exchange schemas.
* _`venv/`_: Dynamically downloaded python virtual environment files.
Items in _italics_ can generally be deleted without any loss of functionality (dynamically
created at install/runtime). The **local** subdirectory contains local setup information that
is not part of the source distribution.