some readme-s

This commit is contained in:
Rusty Striker 2024-12-01 19:40:08 +02:00
parent 5623e962cf
commit 2df8de0a3e
Signed by: RustyStriker
GPG key ID: 87E4D691632DFF15
6 changed files with 49 additions and 0 deletions

11
README.md Normal file
View file

@ -0,0 +1,11 @@
# Project - TODO:
[ ] Create a skeleton protocol
[ ] implement most of the skeleton
[ ] Create basic TCP server
[ ] Create basic client that connects to the server
[ ] Send ping message from client to server
[ ] Add more items based on skeleton protocol
[ ] Refine protocol using the implementation (and update stuff that got changed in impl)
[ ] Finish implementing the protocol
[ ] Update the protocol file with the latest structs and stuff

2
client/README.md Normal file
View file

@ -0,0 +1,2 @@
# Client

6
lib/README.md Normal file
View file

@ -0,0 +1,6 @@
# Shared library
Contains shared stuff between the client and the server:
- Data structures
- helper functions

29
protocol.md Normal file
View file

@ -0,0 +1,29 @@
# The Protocol
All encryptions are made using RSA (key size to be determined), no symmetric encryptions
are used due to messages being short.
## Registration:
- User sends a register request to server `(phone number, RSA public key)`,
giving them a public key and encrypting using the server's public key
- Server sends the user a `Confirm` message & a 6-digit code
- User sends the server the 6-digit code, signed using the key provided at stage 1
(this message is very short and funny, because its a 6-digit code, signed using the
user's private key, and encrypted using the server's public key)
- Server sends a last `Confirm` and the registration process is done
## "Login"
The users dont need to login, as they dont really need to hold a conenction
to the server, only thing that matters is that every message to the server should
be signed with the user's private key, thus the key acts as a form of credentials
## Passing messages
In order to send a message from A to B, A will ask the server for B's key,
A will then encrypt the message using B's key, signed with A, wrapped in a `SendMessage`
request and ultimately signed by A and encrypted using the server's key.
The server will hold on to the message until B will send a `GetMessages` request
to the server.

View file

1
server/README.md Normal file
View file

@ -0,0 +1 @@
# Server