Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.
TypeScript i18nextnext-authnextjspostgresqlprismareact-emailt3-stacktailwindcsstrpcturborepotypescriptzod
⚡️ Add support for custom claim paths (#1197)
Luke Vella104d214d2ef9
diff --git a/apps/docs/self-hosting/single-sign-on.mdx b/apps/docs/self-hosting/single-sign-on.mdxindex 1ddbcf12c..c47cc0906 100644--- a/apps/docs/self-hosting/single-sign-on.mdx+++ b/apps/docs/self-hosting/single-sign-on.mdx@@ -7,12 +7,8 @@ description: How to use your own identity provider<Info>Available in v3.4.0 and later.</Info><Warning>-#### Account Linking--Accounts using the same email are linked together. This assumes-that you are using a trusted identity provider that uses verified email-addresses.-+ Accounts using the same email are linked together. This assumes that you are+ using a trusted identity provider that uses verified email addresses.</Warning>## OpenID Connect (OIDC)@@ -29,7 +25,7 @@ Your OAuth 2.0 application needs to be configured with the following scopes:### Callback URL / Redirect URI-Your identity provider will redirect the user back to the following URL:+Your identity provider should redirect the user back to the following URL:```{BASE_URL}/api/auth/callback/oidc@@ -46,7 +42,7 @@ The following configuration options are available for OIDC.All required fields must be set for OIDC to be enabled.<ParamField path="OIDC_NAME" default="OpenID Connect">- The user-facing name of your provider as it will be shown on the login page+ The display name of your provider as it will be shown on the login page</ParamField><ParamField path="OIDC_DISCOVERY_URL" required>@@ -60,3 +56,17 @@ All required fields must be set for OIDC to be enabled.<ParamField path="OIDC_CLIENT_SECRET" required>The client secret of your OIDC application</ParamField>++<ParamField path="OIDC_NAME_CLAIM_PATH" default="name">+ The path to the claim that contains the user's name+</ParamField>++<ParamField path="OIDC_EMAIL_CLAIM_PATH" default="email">+ The path to the claim that contains the user's email address+</ParamField>++<ParamField path="OIDC_PICTURE_CLAIM_PATH" default="picture">+ The path to the claim that contains the user's profile picture+</ParamField>++<Info>Use dot notation in `_CLAIM_PATH` fields to access nested objects.</Info>diff --git a/apps/docs/tsconfig.json b/apps/docs/tsconfig.jsondeleted file mode 100644index beac8603e..000000000--- a/apps/docs/tsconfig.json+++ /dev/null@@ -1,5 +0,0 @@-{- "extends": "@rallly/tsconfig/next.json",- "include": ["**/*.ts", "**/*.tsx", "**/*.js"],- "exclude": ["node_modules"],-}diff --git a/apps/web/src/env.ts b/apps/web/src/env.tsindex d86588272..efe36187d 100644--- a/apps/web/src/env.ts+++ b/apps/web/src/env.ts@@ -19,6 +19,9 @@ export const env = createEnv({OIDC_DISCOVERY_URL: z.string().optional(),OIDC_CLIENT_ID: z.string().optional(),OIDC_CLIENT_SECRET: z.string().optional(),+ OIDC_EMAIL_CLAIM_PATH: z.string().default("email"),+ OIDC_NAME_CLAIM_PATH: z.string().default("name"),+ OIDC_PICTURE_CLAIM_PATH: z.string().default("picture"),/*** Email Provider* Choose which service provider to use for sending emails.@@ -70,6 +73,9 @@ export const env = createEnv({OIDC_DISCOVERY_URL: process.env.OIDC_DISCOVERY_URL,OIDC_CLIENT_ID: process.env.OIDC_CLIENT_ID,OIDC_CLIENT_SECRET: process.env.OIDC_CLIENT_SECRET,+ OIDC_EMAIL_CLAIM_PATH: process.env.OIDC_EMAIL_CLAIM_PATH,+ OIDC_NAME_CLAIM_PATH: process.env.OIDC_NAME_CLAIM_PATH,+ OIDC_PICTURE_CLAIM_PATH: process.env.OIDC_PICTURE_CLAIM_PATH,EMAIL_PROVIDER: process.env.EMAIL_PROVIDER,SMTP_HOST: process.env.SMTP_HOST,SMTP_USER: process.env.SMTP_USER,diff --git a/apps/web/src/utils/auth.ts b/apps/web/src/utils/auth.tsindex 28e14652d..b1065aea6 100644--- a/apps/web/src/utils/auth.ts+++ b/apps/web/src/utils/auth.ts@@ -7,7 +7,7 @@ import {NextApiRequest,NextApiResponse,} from "next";-import { NextAuthOptions } from "next-auth";+import { NextAuthOptions, User } from "next-auth";import NextAuth, {getServerSession as getServerSessionWithOptions,} from "next-auth/next";@@ -18,10 +18,12 @@ import GoogleProvider from "next-auth/providers/google";import { Provider } from "next-auth/providers/index";import { posthog } from "@/app/posthog";+import { env } from "@/env";import { absoluteUrl } from "@/utils/absolute-url";import { CustomPrismaAdapter } from "@/utils/auth/custom-prisma-adapter";import { mergeGuestsIntoUser } from "@/utils/auth/merge-user";import { emailClient } from "@/utils/emails";+import { getValueByPath } from "@/utils/get-value-by-path";const providers: Provider[] = [// When a user registers, we don't want to go through the email verification process@@ -128,9 +130,10 @@ if (profile(profile) {return {id: profile.sub,- name: profile.name,- email: profile.email,- };+ name: getValueByPath(profile, env.OIDC_NAME_CLAIM_PATH),+ email: getValueByPath(profile, env.OIDC_EMAIL_CLAIM_PATH),+ image: getValueByPath(profile, env.OIDC_PICTURE_CLAIM_PATH),+ } as User;},});}diff --git a/apps/web/src/utils/get-value-by-path.test.ts b/apps/web/src/utils/get-value-by-path.test.tsnew file mode 100644index 000000000..70ebc2e78--- /dev/null+++ b/apps/web/src/utils/get-value-by-path.test.ts@@ -0,0 +1,41 @@+import { describe, expect, it } from "vitest";++import { getValueByPath } from "./get-value-by-path";++describe("getValueByPath", () => {+ describe("when the path is not nested", () => {+ it("should return the value of the key", () => {+ const path = "key";+ const obj = { key: "value" };+ const value = getValueByPath(obj, path);+ expect(value).toBe("value");+ });+ });++ describe("when the path is nested", () => {+ it("should return the value of the nested key", () => {+ const path = "nested.key";+ const obj = { nested: { key: "value" } };+ const value = getValueByPath(obj, path);+ expect(value).toBe("value");+ });+ });++ describe("when the path is deeply nested", () => {+ it("should return the value of the deeply nested key", () => {+ const path = "deeply.nested.key";+ const obj = { deeply: { nested: { key: "value" } } };+ const value = getValueByPath(obj, path);+ expect(value).toBe("value");+ });+ });++ describe("when the path is not found", () => {+ it("should return undefined", () => {+ const path = "key";+ const obj = {};+ const value = getValueByPath(obj, path);+ expect(value).toBeUndefined();+ });+ });+});diff --git a/apps/web/src/utils/get-value-by-path.ts b/apps/web/src/utils/get-value-by-path.tsnew file mode 100644index 000000000..b7fe56d22--- /dev/null+++ b/apps/web/src/utils/get-value-by-path.ts@@ -0,0 +1,15 @@+export function getValueByPath<O extends Record<string, unknown>>(+ obj: O,+ path: string,+): unknown {+ const pathArray = path.split(".");+ // eslint-disable-next-line @typescript-eslint/no-explicit-any+ let curr: any = obj;+ for (const part of pathArray) {+ if (curr[part] === undefined) {+ return undefined;+ }+ curr = curr[part];+ }+ return curr;+}diff --git a/turbo.json b/turbo.jsonindex 8ab7435dd..42005ec8b 100644--- a/turbo.json+++ b/turbo.json@@ -84,7 +84,10 @@"OIDC_CLIENT_ID","OIDC_CLIENT_SECRET","OIDC_DISCOVERY_URL",+ "OIDC_EMAIL_CLAIM_PATH",+ "OIDC_NAME_CLAIM_PATH","OIDC_NAME",+ "OIDC_PICTURE_CLAIM_PATH","PADDLE_PUBLIC_KEY","PORT","SECRET_PASSWORD",