https://github.com/carrington-115/oauth-app

A web application to test OAuth with Nodejs
https://github.com/carrington-115/oauth-app

ejs express nodejs oauth passportjs

Last synced: 3 months ago
JSON representation

A web application to test OAuth with Nodejs

• Host: GitHub
• URL: https://github.com/carrington-115/oauth-app
• Owner: carrington-115
• Created: 2024-08-09T02:33:49.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-11T21:23:18.000Z (5 months ago)
• Last Synced: 2024-09-28T07:21:01.367Z (3 months ago)
• Topics: ejs, express, nodejs, oauth, passportjs
• Language: EJS
• Homepage:
• Size: 118 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# oauth-app

## How to execute project

- To execute the project you need `nodejs` installed on your device.

- Clone the project with `git clone `.

- Create a `.env` file on the root of the project and assign a `PORT` instance to be used be the development server.

- Run `npm run dev` to spin up the development server (primarily running on `nodemon`. check the `package.json` file).

- Open the link on a browser and test the application

## Documentation

### Introduction

- `OAuth` means **Open Authorization**. it is one approach to user authentication using platforms like `Google, Facebook, Github`

- This is so efficient because it requires the filling of no form

- For example if a button on a website is clicked to request signin by Oauth authentication, a request is sent to the service website, for example Google Auth servers. Then by confirming it, the user allows that website to use their user details saved on the google servers for signing into that website.

- `Passport.js` is used to allow the oauth authentication

### Passport setup with Oauth

- To use an OAuth with passport on a project, there are two modules we need to install: `passport` and `passport-strategy`. For example, if we want to use google authentication on the platform, we have to install `passport` and `passport google strategy`.

- In the `passport configuration file` import passport and the `passport strategy` to be used for the authentication.

- Then instantiate `passport.use()`

```js

const passport = require('passport')

const GoogleStrategy = require('passport-google-oauth20')

passport.use(/* strategy */, /* callback function */)

```

- The `Google Strategy` takes the following options: `CLIENT_ID, CLIENT_SECRET, and Redirect_url`

- These details can be obtained from the `google cloud platform` usig the `API credentials` and enabling `OAuth credentials`

- After the consent screen is shown, the user is redirected to the `redirect_url` with a `code` which is used to get the user details

### The Passport callback function

- This function is fired once the user is authenticated by the OAuth service.

- The function takes the `accessToken, refreshToken, profile, done` as arguments.

### Creating the database for users

- The next step is to figure out where the user is new to the application or not. If they are new, then we want to add them to our database.

-