Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/merrychap/fluffychat
:sheep: Decentralized chat with private messages and rooms. Messages and files are encrypted using RSA
https://github.com/merrychap/fluffychat
chat cli client decentralized encryption messaging messanger network room rsa rsa-encryption rsa-key-encryption
Last synced: 2 months ago
JSON representation
:sheep: Decentralized chat with private messages and rooms. Messages and files are encrypted using RSA
- Host: GitHub
- URL: https://github.com/merrychap/fluffychat
- Owner: merrychap
- Created: 2016-03-29T17:41:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-04T14:44:08.000Z (about 7 years ago)
- Last Synced: 2023-03-05T17:49:45.879Z (almost 2 years ago)
- Topics: chat, cli, client, decentralized, encryption, messaging, messanger, network, room, rsa, rsa-encryption, rsa-key-encryption
- Language: Python
- Homepage:
- Size: 487 KB
- Stars: 30
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fluffychat (project is frozen)
## General description
You can communicate with people by writing messages and sending different files. This chat provides rooms and private messages between users. Chat is protected by RSA encryption.
Also, you can run several chat entities on the same host. You have to just clone chat in different directories (it will be changed, of course). It's all because of database.db. When you are trying run another entity in the same directory as the first then database.db will be thinking that first entity and yours are the one entity (bad, I know)
For detailed description see DECOMPOSITION.md file.
## Future
I want to completely change a structure of fluffychat in the future . For now, it's not really convinient tool and contains many grammar mistakes. Stay tuned, guys! Make fluffychat great again <3
## Some details
Chat works only in **local networks** due to the fact that this is under development.
Network protocol of this chat is too naive. Because of that, I started [chat_protocol](https://github.com/merrychap/chat-protocol) repository. After this protocol will be finished network functionality of this chat will be replaced with ```chat_protocol``` implementation.
## Requirements
- Python 3.*
- netifaces
- PyCrypto
- PyQt5
## Architecture
Here will be a little description about architecture.
## Example of using
Here will be examples.
## Where is log file?
Log file is __app.log__. You can see it by typing next:
```sh
$ vim app.log
```
## How to run application
There are two ways of running chat. If you want to create a new chat, then you should run this:
```sh
$ python3 main.py [--create] [--recv-port R]
```
But if you want to join in existing chat, then you should know IP and connection port of a host sitting in this chat. Also you have to
specify port for receiving messages. When you know all this stuff then run next:
```sh
$ python3 main.py [-h] [--create] [--host HOST] [--port PORT]
[--recv-port RECV_PORT] [--gui] [--dis-enc]
```
Argument | Description
-------- | -----------
**--host** | IP of a remote host
**--port** | Default connection port of a remote host
**--recv-port** | Port for receiving data from other hosts
**--create** | Key for creating new chat
**--gui** | Run chat in GUI mode
**--dis-enc** | Disable RSA encryption. It means when a host from the chat sends you a message it will not be encrypted for you.
## Examples
**To start** typing any command you should at first **press "enter"**
Below is placed example of creating a new chat
```sh
$ python3 main.py --create --recv-port 8080
[*] Please, specify your username(a-zA-Z_.):> merrychap
[*] Specify your root path for storing files:> /home/merrychap/Desktop/fluffychat
('192.168.0.102', 8080)
Type "@help" for list of commands with the descriptio
[*] Enter command:> @help
======================================
Type commands with @ on the left side of a command.
List of commands:
+ help : Shows this output
+ room "room_name" : Switches to the room message mode.
+ add_user : "username" "room_name"
+ users : Shows online users.
+ create_room "roomname" : Creates new room.
+ user "username" : Switches to the user message mode.
+ change_root_path "root path" : Changes the directory of storing files
+ change_visibility : Changes your visibility in the chat
+ remove_room "roomname" : Removes created room.
+ username "username" : Changes the current username.
+ exit : Closes chat.
+ rooms : Shows available rooms.
======================================
```
The next example is connecting to the existing chat.
```sh
$ python3 main.py --host 192.168.0.102 --port 8080 --recv-port 8080
*] Please, specify your username(a-zA-Z_.):> Holo
[*] Specify your root path for storing files:> /home/Holo/Desktop/fluffychat
('192.168.0.103', 8080)
Type "@help" for list of commands with the descriptio
[*] Enter command:> @users
======================================
+ merrychap
+ Holo
======================================
```
## Already done
- [x] Private messages
- [x] Rooms
- [x] Sending files
- [x] RSA encryption
- [ ] Tests
- [ ] GUI