SecretKeeper

SecretKeeper is a privacy first messenger where all messages are end-to-end encrypted and secure. The intention is to provide users absolute privacy while sharing files, messages, and other media. No data is persistently stored on remote servers, adhering to a strict no-logs policy. Using this basic idea as the backbone of the app, we will explore additional security-based features that may be used to enhance the app such as file and data storage, disappearing messages, secure key exchange, and metadata minimization. The app may be expanded to include chat rooms, random chatting, secure forums, or other social media style features if time permits.

Members

• Joe Beyrer
• Christian Farese
• Gabriel Kravets
• David Edelstein

Roles

For this project, the intention is for every team member to gain exposure to both front-end AngularJS development and backend GO programming. We do not plan to strictly adhere to the roles below. As a temporary placeholder, the role assignments will be:

• Front-End Engineers: David Edelstein, Christian Farese
• Back-End Engineers: Gabriel Kravets, Joe Beyrer

Project Setup

• Install Go using here

• Run Go server using go run main.go from the secret-keeper-app/backend directory

• Run go get github.com/rs/cors to install CORS middleware

• Run go get golang.org/x/crypto/bcrypt for bcrypt password hashing

• Run go get github.com/google/uuid for UUID use in database

• Run go get github.com/gorilla/websocket for messaging with websockets

• Run go get github.com/joho/godotenv for .env file loading (Linux only)

• Run npm install -g @angular/cli to install Angular CLI

• Install node.js here

• Run npm install from the secret-keeper-app/frontend/secret-keeper-frontend directory to install all required packages

• Run ng serve from the secret-keeper-app/frontend/secret-keeper-frontend directory to run the website at http://localhost:4200

  • May need to run npm install zone.js if a Zone.js error is encountered

Environment Variables

The app requires SMTP credentials to send verification and password reset emails.

Linux — create a .env file in secret-keeper-app/backend with:

SMTP_USER=secretkeeperapp@gmail.com
SMTP_PASS=app-password

Windows — set these in the same terminal window before running go run .:

set SMTP_USER=secretkeeperapp@gmail.com
set SMTP_PASS=app-password

Notes While Writing Code

• To create a new component, run ng g c components/[NAME] from the secret-keeper-frontend directory
• Every request in Angular must include this.http.post(url, body, { withCredentials: true }) so cookies are sent