FileEncryption

<div id="top"></div>

<br /> <div align="center"> <a href="https://github.com/othneildrew/Best-README-Template"> <img src="images/logo.png" alt="Logo"> </a> <h3 align="center">RSA & AES Encryption Program</h3> <p align="center"> Welcome to our project! We are constantly trying to improve this project. So please download the repository and send us feedback! <br /> <a href="https://github.com/cpfluger/RSA-FileEncryption"><strong>Explore the docs »</strong></a> <br /> <br /> <a href="https://github.com/cpfluger/RSA-FileEncryption">View Demo</a> · <a href="https://github.com/cpfluger/RSA-FileEncryption/issues">Report Bug</a> · <a href="https://github.com/cpfluger/RSA-FileEncryption/issues">Request Feature</a> </p> </div> <!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgments">Acknowledgments</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->

About The Project

The goal is to develop a working program that encrypts a text file by reading it. The methods used are AES and RSA Encryption. For illustration purposes, the GUI was designed with PyQt.

<p align="right">(<a href="#top">back to top</a>)</p>

Built With

We have built this program only with python. For the encryption parts and the GUI we have used multiple libraries

• Python
• PyQt
• Cryptodome

<p align="right">(<a href="#top">back to top</a>)</p> <!-- GETTING STARTED -->

Getting Started

To execude this project, please download the repository and make sure all the files are in the folder. To start the program execude the gui.py file.

Prerequisites

You will have to install multiple librarys in order to execude the program:

• PyQt

  pip install PyQt5
  

• Dark Theme

  pip install pyqtdarktheme
  

• Cryptography

  pip install Cryptography
  

<!-- USAGE EXAMPLES -->

Usage

To encrypt files or your own written text in the container, you will have to open your file with the browse button or drag & drop your file into the container. Once you have included your text into the program you may choose between the procedure RSA or AES. Notice! You can only encrypt your file with one procedure at a time. You encrypted text will display on the bottom container.

<p align="right">(<a href="#top">back to top</a>)</p> <!-- ROADMAP -->

Roadmap

• [x] Basic GUI

  • [ ] Drag & Drop function
  • [x] Dark-Mode

• [x] AES implementation

• [ ] RSA implementation

See the open issues for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p> <!-- CONTRIBUTING -->

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

<p align="right">(<a href="#top">back to top</a>)</p> <!-- LICENSE -->

License

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

<p align="right">(<a href="#top">back to top</a>)</p> <!-- CONTACT -->

Contact

Pfluger Clemens (Repository Admin) - @cpfluger - cpfluger@tsn.at <br> Unterberger Lorenz (Contributor) - @MrLolo9 - lounterberger@tsn.at <br> Unterholzner Elias (Contributor) - @ParadoxParadise - eunterholzner@tsn.at <br>

Project Link: https://github.com/cpfluger/RSA-FileEncryption

<p align="right">(<a href="#top">back to top</a>)</p> <!-- ACKNOWLEDGMENTS --> <!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->