Skip to content

feat: oauth autoredirect support #690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshtgl wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: oauth autoredirect support #690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/CONFIGURATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ Used for magic-link login and invites.

### OAuth providers

#### Shared OAuth settings

- `OAUTH_AUTO_REDIRECT`: Optional flag. When set to `true`, the sign-in page automatically redirects to the first configured OAuth provider. This applies to any configured OAuth provider, including Google, Authentik, Keycloak, and generic OIDC.

#### Google

- `GOOGLE_CLIENT_ID`
Expand Down
2 changes: 2 additions & 0 deletions src/env.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ export const env = createEnv({
OIDC_CLIENT_SECRET: z.string().optional(),
OIDC_WELL_KNOWN_URL: z.string().optional(),
OIDC_ALLOW_DANGEROUS_EMAIL_LINKING: z.boolean().optional(),
OAUTH_AUTO_REDIRECT: z.boolean().optional(),
UPLOAD_MAX_FILE_SIZE_MB: z.coerce.number().int().positive().default(10),
},

Expand Down Expand Up @@ -140,6 +141,7 @@ export const env = createEnv({
OIDC_CLIENT_SECRET: process.env.OIDC_CLIENT_SECRET,
OIDC_WELL_KNOWN_URL: process.env.OIDC_WELL_KNOWN_URL,
OIDC_ALLOW_DANGEROUS_EMAIL_LINKING: Boolean(process.env.OIDC_ALLOW_DANGEROUS_EMAIL_LINKING),
OAUTH_AUTO_REDIRECT: 'true' === process.env.OAUTH_AUTO_REDIRECT,
UPLOAD_MAX_FILE_SIZE_MB: process.env.UPLOAD_MAX_FILE_SIZE_MB
? Number(process.env.UPLOAD_MAX_FILE_SIZE_MB)
: 10,
Expand Down
13 changes: 12 additions & 1 deletion src/pages/auth/signin.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ const Home: NextPage<{
feedbackEmail: string;
providers: ClientSafeProvider[];
callbackUrl?: string;
}> = ({ error, providers: serverProviders, feedbackEmail, callbackUrl }) => {
oauthAutoRedirect: boolean;
}> = ({ error, providers: serverProviders, feedbackEmail, callbackUrl, oauthAutoRedirect }) => {
const { t } = useTranslation();
const [emailStatus, setEmailStatus] = useState<'idle' | 'sending' | 'success'>('idle');
const [showVerificationStep, setShowVerificationStep] = useState(false);
Expand Down Expand Up @@ -110,6 +111,15 @@ const Home: NextPage<{
}
}, [error, t]);

useEffect(() => {
if (oauthAutoRedirect && !showVerificationStep && providers.length > 0 && !isLoadingProviders) {
const oauthProvider = providers.find((provider) => 'oauth' === provider.type);
if (oauthProvider) {
void signIn(oauthProvider.id, { callbackUrl });
}
}
}, [oauthAutoRedirect, showVerificationStep, providers, isLoadingProviders, callbackUrl]);

const onEmailSubmit = useCallback(async () => {
setEmailStatus('sending');
const email = emailForm.getValues().email.toLowerCase();
Expand Down Expand Up @@ -293,6 +303,7 @@ export const getServerSideProps: GetServerSideProps = async (context) => {
feedbackEmail: env.FEEDBACK_EMAIL ?? '',
providers: Object.values(providers ?? {}),
callbackUrl: callbackUrl && !Array.isArray(callbackUrl) ? callbackUrl : '',
oauthAutoRedirect: env.OAUTH_AUTO_REDIRECT,
},
};
};
Loading