APIs for CRUD, JWT based login and Two-Factor Authentication using FastAPI

This repository uses FastAPI for creating APIs and many other python libraries such as:- SqlAlchemy Python sql database library to maintain the CRUD operation data. Jose is used for encrypting the login using JSON Web Tokens(JWT) and sign-in using algorithms. Passlib is used for hashing and verifying a hashed password. FastapiMail is used for sending the mail for reseting the password. PyOTP is used for generating and verifying one-time passwords.

To access the Swagger UI for the application, click on the URL. https://crudfastapi.herokuapp.com/docs

To generate the QR Code from the Base64 text(data) goto:- https://codebeautify.org/base64-to-image-converter

Installtion

git clone https://github.com/Ritesh-Kumar-Mandal/Auth.git
cd Auth
py -m venv venv 
source venv/Scripts/activate 
pip3 install -r requirements.txt
uvicorn main:app --reload

Login and SignUp Panel

You can obtain the login token by entering your username (AS Email) and password, or if 2FA is enabled, your username and a one-time pin generated by the Authenticator app.

If you are a new user you can register yourself using the Register API.

In addition, if you are a current user who has forgotten your password, you can use the Forgot and Reset Password feature to generate a new password by receiving an email at your registered email address.

Admin panel

Admin users have more CRUD control than regular users, for example, Admin can change or update any User information.

User panel

Users have less CRUD control than administrators. The current user can view, change or update his or her own information, which is stored in the database.

JWT

After entering the correct login credentials, the user will receive a JSON Web Token that will be valid for an hour or until the user logs out.

roleCheckerUtil

Contains a method for checking the user role, which controls the user's access level, i.e. a normal user is not permitted to perform admin level actions.

2FA Setup

After entering the necessary information, a user who has not yet enabled 2FA can do so by obtaining the QR (Base64 encrypted text as data) and registering in any Authenticator app such as Microsoft Authenticator, Google Authenticator, or any other.

Use Google Authenticator or Microsoft Authenticator or any other Authenticator app to scan QR code and generate TOTP.

After registering with the QR code, enter the One Time Pin to successfully activate the 2FA.

Please star ✨ repository if you like it. Thank you!