Disposable chat session: this app will allow two mutually agreed users to have a chat in end-to-end encrypted environment. The app itself doesn't track you or ask for any information from you. Data is owned by only you and only while chatting. Your private key is generated on your device and never leaves your device. This is not a replacement for your usual chat application.
The project is still in development phase and open for contribution.
Demo: https://chat-e2ee-2.azurewebsites.net
Spin up your own frontend:
JS SDK and use chat-e2ee backend as service - @chate2ee/service
:page_with_curl: Documentation
For installation instruction, go to developer section.
How the encryption works
In this way, no one else can decrypt the message because your private key is never exposed/shared to the internet. More detailed explanation: https://www.youtube.com/watch?v=GSIDS_lvRv4&t=1s
We are using browser window.crypto library for encryption.
Frontend (UI):
This project includes a light weight frontend UI - bootstrapped with create-react-app. The FE client is located in ./client
folder.
Backend:
The backend runs on express/nodejs. In production mode, express server exposes the API endpoints and serves the static frontend from ./client/build
.
JS SDK:
@chat-e2ee/service
- located in ./service
- A SDK that client uses to interact with backend. More info: Readme
Custom frontend
Import @chat-e2ee/service
SDK in your client project and build your own chat client.
npm install
in root dir i.e. inside cloned repo.npm run dev
to spin up your client/server. This will run your react app in dev mode and server in watch mode by nodemon.:exclamation::exclamation:Important:
If you are making changes to ./service
i.e. @chat-e2ee/service
, make sure you run npm run build-service-sdk
to reflect changes.
NOTE: by default, create-react-app
runs webpack-dev-server on port 3000
. The server is configured to run on 3001
port. So, make sure that these ports are not blocked on your system.
Important:
Check .env.sample
to configure your .env
file.
Please use node 16 or above.
To start with docker read the instructions.
For native build read the instructions.
./client
which is coupled with the backend../backend
folder.@chate2ee/service
to communicate with the backend. Located in ./service
. ./app.js
../index.js
.Please follow the convention for the commit message.
https://github.com/conventional-changelog/commitlint/#what-is-commitlint
Example:
git commit -m"feat: some relevant message"
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS) has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.