EtienneDeneuve / Auth-sys

simple auth system with Redis for database session, Fastify and typescript. the auth is fully made with fastify plugins

Auth-sys

A full auth system made with Fastify plugins only, typescript, and redis for session storage.

getting started

first clone the repo and run

>> cd Auth-sys
pnpm install

make sure to define the your secret keys in a .env file in the root dir before starting the .env file should look like this:

// session secret for session management
SESSION_SECRET = "sqfdsqfkjskjfgsdfgdsfg984sdfgsdfqs984f98sqfdsqdf";

// Google config for Google OAuth
GOOGLE_CLIENT_ID = "set your own client id from google console";
GOOGLE_CLIENT_SECRET = "set your own client secret from google console";

// Docker compose database URL
MYSQL_DATABASE_URL =
  "mysql://root:LdsfgjpmLDSFg8941sdfgsdfc@127.0.0.1:3306/mysql-image-database1";

// OAuth URL to gather user info from Google
OAUTH_USERINFO_URL = "https://www.googleapis.com/oauth2/v2/userinfo";

after setting .env file setup the docker compose containers with this command:

make sure you have docker already installed on your machine

docker compose up -d

then you you'll be able to run the server without any issues with this command:

pnpm dev

API endpoints

/

The home route.

/register

credentials method to register a new user in the databse, it requires: username, email, password, preference for the JSON body.

/login

credentials method to login a new user, it require: email, password for the JSON body. If a user is found, it returns a 200 response with a session. If not, it returns a 403 response.

/logout

Destroys the session in the client and redis.

/login/google

OAuth method to register/login a user using Google provider. it saves a new user in the db if it doesn't exists and returns a session to the client, save it in redis.

/api/auth/callback/google

The callback uri for Google OAuth.

/dashboard

A protected route that can be accessible only if the user is logged in, if not a 403 response is thrown

/getAllRecords dev route

returns all the sessions in redis, if no sessions are found it will return an error. ITS A DEV ROUTE DON4T USE IT FOR PROD.

Note

this repo is for education purposes only, don't use it for prod projects as your auth soultion.

Todo

• 2FA
• password Reset
• edit db tables and fileds
• hash passwords