Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iot-onboarding/mud-visualizer
mud-visualizer is a tool to visualize MUD files
https://github.com/iot-onboarding/mud-visualizer
Last synced: 21 days ago
JSON representation
mud-visualizer is a tool to visualize MUD files
- Host: GitHub
- URL: https://github.com/iot-onboarding/mud-visualizer
- Owner: iot-onboarding
- License: bsd-3-clause
- Created: 2019-07-04T17:08:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-01-23T19:40:50.000Z (almost 3 years ago)
- Last Synced: 2024-08-05T17:38:19.294Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 20.9 MB
- Stars: 10
- Watchers: 4
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - iot-onboarding/mud-visualizer - mud-visualizer is a tool to visualize MUD files (JavaScript)
README
# Manufacturer Usage Description (MUD) Visualizer
> Warning: mud-visualizer is currently beta. Use at your own risk.
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://github.com/iot-onboarding/mud-visualizer/issues)
[](https://github.com/iot-onboarding/mud-visualizer/issues)
[](https://github.com/iot-onboarding/mud-visualizer/pulls)
This tool can be used to visualize the MUD files in JSON format.
## Table of Contents
- [Motivation](#motivation)
- [Installation](#installation)
- [Supported MUD Abstractions](#supported-mud-abstractions)
- [Contribution](#contribution)
- [Support](#support)
- [Citation](#citation)
- [License](#license)
## Motivation
MUD files are plain text files in JSON format that contain ACL rules for a device. A MUD file can contains tens or hundrends of ACL rules which makes it difficult to read and validate the files manually. mud-visualizer will help you to read and validate (and modify in near future) the MUD files.
## Installation
Use the following commands to install and run `mud-visualizer`:
```shell
$ git clone https://github.com/iot-onboarding/mud-visualizer
$ cd mud-visualizer
$ npm install
$ npm start
```
## Supported MUD Abstractions
Currently the following MUD abstractions are supported in both `incoming` and `outgoing` traffic directions:
- `domain-names`
- `local-networks`
- `same-manufacturer`
- `manufacturer`
- `my-controller`
- `controller`
## Contribution
Contributions are welcome! Submit your pull requests to the `master` branch.
## Support
Feel free to reach out to us at .
Also, you are strongly encouraged to use Github's Issues to submit new issues, or request enhancements or new features.
## Citation
If you find this tool useful in your research, please consider citing our papers:
```
@inproceedings{andalibi2021analysis,
title={On the Analysis of MUD-Files’ Interactions, Conflicts, and Configuration Requirements Before Deployment},
author={Andalibi, Vafa and Lear, Eliot and Kim, DongInn and Camp, L Jean},
booktitle={5th EAI International Conference on Safety and Security in Internet of Things, SaSeIoT},
year={2021}
}
```
```
@inproceedings{andalibi2021making,
title={Making Access Control Easy in IoT},
author={Andalibi, Vafa and Dev, Jayati and Kim, DongInn and Lear, Eliot and Camp, L Jean},
booktitle={International Symposium on Human Aspects of Information Security and Assurance},
pages={127--137},
year={2021},
organization={Springer}
}
```
```
@inproceedings{andalibi2021visualization,
title={Is Visualization Enough? Evaluating the Efficacy of MUD-Visualizer in Enabling Ease of Deployment for Manufacturer Usage Description (MUD)},
author={Andalibi, Vafa and Dev, Jayati and Kim, DongInn and Lear, Eliot and Camp, L Jean},
booktitle={Annual Computer Security Applications Conference},
pages={337--348},
year={2021}
}
```
## License
[](https://opensource.org/licenses/BSD-3-Clause)
- **[BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause)**
- Copyright 2019 © Cisco Systems.