Skip to content

iot-onboarding/mud-visualizer

Repository files navigation

Manufacturer Usage Description (MUD) Visualizer

Warning: mud-visualizer is currently beta. Use at your own risk.

License Github Issues Github Issues Github Issues

This tool can be used to visualize the MUD files in JSON format.

mud-visualizer

Table of Contents

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:

$ 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 mud@ietf.org.

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

License

About

mud-visualizer is a tool to visualize MUD files

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published