Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/escapedshadows/actually-secure-chatapp
The Actually Secure ChatApp is a self-hosted chat application created with Python and Flask, offering private messaging through end-to-end encryption. It allows users to communicate securely without relying on external servers, supporting both terminal and web clients.
https://github.com/escapedshadows/actually-secure-chatapp
chatapplication decryption encryption encryption-decryption flask flask-api privacy-protection python secure self-hosted
Last synced: about 2 months ago
JSON representation
The Actually Secure ChatApp is a self-hosted chat application created with Python and Flask, offering private messaging through end-to-end encryption. It allows users to communicate securely without relying on external servers, supporting both terminal and web clients.
- Host: GitHub
- URL: https://github.com/escapedshadows/actually-secure-chatapp
- Owner: EscapedShadows
- License: apache-2.0
- Created: 2024-10-09T14:50:56.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-12T08:36:28.000Z (3 months ago)
- Last Synced: 2024-11-30T18:54:32.707Z (about 2 months ago)
- Topics: chatapplication, decryption, encryption, encryption-decryption, flask, flask-api, privacy-protection, python, secure, self-hosted
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Actually Secure ChatApp V1.2.0
### A Project by [EscapedShadows](https://actuallysecurechatapp.escapedshadows.com)
## Overview
Actually Secure ChatApp is a secure chat application built with Python and Flask, designed for self-hosting. It prioritizes user privacy and offers a robust solution for private communications.
## Key Features
- **End-to-End Encryption**: All messages are encrypted on the client side before transmission, ensuring secure communication.
- **Fully Self-Hosted**: Enjoy total control and autonomy without reliance on external servers or databases.
- **Zero Data Collection**: Your privacy is respected; we do not collect any user data.
---
# Setup Instructions
### **INDEV MANY PLACEHOLDER FILES ARE STILL THERE. NOT FUNCTIONAL YET**
**Skip to Client Instructions if you do not want to set up your own server and already have one / received a key.**
## Step 1: Install Required Packages
### You can install the required packages using pip:
```bash
pip install flask cryptography argparse pyinstaller
```
## Step 2: Download the Code
### Download the latest `server.zip` release from the [GitHub repository](https://github.com/EscapedShadows/Actually-Secure-ChatApp/releases). Extract the ZIP file and navigate to the folder using your terminal or command prompt.
## Step 3: Generate a Secret Key
### Generate a secret key using the following command:
**For Windows:**
```bash
python keyGenerator.py
```
**For Linux:**
```bash
python3 keyGenerator.py
```
### This will create a `secret.key` file containing your generated secret key.
## Step 4: Host the Server
### To host your ChatApp, you will need a server that supports Python and is accessible over the web. You can use any service that allows you to host your own cloud server. If you want to use the app locally, you can run it on your machine.
## Step 5: Upload `server.py`
### You will need to upload the `server.py` file to your server and run it. This will start the server and make it accessible over the web. Copy and paste the information printed when you start the server into a text editor.
## Step 6: Run `test.py`
### Replace `[your_ip]` in `test.py` with your server's IP address. Run the `test.py` file to test your ChatApp. You are ready to go!
###
# Client Instructions
## Step 1: Decide on a Client and Download
### Get the latest `client.zip` release from the [GitHub repository](https://github.com/EscapedShadows/Actually-Secure-ChatApp/releases). Extract the ZIP file and navigate to the folder using your terminal or command prompt.
### There are two clients available:
- Terminal
- Web
### I think it's self-explanatory what the difference is. I recommend the Web Version, but hey, it's up to you!
### To choose the client, simply run the following command in your terminal:
**For Windows:**
```bash
python setupClient.py --client [terminal/web]
```
**For Linux:**
```bash
python3 setupClient.py --client [terminal/web]
```
## Step 2: Set Up the Client
### The `remove` argument instructs the script to delete itself after execution. The `path` argument adds the ChatApp to your system's PATH. The `menu` argument adds the ChatApp to the Start menu. The `executable` option turns the script into an `.exe` file (sorry Linux users, you'll have to wait a bit).
### To set up your client, simply run:
**For Windows:**
```bash
python setup.py --ip [servers_ip] --key [secret_key] --remove [True/False] --path [True/False] --menu [True/False] --executable [True/False]
```
**For Linux:**
```bash
python3 setup.py --ip [servers_ip] --key [secret_key] --remove [True/False] --path [True/False] --menu [True/False] --executable [True/False]
```
## Step 3: Finished!
### Alright, you are all set for the next level of private conversations! Have fun!
# Notes
- If you are having trouble with the setup, please refer to the [Troubleshooting Guide](https://actuallysecurechatapp.escapedshadows.com/troubleshooting).
- Please be kind to me; I dont have much time to develop this project, but I hope someone out there will actually appreciate it. :)
# Development Plan
- [ ] Sending Attachments (very limited size for now)
- [ ] Adding some sort of authentication system for the server so that only trusted clients can connect
- [ ] Error handling :D
### **A Project made with ❤️ by [EscapedShadows](https://escapedshadows.com)**