Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #10

Merged
merged 1 commit into from
Oct 8, 2019
Merged

Update README.md #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# safer.chat

https://safer.chat is an end-to-end encrypted web chat that allows users to create rooms with up to 4 participants. The idea is to have what cryptocat used to be, without the need to install browser extensions, or applications. In 2019 we have the [Web Crypto API](https://www.w3.org/TR/WebCryptoAPI/) which allow us to do all operations.
https://safer.chat is an end-to-end encrypted webchat that allows users to create rooms with up to 4 participants. The idea is to have what crypto cat used to be, without the need to install browser extensions or applications. In 2019 we have the [Web Crypto API](https://www.w3.org/TR/WebCryptoAPI/) which allows us to do all operations.

We do not store any tracking information or history, and the server logs don't include any keys, or encrypted messages. In fact, all of the server's data lives in-memory.
We do not store any tracking information or history, and the server logs don't include any keys or encrypted messages. In fact, all of the server's data lives in-memory.

In order to start a conversation, you need to choose a room and a password, then, only people knowing these details are able to log into that room, this password isn't transferred in plain text.
To start a conversation, you need to choose a room and a password, then, only people knowing these details can log into that room, this password isn't transferred in plain text.

We hope you enjoy it.

Expand All @@ -15,13 +15,13 @@ There are two components, the `web` and the `server`. The `web` component is the

- While joining a room, the app generates an RSA 2048 key-pair and shares the public key with the server (see [Public-key cryptography](https://en.wikipedia.org/wiki/Public-key_cryptography)).
- When a participant joins a room, it gets the participants and their public keys from the server.
- Each time a message is sent, it is encrypted using each participant public key and sent to the server, which knows how to reach the participants.
- Each time a message is sent, it is encrypted using each participant's public key and sent to the server, which knows how to reach the participants.

As you can see by reading the technical details, all messages sent to the server are encrypted, any websocket debugger can be used to verify that the server doesn't alter any encrypted message or keys.
As you can see by reading the technical details, all messages sent to the server are encrypted, any WebSocket debugger can be used to verify that the server doesn't alter any encrypted message or keys.

## Development

The project is a monorepository involving the following components:
The project is a mono repository involving the following components:
- The [web](/web) project is the frontend app, what you see at https://safer.chat is what the [web](/web) has, it is built using Angular, communicates to the [server](/server) project using a web socket.
- The [server](/server) project is what connects the peers, it allows them to exchange their keys and messages, as well as handling the room reservation, it is built with Scala.
- The [infra](/infra) project has the deployment scripts, it uses Ansible.