Mudp

<!-- PROJECT LOGO --> <br /> <p align="center"> <a href="https://github.com/joaoofreitas/mudp"/> <img src="https://user-images.githubusercontent.com/31630346/109370669-36d21880-7899-11eb-97cb-2f759caf0ec6.png" alt="Logo" width="160" height="113"> </a> <h3 align="center">MUDP - Message User Datagram Protocol</h3> <p align="center"> An implementation of a secure, decentralised and privacy-focused messaging network protocol. <br /> <a href="https://github.com/joaoofreitas/mudp/"><strong>Explore the docs »</strong></a> <br /> <br /> <a href="https://github.com/joaoofreitas/mudp/">View</a> · <a href="https://github.com/joaoofreitas/mudp/issues">Report Bug</a> · <a href="https://github.com/joaoofreitas/mudp/issues">Request Feature</a> · <a href="https://github.com/joaoofreitas/mudp/pulls">Send a Pull Request</a> </p> </p>

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Contact

<!-- ABOUT THE PROJECT -->

About The Project 📬

<p align="center"> <img src="https://user-images.githubusercontent.com/31630346/109371170-9c270900-789b-11eb-8a9e-58391746aceb.gif" alt="App"> </p>

MUDP stands for Messaging User Datagram Protocol and it is a UDP based protocol created by @joaoofreitas that sends and receives asynchronous encrypted messages from a peer to another.

This project is a code implementation of this protocol (I consider the protocol itself just theory).

I decided to start this project mostly for learning and going a little bit deeper around networking. This project gave me skills in sockets, encryption, compression and raw packet networking.

Use cases:

• Full control of communication with another person without sniffing or network tracking.

Built With 🐍

• python
• rsa

Getting Started 🏁

Follow the steps bellow for installing test te project in your machine.

Prerequisites 🛠

To install this software you need to have installed:

• Git
• Python3
• Python package manager - pip3

Installation

1. Clone the repository

  git clone https://github.com/joaoofreitas/mudp.git

2. Install dependencies

  pip3 install -r requirements.txt

3. Give execution permission

• On Linux/MacOS

  chmod +x main.py

<!-- USAGE EXAMPLES -->

Usage

For running this program you can use optional argument flags such as username, port and debug.

• Example

  ./main.py --username=Anonymous --port=8080

• If you are having problems you can add the flag --debug to see what may be happening.

    ./main.py --debug
  

  Or:

    ./main.py --username=Anonymous --port=8080 --debug
  

Anyways if you have any trouble running the program feel free o open a issue.

<!-- CONTRIBUTING -->

🤝 Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are extremely appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

<!-- LICENSE -->

📝 License

Distributed under the MIT License. See LICENSE for more information.

<!-- CONTACT -->

📫 Contact

João Freitas - @joaoofreitas - joaoofreitas@pm.me

Miguel Andrade - @miguel1996