elysia-oauth2

Elysia plugin for OAuth 2.0 Authorization Flow.

Powered by Arctic@2 with more than 53 oauth2 providers!

Installation

bun install elysia-oauth2 arctic

Update

if Arctic will release some new providers, you can update it with

bun install arctic@latest

Example

import { Elysia } from "elysia";
import { oauth2 } from "elysia-oauth2";

new Elysia()
    .use(
        oauth2({
            VK: [
                "clientID",
                "clientSecret",
                "https://example.com/auth/vk/callback",
            ],
        })
    )
    .get("/auth/vk", ({ oauth2 }) => oauth2.redirect("VK"))
    .get("/auth/vk/callback", async ({ oauth2 }) => {
        const tokens = await oauth2.authorize("VK");

        const accessToken = tokens.accessToken();

        // send request to API with token
    })
    .listen(3000);

Important

You should return oauth2.redirect from the handler, because it relies on elysia's redirect() which need to return Response

CreateURL example

import { Elysia } from "elysia";
import { oauth2 } from "elysia-oauth2";

new Elysia()
    .use(
        oauth2({
            Google: [
                "clientID",
                "clientSecret",
                "https://example.com/auth/google/callback",
            ],
        })
    )
    .get("/auth/google", async ({ oauth2, redirect }) => {
        const url = oauth2.createURL("Google", ["email"]);
        url.searchParams.set("access_type", "offline");

        return redirect(url.href);
    })
    .get("/auth/google/callback", async ({ oauth2 }) => {
        const tokens = await oauth2.authorize("Google");

        const accessToken = tokens.accessToken();

        // send request to API with token
    })
    .listen(3000);

Options

You can configure plugin by providing options object in second argument.

import { Elysia } from "elysia";
import { oauth2 } from "elysia-oauth2";

new Elysia().use(
    oauth2(
        {},
        {
            cookie: {
                // defaults
                secure: true,
                sameSite: "lax",
                path: "/",
                httpOnly: true,
                maxAge: 60 * 30, // 30 min
            },
        }
    )
);

Supported providers

• 42 School
• Amazon Cognito
• AniList
• Apple
• Atlassian
• Auth0
• Authentik
• Bitbucket
• Box
• Bungie
• Coinbase
• Discord
• Dribbble
• Dropbox
• Epic Games
• Etsy
• Facebook
• Figma
• GitHub
• GitLab
• Google
• Intuit
• Kakao
• KeyCloak
• Lichess
• Line
• Linear
• LinkedIn
• Microsoft Entra ID
• MyAnimeList
• Naver
• Notion
• Okta
• osu!
• Patreon
• Polar
• Reddit
• Roblox
• Salesforce
• Shikimori
• Slack
• Spotify
• Start.gg
• Strava
• Tiltify
• Tumblr
• Twitch
• Twitter
• VK
• WorkOS
• Yahoo
• Yandex
• Zoom