This version uses React, Redux, Express, Passport, and PostgreSQL (a full list of dependencies can be found in package.json
). This version uses React to control the login requests and redirection in coordination with client-side routing.
NOTE: Do not clone this repository.
- Don't Fork or Clone. Instead, have one memeber of your group click the
Clone or Download
button and selectDownload Zip
. - Unzip the project and start with the code in that folder.
- Create a new GitHub project and push this code to the new repository.
Before you get started, make sure you have the following software installed on your computer:
Create a new database called secure_submarine
and create a user
table and secret
table:
CREATE TABLE "user" (
"id" SERIAL PRIMARY KEY,
"username" VARCHAR (80) UNIQUE NOT NULL,
"password" VARCHAR (1000) NOT NULL,
"clearance_level" INTEGER NOT NULL DEFAULT 0
);
INSERT INTO "user" ("username", "password", "clearance_level")
VALUES ('Admiral Greer', 'tuna', 18),
('Captain Borodin', 'shark', 10),
('Lieutenant Nguyen', 'fishy', 4),
('Lieutenant Ryan', 'tuna', 4);
CREATE TABLE "secret" (
"id" SERIAL PRIMARY KEY,
"content" VARCHAR (80) UNIQUE NOT NULL,
"secrecy_level" INTEGER NOT NULL DEFAULT 0
);
INSERT INTO "secret" ("content", "secrecy_level")
VALUES ('Admirals Only: Captain Borodin is totally weird.', 13),
('Captains Or Above: Lieutenant Ryan is looking fly.', 6),
('Lieutenants Or Above: We are heading to the Bahamas.', 3);
- Don't Fork or Clone. Instead, click the
Clone or Download
button and selectDownload Zip
. - Unzip the project and start with the code in that folder.
- Create a new GitHub project and push this code to the new repository.
- Run
npm install
- Start postgres if not running already by using
brew services start postgresql
- Run
npm run server
- Run
npm run client
- Navigate to
localhost:3000
- Import the sample routes JSON file by clicking
Import
in Postman. Select the file. - Click
Collections
andSend
the following three calls in order:POST /api/user/register
registers a new user, see body to change username/passwordPOST /api/user/login
will login a user, see body to change username/passwordGET /api/user
will get user information, by default it's not very much
On the Secure Submarine, there are many secrets, but our enemies are out to steal our secrets! We just realized that our Secure Submarine web portal (the portal for all of the hottest gossip on the secure submarine) is compromised! Anyone, logged in or not, can visit http://localhost:5000/api/secrets
to see all of the secrets for the entire crew!
Task: Only users who are authenticated should see any secrets.
The user router is protected from unauthenticated requests thanks to the rejectUnauthenticated
middleware:
router.get('/', rejectUnauthenticated, (req, res) => {
res.send(req.user);
});
Do this for the secrets route to achieve these results:
-
An unauthenticated user visiting
http://localhost:5000/api/secrets
should get a403
orforbidden
error instead of seeing the secrets. -
A user like
Admiral Greer
with passwordtuna
should still be able to visithttp://localhost:3000/#/secrets
to see all of the secrets.
Task: When authenticated, a user should only see secrets with a
secrecy_level
that is equal or less than the user'sclearance_level
.
A user like Captain Borodin
with password shark
is be to visit http://localhost:3000/#/secrets
to see all of the secrets! That's no good! There's a secret in there that calls him weird!
You should see the clearance level in the console log inside of secrets GET request in secrets.router.js
. Now fix the query in secrets.router.js
so that it uses the clearance level to determine which secrets to return.
- A user like
Captain Borodin
with passwordshark
should no longer be able to see any secrets above hisclearance_level
which is10
. - A user like
Admiral Greer
with passwordtuna
should still be able to visithttp://localhost:3000/#/secrets
to see all of the secrets.
If you're interested in securely storing passwords, you should salt and hash them. Here is a quick video that explains it pretty well: https://www.youtube.com/watch?v=8ZtInClXe1Q
Right now, we are storing the passwords in plain text, so if the enemy got a hold of our database, they would know everybody's password! Instead of storing plain passwords, we should scramble them up. That is called hashing.
Uncomment this line to start hashing passwords for each user.
return bcrypt.hashSync(password, '$2b$10$p5Wkte33hlOBOcUtJie6H.');
Because the database doesn't store the actual password, we can't just check to see if they are equal like we were doing before. Uncomment this line to allow us to check candidatePasswords
(what the user entered), against the storedPassword
(the hash in the database).
return bcrypt.compareSync(candidatePassword, storedPassword);
New users will now have their passwords hashed!
Run these queries to add your users back to the database with hashed passwords:
DROP TABLE "user";
CREATE TABLE "user" (
"id" SERIAL PRIMARY KEY,
"username" VARCHAR (80) UNIQUE NOT NULL,
"password" VARCHAR (1000) NOT NULL,
"clearance_level" INTEGER NOT NULL DEFAULT 0
);
INSERT INTO "user" ("username", "password", "clearance_level")
VALUES ('Admiral Greer', '$2b$10$p5Wkte33hlOBOcUtJie6H.PnCvk8v.KjZspVoAFtT7g5v5xK.EXVG', 18),
('Captain Borodin', '$2b$10$p5Wkte33hlOBOcUtJie6H.ZIgFjzr4zY8FItxC8gZyqIWD5gYmL0m', 10),
('Lieutenant Nguyen', '$2b$10$p5Wkte33hlOBOcUtJie6H.vaUd5ikB1LWCbVZAA87BR63NiDorn1C', 4),
('Lieutenant Ryan', '$2b$10$p5Wkte33hlOBOcUtJie6H.PnCvk8v.KjZspVoAFtT7g5v5xK.EXVG', 4);
Now that we are no longer storing plain text passwords. The enemy is unable to see the crew's passwords. However, Lieutenant Ryan has been careless, and the enemy knows that his password is tuna
. Because of this, they can see the lowest security information. Then they notice that Admiral Greer's hashed password perfectly matches Lieutenant Ryan's hashed password! They now know that Admiral Greer's password is tuna
as well! We should fix our code so that even if two people have the same password, it has a different hash in the database. Enter salting! Salting is the process of generating a random string for each user. Notice that every password starts with $2b$10$p5Wkte33hlOBOcUtJie6H.
. That is the salt! These should be random and generated uniquely for each user.
Uncomment these two lines to start creating a unique salt for each user.
const salt = bcrypt.genSaltSync(SALT_WORK_FACTOR); // This generates a random salt
return bcrypt.hashSync(password, salt);
New users will now have their passwords salted and hashed!
Run these queries to add your users back to the database with hashed passwords:
DROP TABLE "user";
CREATE TABLE "user" (
"id" SERIAL PRIMARY KEY,
"username" VARCHAR (80) UNIQUE NOT NULL,
"password" VARCHAR (1000) NOT NULL,
"clearance_level" INTEGER NOT NULL DEFAULT 0
);
INSERT INTO "user" ("username", "password", "clearance_level")
VALUES ('Admiral Greer', '$2b$10$uxPm0qeJAz70oqhEg8dX6uXlYc2PWUtPuZhTa65OiDv2LCHA41OLq', 18),
('Captain Borodin', '$2b$10$iUCrWSMvLpYuKQLsmmTiNe3gfU6jAdyElCbCLtboVH6DlXJdsuPxG', 10),
('Lieutenant Nguyen', '$2b$10$/3yhbbjXPPf3L4Z1gXDA5OJzJkf6b.2CuvIA8OzP6c8jPEQlbo5re', 4),
('Lieutenant Ryan', '$2b$10$hr1Tlo6K.yxAq3FC4iIHsuYQwYpjQC8SyDnYykMu/LNB9TXMkxMt2', 4);
Admiral Greer and Lieutenant Ryan still have the same passwords as before, but it's not easy to see that because of salting and hashing.
SERVER_SESSION_SECRET
is supposed to be a secret, but right now we are pushing it to GitHub! Let's create an environment variable so that we don't do this.
- Uncomment
// return process.env.SERVER_SESSION_SECRET;
insession-middleware.js
- Run
npm install dotenv
to get the node module that can create environment variables - Add the line
require('dotenv').config();
to the top ofserver.js
to use the module - add
.env
to your.gitignore
file - Create a
.env
file at the root of the project and paste this line into the file:While you're in your newSERVER_SESSION_SECRET=superDuperSecret
.env
file, take the time to replacesuperDuperSecret
with some long random string like25POUbVtx6RKVNWszd9ERB9Bb6
to keep your application secure. Here's a site that can help you: https://passwordsgenerator.net/.
Before pushing to Heroku, run npm run build
in terminal. This will create a build folder that contains the code Heroku will be pointed at. You can test this build by typing npm start
. Keep in mind that npm start
will let you preview the production build but will not auto update.
- Start postgres if not running already by using
brew services start postgresql
- Run
npm start
- Navigate to
localhost:5000
- Create a new Heroku project
- Link the Heroku project to the project GitHub Repo
- Create an Heroku Postgres database
- Connect to the Heroku Postgres database from Postico
- Create the necessary tables
- Add an environment variable for
SERVER_SESSION_SECRET
with a nice random string for security - In the deploy section, select manual deploy