Giter VIP home page Giter VIP logo

imlaxman / chat-e2ee Goto Github PK

View Code? Open in Web Editor NEW

This project forked from muke1908/chat-e2ee

0.0 0.0 0.0 702 KB

A platform that allows you to chat with someone without any registration. You don't need to identify yourself to the internet and can chat anonymously. The end-users are not traceable and data is not owned by anyone.

Home Page: https://chat-e2ee.azurewebsites.net

License: Apache License 2.0

JavaScript 80.88% HTML 3.40% CSS 15.72%

chat-e2ee's Introduction

chat-e2ee

Open in Gitpod
The project is still in development phase.

Working prototype:
https://chat-e2ee.azurewebsites.net
https://chat-e2ee.herokuapp.com


This app will allow two mutually agreed users to have a conversation in end-to-end encrypted environment. The app itself doesn't track you or ask any infromation 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 of your usual chat application.


Open Source Love GitHub last commit Sonarcloud Status

Contribute:


Contributors โœจ


Mukesh

๐Ÿ’ป

Gagan Aryan

๐Ÿ’ป

Radha Jayaraman

๐Ÿ’ป

Jessie

๐Ÿ’ป

zygisS22

๐Ÿ’ป

lindsayjohnston

๐Ÿ“–

Julien

๐Ÿ“–

FabiSdr

๐Ÿ“–

AudreyKj

๐Ÿ’ป

Sundeep Babbur

๐Ÿš‡ ๐Ÿ’ป

This project follows the all-contributors specification. Contributions of any kind welcome!


Key Features

  1. The end users are not tracable.
  2. Data is not stored on any remote server.
  3. Secure image sharing. Read more
  4. No saved history i.e. once chat is closed the data is not recoverable.
  5. It doesn't ask any information from you -- no login/signup.

How to initiate chat

  1. Generate unique link.
  2. Share the link with the person you want to chat with.
  3. Both users identify themselves.
  4. The messages are end-to-end encrypted hence, no one can decrypt your message other than you.

How the encryption works

  1. Alice and Bob generate a public and private key pair.
  2. Alice and Bob share their public keys with each other.
  3. Alice encrypts her message with her private key and Bob's public key and sends it to Bob.
  4. Bob receives the encrypted message and decrypts it with his private key and Alice's public key.

In this way, no one else can decrypt the message because your private key is never exposed to the internet. More detailed explanation: https://www.youtube.com/watch?v=GSIDS_lvRv4&t=1s

We are using NaCL & TweetNaCL.js library for asymmetric encryption. The NaCL project is being lead by Daniel J.Bernstein, one of the most prominent Computer Scientists of our era.


Proposed flow

flow


For developers

FE: This project includes a light weight frontend UI - bootstrapped with create-react-app. The FE client is located in ./client folder.
BE: The backend runs on express/nodejs. In production mode, express server exposes the API endpoints and serve the static frontend from ./client/build.

Installation

  1. Fork the repo.
  2. Run npm install in root dir.
  3. Run 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.

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.

Folder structure

  • The FE client is located in ./client which is coupled with the backend
  • All the backend controllers goes to ./backend folder
  • Express instance is on ./app.js
  • Entry point is ./index.js

APIs

url method paylod filename description
/api/getLink POST {token} /api/index.js to generate unique link to start chat session
/api/chat/send POST { channel, sender, message } /api/messaging/index.js to send a message to a specific channel
/api/validateLink/:channel GET /api/index.js to check if a channel is valid

Currently it's using pubnub for real time communication. Utils are in /backend/external/pubnub.js.

Messaging flow:

  • Client encrypts message at client-side and sends via REST call.
  • Client receives message in realtime via PUBNUB subscription and decrypt locally at client side.
  • Your messages can not be recovered if you lose encryption keys.

Please follow the convention for commit message.
https://github.com/conventional-changelog/commitlint/#what-is-commitlint

Example:
git commit -m"feat: some relevant message"


External:

Powered By PubNub Powered By Mongodb

chat-e2ee's People

Contributors

muke1908 avatar encrypted-soul avatar audreykj avatar allcontributors[bot] avatar fabisdr avatar jradha11 avatar darksoul11 avatar jessiematias avatar julienzd avatar lindsayjohnston avatar zygiss22 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.