The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
feat: add oidc support
Matt Kilgoree0440fd8a213
diff --git a/apps/web/process-env.d.ts b/apps/web/process-env.d.tsindex 0c00cb4c1..63a341060 100644--- a/apps/web/process-env.d.ts+++ b/apps/web/process-env.d.ts@@ -12,5 +12,9 @@ declare namespace NodeJS {NEXT_PRIVATE_GOOGLE_CLIENT_ID: string;NEXT_PRIVATE_GOOGLE_CLIENT_SECRET: string;++ NEXT_PRIVATE_OIDC_WELL_KNOWN: string;+ NEXT_PRIVATE_OIDC_CLIENT_ID: string;+ NEXT_PRIVATE_OIDC_CLIENT_SECRET: string;}}diff --git a/apps/web/src/app/(unauthenticated)/signin/page.tsx b/apps/web/src/app/(unauthenticated)/signin/page.tsxindex 21136f2e6..a0599ac1a 100644--- a/apps/web/src/app/(unauthenticated)/signin/page.tsx+++ b/apps/web/src/app/(unauthenticated)/signin/page.tsx@@ -4,7 +4,7 @@ import { redirect } from 'next/navigation';import { env } from 'next-runtime-env';-import { IS_GOOGLE_SSO_ENABLED } from '@documenso/lib/constants/auth';+import { IS_GOOGLE_SSO_ENABLED, IS_OIDC_SSO_ENABLED } from '@documenso/lib/constants/auth';import { decryptSecondaryData } from '@documenso/lib/server-only/crypto/decrypt';import { SignInForm } from '~/components/forms/signin';@@ -37,10 +37,13 @@ export default function SignInPage({ searchParams }: SignInPageProps) {<p className="text-muted-foreground mt-2 text-sm">Welcome back, we are lucky to have you.</p>-<hr className="-mx-6 my-4" />- <SignInForm initialEmail={email || undefined} isGoogleSSOEnabled={IS_GOOGLE_SSO_ENABLED} />+ <SignInForm+ initialEmail={email || undefined}+ isGoogleSSOEnabled={IS_GOOGLE_SSO_ENABLED}+ isOIDCSSOEnabled={IS_OIDC_SSO_ENABLED}+ />{NEXT_PUBLIC_DISABLE_SIGNUP !== 'true' && (<p className="text-muted-foreground mt-6 text-center text-sm">diff --git a/apps/web/src/app/(unauthenticated)/signup/page.tsx b/apps/web/src/app/(unauthenticated)/signup/page.tsxindex c7284fac6..2373af770 100644--- a/apps/web/src/app/(unauthenticated)/signup/page.tsx+++ b/apps/web/src/app/(unauthenticated)/signup/page.tsx@@ -3,7 +3,7 @@ import { redirect } from 'next/navigation';import { env } from 'next-runtime-env';-import { IS_GOOGLE_SSO_ENABLED } from '@documenso/lib/constants/auth';+import { IS_GOOGLE_SSO_ENABLED, IS_OIDC_SSO_ENABLED } from '@documenso/lib/constants/auth';import { decryptSecondaryData } from '@documenso/lib/server-only/crypto/decrypt';import { SignUpFormV2 } from '~/components/forms/v2/signup';@@ -37,6 +37,7 @@ export default function SignUpPage({ searchParams }: SignUpPageProps) {className="w-screen max-w-screen-2xl px-4 md:px-16 lg:-my-16"initialEmail={email || undefined}isGoogleSSOEnabled={IS_GOOGLE_SSO_ENABLED}+ isOIDCSSOEnabled={IS_OIDC_SSO_ENABLED}/>);}diff --git a/apps/web/src/components/forms/signin.tsx b/apps/web/src/components/forms/signin.tsxindex 8d4dd7cd0..6b1e25539 100644--- a/apps/web/src/components/forms/signin.tsx+++ b/apps/web/src/components/forms/signin.tsx@@ -10,6 +10,7 @@ import { browserSupportsWebAuthn, startAuthentication } from '@simplewebauthn/brimport { KeyRoundIcon } from 'lucide-react';import { signIn } from 'next-auth/react';import { useForm } from 'react-hook-form';+import { FaIdCardClip } from 'react-icons/fa6';import { FcGoogle } from 'react-icons/fc';import { match } from 'ts-pattern';import { z } from 'zod';@@ -68,9 +69,15 @@ export type SignInFormProps = {className?: string;initialEmail?: string;isGoogleSSOEnabled?: boolean;+ isOIDCSSOEnabled?: boolean;};-export const SignInForm = ({ className, initialEmail, isGoogleSSOEnabled }: SignInFormProps) => {+export const SignInForm = ({+ className,+ initialEmail,+ isGoogleSSOEnabled,+ isOIDCSSOEnabled,+}: SignInFormProps) => {const { toast } = useToast();const { getFlag } = useFeatureFlags();@@ -256,6 +263,19 @@ export const SignInForm = ({ className, initialEmail, isGoogleSSOEnabled }: Sign}};+ const onSignInWithOIDCClick = async () => {+ try {+ await signIn('oidc', { callbackUrl: LOGIN_REDIRECT_PATH });+ } catch (err) {+ toast({+ title: 'An unknown error occurred',+ description:+ 'We encountered an unknown error while attempting to sign you In. Please try again later.',+ variant: 'destructive',+ });+ }+ };+return (<Form {...form}><form@@ -316,7 +336,7 @@ export const SignInForm = ({ className, initialEmail, isGoogleSSOEnabled }: Sign{isSubmitting ? 'Signing in...' : 'Sign In'}</Button>- {(isGoogleSSOEnabled || isPasskeyEnabled) && (+ {(isGoogleSSOEnabled || isPasskeyEnabled || isOIDCSSOEnabled) && (<div className="relative flex items-center justify-center gap-x-4 py-2 text-xs uppercase"><div className="bg-border h-px flex-1" /><span className="text-muted-foreground bg-transparent">Or continue with</span>@@ -338,6 +358,20 @@ export const SignInForm = ({ className, initialEmail, isGoogleSSOEnabled }: Sign</Button>)}+ {isOIDCSSOEnabled && (+ <Button+ type="button"+ size="lg"+ variant="outline"+ className="bg-background text-muted-foreground border"+ disabled={isSubmitting}+ onClick={onSignInWithOIDCClick}+ >+ <FaIdCardClip className="mr-2 h-5 w-5" />+ OIDC+ </Button>+ )}+{isPasskeyEnabled && (<Buttontype="button"diff --git a/apps/web/src/components/forms/signup.tsx b/apps/web/src/components/forms/signup.tsxindex 7082bcee3..7cb037c1e 100644--- a/apps/web/src/components/forms/signup.tsx+++ b/apps/web/src/components/forms/signup.tsx@@ -52,9 +52,15 @@ export type SignUpFormProps = {className?: string;initialEmail?: string;isGoogleSSOEnabled?: boolean;+ isOIDCSSOEnabled?: boolean;};-export const SignUpForm = ({ className, initialEmail, isGoogleSSOEnabled }: SignUpFormProps) => {+export const SignUpForm = ({+ className,+ initialEmail,+ isGoogleSSOEnabled,+ isOIDCSSOEnabled,+}: SignUpFormProps) => {const { toast } = useToast();const analytics = useAnalytics();const router = useRouter();@@ -121,6 +127,19 @@ export const SignUpForm = ({ className, initialEmail, isGoogleSSOEnabled }: Sign}};+ const onSignUpWithOIDCClick = async () => {+ try {+ await signIn('google', { callbackUrl: SIGN_UP_REDIRECT_PATH });+ } catch (err) {+ toast({+ title: 'An unknown error occurred',+ description:+ 'We encountered an unknown error while attempting to sign you Up. Please try again later.',+ variant: 'destructive',+ });+ }+ };+return (<Form {...form}><form@@ -221,6 +240,28 @@ export const SignUpForm = ({ className, initialEmail, isGoogleSSOEnabled }: Sign</Button></>)}++ {isOIDCSSOEnabled && (+ <>+ <div className="relative flex items-center justify-center gap-x-4 py-2 text-xs uppercase">+ <div className="bg-border h-px flex-1" />+ <span className="text-muted-foreground bg-transparent">Or</span>+ <div className="bg-border h-px flex-1" />+ </div>++ <Button+ type="button"+ size="lg"+ variant={'outline'}+ className="bg-background text-muted-foreground border"+ disabled={isSubmitting}+ onClick={onSignUpWithOIDCClick}+ >+ <FcGoogle className="mr-2 h-5 w-5" />+ Sign Up with OIDC+ </Button>+ </>+ )}</form></Form>);diff --git a/apps/web/src/components/forms/v2/signup.tsx b/apps/web/src/components/forms/v2/signup.tsxindex b3b502993..4c177ddef 100644--- a/apps/web/src/components/forms/v2/signup.tsx+++ b/apps/web/src/components/forms/v2/signup.tsx@@ -10,6 +10,7 @@ import { zodResolver } from '@hookform/resolvers/zod';import { AnimatePresence, motion } from 'framer-motion';import { signIn } from 'next-auth/react';import { useForm } from 'react-hook-form';+import { FaIdCardClip } from 'react-icons/fa6';import { FcGoogle } from 'react-icons/fc';import { z } from 'zod';@@ -73,12 +74,14 @@ export type SignUpFormV2Props = {className?: string;initialEmail?: string;isGoogleSSOEnabled?: boolean;+ isOIDCSSOEnabled?: boolean;};export const SignUpFormV2 = ({className,initialEmail,isGoogleSSOEnabled,+ isOIDCSSOEnabled,}: SignUpFormV2Props) => {const { toast } = useToast();const analytics = useAnalytics();@@ -179,6 +182,19 @@ export const SignUpFormV2 = ({}};+ const onSignUpWithOIDCClick = async () => {+ try {+ await signIn('oidc', { callbackUrl: SIGN_UP_REDIRECT_PATH });+ } catch (err) {+ toast({+ title: 'An unknown error occurred',+ description:+ 'We encountered an unknown error while attempting to sign you Up. Please try again later.',+ variant: 'destructive',+ });+ }+ };+return (<div className={cn('flex justify-center gap-x-12', className)}><div className="border-border relative hidden flex-1 overflow-hidden rounded-xl border xl:flex">@@ -255,7 +271,7 @@ export const SignUpFormV2 = ({<fieldsetclassName={cn('flex h-[550px] w-full flex-col gap-y-4',- isGoogleSSOEnabled && 'h-[650px]',+ (isGoogleSSOEnabled || isOIDCSSOEnabled) && 'h-[650px]',)}disabled={isSubmitting}>@@ -323,14 +339,18 @@ export const SignUpFormV2 = ({)}/>- {isGoogleSSOEnabled && (+ {(isGoogleSSOEnabled || isOIDCSSOEnabled) && (<><div className="relative flex items-center justify-center gap-x-4 py-2 text-xs uppercase"><div className="bg-border h-px flex-1" /><span className="text-muted-foreground bg-transparent">Or</span><div className="bg-border h-px flex-1" /></div>+ </>+ )}+ {isGoogleSSOEnabled && (+ <><Buttontype="button"size="lg"@@ -345,6 +365,22 @@ export const SignUpFormV2 = ({</>)}+ {isOIDCSSOEnabled && (+ <>+ <Button+ type="button"+ size="lg"+ variant={'outline'}+ className="bg-background text-muted-foreground border"+ disabled={isSubmitting}+ onClick={onSignUpWithOIDCClick}+ >+ <FaIdCardClip className="mr-2 h-5 w-5" />+ Sign Up with OIDC+ </Button>+ </>+ )}+<p className="text-muted-foreground mt-4 text-sm">Already have an account?{' '}<Link href="/signin" className="text-documenso-700 duration-200 hover:opacity-70">diff --git a/packages/lib/constants/auth.ts b/packages/lib/constants/auth.tsindex 137ebe640..4df19b407 100644--- a/packages/lib/constants/auth.ts+++ b/packages/lib/constants/auth.ts@@ -5,12 +5,19 @@ export const SALT_ROUNDS = 12;export const IDENTITY_PROVIDER_NAME: { [key in IdentityProvider]: string } = {[IdentityProvider.DOCUMENSO]: 'Documenso',[IdentityProvider.GOOGLE]: 'Google',+ [IdentityProvider.OIDC]: 'OIDC',};export const IS_GOOGLE_SSO_ENABLED = Boolean(process.env.NEXT_PRIVATE_GOOGLE_CLIENT_ID && process.env.NEXT_PRIVATE_GOOGLE_CLIENT_SECRET,);+export const IS_OIDC_SSO_ENABLED = Boolean(+ process.env.NEXT_PRIVATE_OIDC_WELL_KNOWN &&+ process.env.NEXT_PRIVATE_OIDC_CLIENT_ID &&+ process.env.NEXT_PRIVATE_OIDC_CLIENT_SECRET,+);+export const USER_SECURITY_AUDIT_LOG_MAP: { [key in UserSecurityAuditLogType]: string } = {[UserSecurityAuditLogType.ACCOUNT_SSO_LINK]: 'Linked account to SSO',[UserSecurityAuditLogType.ACCOUNT_PROFILE_UPDATE]: 'Profile updated',diff --git a/packages/lib/next-auth/auth-options.ts b/packages/lib/next-auth/auth-options.tsindex 6805eedbe..e05fae573 100644--- a/packages/lib/next-auth/auth-options.ts+++ b/packages/lib/next-auth/auth-options.ts@@ -136,6 +136,25 @@ export const NEXT_AUTH_OPTIONS: AuthOptions = {};},}),+ {+ id: 'oidc',+ name: 'OIDC',+ wellKnown: process.env.NEXT_PRIVATE_OIDC_WELL_KNOWN,+ clientId: process.env.NEXT_PRIVATE_OIDC_CLIENT_ID,+ clientSecret: process.env.NEXT_PRIVATE_OIDC_CLIENT_SECRET,+ authorization: { params: { scope: 'openid email profile' } },+ idToken: true,+ checks: ['pkce', 'state'],+ type: 'oauth',+ allowDangerousEmailAccountLinking: true,+ profile(profile) {+ return {+ id: Number(profile.sub),+ email: profile.email,+ name: profile.name || `${profile.given_name} ${profile.family_name}`.trim(),+ };+ },+ },CredentialsProvider({id: 'webauthn',name: 'Keypass',diff --git a/packages/prisma/migrations/20240413202001_add_oidc_auth/migration.sql b/packages/prisma/migrations/20240413202001_add_oidc_auth/migration.sqlnew file mode 100644index 000000000..929ae8d97--- /dev/null+++ b/packages/prisma/migrations/20240413202001_add_oidc_auth/migration.sql@@ -0,0 +1 @@+ALTER TYPE "IdentityProvider" ADD VALUE IF NOT EXISTS 'OIDC';\ No newline at end of filediff --git a/packages/prisma/schema.prisma b/packages/prisma/schema.prismaindex 35d429779..c707ff08b 100644--- a/packages/prisma/schema.prisma+++ b/packages/prisma/schema.prisma@@ -11,6 +11,7 @@ datasource db {enum IdentityProvider {DOCUMENSO+ OIDC}enum Role {diff --git a/packages/tsconfig/process-env.d.ts b/packages/tsconfig/process-env.d.tsindex 0e05004a4..6af9c44c2 100644--- a/packages/tsconfig/process-env.d.ts+++ b/packages/tsconfig/process-env.d.ts@@ -6,6 +6,10 @@ declare namespace NodeJS {NEXT_PRIVATE_GOOGLE_CLIENT_ID?: string;NEXT_PRIVATE_GOOGLE_CLIENT_SECRET?: string;+ NEXT_PRIVATE_OIDC_WELL_KNOWN?: string;+ NEXT_PRIVATE_OIDC_CLIENT_ID?: string;+ NEXT_PRIVATE_OIDC_CLIENT_SECRET?: string;+NEXT_PRIVATE_DATABASE_URL: string;NEXT_PRIVATE_ENCRYPTION_KEY: string;NEXT_PRIVATE_ENCRYPTION_SECONDARY_KEY: string;diff --git a/turbo.json b/turbo.jsonindex fa89193eb..6accaee57 100644--- a/turbo.json+++ b/turbo.json@@ -70,6 +70,9 @@"NEXT_PRIVATE_SIGNING_GCLOUD_APPLICATION_CREDENTIALS_CONTENTS","NEXT_PRIVATE_GOOGLE_CLIENT_ID","NEXT_PRIVATE_GOOGLE_CLIENT_SECRET",+ "NEXT_PRIVATE_OIDC_WELL_KNOWN",+ "NEXT_PRIVATE_OIDC_CLIENT_ID",+ "NEXT_PRIVATE_OIDC_CLIENT_SECRET","NEXT_PUBLIC_UPLOAD_TRANSPORT","NEXT_PRIVATE_UPLOAD_ENDPOINT","NEXT_PRIVATE_UPLOAD_FORCE_PATH_STYLE",