feat: Create the auth_provider module

Author: Blckbrry-Pi

modules/auth_providers/config.ts

@@ -0,0 +1,11 @@
+export interface Config {
+    providers: Record<string, ProviderEndpoints | string>;
+}
+
+export interface ProviderEndpoints {
+    authorization: string;
+    token: string;
+    userinfo: string;
+    scopes: string;
+    userinfoKey: string;
+}

modules/auth_providers/db/migrations/20240629231731_init/migration.sql

@@ -0,0 +1,15 @@
+-- CreateTable
+CREATE TABLE "ProviderEntries" (
+    "userId" UUID NOT NULL,
+    "providerType" TEXT NOT NULL,
+    "providerId" TEXT NOT NULL,
+    "providerData" JSONB NOT NULL,
+
+    CONSTRAINT "ProviderEntries_pkey" PRIMARY KEY ("userId","providerType","providerId")
+);
+
+-- CreateIndex
+CREATE INDEX "ProviderEntries_userId_idx" ON "ProviderEntries"("userId");
+
+-- CreateIndex
+CREATE INDEX "ProviderEntries_providerType_providerId_idx" ON "ProviderEntries"("providerType", "providerId");

modules/auth_providers/db/migrations/migration_lock.toml

@@ -0,0 +1,3 @@
+# Please do not edit this file manually
+# It should be added in your version-control system (i.e. Git)
+provider = "postgresql"

modules/auth_providers/db/schema.prisma

@@ -0,0 +1,16 @@
+// Do not modify this `datasource` block
+datasource db {
+	provider = "postgresql"
+	url      = env("DATABASE_URL")
+}
+
+model ProviderEntries {
+    userId          String      @db.Uuid
+	providerType    String
+	providerId      String
+	providerData    Json
+
+	@@id([userId, providerType, providerId])
+	@@index([userId])
+	@@index([providerType, providerId])
+}

modules/auth_providers/module.json

@@ -0,0 +1,48 @@
+{
+    "name": "OAuth2 Authentication Provider",
+    "description": "Authenticate users with OAuth 2.0.",
+    "icon": "key",
+    "tags": [
+        "core",
+        "user",
+        "auth"
+    ],
+    "authors": [
+        "rivet-gg",
+        "Skyler Calaman"
+    ],
+    "status": "beta",
+    "dependencies": {
+        "rate_limit": {},
+        "users": {},
+        "tokens": {}
+    },
+    "scripts": {
+        "list_providers": {
+            "name": "List Providers",
+            "description": "List all providers the user is identified with.",
+            "public": true
+        },
+        "get_provider_data": {
+            "name": "Get Provider Data",
+            "description": "Get the data associated with a specific provider for a user."
+        },
+        "set_provider_data": {
+            "name": "Set Provider Data",
+            "description": "Set the data associated with a specific provider for a user."
+        },
+        "add_provider_to_user": {
+            "name": "Add Provider To User",
+            "description": "Add a new provider and its associated data to a user."
+        }
+    },
+    "routes": {},
+    "errors": {
+        "provider_not_found": {
+            "name": "Provider Not Found"
+        },
+        "provider_already_added": {
+            "name": "Provider Already Added"
+        }
+    }
+}

modules/auth_providers/scripts/add_provider_to_user.ts

@@ -0,0 +1,43 @@
+import { RuntimeError, ScriptContext, prisma } from "../module.gen.ts";
+import { ProviderData, ProviderInfo } from "../utils/types.ts";
+
+export interface Request {
+	userToken: string;
+    info: ProviderInfo;
+    data: ProviderData & prisma.Prisma.InputJsonValue;
+}
+
+export interface Response {
+	providers: ProviderInfo[];
+}
+
+export async function run(
+	ctx: ScriptContext,
+	req: Request,
+): Promise<Response> {
+	await ctx.modules.rateLimit.throttle({
+        key: req.userToken,
+        period: 10,
+        requests: 10,
+        type: "user",
+    });
+
+    // Ensure the user token is valid and get the user ID
+    const { userId } = await ctx.modules.users.authenticateToken({ userToken: req.userToken } );
+
+    // Error if this provider is ALREADY associated with the user
+    const { data: prevData } = await ctx.modules.authProviders.getProviderData({ userToken: req.userToken, info: req.info });
+    if (prevData) throw new RuntimeError("provider_already_added");
+
+    // Add a new entry to the table with the associated data
+    await ctx.db.providerEntries.create({
+        data: {
+            userId,
+            providerType: req.info.providerType,
+            providerId: req.info.providerId,
+            providerData: req.data,
+        },
+    });
+
+    return await ctx.modules.authProviders.listProviders({ userToken: req.userToken });
+}

modules/auth_providers/scripts/get_provider_data.ts

@@ -0,0 +1,44 @@
+import { ScriptContext } from "../module.gen.ts";
+import { ProviderData, ProviderInfo } from "../utils/types.ts";
+
+export interface Request {
+	userToken: string;
+    info: ProviderInfo;
+}
+
+export interface Response {
+    data: ProviderData | null;
+}
+
+export async function run(
+	ctx: ScriptContext,
+	req: Request,
+): Promise<Response> {
+	await ctx.modules.rateLimit.throttle({
+        key: req.userToken,
+        period: 10,
+        requests: 10,
+        type: "user",
+    });
+
+    const { userId } = await ctx.modules.users.authenticateToken({ userToken: req.userToken } );
+
+    const provider = await ctx.db.providerEntries.findFirst({
+        where: {
+            userId,
+            providerType: req.info.providerType,
+            providerId: req.info.providerId,
+        },
+        select: {
+            providerData: true,
+        }
+    });
+
+    const data = provider?.providerData;
+
+    if (data && typeof data === 'object' && !Array.isArray(data)) {
+        return { data };
+    } else {
+        return { data: null };
+    }
+}

modules/auth_providers/scripts/list_providers.ts

@@ -0,0 +1,31 @@
+import { ScriptContext } from "../module.gen.ts";
+import { ProviderInfo } from "../utils/types.ts";
+
+export interface Request {
+	userToken: string;
+}
+
+export interface Response {
+    providers: ProviderInfo[];
+}
+
+export async function run(
+	ctx: ScriptContext,
+	req: Request,
+): Promise<Response> {
+	await ctx.modules.rateLimit.throttlePublic({});
+
+    const { userId } = await ctx.modules.users.authenticateToken({ userToken: req.userToken } );
+
+    return {
+        providers: await ctx.db.providerEntries.findMany({
+            where: {
+                userId,
+            },
+            select: {
+                providerType: true,
+                providerId: true,
+            }
+        }),
+    };
+}

modules/auth_providers/scripts/set_provider_data.ts

@@ -0,0 +1,45 @@
+import { ScriptContext, Empty, RuntimeError, prisma } from "../module.gen.ts";
+import { ProviderData, ProviderInfo } from "../utils/types.ts";
+
+export interface Request {
+	userToken: string;
+    info: ProviderInfo;
+    data: ProviderData & prisma.Prisma.InputJsonValue;
+}
+
+export type Response = Empty;
+
+export async function run(
+	ctx: ScriptContext,
+	req: Request,
+): Promise<Response> {
+	await ctx.modules.rateLimit.throttle({
+        key: req.userToken,
+        period: 10,
+        requests: 10,
+        type: "user",
+    });
+
+    // Ensure the user token is valid and get the user ID
+    const { userId } = await ctx.modules.users.authenticateToken({ userToken: req.userToken } );
+
+    // Error if this provider is not associated with the user
+    const { data: prevData } = await ctx.modules.authProviders.getProviderData({ userToken: req.userToken, info: req.info });
+    if (!prevData) throw new RuntimeError("provider_not_found");
+
+    // Update the provider data where userId, providerType, and providerId match
+    await ctx.db.providerEntries.update({
+        where: {
+            userId_providerType_providerId: {
+                userId,
+                providerType: req.info.providerType,
+                providerId: req.info.providerId,
+            }
+        },
+        data: {
+            providerData: req.data,
+        },
+    });
+
+    return {};
+}

modules/auth_providers/utils/types.ts

@@ -0,0 +1,8 @@
+export type ProviderData = Record<string, unknown>;
+
+export interface ProviderInfo {
+    providerType: string;
+    providerId: string;
+}
+
+