• Stars
    star
    129
  • Rank 279,262 (Top 6 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created almost 3 years ago
  • Updated 7 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A OAuth2Strategy for Remix Auth

OAuth2Strategy

A strategy to use and implement OAuth2 framework for authentication with federated services like Google, Facebook, GitHub, etc.

Supported runtimes

Runtime Has Support
Node.js
Cloudflare

How to use

Installation

npm add remix-auth-oauth2

Directly

You can use this strategy by adding it to your authenticator instance and configuring the correct endpoints.

export let authenticator = new Authenticator<User>(sessionStorage);

authenticator.use(
  new OAuth2Strategy(
    {
      authorizationURL: "https://provider.com/oauth2/authorize",
      tokenURL: "https://provider.com/oauth2/token",
      clientID: process.env.CLIENT_ID,
      clientSecret: process.env.CLIENT_SECRET,
      callbackURL: "https://example.app/auth/callback",
      scope: "openid email profile", // optional
      useBasicAuthenticationHeader: false // defaults to false
    },
    async ({
      accessToken,
      refreshToken,
      extraParams,
      profile,
      context,
      request,
    }) => {
      // here you can use the params above to get the user and return it
      // what you do inside this and how you find the user is up to you
      return await getUser(
        accessToken,
        refreshToken,
        extraParams,
        profile,
        context,
        request
      );
    }
  ),
  // this is optional, but if you setup more than one OAuth2 instance you will
  // need to set a custom name to each one
  "provider-name"
);

Extending it

You can use this strategy as a base class for another strategy using the OAuth2 framework. That way, you wouldn't need to implement the whole OAuth2 flow yourself.

The OAuth2Strategy will handle the whole flow for you and let you replace parts of it where you need.

Let's see how the Auth0Strategy is implemented using the OAuth2Strategy as a base.

// We need to import from Remix Auth the type of the strategy verify callback
import type { StrategyVerifyCallback } from "remix-auth";
// We need to import the OAuth2Strategy, the verify params and the profile interfaces
import type {
  OAuth2Profile,
  OAuth2StrategyVerifyParams,
} from "remix-auth-oauth2";
import { OAuth2Strategy } from "remix-auth-oauth2";

// These are the custom options we need from the developer to use the strategy
export interface Auth0StrategyOptions {
  domain: string;
  clientID: string;
  clientSecret: string;
  callbackURL: string;
}

// This interface declare what extra params we will get from Auth0 on the
// verify callback
export interface Auth0ExtraParams extends Record<string, string | number> {
  id_token: string;
  scope: string;
  expires_in: 86_400;
  token_type: "Bearer";
}

// The Auth0Profile extends the OAuth2Profile with the extra params and mark
// some of them as required
export interface Auth0Profile extends OAuth2Profile {
  id: string;
  displayName: string;
  name: {
    familyName: string;
    givenName: string;
    middleName: string;
  };
  emails: Array<{ value: string }>;
  photos: Array<{ value: string }>;
  _json: {
    sub: string;
    name: string;
    given_name: string;
    family_name: string;
    middle_name: string;
    nickname: string;
    preferred_username: string;
    profile: string;
    picture: string;
    website: string;
    email: string;
    email_verified: boolean;
    gender: string;
    birthdate: string;
    zoneinfo: string;
    locale: string;
    phone_number: string;
    phone_number_verified: boolean;
    address: {
      country: string;
    };
    updated_at: string;
  };
}

// And we create our strategy extending the OAuth2Strategy, we also need to
// pass the User as we did on the FormStrategy, we pass the Auth0Profile and the
// extra params
export class Auth0Strategy<User> extends OAuth2Strategy<
  User,
  Auth0Profile,
  Auth0ExtraParams
> {
  // The OAuth2Strategy already has a name but we override it to be specific of
  // the service we are using
  name = "auth0";

  private userInfoURL: string;

  // We receive our custom options and our verify callback
  constructor(
    options: Auth0StrategyOptions,
    // Here we type the verify callback as a StrategyVerifyCallback receiving
    // the User type and the OAuth2StrategyVerifyParams with the Auth0Profile
    // and the Auth0ExtraParams
    // This way, when using the strategy the verify function will receive as
    // params an object with accessToken, refreshToken, extraParams and profile.
    // The latest two matching the types of Auth0Profile and Auth0ExtraParams.
    verify: StrategyVerifyCallback<
      User,
      OAuth2StrategyVerifyParams<Auth0Profile, Auth0ExtraParams>
    >
  ) {
    // And we pass the options to the super constructor using our own options
    // to generate them, this was we can ask less configuration to the developer
    // using our strategy
    super(
      {
        authorizationURL: `https://${options.domain}/authorize`,
        tokenURL: `https://${options.domain}/oauth/token`,
        clientID: options.clientID,
        clientSecret: options.clientSecret,
        callbackURL: options.callbackURL,
      },
      verify
    );

    this.userInfoURL = `https://${options.domain}/userinfo`;
    this.scope = options.scope || "openid profile email";
    this.audience = options.audience;
  }

  // We override the protected authorizationParams method to return a new
  // URLSearchParams with custom params we want to send to the authorizationURL.
  // Here we add the scope so Auth0 can use it, you can pass any extra param
  // you need to send to the authorizationURL here base on your provider.
  protected authorizationParams() {
    const urlSearchParams: Record<string, string> = {
      scope: this.scope,
    };

    if (this.audience) {
      urlSearchParams.audience = this.audience;
    }

    return new URLSearchParams(urlSearchParams);
  }

  // We also override how to use the accessToken to get the profile of the user.
  // Here we fetch a Auth0 specific URL, get the profile data, and build the
  // object based on the Auth0Profile interface.
  protected async userProfile(accessToken: string): Promise<Auth0Profile> {
    let response = await fetch(this.userInfoURL, {
      headers: { Authorization: `Bearer ${accessToken}` },
    });

    let data: Auth0Profile["_json"] = await response.json();

    let profile: Auth0Profile = {
      provider: "auth0",
      displayName: data.name,
      id: data.sub,
      name: {
        familyName: data.family_name,
        givenName: data.given_name,
        middleName: data.middle_name,
      },
      emails: [{ value: data.email }],
      photos: [{ value: data.picture }],
      _json: data,
    };

    return profile;
  }
}

And that's it, thanks to the OAuth2Strategy we don't need to implement the whole OAuth2 flow ourselves and can focus on the unique parts of our strategy which is the user profile and extra params our provider may require us to send.

More Repositories

1

remix-utils

A set of utility functions and types to use with Remix.run
TypeScript
1,934
star
2

remix-auth

Simple Authentication for Remix
TypeScript
1,782
star
3

remix-i18next

The easiest way to translate your Remix apps
TypeScript
520
star
4

impresionante-javascript

Recopilación de links en español sobre JavaScript
415
star
5

flagged

Feature Flags for React made easy with hooks, HOC and Render Props
TypeScript
386
star
6

remix-hono

Hono middlewares for Remix
TypeScript
321
star
7

next-ga

Next.js HOC to integrate Google Analytics on every page change
JavaScript
232
star
8

grial

A Node.js framework for creating GraphQL API servers easily and without a lot of boilerplate.
JavaScript
189
star
9

next-nprogress

Next.js HOC to integrate NProgress inside your app
JavaScript
149
star
10

use-mutation

🧬 Run side-effects safely in React
TypeScript
119
star
11

swr-sync-storage

Synchronize SWR cache with localStorage or sessionStorage to get offline cache
TypeScript
109
star
12

react-lazy-image

Component to render images and lazyload them if are in the viewport (or near to them).
JavaScript
101
star
13

personal-site

Personal website
TypeScript
95
star
14

now-storage

Use Now static deployments to upload and store files.
JavaScript
90
star
15

remix-auth-form

A Remix Auth strategy for working with forms.
TypeScript
79
star
16

sergiodxa.com

The code behind sergiodxa.com
TypeScript
71
star
17

remix-auth-github

A GitHubStrategy for Remix Auth, based on the OAuth2Strategy
TypeScript
66
star
18

redux-in-spanish

Traducción al español de la documentación de Redux.
64
star
19

web-oidc

An OpenID Connect client built using only Web APIs
TypeScript
49
star
20

remix-auth-strategy-template

A template for creating a new Remix Auth strategy.
TypeScript
47
star
21

remix-socket.io

A Remix app using Express and Socket.io
TypeScript
45
star
22

next-socket.io

An example app with Next.js and socket.io
JavaScript
38
star
23

remix-inspector

Remix devtools to inspect your route data.
TypeScript
38
star
24

react-wordpress

Example of a React+Next.js+WordPress application.
JavaScript
36
star
25

react-lazy-memo

CRA with Suspense, lazy and memo usage demo app
JavaScript
36
star
26

swr-mutate-many

Little function to call mutate against multiple cached keys of SWR
TypeScript
26
star
27

remix-demo-infinite-scroll

A collection of infinite scroll pagination demos built with Remix
TypeScript
26
star
28

now-ab

A simple proxy server to handle Now.sh deployments AB tests
JavaScript
25
star
29

remix-on-bun

TypeScript
25
star
30

es6

Material para la clase BONUS en Comunidad Platzi sobre ECMAScript 6.
HTML
23
star
31

react-course-project

Proyecto para el curso de React.js
JavaScript
22
star
32

micro-next

Integrations between Micro and Next.js
JavaScript
20
star
33

collected-notes

A TypeScript client for the Collected Notes API
17
star
34

now-parcel

A Now v2 Parcel builder.
JavaScript
16
star
35

api-client

A strongly typed API client using Zod
TypeScript
15
star
36

remix-demo-file-upload

A simple demo on how to add a file upload that shows the image being uploaded and later replace it with the actual one
TypeScript
15
star
37

remix-vite-i18next

An example Remix + Vite app with remix-i18next setup
TypeScript
14
star
38

collected-remix

A Collected Notes client in Remix
TypeScript
12
star
39

micro-platzi-profile

Ejemplo de microservicio usando https://github.com/zeit/micro para scrappear un perfíl de Platzi
JavaScript
12
star
40

markdown-it-mentions

markdown-it plugin to support Twitter like mentions
JavaScript
11
star
41

react-use-permissions

React hook for Permissions API
JavaScript
11
star
42

use-safe-callback

Wrap a function to ensure you never call it if a component is unmounted, useful to avoid cases where an async code could finish after a component has unmounted and it tries to update a state
TypeScript
11
star
43

redux-duck

Helper function to create Redux modules using the ducks-modular-redux proposal
TypeScript
10
star
44

use-log

Log a state or prop every time it changes
TypeScript
10
star
45

cf-bootcamp-react-router-lesson

TypeScript
9
star
46

react-simple-modal

React modal make it simple.
JavaScript
8
star
47

collected-notes-website

A Next.js based clon of the Collected Notes website
TypeScript
8
star
48

remix-mdn

A MDN clone of Remix
TypeScript
8
star
49

remix-auth-token

Token based authentication for Remix Auth
TypeScript
8
star
50

next-analytics

Next.js HOC to integrate Google Analytics and FB Pixel
JavaScript
8
star
51

personal-slides

The slides of my talks
JavaScript
7
star
52

collected-notes-next-blog

Blog example using Collected Notes as CMS
TypeScript
7
star
53

react-use-quicklink

Quicklink hook for React
JavaScript
6
star
54

use-validate-image-url

TypeScript
6
star
55

email-value

TypeScript
6
star
56

isomorphic-react-todo

Aplicación web de TODOs isomórfica hecha con React.js
JavaScript
6
star
57

use-consistent-value

Keep a consistent reference to an object or array based on their values.
TypeScript
6
star
58

markdown-it-codesandbox

markdown-it plugin to embed CodeSandbox editor.
JavaScript
5
star
59

remix-demo-prefetch-fetcher

Demo Remix app to prefetch the fetcher data
TypeScript
5
star
60

next-custom-query

Example Next.js app using a custom server with queries in the URLs.
JavaScript
5
star
61

yifi-search

Backbone.js WebApp for search torrents with the YIFI's API.
JavaScript
5
star
62

navBarAdaptable-mejorUX

Barra de navegación adaptable con Media Queries y JS
CSS
5
star
63

next-babel-minify

Next.js plugin to replace UglifyJS for BabelMinify
JavaScript
5
star
64

gulp-tasks-boilerplate

Plantilla de tareas de Gulp.js para distintos usos, con un package.json con todos los módulos requeridos.
JavaScript
5
star
65

remix-auth-webauthn

A strategy to support WebAuthn
TypeScript
4
star
66

remix-auth-austin-demo

Remix Auth demo for the Remix Austin meetup
TypeScript
4
star
67

MarvelDB

Webapp to find characters in the Marvel database.
JavaScript
4
star
68

remix-markdoc-example

TypeScript
4
star
69

remix-define-routes

A DSL to define Remix routes with code
TypeScript
4
star
70

swr-sync-session

This is an example Next.js + SWR application using SWR revalidation on focus feature to sync session between tabs
JavaScript
4
star
71

dataset

A free to use API to get a lists of various common datasets such as languages, countries, etc.
JavaScript
3
star
72

next-credentials

Next.js example using Credential Management API
JavaScript
3
star
73

personal-cli

A CLI tool with commands for personal usage.
JavaScript
3
star
74

platzimusic

Proyecto para el diplomado de React en Platzi
JavaScript
3
star
75

cf-custom-hooks

Ejercicios de Custom Hooks para Código Facilito
TypeScript
3
star
76

personal-api

An API created for my personal site usage.
JavaScript
2
star
77

cf-bootcamp-deploy

TypeScript
2
star
78

techtalks-remix-demo

Demo of Remix.run for Tech Talks.pe
TypeScript
2
star
79

react-render-service

React Render as a Service
JavaScript
1
star
80

personal-shortening

A personal URL shortening service
JavaScript
1
star
81

virtual-event-starter-kit

TypeScript
1
star
82

remix-with-sentry-sdk

A reproduction of the issue https://github.com/getsentry/sentry-javascript/issues/6294
TypeScript
1
star
83

archive-it

API to get the messages of a Slack channel
TypeScript
1
star
84

ngCreate

CLI to create AngularJS files
JavaScript
1
star
85

react-chat-app

JavaScript
1
star
86

pokedex-swr

Pokedex Application using Next.js and SWR with Tailwind for styling
TypeScript
1
star
87

swr-devtools

TypeScript
1
star
88

dice-roller

A tiny library to calculate roll dices using the classic D&D sintax: 1d20+4.
JavaScript
1
star
89

react-i18n

Ejemplo de internacionalización con React.js y Format.js
JavaScript
1
star
90

es-query

An utilitarian library for DOM manipulation using ECMAScript 7 Function Bind Syntax
JavaScript
1
star
91

device-info

A little service to check a device information.
HTML
1
star
92

deno-md-to-html

Simple MD to HTML parser
TypeScript
1
star
93

package

A template to create new packages.
TypeScript
1
star
94

Check-userAgent

New method for JS window object that checks the userAgent and returns true if a mobile.
1
star
95

Elecalc

Webapp hecha con AngularJS para realizar distintos cálculos de electricidad de una manera fácil y rápida
HTML
1
star
96

tpb-app

WebApp in NodeJS to search torrents in The Pirate Bay
JavaScript
1
star
97

remix-island-demos

TypeScript
1
star