Authentication

JWT, Firebase, Auth0, AWS Cognito setup

Berry offers four authentication methods - JSON Web Token (JWT), Firebase, Auth0 and AWS - for users to choose from and can be changed to match the user's needs.

JWT Authentication is set by default

Authentication

How does it work?

Access to dashboard pages is restricted to authenticated users. If a user is not authenticated, they will be redirected to the login page.

We used two guards GuestGuard and AuthGuard. Guards have been configured in src\utils\route-guard\ folder.

In the src/layout/App.js, we have specified auth provider JWTProvider like,

App.js

import { JWTProvider as AuthProvider } from 'contexts/JWTContext';

App component wrap with the <JWTProvider>

<ThemeCustomization>
  ...
  <AuthProvider>
    <Routes />
    <Snackbar />
  </AuthProvider>
  ...
</<ThemeCustomization>>

Using <JWTProvider>, we can use the context directly by importing useContext from React and specifying the context JWTContext or we can use the custom hook useAuth from src/hooks/useAuth.js

For Remix

We used two guards GuestGuard and AuthGuard. Guards have been configured in app\utils\route-guard\ folder.

In the app/root.tsx, we have specified auth provider JWTProvider like,

root.tsx

import { JWTProvider as AuthProvider } from 'contexts/JWTContext';

App component wrap with the <JWTProvider>

<ThemeCustomization>
  ...
  <AuthProvider>
    <Outlet />
    <Snackbar />
  </AuthProvider>
  ...
</ThemeCustomization>

Auth Configuration:

All configurations related to authentication are stored in .env file. Those configs are like APIKey to connect authentication server, project id, etc.

Berry has a dummy/test credentials to make authentication work. Users have to change API and secret as per their project needs. One should not use those provided keys in their live environment.

.env

VITE_APP_VERSION=v3.8.0
GENERATE_SOURCEMAP=false

## Bakeend API URL
VITE_APP_API_URL=https://mock-data-api-nextjs.vercel.app/
VITE_APP_BASE_NAME=

## Map Box 
VITE_APP_MAPBOX_ACCESS_TOKEN=

## Firebase - Google Auth 
VITE_APP_FIREBASE_API_KEY=
VITE_APP_FIREBASE_AUTH_DOMAIN=
VITE_APP_FIREBASE_PROJECT_ID=
VITE_APP_FIREBASE_STORAGE_BUCKET=
VITE_APP_FIREBASE_MESSAGING_SENDER_ID=
VITE_APP_FIREBASE_APP_ID=
VITE_APP_FIREBASE_MEASUREMENT_ID=

## AWS
VITE_APP_AWS_POOL_ID=
VITE_APP_AWS_APP_CLIENT_ID=

## Auth0
VITE_APP_AUTH0_CLIENT_ID=
VITE_APP_AUTH0_DOMAIN=

The theme provides working an example for Login and Register only. Other flow like reset password, verification have to make it workable by the user himself.

Switching between Authentication methods

JWT to Firebase

Set Firebase Config

At present, firebase uses you need to set a secret in the following file. For more detail refer to firebase here: https://firebase.google.com/docs/reference/rest/auth

.env

###
## Firebase - Google Auth 

VITE_APP_FIREBASE_API_KEY=
VITE_APP_FIREBASE_AUTH_DOMAIN=
VITE_APP_FIREBASE_PROJECT_ID=
VITE_APP_FIREBASE_STORAGE_BUCKET=
VITE_APP_FIREBASE_MESSAGING_SENDER_ID=
VITE_APP_FIREBASE_APP_ID=
VITE_APP_FIREBASE_MEASUREMENT_ID=
###

Change AuthProvider

..\src\App.js

// Replace at line 6:
import { FirebaseProvider as AuthProvider } from 'contexts/FirebaseContext';

Change auth Hooks

Comment another context in the following file and uncomment Firebase one.

..\src\hooks\useAuth.js

import AuthContext from 'contexts/FirebaseContext';

Copy login code

It's also super simple. We have provided a code that just needs to be replaced. Copy src\views\pages\authentication\login\FirebaseLogin to src\views\pages\authentication\auth-forms\AuthLogin.tsx

For nextJS, src\components\Authentication\login\FirebaseLogin to src\components\Authentication\auth-forms\AuthLogin.tsx

Copy register code

We have provided a code that just needs to be replaced. Copy src\views\pages\authentication\login\FirebaseRegister to src\views\pages\authentication\auth-forms\AuthRegister.tsx

For nextJS, src\components\Authentication\login\JWTRegister to src\components\Authentication\auth-forms\AuthRegister.tsx

JWT to Auth0

Set Auth0 Config

At present, Auth0 uses a dummy client id and domain, so we don't need to change anything, but in actual implementation, you need to set client id and domain in the following file. For more detail refer to Auth0 here: https://auth0.com/docs/get-started/auth0-overview

.env

###
## Auth0

VITE_APP_AUTH0_CLIENT_ID=
VITE_APP_AUTH0_DOMAIN=
###

Change AuthProvider

..\src\App.js

import { Auth0Provider as AuthProvider } from 'contexts/Auth0Context';

Change auth Hooks

Comment another context in the following file and uncomment Auth0 one.

..\src\hooks\useAuth.js

import AuthContext from 'contexts/Auth0Context';

Copy login code

It's super simple. We have provided a code that just needs to be replaced.

Copy code from src\views\pages\authentication\login\Auth0Login to src\views\pages\authentication\auth-forms\AuthLogin.tsx

For nextJS, src\components\Authentication\login\Auth0Login to src\components\Authentication\auth-forms\AuthLogin.tsx

Copy register code

We have provided a code that just needs to be replaced. Copy code from src\views\pages\authentication\login\Auth0Register to src\views\pages\authentication\auth-forms\AuthRegister.tsx

For nextJS, src\components\Authentication\login\Auth0Register to src\components\Authentication\auth-forms\AuthRegister.tsx

JWT to AWS Congnito

Set AWS Config

At present, AWS uses a dummy config, so we don't need to change anything, but in actual implementation, you need to set poolId and appClientId in the following file. For more detail refer to AWS here: https://aws.amazon.com/cognito/

.

###
## AWS

VITE_APP_AWS_POOL_ID=
VITE_APP_AWS_APP_CLIENT_ID=
###

Change AuthProvider

..\src\App.js

import { AWSCognitoProvider as AuthProvider } from 'contexts/AWSCognitoContext';

Change auth Hooks

Comment another context in the following file and uncomment Auth0 one.

..\src\hooks\useAuth.js

import AuthContext from 'contexts/AWSCognitoContext';

Copy login code

It's super simple. We have provided a code that just needs to be replaced. Copy code from src\views\pages\authentication\login\AWSCognitoLogin to src\views\pages\authentication\auth-forms\AuthLogin.tsx

For nextJS, src\components\Authentication\login\AWSCongnitoLogin to src\components\Authentication\auth-forms\AuthLogin.tsx

Copy register code

We have provided a code that just needs to be replaced. Copy code from src\views\pages\authentication\login\AWSCognitoRegister to src\views\pages\authentication\auth-forms\AuthRegister.tsx

For nextJS, src\components\Authentication\login\AWSCognitoRegister to src\components\Authentication\auth-forms\AuthRegister.tsx