# @jlguenego/express-oauth2-client > Express Middleware for OAuth2 connection. Latest version **0.0.8** (published 2022-02-19) · ISC license · 0 weekly downloads ## Install ```sh npm install @jlguenego/express-oauth2-client pnpm add @jlguenego/express-oauth2-client yarn add @jlguenego/express-oauth2-client bun add @jlguenego/express-oauth2-client ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.8 | | Published | 2022-02-19 | | First published | 2021-10-04 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 58.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | jlguenego | ## Links - npm: https://www.npmjs.com/package/@jlguenego/express-oauth2-client - npm.io page: https://npm.io/package/@jlguenego/express-oauth2-client ## Dependencies (1) - [got](https://npm.io/package/got.md) ^11.8.2 ## Recent versions - 0.0.8 (latest) — 2022-02-19 - 0.0.7 — 2022-01-16 - 0.0.6 — 2021-12-15 - 0.0.5 — 2021-10-15 - 0.0.4 — 2021-10-04 - 0.0.3 — 2021-10-04 - 0.0.2 — 2021-10-04 ## README # @jlguenego/express-oauth2-client ## Install ``` mdkir test-oauth2 cd test-oauth2 npm init -y npm i @jlguenego/express-oauth2-client express express-session dotenv ejs ``` - `ejs` is just to see the demo (when setting `exposeTest` to `true`). - `dotenv` is to make environment variable taken from an `.env` file. - `express` is the famous express server. - `express-session` is needed for making authentication with session cookies. ## Usage ### environment variables Create the `.env` file: ``` # Comma separated list of providers (uppercase) OAUTH2_PROVIDER_LIST=GITHUB,AZUREAD # example for GITHUB OAUTH2_GITHUB_CLIENT_ID= OAUTH2_GITHUB_CLIENT_SECRET= OAUTH2_GITHUB_AUTHORIZATION_URL=https://github.com/login/oauth/authorize OAUTH2_GITHUB_ACCESS_TOKEN_URL=https://github.com/login/oauth/access_token # example for AZUREAD OAUTH2_AZUREAD_CLIENT_ID= OAUTH2_AZUREAD_CLIENT_SECRET= OAUTH2_AZUREAD_AUTHORIZATION_URL=https://login.microsoftonline.com/common/oauth2/v2.0/authorize OAUTH2_AZUREAD_ACCESS_TOKEN_URL=https://login.microsoftonline.com/common/oauth2/v2.0/token ``` ### javascript example Create a `server.js` file: ```js const express = require('express'); const session = require('express-session'); const {oauth2Client} = require('@jlguenego/express-oauth2-client'); const app = express(); app.use( session({ name: 'test-app.sid', secret: '$keep this secret$', resave: false, saveUninitialized: true, }) ); app.use('/api', oauth2Client.router({exposeTest: true})); app.use('/hello', oauth2Client.auth(), (req, res) => { res.send('Hello world'); }); app.get('/', (req, res) => { res.redirect('/api/oauth2/test/'); }); app.listen(3000, () => { console.log('Server started on port 3000'); }); ``` ### Running ``` node -r dotenv/config server.js ``` Open your browser to `http://localhost:3000` and try to connect with your providers. Gooooooooooood luck!!! :grin: ## Documentation You want to make button with `Connect with Github`, or `Connect with Azure AD` ? This module is designed to help you with that. How it works ? An **authentication provider** offers the OAuth2 mechanism in order to let you put on your website buttons like "Connect with ". This module currently works with: - Github - Azure AD ### Prerequisites 1. `express` node module. 2. `express-session` node module because all users will be identified with session cookies. 3. configuring the client application within your providers (Github, Azure AD, etc.). You need to have information with: 1. Application id 2. Secret key 3. authorization url 4. access token url ### Environment variables the `` name should be in uppercase. Example: ``` # Comma separated list of providers (uppercase) OAUTH2_PROVIDER_LIST=GITHUB,AZUREAD # example for GITHUB OAUTH2_GITHUB_CLIENT_ID= OAUTH2_GITHUB_CLIENT_SECRET= OAUTH2_GITHUB_AUTHORIZATION_URL=https://github.com/login/oauth/authorize OAUTH2_GITHUB_ACCESS_TOKEN_URL=https://github.com/login/oauth/access_token # example for AZUREAD OAUTH2_AZUREAD_CLIENT_ID= OAUTH2_AZUREAD_CLIENT_SECRET= OAUTH2_AZUREAD_AUTHORIZATION_URL=https://login.microsoftonline.com/common/oauth2/v2.0/authorize OAUTH2_AZUREAD_ACCESS_TOKEN_URL=https://login.microsoftonline.com/common/oauth2/v2.0/token ``` To add a provider, add: ``` OAUTH2_PROVIDER_LIST=GITHUB,AZUREAD, OAUTH2__CLIENT_ID= OAUTH2__CLIENT_SECRET= OAUTH2__AUTHORIZATION_URL=https://login.microsoftonline.com/common/oauth2/v2.0/authorize OAUTH2__ACCESS_TOKEN_URL=https://login.microsoftonline.com/common/oauth2/v2.0/token ``` ### the oauth2Client object This module exports a singleton object `oauth2Client` with following properties: - `oauth2Client.auth()`: a middleware to check if someone is authenticated. It returns a 401 HTTP response error if nobody is authenticated. - `oauth2Client.router(options: {exposeTest: boolean})`: a router middleware that offers some route url paths: - `GET /auth/isConnected`: checks if a user is connected - `POST /auth/disconnect`: disconnects a user (if any is connected) - `POST /auth/afterLoginRoute`: set the url to go after a user have been just authenticated. - The connection process is done with the `/oauth2` routes: - `GET /oauth2/config`: get the `OAuth2Config` config object. This object gives a set of providers (Github, Azure AD, etc.) with the OAuth2 authorization url. All buttons `Connect with ` should link to the provider authorization url. - `GET /redirect/:provider`: url to be redirected from the provider. - `/oauth2/test`: accessible only if the `exposeTest` option is set, this is the demo test routes (implemented with `ejs` module). ## Author Made with :hearts: by Jean-Louis GUENEGO --- _Source: https://npm.io/package/@jlguenego/express-oauth2-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._